@dotcms/client 0.0.1-alpha.9 → 0.0.1-beta.2

package/jest.config.ts

@@ -1,15 +0,0 @@
-/* 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/project.json

@@ -1,63 +0,0 @@
-{
-    "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

@@ -1,4 +0,0 @@
-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

@@ -1,258 +0,0 @@
-/// <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);
-        });
-    });
-});

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

@@ -1,297 +0,0 @@
-export interface ClientConfig {
-    /**
-     * The URL of the dotCMS instance.
-     *
-     * @description This is the URL of the dotCMS instance you want to interact with. Ensure to include the protocol (http or https).
-     * @example `https://demo.dotcms.com`
-     * @type {string}
-     * @required
-     */
-    dotcmsUrl: string;
-    /**
-     * The id of the site you want to interact with.
-     *
-     * @description to get the site id, go to the site you want to interact with and copy the id from the History tab
-     *
-     * @type {string}
-     * @required
-     */
-    siteId?: string;
-    /**
-     * The authentication token to use for the requests. If not provided, it will fallback to default site.
-     *
-     * @description you can get the auth token from our UI {@link https://www.dotcms.com/docs/latest/rest-api-authentication#creating-an-api-token-in-the-ui}
-     *
-     * @type {string}
-     * @required
-     */
-    authToken: string;
-    /**
-     * Additional options to pass to the fetch request.
-     *
-     * @description These options will be used in the fetch request. Any option can be specified except for 'body' and 'method' which are omitted.
-     * @example `{ headers: { 'Content-Type': 'application/json' } }`
-     * @type {Omit<RequestInit, 'body' | 'method'>}
-     * @optional
-     */
-    requestOptions?: Omit<RequestInit, 'body' | 'method'>;
-}
-
-type PageApiOptions = {
-    /**
-     * The path of the page you want to retrieve.
-     *
-     * @type {string}
-     */
-    path: string;
-    /**
-     * The id of the site you want to interact with. If not provided, the one from the config will be used.
-     *
-     * @type {number}
-     */
-    siteId?: string;
-    /**
-     * The mode of the page you want to retrieve. If not provided will use the default mode of the site.
-     *
-     * @type {number}
-     */
-    mode?: string;
-    /**
-     * The language id of the page you want to retrieve. If not provided will use the default language of the site.
-     *
-     * @type {number}
-     */
-    language_id?: number;
-    /**
-     * The id of the persona you want to retrieve the page for.
-     *
-     * @type {string}
-     */
-    personaId?: string;
-    /**
-     * If you want to fire the rules set on the page
-     *
-     * @type {boolean}
-     */
-    fireRules?: boolean;
-    /**
-     * Allows access to related content via the Relationship fields of contentlets on a Page; 0 (default)
-     *
-     * @type {number}
-     */
-    depth?: number;
-};
-
-type NavApiOptions = {
-    /**
-     * The root path to begin traversing the folder tree.
-     *
-     * @example
-     * `/api/v1/nav/` starts from the root of the site
-     * @example
-     * `/about-us` starts from the "About Us" folder
-     *
-     * @type {string}
-     */
-    path: string;
-    /**
-     * The depth of the folder tree to return.
-     * @example
-     * `1` returns only the element specified in the path.
-     * @example
-     * `2` returns the element specified in the path, and if that element is a folder, returns all direct children of that folder.
-     * @example
-     * `3` returns all children and grandchildren of the element specified in the path.
-     *
-     * @type {number}
-     */
-    depth?: number;
-    /**
-     * The language ID of content to return.
-     * @example
-     * `1` (or unspecified) returns content in the default language of the site.
-     *
-     * @link https://www.dotcms.com/docs/latest/system-language-properties#DefaultLanguage
-     * @link https://www.dotcms.com/docs/latest/adding-and-editing-languages#LanguageID
-     * @type {number}
-     */
-    languageId?: number;
-};
-
-function isValidUrl(url: string): boolean {
-    try {
-        new URL(url);
-
-        return true;
-    } catch (error) {
-        return false;
-    }
-}
-
-/**
- * `DotCmsClient` is a TypeScript class that provides methods to interact with the DotCMS REST API.
- * It requires a configuration object on instantiation, which includes the DotCMS URL, site ID, and authentication token.
- *
- * @class DotCmsClient
- *
- * @property {ClientConfig} config - The configuration object for the DotCMS client.
- *
- * @method constructor(config: ClientConfig) - Constructs a new instance of the DotCmsClient class.
- *
- * @method page.get(options: PageApiOptions): Promise<unknown> - Retrieves all the elements of any Page in your dotCMS system in JSON format.
- *
- * @method nav.get(options: NavApiOptions = { depth: 0, path: '/', languageId: 1 }): Promise<unknown> - Retrieves information about the dotCMS file and folder tree.
- *
- */
-export class DotCmsClient {
-    private config: ClientConfig;
-    private requestOptions!: Omit<RequestInit, 'body' | 'method'>;
-
-    constructor(
-        config: ClientConfig = { dotcmsUrl: '', authToken: '', requestOptions: {}, siteId: '' }
-    ) {
-        if (!config.dotcmsUrl) {
-            throw new Error("Invalid configuration - 'dotcmsUrl' is required");
-        }
-
-        if (!isValidUrl(config.dotcmsUrl)) {
-            throw new Error("Invalid configuration - 'dotcmsUrl' must be a valid URL");
-        }
-
-        if (!config.authToken) {
-            throw new Error("Invalid configuration - 'authToken' is required");
-        }
-
-        this.config = config;
-
-        this.requestOptions = {
-            ...this.config.requestOptions,
-            headers: {
-                Authorization: `Bearer ${this.config.authToken}`,
-                ...this.config.requestOptions?.headers
-            }
-        };
-    }
-
-    page = {
-        /**
-         * `page.get` is an asynchronous method of the `DotCmsClient` class that retrieves all the elements of any Page in your dotCMS system in JSON format.
-         * It takes a `PageApiOptions` object as a parameter and returns a Promise that resolves to the response from the DotCMS API.
-         *
-         * The Page API enables you to retrieve all the elements of any Page in your dotCMS system.
-         * The elements may be retrieved in JSON format.
-         *
-         * @link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas
-         * @async
-         * @param {PageApiOptions} options - The options for the Page API call.
-         * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
-         * @throws {Error} - Throws an error if the options are not valid.
-         */
-        get: async (options: PageApiOptions): Promise<unknown> => {
-            this.validatePageOptions(options);
-
-            const queryParamsObj: Record<string, string> = {};
-            for (const [key, value] of Object.entries(options)) {
-                if (value === undefined || key === 'path' || key === 'siteId') continue;
-
-                if (key === 'personaId') {
-                    queryParamsObj['com.dotmarketing.persona.id'] = String(value);
-                } else if (key === 'mode' && value) {
-                    queryParamsObj['mode'] = String(value);
-                } else {
-                    queryParamsObj[key] = String(value);
-                }
-            }
-
-            const queryHostId = options.siteId ?? this.config.siteId ?? '';
-
-            if (queryHostId) {
-                queryParamsObj['host_id'] = queryHostId;
-            }
-
-            const queryParams = new URLSearchParams(queryParamsObj).toString();
-
-            const formattedPath = options.path.startsWith('/') ? options.path : `/${options.path}`;
-            const url = `${this.config.dotcmsUrl}/api/v1/page/json${formattedPath}${
-                queryParams ? `?${queryParams}` : ''
-            }`;
-            const response = await fetch(url, this.requestOptions);
-
-            return response.json();
-        }
-    };
-
-    nav = {
-        /**
-         * `nav.get` is an asynchronous method of the `DotCmsClient` class that retrieves information about the dotCMS file and folder tree.
-         * It takes a `NavApiOptions` object as a parameter (with default values) and returns a Promise that resolves to the response from the DotCMS API.
-         *
-         * The navigation REST API enables you to retrieve information about the dotCMS file and folder tree through REST API calls.
-         * @link https://www.dotcms.com/docs/latest/navigation-rest-api
-         * @async
-         * @param {NavApiOptions} options - The options for the Nav API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
-         * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
-         * @throws {Error} - Throws an error if the options are not valid.
-         */
-        get: async (
-            options: NavApiOptions = { depth: 0, path: '/', languageId: 1 }
-        ): Promise<unknown> => {
-            this.validateNavOptions(options);
-
-            // Extract the 'path' from the options and prepare the rest as query parameters
-            const { path, ...queryParamsOptions } = options;
-            const queryParamsObj: Record<string, string> = {};
-            Object.entries(queryParamsOptions).forEach(([key, value]) => {
-                if (value !== undefined) {
-                    queryParamsObj[key] = String(value);
-                }
-            });
-
-            const queryParams = new URLSearchParams(queryParamsObj).toString();
-
-            // Format the URL correctly depending on the 'path' value
-            const formattedPath = path === '/' ? '/' : `/${path}`;
-            const url = `${this.config.dotcmsUrl}/api/v1/nav${formattedPath}${
-                queryParams ? `?${queryParams}` : ''
-            }`;
-
-            const response = await fetch(url, this.requestOptions);
-
-            return response.json();
-        }
-    };
-
-    private validatePageOptions(options: PageApiOptions): void {
-        if (!options.path) {
-            throw new Error("The 'path' parameter is required for the Page API");
-        }
-    }
-
-    private validateNavOptions(options: NavApiOptions): void {
-        if (!options.path) {
-            throw new Error("The 'path' parameter is required for the Nav API");
-        }
-    }
-}
-
-/**
- * `dotcmsClient` is an object that provides a method to initialize the DotCMS SDK client.
- * It has a single method `init` which takes a configuration object and returns an instance of the `DotCmsClient` class.
- *
- * @namespace dotcmsClient
- *
- * @method init(config: ClientConfig): DotCmsClient - Initializes the SDK client.
- */
-export const dotcmsClient = {
-    /**
-     * `init` is a method of the `dotcmsClient` object that initializes the SDK client.
-     * It takes a configuration object as a parameter and returns an instance of the `DotCmsClient` class.
-     *
-     * @method init
-     * @param {ClientConfig} config - The configuration object for the DotCMS client.
-     * @returns {DotCmsClient} - An instance of the {@link DotCmsClient} class.
-     */
-    init: (config: ClientConfig): DotCmsClient => {
-        return new DotCmsClient(config);
-    }
-};

package/src/lib/editor/listeners/listeners.spec.ts

@@ -1,55 +0,0 @@
-import {
-    listenContentChange,
-    listenEditorMessages,
-    listenHoveredContentlet,
-    pingEditor,
-    scrollHandler
-} from './listeners';
-
-import { CUSTOMER_ACTIONS, postMessageToEditor } from '../models/client.model';
-
-jest.mock('../models/client.model', () => ({
-    postMessageToEditor: jest.fn(),
-    CUSTOMER_ACTIONS: {
-        NAVIGATION_UPDATE: 'set-url',
-        SET_BOUNDS: 'set-bounds',
-        SET_CONTENTLET: 'set-contentlet',
-        IFRAME_SCROLL: 'scroll',
-        PING_EDITOR: 'ping-editor',
-        CONTENT_CHANGE: 'content-change',
-        NOOP: 'noop'
-    }
-}));
-
-describe('listeners', () => {
-    it('should listen editor messages', () => {
-        const addEventListenerSpy = jest.spyOn(window, 'addEventListener');
-        listenEditorMessages();
-        expect(addEventListenerSpy).toHaveBeenCalledWith('message', expect.any(Function));
-    });
-
-    it('should listen to hovered contentlet', () => {
-        const addEventListenerSpy = jest.spyOn(document, 'addEventListener');
-        listenHoveredContentlet();
-        expect(addEventListenerSpy).toHaveBeenCalledWith('pointermove', expect.any(Function));
-    });
-
-    it('should handle scroll', () => {
-        const addEventListenerSpy = jest.spyOn(window, 'addEventListener');
-        scrollHandler();
-        expect(addEventListenerSpy).toHaveBeenCalledWith('scroll', expect.any(Function));
-    });
-
-    it('should listen to content change', () => {
-        const observeSpy = jest.spyOn(MutationObserver.prototype, 'observe');
-        listenContentChange();
-        expect(observeSpy).toHaveBeenCalledWith(document, { childList: true, subtree: true });
-    });
-
-    it('should send ping to editor', () => {
-        pingEditor();
-        expect(postMessageToEditor).toHaveBeenCalledWith({
-            action: CUSTOMER_ACTIONS.PING_EDITOR
-        });
-    });
-});