@dotcms/client 0.0.1-alpha.1 → 0.0.1-alpha.11

package/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+    "extends": ["../../../.eslintrc.base.json"],
+    "ignorePatterns": ["!**/*"],
+    "overrides": [
+        {
+            "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+            "rules": {}
+        },
+        {
+            "files": ["*.ts", "*.tsx"],
+            "rules": {}
+        },
+        {
+            "files": ["*.js", "*.jsx"],
+            "rules": {}
+        }
+    ]
+}

package/README.md

@@ -6,9 +6,9 @@ This client library provides a streamlined, promise-based interface to fetch pag
 
 ## Features
 
-- Easy-to-use methods to interact with the [DotCMS Page](https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas) and [Navigation APIs](https://www.dotcms.com/docs/latest/navigation-rest-api).
-- Support for custom actions to communicate with the DotCMS page editor.
-- Comprehensive TypeScript typings for better development experience.
+-   Easy-to-use methods to interact with the [DotCMS Page](https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas) and [Navigation APIs](https://www.dotcms.com/docs/latest/navigation-rest-api).
+-   Support for custom actions to communicate with the DotCMS page editor.
+-   Comprehensive TypeScript typings for better development experience.
 
 ## Installation
 
@@ -43,7 +43,7 @@ const client = dotcmsClient.init({
 Retrieve the elements of any page in your DotCMS system in JSON format.
 
 ```javascript
-const pageData = await client.getPage({
+const pageData = await client.page.get({
     path: '/your-page-path',
     language_id: 1,
     personaId: 'optional-persona-id'
@@ -57,7 +57,7 @@ console.log(pageData);
 Retrieve information about the DotCMS file and folder tree.
 
 ```javascript
-const navData = await client.getNav({
+const navData = await client.nav.get({
     path: '/',
     depth: 2,
     languageId: 1
@@ -74,20 +74,18 @@ Detailed documentation of the `@dotcms/client` methods, parameters, and types ca
 
 Initializes the DotCMS client with the specified configuration.
 
-### `DotCmsClient.getPage(options: PageApiOptions): Promise<unknown>`
+### `DotCmsClient.page.get(options: PageApiOptions): Promise<unknown>`
 
 Retrieves the specified page's elements from your DotCMS system in JSON format.
 
-### `DotCmsClient.getNav(options: NavApiOptions): Promise<unknown>`
+### `DotCmsClient.nav.get(options: NavApiOptions): Promise<unknown>`
 
 Retrieves information about the DotCMS file and folder tree.
 
-
 ## Contributing
 
 GitHub pull requests are the preferred method to contribute code to dotCMS. Before any pull requests can be accepted, an automated tool will ask you to agree to the [dotCMS Contributor's Agreement](https://gist.github.com/wezell/85ef45298c48494b90d92755b583acb3).
 
-
 ## Licensing
 
 dotCMS comes in multiple editions and as such is dual licensed. The dotCMS Community Edition is licensed under the GPL 3.0 and is freely available for download, customization and deployment for use within organizations of all stripes. dotCMS Enterprise Editions (EE) adds a number of enterprise features and is available via a supported, indemnified commercial license from dotCMS. For the differences between the editions, see [the feature page](http://dotcms.com/cms-platform/features).
@@ -110,4 +108,4 @@ Always refer to the official [DotCMS documentation](https://www.dotcms.com/docs/
 | Code Examples   | [Codeshare](https://dotcms.com/codeshare/)                          |
 | Forums/Listserv | [via Google Groups](https://groups.google.com/forum/#!forum/dotCMS) |
 | Twitter         | @dotCMS                                                             |
-| Main Site       | [dotCMS.com](https://dotcms.com/)                                   |
+| Main Site       | [dotCMS.com](https://dotcms.com/)                                   |

package/jest.config.ts

@@ -0,0 +1,15 @@
+/* eslint-disable */
+export default {
+    displayName: 'sdk-client',
+    preset: '../../../jest.preset.js',
+    globals: {
+        'ts-jest': {
+            tsconfig: '<rootDir>/tsconfig.spec.json'
+        }
+    },
+    transform: {
+        '^.+\\.[tj]s$': 'ts-jest'
+    },
+    moduleFileExtensions: ['ts', 'js', 'html'],
+    coverageDirectory: '../../../coverage/libs/sdk/client'
+};

package/package.json

@@ -1,28 +1,26 @@
 {
-  "name": "@dotcms/client",
-  "version": "0.0.1-alpha.1",
-  "type": "module",
-  "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/dotCMS/core.git#master"
-  },
-  "keywords": [
-    "dotCMS",
-    "CMS",
-    "Content Management",
-    "API Client",
-    "REST API"
-  ],
-  "author": "dotcms <dev@dotcms.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/dotCMS/core/issues"
-  },
-  "homepage": "https://github.com/dotCMS/core/tree/master/core-web/libs/sdk/client/README.md",
-  "peerDependencies": {
-    "tslib": "^2.3.0"
-  },
-  "main": "./src/index.js",
-  "types": "./src/index.d.ts"
+    "name": "@dotcms/client",
+    "version": "0.0.1-alpha.11",
+    "type": "module",
+    "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/dotCMS/core.git#master"
+    },
+    "scripts": {
+        "build": "nx run sdk-client:build:js; cd ../../../../dotCMS/src/main/webapp/html/js/editor-js; rm -rf src package.json *.esm.d.ts"
+    },
+    "keywords": [
+        "dotCMS",
+        "CMS",
+        "Content Management",
+        "API Client",
+        "REST API"
+    ],
+    "author": "dotcms <dev@dotcms.com>",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/dotCMS/core/issues"
+    },
+    "homepage": "https://github.com/dotCMS/core/tree/master/core-web/libs/sdk/client/README.md"
 }

package/project.json

@@ -0,0 +1,63 @@
+{
+    "name": "sdk-client",
+    "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+    "sourceRoot": "libs/sdk/client/src",
+    "projectType": "library",
+    "targets": {
+        "build": {
+            "executor": "@nrwl/js:tsc",
+            "outputs": ["{options.outputPath}"],
+            "options": {
+                "outputPath": "dist/libs/sdk/client",
+                "main": "libs/sdk/client/src/index.ts",
+                "tsConfig": "libs/sdk/client/tsconfig.lib.json",
+                "assets": ["libs/sdk/client/*.md"]
+            }
+        },
+        "build:js": {
+            "executor": "@nrwl/rollup:rollup",
+            "outputs": ["{options.outputPath}"],
+            "options": {
+                "outputPath": "../dotCMS/src/main/webapp/html/js/editor-js",
+                "outputFileName": "sdk-editor",
+                "format": ["esm"],
+                "tsConfig": "libs/sdk/client/tsconfig.lib.json",
+                "project": "libs/sdk/client/package.json",
+                "entryFile": "libs/sdk/client/src/lib/editor/sdk-editor-vtl.ts",
+                "external": ["react/jsx-runtime"],
+                "rollupConfig": "@nrwl/react/plugins/bundle-rollup",
+                "compiler": "swc",
+                "extractCss": false
+            }
+        },
+        "publish": {
+            "executor": "nx:run-commands",
+            "options": {
+                "command": "node tools/scripts/publish.mjs sdk-js-client {args.ver} {args.tag}"
+            },
+            "dependsOn": ["build"]
+        },
+        "lint": {
+            "executor": "@nrwl/linter:eslint",
+            "outputs": ["{options.outputFile}"],
+            "options": {
+                "lintFilePatterns": ["libs/sdk/client/**/*.ts"]
+            }
+        },
+        "test": {
+            "executor": "@nrwl/jest:jest",
+            "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+            "options": {
+                "jestConfig": "libs/sdk/client/jest.config.ts",
+                "passWithNoTests": true
+            },
+            "configurations": {
+                "ci": {
+                    "ci": true,
+                    "codeCoverage": true
+                }
+            }
+        }
+    },
+    "tags": []
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './lib/client/sdk-js-client';
+export * from './lib/editor/sdk-editor';
+export * from './lib/editor/models/editor.model';
+export * from './lib/editor/models/client.model';

package/src/lib/client/sdk-js-client.spec.ts

@@ -0,0 +1,258 @@
+/// <reference types="jest" />
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { DotCmsClient, dotcmsClient } from './sdk-js-client';
+global.fetch = jest.fn();
+
+// Utility function to mock fetch responses
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const mockFetchResponse = (body: any, ok = true, status = 200) => {
+    (fetch as jest.Mock).mockImplementationOnce(() =>
+        Promise.resolve({
+            ok,
+            status,
+            json: () => Promise.resolve(body)
+        })
+    );
+};
+
+describe('DotCmsClient', () => {
+    describe('with full configuration', () => {
+        let client: DotCmsClient;
+
+        beforeEach(() => {
+            (fetch as jest.Mock).mockClear();
+
+            client = dotcmsClient.init({
+                dotcmsUrl: 'http://localhost',
+                siteId: '123456',
+                authToken: 'ABC'
+            });
+        });
+
+        describe('init', () => {
+            it('should initialize with valid configuration', () => {
+                const config = {
+                    dotcmsUrl: 'https://example.com',
+                    siteId: '123456',
+                    authToken: 'ABC'
+                };
+
+                const client = dotcmsClient.init(config);
+                expect(client).toBeDefined();
+            });
+
+            it('should throw error on missing dotcmsUrl', () => {
+                const config = {
+                    dotcmsUrl: '',
+                    siteId: '123456',
+                    authToken: 'ABC'
+                };
+
+                expect(() => {
+                    dotcmsClient.init(config);
+                }).toThrow("Invalid configuration - 'dotcmsUrl' is required");
+            });
+
+            it('should throw error if dotcmsUrl is not a valid URL', () => {
+                const config = {
+                    dotcmsUrl: '//example.com',
+                    siteId: '123456',
+                    authToken: 'ABC'
+                };
+
+                expect(() => {
+                    dotcmsClient.init(config);
+                }).toThrow("Invalid configuration - 'dotcmsUrl' must be a valid URL");
+            });
+
+            it('should throw error on missing authToken', () => {
+                const config = {
+                    dotcmsUrl: 'https://example.com',
+                    siteId: '123456',
+                    authToken: ''
+                };
+
+                expect(() => {
+                    dotcmsClient.init(config);
+                }).toThrow("Invalid configuration - 'authToken' is required");
+            });
+        });
+
+        describe('page.get', () => {
+            it('should fetch page data successfully', async () => {
+                const mockResponse = { content: 'Page data' };
+                mockFetchResponse(mockResponse);
+
+                const data = await client.page.get({ path: '/home' });
+
+                expect(fetch).toHaveBeenCalledTimes(1);
+                expect(fetch).toHaveBeenCalledWith(
+                    'http://localhost/api/v1/page/json/home?host_id=123456',
+                    {
+                        headers: { Authorization: 'Bearer ABC' }
+                    }
+                );
+                expect(data).toEqual(mockResponse);
+            });
+
+            it('should throw an error if the path is not provided', async () => {
+                await expect(client.page.get({} as any)).rejects.toThrowError(
+                    `The 'path' parameter is required for the Page API`
+                );
+            });
+
+            it('should get the page for specified persona', () => {
+                const mockResponse = { content: 'Page data' };
+                mockFetchResponse(mockResponse);
+
+                client.page.get({ path: '/home', personaId: 'doe123' });
+
+                expect(fetch).toHaveBeenCalledWith(
+                    'http://localhost/api/v1/page/json/home?com.dotmarketing.persona.id=doe123&host_id=123456',
+                    {
+                        headers: { Authorization: 'Bearer ABC' }
+                    }
+                );
+            });
+
+            it('should get the page for specified siteId', () => {
+                const mockResponse = { content: 'Page data' };
+                mockFetchResponse(mockResponse);
+
+                client.page.get({ path: '/home', siteId: 'host-123' });
+
+                expect(fetch).toHaveBeenCalledWith(
+                    'http://localhost/api/v1/page/json/home?host_id=host-123',
+                    {
+                        headers: { Authorization: 'Bearer ABC' }
+                    }
+                );
+            });
+
+            it('should get the page for specified language', () => {
+                const mockResponse = { content: 'Page data' };
+                mockFetchResponse(mockResponse);
+
+                client.page.get({ path: '/home', language_id: 99 });
+
+                expect(fetch).toHaveBeenCalledWith(
+                    'http://localhost/api/v1/page/json/home?language_id=99&host_id=123456',
+                    {
+                        headers: { Authorization: 'Bearer ABC' }
+                    }
+                );
+            });
+        });
+
+        describe('nav.get', () => {
+            it('should fetch navigation data successfully', async () => {
+                const mockResponse = { nav: 'Navigation data' };
+                mockFetchResponse(mockResponse);
+
+                const data = await client.nav.get({ path: '/', depth: 1 });
+
+                expect(fetch).toHaveBeenCalledTimes(1);
+                expect(fetch).toHaveBeenCalledWith('http://localhost/api/v1/nav/?depth=1', {
+                    headers: { Authorization: 'Bearer ABC' }
+                });
+                expect(data).toEqual(mockResponse);
+            });
+
+            it('should correctly handle the root path', async () => {
+                const mockResponse = { nav: 'Root nav data' };
+                mockFetchResponse(mockResponse);
+
+                const data = await client.nav.get({ path: '/' });
+
+                expect(fetch).toHaveBeenCalledWith('http://localhost/api/v1/nav/', {
+                    headers: { Authorization: 'Bearer ABC' }
+                });
+                expect(data).toEqual(mockResponse);
+            });
+
+            it('should throw an error if the path is not provided', async () => {
+                await expect(client.nav.get({} as any)).rejects.toThrowError(
+                    `The 'path' parameter is required for the Nav API`
+                );
+            });
+        });
+    });
+
+    describe('with minimal configuration', () => {
+        let client: DotCmsClient;
+
+        beforeEach(() => {
+            (fetch as jest.Mock).mockClear();
+
+            client = dotcmsClient.init({
+                dotcmsUrl: 'http://localhost',
+                authToken: 'ABC'
+            });
+        });
+
+        it('should get the page without siteId', () => {
+            const mockResponse = { content: 'Page data' };
+            mockFetchResponse(mockResponse);
+
+            client.page.get({ path: '/home' });
+
+            expect(fetch).toHaveBeenCalledWith('http://localhost/api/v1/page/json/home', {
+                headers: { Authorization: 'Bearer ABC' }
+            });
+        });
+    });
+
+    describe('with requestOptions', () => {
+        let client: DotCmsClient;
+
+        beforeEach(() => {
+            (fetch as jest.Mock).mockClear();
+
+            client = dotcmsClient.init({
+                dotcmsUrl: 'http://localhost',
+                siteId: '123456',
+                authToken: 'ABC',
+                requestOptions: {
+                    headers: {
+                        'X-My-Header': 'my-value'
+                    },
+                    cache: 'no-cache'
+                }
+            });
+        });
+
+        it('should fetch page data with extra headers and cache', async () => {
+            const mockResponse = { content: 'Page data' };
+            mockFetchResponse(mockResponse);
+
+            const data = await client.page.get({ path: '/home' });
+
+            expect(fetch).toHaveBeenCalledTimes(1);
+            expect(fetch).toHaveBeenCalledWith(
+                'http://localhost/api/v1/page/json/home?host_id=123456',
+                {
+                    headers: { Authorization: 'Bearer ABC', 'X-My-Header': 'my-value' },
+                    cache: 'no-cache'
+                }
+            );
+            expect(data).toEqual(mockResponse);
+        });
+
+        it('should fetch bav data with extra headers and cache', async () => {
+            const mockResponse = { content: 'Page data' };
+            mockFetchResponse(mockResponse);
+
+            const data = await client.nav.get();
+
+            expect(fetch).toHaveBeenCalledTimes(1);
+            expect(fetch).toHaveBeenCalledWith(
+                'http://localhost/api/v1/nav/?depth=0&languageId=1',
+                {
+                    headers: { Authorization: 'Bearer ABC', 'X-My-Header': 'my-value' },
+                    cache: 'no-cache'
+                }
+            );
+            expect(data).toEqual(mockResponse);
+        });
+    });
+});