squidex-client-manager
Version:
a client for interacting with the Squidex API
388 lines (334 loc) • 11.4 kB
Markdown
# Squidex Client Manager [](https://badge.fury.io/js/squidex-client-manager) [](https://circleci.com/gh/scanf/squidex-client-manager)
[](https://squidex.io)
This is a wrapper around the swagger [API][a] provided by Squidex.
> The project is still a in early phase so the featureset is limited.
Please note all examples below use `cloud.squidex.io` in the examples but you
can easily change out the `https://cloud.squidex.io/api` portion with the
following format `https://<my-server-url>/api/` for self-hosted version.
## What is Squidex?
[Squidex][s] is a open source headless CMS. To learn more about it checkout the
following links:
- [Docker containers](https://github.com/squidex/squidex-dockers)
- [Source code](https://github.com/squidex/squidex)
- [Documentation](https://docs.squidex.io)
- [Hosted][s]
## Installation
### NPM
```
npm install squidex-client-manager
```
### Yarn
```
yarn add squidex-client-manager
```
## Usage
You need to setup the client before using it. For getting values for the client see
`https://cloud.squidex.io/app/<my-app>/settings/clients`
When you have those values you can setup the client. Note that all examples
below assume you are running in an `async` function.
### Setting up the client
```javascript
const { SquidexClientManager } = require('squidex-client-manager');
const client = new SquidexClientManager(
// Server Url
'https://cloud.squidex.io',
// App name
'my-blog-squidex',
// Client Id
'my-blog-squidex:developer',
// Client Secret
'my-secret',
);
```
### Retrieving records
By default only `20` records are returned, the max is `200` but you can combine
it with `skip` to paginate between the results or use `AllRecords` like below.
```javascript
const records = await client.RecordsAsync('Articles', { top: 0 })
console.log(JSON.stringify(records, null, 2))
/* Output:
[squidex-client-manager][debug]: Records(Articles, [object Object])
[squidex-client-manager][debug]: GetModelByName(Articles)
{
"total": 1,
"items": [
{
"id": "ffcbecb0-07a0-45f5-9b8e-bf53059fe25d",
"createdBy": "subject:5ce8610ec020db00018051c7",
"lastModifiedBy": "subject:5ce8610ec020db00018051c7",
"data": {
"title": {
"iv": "Hello Squidex"
},
"text": {
"iv": "## Testing markdown support"
}
},
"isPending": false,
"created": "2019-06-12T17:24:38Z",
"lastModified": "2019-06-12T17:24:38Z",
"status": "Published",
"version": 1
}
]
}
*/
const allRecords = await client.AllRecordsAsync('Articles');
console.log(allRecords.length);
500
```
### Retrieving a record
```javascript
const records = await client.RecordAsync('Articles', {
id: '4bb3a7bb-962d-4183-9ca6-35d170c34f3b'
})
console.log(JSON.stringify(records, null, 2))
/* Output:
[squidex-client-manager][debug]: Record(Articles, [object Object])
[squidex-client-manager][debug]: GetModelByName(Articles)
{
"title": {
"iv": "Testo-Wed Jun 12 2019 20:11:19 GMT+0200 (Central European Summer Time)"
}
} */
```
### Creating a record
```javascript
const title = 'My post'
const body = `
## topic 1
Lorem ipsum dolor sit amet, quo ne malis saperet fierent, has ut vivendo
imperdiet disputando, no cum oratio abhorreant. Agam accusata prodesset cu
pri, qui iudico constituto constituam an. Ne mel liber libris expetendis, per
eu imperdiet dignissim. Pro ridens fabulas evertitur ut.
`
const expected = {
data: { title: { iv: title }, text: { iv: body } },
publish: true
}
const article = await client.CreateAsync('Articles', expected)
console.log(JSON.stringify(article, null, 2))
/* Output:
[squidex-client-manager][debug]: Create(Articles, [object Object])
[squidex-client-manager][debug]: GetModelByName(Articles)
{
"id": "cdbcb9f7-f6f6-4a6a-81d9-0c6f9cf385f8",
"createdBy": "client:my-blog-squidex:developer",
"lastModifiedBy": "client:my-blog-squidex:developer",
"data": {
"title": {
"iv": "My post"
},
"text": {
"iv": "\n ## topic 1\n \n Lorem ipsum dolor sit amet, quo ne malis saperet fierent, has ut vivendo\n imperdiet disputando, no cum oratio abhorreant. Agam accusata prodesset cu\n pri, qui iudico constituto constituam an. Ne mel liber libris expetendis, per\n eu imperdiet dignissim. Pro ridens fabulas evertitur ut.\n "
}
},
"isPending": false,
"created": "2019-06-12T18:22:51Z",
"lastModified": "2019-06-12T18:22:51Z",
"status": "Published",
"version": 1
}
*/
```
### Deleting a record
```javascript
const deleted = await client.DeleteAsync('Articles', {
id: 'cdbcb9f7-f6f6-4a6a-81d9-0c6f9cf385f8'
})
console.log(JSON.stringify(deleted, null, 2))
/* Output:
[squidex-client-manager][debug]: Delete(Articles, [object Object])
[squidex-client-manager][debug]: GetModelByName(Articles)
{
"ok": true,
"url": "https://cloud.squidex.io/api/content/my-blog-squidex/articles/cdbcb9f7-f6f6-4a6a-81d9-0c6f9cf385f8/",
"status": 204,
"statusText": "No Content",
"headers": {
"date": "Wed, 12 Jun 2019 18:26:10 GMT",
"connection": "close",
"set-cookie": "__cfduid=d8ef8efcbcf5e2fb0d137c4ad4f26edf41560363970; expires=Thu, 11-Jun-20 18:26:10 GMT; path=/; domain=.squidex.io; HttpOnly; Secure",
"etag": "W/2",
"expect-ct": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"",
"server": "cloudflare",
"cf-ray": "4e5ddf1eaef0cae4-ARN"
},
"text": {
"type": "Buffer",
"data": []
},
"data": {
"type": "Buffer",
"data": []
}
}
*/
```
### Updating a record
Note that this function will override the other fields.
```javascript
// Get our record data
const record = await client.RecordAsync('Articles', {
id: '4bb3a7bb-962d-4183-9ca6-35d170c34f3b'
})
// Change the relevant fields
record.title.iv = 'the title is updated'
record.text.iv = 'the article text updated'
// Send the update
const update = await client.UpdateAsync('Articles', {
id: '4bb3a7bb-962d-4183-9ca6-35d170c34f3b',
data: record
});
console.log(JSON.stringify(update, null, 2))
/* Output:
[squidex-client-manager][debug]: Update(Articles, [object Object])
[squidex-client-manager][debug]: GetModelByName(Articles)
{
"title": {
"iv": "the title is updated"
},
"text": {
"iv": "the article text"
}
}
*/
```
### Create or update a record
If a record already exists it willl be merged.
```javascript
const createOrUpdate = await client.CreateOrUpdateAsync(
'Articles',
{
id: '4bb3a7bb-962d-4183-9ca6-35d170c34f3b',
data: {
title: { iv: 'title here is used as unique value for comparison' },
text: { iv: 'y' }
}
},
'title'
)
console.log(JSON.stringify(createOrUpdate, null, 2))
/* Output:
[squidex-client-manager][debug]: CreateOrUpdate(Articles, [object Object], title)
[squidex-client-manager][debug]: filter Articles where title eq title here is used as unique value for comparison
[squidex-client-manager][debug]: Records(Articles, [object Object])
[squidex-client-manager][debug]: GetModelByName(Articles)
[squidex-client-manager][debug]: Create(Articles, [object Object])
[squidex-client-manager][debug]: GetModelByName(Articles)
{
"id": "3b6c5b1c-51bd-45a2-8c07-736286c71b67",
"createdBy": "client:my-blog-squidex:developer",
"lastModifiedBy": "client:my-blog-squidex:developer",
"data": {
"title": {
"iv": "title here is used as unique value for comparison"
},
"text": {
"iv": "y"
}
},
"isPending": false,
"created": "2019-06-12T18:44:00Z",
"lastModified": "2019-06-12T18:44:00Z",
"status": "Draft",
"version": 0
}
*/
```
### Filtering
The current implementation of filtering only supports comparisons i.e only
`eq`. If you have use case that requests the full support of [OData
Conventions][oc], please reach out by creating a [issue][i].
If you only want to use `eq` then the following example should suffice
```javascript
const input = { data: { title: { iv: 'Hello Squidex' } }, publish: true }
const filter = await client.FilterRecordsAsync('Articles', input, 'title')
console.log(JSON.stringify(filter, null, 2))
/* Output:
[squidex-client-manager][debug]: filter Articles where title eq Hello Squidex
[squidex-client-manager][debug]: Records(Articles, [object Object])
[squidex-client-manager][debug]: GetModelByName(Articles)
[
{
"id": "ffcbecb0-07a0-45f5-9b8e-bf53059fe25d",
"createdBy": "subject:5ce8610ec020db00018051c7",
"lastModifiedBy": "subject:5ce8610ec020db00018051c7",
"data": {
"title": {
"iv": "Hello Squidex"
},
"text": {
"iv": "## Testing markdown support"
}
},
"isPending": false,
"created": "2019-06-12T17:24:38Z",
"lastModified": "2019-06-12T17:24:38Z",
"status": "Published",
"version": 1
}
]
*/
```
#### Find one
```javascript
const record = await client.FindOne('Articles', 'title', 'Hello Squidex')
console.log(JSON.stringify(record, null, 2))
/* Output:
[squidex-client-manager][debug]: Records(Articles, [object Object])
[squidex-client-manager][debug]: GetModelByName(Articles)
{
"id": "ffcbecb0-07a0-45f5-9b8e-bf53059fe25d",
"createdBy": "subject:5ce8610ec020db00018051c7",
"lastModifiedBy": "subject:5ce8610ec020db00018051c7",
"data": {
"title": {
"iv": "Hello Squidex"
},
"text": {
"iv": "## Testing markdown support"
}
},
"isPending": false,
"created": "2019-06-12T17:24:38Z",
"lastModified": "2019-06-12T17:24:38Z",
"status": "Published",
"version": 1
}
*/
```
#### Creating assets
If you need to upload images or PDF's you can use `CreateAssetAsync`. The only restriction currently
set is that the file must exist locally and be accessible. Also the mime type should be detectable.
```javascript
// The path to the file locally
const filename = '../GitHub/power-by.png';
const localImageFile = path.resolve(__dirname, filename);
const upload = await client.CreateAssetAsync(localImageFile);
console.log(upload.statusText, `${upload.url}/${upload.body.id}`);
/* Output:
Created https://cloud.squidex.io/api/assets/826d1176-d7c3-41cd-b166-13249fdcc225?version=0
*/
```
## Disclaimer
This project is not affiliated with [Squidex][0] and is an unofficial client.
The project is developed and maintained by [Alexander Alemayhu][twitter] for [Fortress][f].
## Troubleshooting
This repository is intentionally testing against [cloud.squidex.io][c]. If for
some reason you experience issues creating content via the API and are
self-hosting. Make sure you are running a [recent release][rr] of Squidex.
To check your version visit check version visit `https://<my-server-url>/api/info`
### Misc things to check
- Check the client has enough permissions (recommended role for testing is `Developer`).
- Check the model name you are querying exists in the Squidex schema.
- Check your token is valid.
[a]: https://docs.squidex.io/guides/02-api
[0]: https://squidex.io/
[twitter]: https://twitter.com/aalemayhu
[oc]: https://docs.squidex.io/guides/02-api#odata-conventions
[i]: https://github.com/scanf/squidex-client-manager/issues/new
[s]: https://squidex.io
[f]: https://fortress.no/
[rr]: https://github.com/Squidex/squidex/releases
[c]: https://cloud.squidex.io