@dotcms/client 1.0.0-next.6 → 1.0.1

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/jest.config.ts

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

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@dotcms/client",
-  "version": "1.0.0-next.6",
+  "version": "1.0.1",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/dotCMS/core.git#main"
   },
   "dependencies": {
-    "consola": "^3.4.2"
+    "consola": "^3.4.2" 
   },
   "devDependencies": {
     "@dotcms/types": "latest"
@@ -24,27 +24,13 @@
   ],
   "exports": {
     "./package.json": "./package.json",
-    ".": {
-      "module": "./index.esm.js",
-      "types": "./index.esm.d.ts",
-      "import": "./index.cjs.mjs",
-      "default": "./index.cjs.js"
-    },
-    "./internal": {
-      "module": "./internal.esm.js",
-      "types": "./internal.esm.d.ts",
-      "import": "./internal.cjs.mjs",
-      "default": "./internal.cjs.js"
-    }
+    ".": "./src/index.ts",
+    "./internal": "./src/internal.ts"
   },
   "typesVersions": {
     "*": {
-      ".": [
-        "./src/index.d.ts"
-      ],
-      "internal": [
-        "./src/internal.d.ts"
-      ]
+      ".": ["./src/index.d.ts"],
+      "internal": ["./src/internal.d.ts"]
     }
   },
   "author": "dotcms <dev@dotcms.com>",
@@ -52,8 +38,5 @@
   "bugs": {
     "url": "https://github.com/dotCMS/core/issues"
   },
-  "homepage": "https://github.com/dotCMS/core/tree/main/core-web/libs/sdk/client/README.md",
-  "module": "./index.esm.js",
-  "main": "./index.cjs.js",
-  "types": "./index.esm.d.ts"
+  "homepage": "https://github.com/dotCMS/core/tree/main/core-web/libs/sdk/client/README.md"
 }

package/project.json

@@ -0,0 +1,73 @@
+{
+    "name": "sdk-client",
+    "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+    "sourceRoot": "libs/sdk/client/src",
+    "projectType": "library",
+    "targets": {
+        "build": {
+            "executor": "@nx/rollup:rollup",
+            "outputs": ["{options.outputPath}"],
+            "options": {
+                "format": ["esm", "cjs"],
+                "compiler": "tsc",
+                "additionalEntryPoints": ["libs/sdk/client/src/internal.ts"],
+                "generateExportsField": true,
+                "outputPath": "dist/libs/sdk/client",
+                "assets": [{ "input": "libs/sdk/client", "output": ".", "glob": "*.md" }],
+                "main": "libs/sdk/client/src/index.ts",
+                "tsConfig": "libs/sdk/client/tsconfig.lib.json"
+            }
+        },
+        "build:js": {
+            "executor": "@nx/esbuild:esbuild",
+            "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/deprecated/editor/sdk-editor-vtl.ts",
+                "external": ["react/jsx-runtime"],
+                "rollupConfig": "@nrwl/react/plugins/bundle-rollup",
+                "compiler": "tsc",
+                "extractCss": false,
+                "minify": true
+            }
+        },
+        "publish": {
+            "executor": "nx:run-commands",
+            "options": {
+                "command": "node tools/scripts/publish.mjs sdk-client {args.ver} {args.tag}"
+            },
+            "dependsOn": ["build"]
+        },
+        "nx-release-publish": {
+            "options": {
+                "packageRoot": "dist/libs/sdk/client"
+            }
+        },
+        "lint": {
+            "executor": "@nx/eslint:lint",
+            "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/lib/client/client.spec.ts

@@ -0,0 +1,147 @@
+import { DotCMSClientConfig, RequestOptions } from '@dotcms/types';
+
+import { createDotCMSClient } from './client';
+import { Content } from './content/content-api';
+import { NavigationClient } from './navigation/navigation-api';
+import { PageClient } from './page/page-api';
+
+// Mock the dependencies
+jest.mock('./content/content-api');
+jest.mock('./navigation/navigation-api');
+jest.mock('./page/page-api');
+
+describe('DotCMSClient', () => {
+    const originalTypeError = global.TypeError;
+    const mockTypeError = jest.fn().mockImplementation((...args) => new originalTypeError(...args));
+    const validConfig: DotCMSClientConfig = {
+        dotcmsUrl: 'https://demo.dotcms.com',
+        authToken: 'test-token',
+        siteId: 'test-site',
+        requestOptions: {
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        }
+    };
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        global.TypeError = mockTypeError as unknown as ErrorConstructor;
+    });
+
+    afterAll(() => {
+        global.TypeError = originalTypeError;
+    });
+
+    it('should initialize sub-clients with correct parameters', () => {
+        createDotCMSClient(validConfig);
+
+        const expectedRequestOptions: RequestOptions = {
+            headers: {
+                'Content-Type': 'application/json',
+                Authorization: 'Bearer test-token'
+            }
+        };
+
+        expect(PageClient).toHaveBeenCalledWith(
+            expect.objectContaining({
+                dotcmsUrl: 'https://demo.dotcms.com',
+                authToken: 'test-token',
+                siteId: 'test-site'
+            }),
+            expectedRequestOptions
+        );
+
+        expect(Content).toHaveBeenCalledWith(expectedRequestOptions, 'https://demo.dotcms.com');
+
+        expect(NavigationClient).toHaveBeenCalledWith(
+            expect.objectContaining({
+                dotcmsUrl: 'https://demo.dotcms.com',
+                authToken: 'test-token',
+                siteId: 'test-site'
+            }),
+            expectedRequestOptions
+        );
+    });
+
+    it('should add authorization header to request options', () => {
+        const configWithoutHeaders: DotCMSClientConfig = {
+            dotcmsUrl: 'https://demo.dotcms.com',
+            authToken: 'test-token'
+        };
+
+        createDotCMSClient(configWithoutHeaders);
+
+        expect(PageClient).toHaveBeenCalledWith(
+            expect.anything(),
+            expect.objectContaining({
+                headers: {
+                    Authorization: 'Bearer test-token'
+                }
+            })
+        );
+    });
+
+    it('should preserve existing headers when adding authorization', () => {
+        createDotCMSClient(validConfig);
+
+        expect(PageClient).toHaveBeenCalledWith(
+            expect.anything(),
+            expect.objectContaining({
+                headers: {
+                    'Content-Type': 'application/json',
+                    Authorization: 'Bearer test-token'
+                }
+            })
+        );
+    });
+
+    describe('validation and normalization', () => {
+        it('should throw TypeError when dotcmsUrl is invalid', () => {
+            const invalidConfig = {
+                ...validConfig,
+                dotcmsUrl: 'invalid-url'
+            };
+
+            try {
+                createDotCMSClient(invalidConfig);
+                fail('Expected TypeError to be thrown');
+            } catch (error) {
+                // This is expected, verify the error
+            }
+
+            expect(mockTypeError).toHaveBeenCalledWith(
+                "Invalid configuration - 'dotcmsUrl' must be a valid URL"
+            );
+        });
+
+        it('should throw TypeError when authToken is missing', () => {
+            const invalidConfig = {
+                ...validConfig,
+                authToken: ''
+            };
+
+            try {
+                createDotCMSClient(invalidConfig);
+                fail('Expected TypeError to be thrown');
+            } catch (error) {
+                // This is expected, verify the error
+            }
+
+            expect(mockTypeError).toHaveBeenCalledWith(
+                "Invalid configuration - 'authToken' is required"
+            );
+        });
+
+        it('should extract origin from dotcmsUrl', () => {
+            const configWithPath = {
+                ...validConfig,
+                dotcmsUrl: 'https://demo.dotcms.com/some/path'
+            };
+
+            createDotCMSClient(configWithPath);
+
+            expect(Content).toHaveBeenCalledWith(expect.anything(), 'https://demo.dotcms.com');
+        });
+    });
+});

package/src/lib/client/client.ts

@@ -0,0 +1,125 @@
+import { consola } from 'consola';
+
+import { DotCMSClientConfig, RequestOptions } from '@dotcms/types';
+
+import { Content } from './content/content-api';
+import { NavigationClient } from './navigation/navigation-api';
+import { PageClient } from './page/page-api';
+
+/**
+ * Parses a string into a URL object.
+ *
+ * @param url - The URL string to parse
+ * @returns A URL object if parsing is successful, undefined otherwise
+ */
+function parseURL(url: string): URL | undefined {
+    try {
+        return new URL(url);
+    } catch {
+        consola.error('[DotCMS Client]: Invalid URL:', url);
+
+        return undefined;
+    }
+}
+
+/**
+ * Default configuration for the DotCMS client.
+ */
+const defaultConfig: DotCMSClientConfig = {
+    dotcmsUrl: '',
+    authToken: '',
+    requestOptions: {}
+};
+
+/**
+ * Client for interacting with the DotCMS REST API.
+ * Provides access to content, page, and navigation functionality.
+ */
+class DotCMSClient {
+    private config: DotCMSClientConfig;
+    private requestOptions!: RequestOptions;
+
+    /**
+     * Client for content-related operations.
+     */
+    content: Content;
+
+    /**
+     * Client for page-related operations.
+     */
+    page: PageClient;
+
+    /**
+     * Client for navigation-related operations.
+     */
+    nav: NavigationClient;
+
+    /**
+     * Creates a new DotCMS client instance.
+     *
+     * @param config - Configuration options for the client
+     * @throws Warning if dotcmsUrl is invalid or authToken is missing
+     */
+    constructor(config: DotCMSClientConfig = defaultConfig) {
+        this.config = config;
+        this.requestOptions = this.createAuthenticatedRequestOptions(this.config);
+
+        // Initialize clients
+        this.page = new PageClient(this.config, this.requestOptions);
+        this.nav = new NavigationClient(this.config, this.requestOptions);
+        this.content = new Content(this.requestOptions, this.config.dotcmsUrl);
+    }
+
+    /**
+     * Creates request options with authentication headers.
+     *
+     * @param config - The client configuration
+     * @returns Request options with authorization headers
+     */
+    private createAuthenticatedRequestOptions(config: DotCMSClientConfig): RequestOptions {
+        return {
+            ...config.requestOptions,
+            headers: {
+                ...config.requestOptions?.headers,
+                Authorization: `Bearer ${config.authToken}`
+            }
+        };
+    }
+}
+
+/**
+ * Creates and returns a new DotCMS client instance.
+ *
+ * @param config - Configuration options for the client
+ * @returns A configured DotCMS client instance
+ * @example
+ * ```typescript
+ * const client = dotCMSCreateClient({
+ *   dotcmsUrl: 'https://demo.dotcms.com',
+ *   authToken: 'your-auth-token'
+ * });
+ *
+ * // Use the client to fetch content
+ * const pages = await client.page.get('/about-us');
+ * ```
+ */
+export const createDotCMSClient = (clientConfig: DotCMSClientConfig): DotCMSClient => {
+    const { dotcmsUrl, authToken } = clientConfig || {};
+    const instanceUrl = parseURL(dotcmsUrl)?.origin;
+
+    if (!instanceUrl) {
+        throw new TypeError("Invalid configuration - 'dotcmsUrl' must be a valid URL");
+    }
+
+    if (!authToken) {
+        throw new TypeError("Invalid configuration - 'authToken' is required");
+    }
+
+    const config = {
+        ...clientConfig,
+        authToken,
+        dotcmsUrl: instanceUrl
+    };
+
+    return new DotCMSClient(config);
+};