@dotcms/client 0.0.1-alpha.37 → 0.0.1-alpha.38
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/index.cjs.js +579 -116
- package/index.esm.js +579 -116
- package/package.json +1 -1
- package/src/lib/client/content/builders/collection/collection.d.ts +138 -60
- package/src/lib/client/content/content-api.d.ts +60 -9
- package/src/lib/client/content/shared/const.d.ts +10 -0
- package/src/lib/client/content/shared/types.d.ts +76 -0
- package/src/lib/client/content/shared/utils.d.ts +12 -4
- package/src/lib/client/models/index.d.ts +11 -0
- package/src/lib/client/models/types.d.ts +8 -0
- package/src/lib/client/sdk-js-client.d.ts +113 -30
- package/src/lib/editor/listeners/listeners.d.ts +5 -1
- package/src/lib/editor/sdk-editor.d.ts +28 -3
- package/src/lib/editor/utils/editor.utils.d.ts +88 -12
- package/src/lib/query-builder/lucene-syntax/Equals.d.ts +38 -7
- package/src/lib/query-builder/lucene-syntax/Field.d.ts +13 -4
- package/src/lib/query-builder/lucene-syntax/NotOperand.d.ts +5 -1
- package/src/lib/query-builder/sdk-query-builder.d.ts +37 -3
- package/src/lib/query-builder/utils/index.d.ts +51 -0
- package/src/lib/utils/graphql/transforms.d.ts +23 -10
- package/src/lib/utils/page/common-utils.d.ts +30 -8
package/README.md
CHANGED
|
@@ -31,19 +31,19 @@ yarn add @dotcms/client
|
|
|
31
31
|
### ES Modules
|
|
32
32
|
|
|
33
33
|
```javascript
|
|
34
|
-
import {
|
|
34
|
+
import { DotCmsClient } from '@dotcms/client';
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
### CommonJS
|
|
38
38
|
|
|
39
39
|
```javascript
|
|
40
|
-
const {
|
|
40
|
+
const { DotCmsClient } = require('@dotcms/client');
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
First, initialize the client with your DotCMS instance details.
|
|
44
44
|
|
|
45
45
|
```javascript
|
|
46
|
-
const client =
|
|
46
|
+
const client = DotCmsClient.init({
|
|
47
47
|
dotcmsUrl: 'https://your-dotcms-instance.com',
|
|
48
48
|
authToken: 'your-auth-token',
|
|
49
49
|
siteId: 'your-site-id'
|
|
@@ -82,7 +82,7 @@ console.log(navData);
|
|
|
82
82
|
|
|
83
83
|
Detailed documentation of the `@dotcms/client` methods, parameters, and types can be found below:
|
|
84
84
|
|
|
85
|
-
### `
|
|
85
|
+
### `DotCmsClient.init(config: ClientConfig): DotCmsClient`
|
|
86
86
|
|
|
87
87
|
Initializes the DotCMS client with the specified configuration.
|
|
88
88
|
|