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

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/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/editor/listeners/listeners.spec.ts

@@ -1,58 +0,0 @@
-import {
-    listenEditorMessages,
-    listenHoveredContentlet,
-    pingEditor,
-    preserveScrollOnIframe,
-    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'
-    }
-}));
-
-/**
- * Observation: We must test the execution of methods as well.
- */
-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 preserve scroll on iframe', () => {
-        const addEventListenerSpy = jest.spyOn(window, 'addEventListener');
-        preserveScrollOnIframe();
-        expect(addEventListenerSpy).toHaveBeenCalledWith('load', expect.any(Function));
-    });
-
-    it('should send ping to editor', () => {
-        pingEditor();
-        expect(postMessageToEditor).toHaveBeenCalledWith({
-            action: CUSTOMER_ACTIONS.PING_EDITOR
-        });
-    });
-});

package/src/lib/editor/sdk-editor.spec.ts

@@ -1,92 +0,0 @@
-import {
-    listenEditorMessages,
-    listenHoveredContentlet,
-    pingEditor,
-    scrollHandler
-} from './listeners/listeners';
-import { postMessageToEditor, CUSTOMER_ACTIONS } from './models/client.model';
-import { initEditor, isInsideEditor, updateNavigation } from './sdk-editor';
-
-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'
-    }
-}));
-
-jest.mock('./listeners/listeners', () => ({
-    pingEditor: jest.fn(),
-    listenEditorMessages: jest.fn(),
-    listenHoveredContentlet: jest.fn(),
-    scrollHandler: jest.fn(),
-    listenContentChange: jest.fn()
-}));
-
-describe('DotCMSPageEditor', () => {
-    describe('is NOT inside editor', () => {
-        beforeEach(() => {
-            const mockWindow = {
-                ...window,
-                parent: window
-            };
-
-            const spy = jest.spyOn(global, 'window', 'get');
-            spy.mockReturnValueOnce(mockWindow as unknown as Window & typeof globalThis);
-        });
-
-        afterEach(() => {
-            jest.clearAllMocks();
-        });
-
-        it('should initialize without any listener', () => {
-            const addEventListenerSpy = jest.spyOn(window, 'addEventListener');
-
-            expect(isInsideEditor()).toBe(false);
-            expect(addEventListenerSpy).not.toHaveBeenCalled();
-        });
-    });
-
-    describe('is inside editor', () => {
-        beforeEach(() => {
-            const mockWindow = {
-                ...window,
-                parent: null
-            };
-
-            const spy = jest.spyOn(global, 'window', 'get');
-            spy.mockReturnValue(mockWindow as unknown as Window & typeof globalThis);
-        });
-
-        afterEach(() => {
-            jest.clearAllMocks();
-        });
-
-        it('should initialize properly', () => {
-            expect(isInsideEditor()).toBe(true);
-        });
-
-        it('should update navigation', () => {
-            updateNavigation('/');
-            expect(postMessageToEditor).toHaveBeenCalledWith({
-                action: CUSTOMER_ACTIONS.NAVIGATION_UPDATE,
-                payload: {
-                    url: 'index'
-                }
-            });
-        });
-
-        it('should init editor calling listeners', () => {
-            initEditor();
-            expect(pingEditor).toHaveBeenCalled();
-            expect(listenEditorMessages).toHaveBeenCalled();
-            expect(listenHoveredContentlet).toHaveBeenCalled();
-            expect(scrollHandler).toHaveBeenCalled();
-        });
-    });
-});

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

@@ -1,164 +0,0 @@
-import { getContentletsBound } from './editor.utils';
-
-describe('getContentletsBound', () => {
-    const createContentlet = ({
-        x,
-        y,
-        width,
-        height,
-        dataset
-    }: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-        dataset: { [key: string]: string };
-    }): HTMLDivElement => {
-        const contentlet = document.createElement('div');
-        const mockGetBoundingClientRect = jest.fn(() => ({
-            x,
-            y,
-            width,
-            height
-        })) as unknown as () => DOMRect;
-        contentlet.getBoundingClientRect = mockGetBoundingClientRect;
-        Object.keys(dataset).forEach((key) => {
-            contentlet.setAttribute(`data-${key}`, dataset[key]);
-        });
-
-        return contentlet;
-    };
-
-    const containerRect = {
-        x: 0,
-        y: 0,
-        width: 100,
-        height: 100,
-        top: 0,
-        right: 100,
-        bottom: 100,
-        left: 0
-    } as DOMRect;
-
-    const contentlets: HTMLDivElement[] = [
-        createContentlet({
-            x: 10,
-            y: 20,
-            width: 30,
-            height: 40,
-            dataset: {
-                'dot-container': JSON.stringify({ uuid: 'container1' }),
-                'dot-identifier': 'contentlet1',
-                'dot-title': 'Contentlet 1',
-                'dot-inode': 'inode1',
-                'dot-type': 'type1'
-            }
-        }),
-        createContentlet({
-            x: 50,
-            y: 60,
-            width: 70,
-            height: 80,
-            dataset: {
-                'dot-container': JSON.stringify({ uuid: 'container1' }),
-                'dot-identifier': 'contentlet2',
-                'dot-title': 'Contentlet 2',
-                'dot-inode': 'inode2',
-                'dot-type': 'type2'
-            }
-        })
-    ];
-
-    it('should return an array of contentlets bound from contentlet with data atrribute dotContainer ', () => {
-        const result = getContentletsBound(containerRect, contentlets);
-
-        expect(result).toEqual([
-            {
-                x: 0,
-                y: 20,
-                width: 30,
-                height: 40,
-                payload: JSON.stringify({
-                    container: { uuid: 'container1' },
-                    contentlet: {
-                        identifier: 'contentlet1',
-                        title: 'Contentlet 1',
-                        inode: 'inode1',
-                        contentType: 'type1'
-                    }
-                })
-            },
-            {
-                x: 0,
-                y: 60,
-                width: 70,
-                height: 80,
-                payload: JSON.stringify({
-                    container: { uuid: 'container1' },
-                    contentlet: {
-                        identifier: 'contentlet2',
-                        title: 'Contentlet 2',
-                        inode: 'inode2',
-                        contentType: 'type2'
-                    }
-                })
-            }
-        ]);
-    });
-
-    it('should return an empty array if contentlets is empty', () => {
-        const result = getContentletsBound(containerRect, []);
-
-        expect(result).toEqual([]);
-    });
-
-    it('should return an array of contentlets with correct properties when dotContainer is not present in dataset', () => {
-        const contentletsWithMissingContainer: HTMLDivElement[] = [
-            createContentlet({
-                x: 10,
-                y: 20,
-                width: 30,
-                height: 40,
-                dataset: {
-                    'dot-identifier': 'contentlet1',
-                    'dot-title': 'Contentlet 1',
-                    'dot-inode': 'inode1',
-                    'dot-type': 'type1'
-                }
-            })
-        ];
-
-        const container = document.createElement('div');
-
-        container.appendChild(contentletsWithMissingContainer[0]);
-        container.setAttribute('data-dot-object', 'container');
-        container.setAttribute('data-dot-accept-types', '[Blogs]');
-        container.setAttribute('data-dot-identifier', '1');
-        container.setAttribute('data-max-contentlets', '1');
-        container.setAttribute('data-dot-uuid', '1');
-        const result = getContentletsBound(containerRect, contentletsWithMissingContainer);
-
-        expect(result).toEqual([
-            {
-                x: 0,
-                y: 20,
-                width: 30,
-                height: 40,
-                payload: JSON.stringify({
-                    container: {
-                        acceptTypes: '[Blogs]',
-                        identifier: '1',
-                        maxContentlets: '1',
-                        uuid: '1'
-                    },
-                    contentlet: {
-                        identifier: 'contentlet1',
-                        title: 'Contentlet 1',
-                        inode: 'inode1',
-                        contentType: 'type1'
-                    }
-                })
-            }
-        ]);
-    });
-});

package/tsconfig.json

@@ -1,22 +0,0 @@
-{
-    "extends": "../../../tsconfig.base.json",
-    "compilerOptions": {
-        "module": "ESNext",
-        "forceConsistentCasingInFileNames": true,
-        "strict": true,
-        "noImplicitOverride": true,
-        "noPropertyAccessFromIndexSignature": true,
-        "noImplicitReturns": true,
-        "noFallthroughCasesInSwitch": true
-    },
-    "files": [],
-    "include": [],
-    "references": [
-        {
-            "path": "./tsconfig.lib.json"
-        },
-        {
-            "path": "./tsconfig.spec.json"
-        }
-    ]
-}

package/tsconfig.lib.json

@@ -1,10 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "../../../dist/out-tsc",
-        "declaration": true,
-        "types": ["node"]
-    },
-    "include": ["src/**/*.ts"],
-    "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
-}

package/tsconfig.spec.json

@@ -1,9 +0,0 @@
-{
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-        "outDir": "../../../dist/out-tsc",
-        "module": "commonjs",
-        "types": ["jest", "node"]
-    },
-    "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
-}