@dotcms/client 0.0.1-alpha.4 → 0.0.1-alpha.40

package/src/lib/utils/graphql/transforms.ts

@@ -0,0 +1,99 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * Represents the response from a GraphQL query for a page.
+ *
+ * @interface GraphQLPageResponse
+ * @property {Record<string, unknown>} page - The main page data.
+ * @property {unknown} [key: string] - Additional properties that may be included in the response.
+ */
+interface GraphQLPageResponse {
+    page: Record<string, unknown>;
+    [key: string]: unknown;
+}
+
+/**
+ * Transforms a GraphQL Page response to a Page Entity.
+ *
+ * @param {GraphQLPageResponse} graphQLPageResponse - The GraphQL Page response object.
+ * @returns {object|null} The transformed Page Entity or null if the page is not present.
+ *
+ * @example
+ * ```ts
+ * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
+ * ```
+ */
+export const graphqlToPageEntity = (graphQLPageResponse: GraphQLPageResponse) => {
+    const { page } = graphQLPageResponse;
+
+    // If there is no page, return null
+    if (!page) {
+        return null;
+    }
+
+    const { layout, template, containers, urlContentMap, viewAs, site, _map, ...pageAsset } = page;
+    const data = (_map || {}) as Record<string, unknown>;
+
+    return {
+        layout,
+        template,
+        viewAs,
+        urlContentMap,
+        site,
+        page: {
+            ...data,
+            ...pageAsset
+        },
+        containers: parseContainers(containers as [])
+    } as any;
+};
+
+/**
+ * Parses the containers from the GraphQL response.
+ *
+ * @param {Array<Record<string, unknown>>} [containers=[]] - The containers array from the GraphQL response.
+ * @returns {Record<string, unknown>} The parsed containers.
+ */
+const parseContainers = (containers: Record<string, unknown>[] = []) => {
+    return containers.reduce((acc: Record<string, unknown>, container: Record<string, unknown>) => {
+        const { path, identifier, containerStructures, containerContentlets, ...rest } = container;
+
+        const key = (path || identifier) as string;
+
+        acc[key] = {
+            containerStructures,
+            container: {
+                path,
+                identifier,
+                ...rest
+            },
+            contentlets: parseContentletsToUuidMap(containerContentlets as [])
+        };
+
+        return acc;
+    }, {});
+};
+
+/**
+ * Parses the contentlets from the GraphQL response.
+ *
+ * @param {Array<Record<string, unknown>>} containerContentlets - The contentlets array from the GraphQL response.
+ * @returns {Record<string, Array<Record<string, unknown>>>} The parsed contentlets mapped by UUID.
+ */
+const parseContentletsToUuidMap = (containerContentlets: Record<string, unknown>[] = []) => {
+    return containerContentlets.reduce((acc, containerContentlet) => {
+        const { uuid, contentlets } = containerContentlet as {
+            uuid: string;
+            contentlets: Record<string, unknown>[];
+        };
+
+        // TODO: This is a temporary solution, we need to find a better way to handle this.
+        acc[uuid] = contentlets.map(({ _map = {}, ...rest }) => {
+            return {
+                ...(_map as Record<string, unknown>),
+                ...rest
+            };
+        });
+
+        return acc;
+    }, {});
+};

package/src/lib/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './graphql/transforms';
+export * from './page/common-utils';

package/src/lib/utils/page/common-utils.spec.ts

@@ -0,0 +1,37 @@
+import { getPageRequestParams } from './common-utils';
+
+describe('Common Utils', () => {
+    it('should return the correct Request Params', () => {
+        const pageRequestParams = getPageRequestParams({
+            path: 'test',
+            params: {
+                personaId: '123',
+                language_id: '1',
+                mode: 'LIVE',
+                variantName: 'default'
+            }
+        });
+
+        expect(pageRequestParams).toEqual({
+            path: 'test',
+            mode: 'LIVE',
+            language_id: '1',
+            variantName: 'default',
+            personaId: '123'
+        });
+    });
+
+    it('should return the correct Request Params with empty params', () => {
+        const pageRequestParams = getPageRequestParams({
+            path: 'test',
+            params: {
+                personaId: '',
+                language_id: '',
+                mode: '',
+                variantName: ''
+            }
+        });
+
+        expect(pageRequestParams).toEqual({ path: 'test' });
+    });
+});

package/src/lib/utils/page/common-utils.ts

@@ -0,0 +1,64 @@
+import { PageApiOptions } from '../../client/sdk-js-client';
+
+/**
+ * Interface representing the properties for page request parameters.
+ *
+ * @export
+ * @interface PageRequestParamsProps
+ */
+export interface PageRequestParamsProps {
+    /**
+     * The API endpoint path.
+     * @type {string}
+     */
+    path: string;
+
+    /**
+     * The query parameters for the API request.
+     * Can be an object with key-value pairs or a URLSearchParams instance.
+     * @type {{ [key: string]: unknown } | URLSearchParams}
+     */
+    params: { [key: string]: unknown } | URLSearchParams;
+}
+
+/**
+ * Generates the page request parameters to be used in the API call.
+ *
+ * @param {PageRequestParamsProps} PageRequestParamsProps - The properties for the page request.
+ * @returns {PageApiOptions} The options for the page API.
+ * @example
+ * ```ts
+ * const pageApiOptions = getPageRequestParams({ path: '/api/v1/page', params: queryParams });
+ * ```
+ */
+export const getPageRequestParams = ({
+    path = '',
+    params = {}
+}: PageRequestParamsProps): PageApiOptions => {
+    const copiedParams: PageRequestParamsProps['params'] =
+        params instanceof URLSearchParams ? Object.fromEntries(params.entries()) : { ...params };
+
+    const finalParams: Record<string, unknown> = {};
+    const dotMarketingPersonaId = copiedParams['com.dotmarketing.persona.id'] || '';
+
+    if (copiedParams['mode']) {
+        finalParams['mode'] = copiedParams['mode'];
+    }
+
+    if (copiedParams['language_id']) {
+        finalParams['language_id'] = copiedParams['language_id'];
+    }
+
+    if (copiedParams['variantName']) {
+        finalParams['variantName'] = copiedParams['variantName'];
+    }
+
+    if (copiedParams['personaId'] || dotMarketingPersonaId) {
+        finalParams['personaId'] = copiedParams['personaId'] || dotMarketingPersonaId;
+    }
+
+    return {
+        path,
+        ...finalParams
+    };
+};

package/tsconfig.json

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

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

package/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+    "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"]
+}

package/src/index.d.ts

@@ -1,2 +0,0 @@
-export * from './lib/sdk-js-client';
-export * from './lib/postMessageToEditor';

package/src/index.js

@@ -1,3 +0,0 @@
-export * from './lib/sdk-js-client';
-export * from './lib/postMessageToEditor';
-//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../libs/sdk/client/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC"}

package/src/lib/postMessageToEditor.d.ts

@@ -1,50 +0,0 @@
-/**
- * Actions send to the dotcms editor
- *
- * @export
- * @enum {number}
- */
-export declare enum CUSTOMER_ACTIONS {
-    /**
-     * Tell the dotcms editor that page change
-     */
-    SET_URL = "set-url",
-    /**
-     * Send the element position of the rows, columnsm containers and contentlets
-     */
-    SET_BOUNDS = "set-bounds",
-    /**
-     * Send the information of the hovered contentlet
-     */
-    SET_CONTENTLET = "set-contentlet",
-    /**
-     * Tell the editor that the page is being scrolled
-     */
-    IFRAME_SCROLL = "scroll",
-    /**
-     * Ping the editor to see if the page is inside the editor
-     */
-    PING_EDITOR = "ping-editor",
-    CONTENT_CHANGE = "content-change",
-    NOOP = "noop"
-}
-/**
- * Post message props
- *
- * @export
- * @template T
- * @interface PostMessageProps
- */
-type PostMessageProps<T> = {
-    action: CUSTOMER_ACTIONS;
-    payload?: T;
-};
-/**
- * Post message to dotcms page editor
- *
- * @export
- * @template T
- * @param {PostMessageProps<T>} message
- */
-export declare function postMessageToEditor<T = unknown>(message: PostMessageProps<T>): void;
-export {};

package/src/lib/postMessageToEditor.js

@@ -1,42 +0,0 @@
-/**
- * Actions send to the dotcms editor
- *
- * @export
- * @enum {number}
- */
-export var CUSTOMER_ACTIONS;
-(function (CUSTOMER_ACTIONS) {
-    /**
-     * Tell the dotcms editor that page change
-     */
-    CUSTOMER_ACTIONS["SET_URL"] = "set-url";
-    /**
-     * Send the element position of the rows, columnsm containers and contentlets
-     */
-    CUSTOMER_ACTIONS["SET_BOUNDS"] = "set-bounds";
-    /**
-     * Send the information of the hovered contentlet
-     */
-    CUSTOMER_ACTIONS["SET_CONTENTLET"] = "set-contentlet";
-    /**
-     * Tell the editor that the page is being scrolled
-     */
-    CUSTOMER_ACTIONS["IFRAME_SCROLL"] = "scroll";
-    /**
-     * Ping the editor to see if the page is inside the editor
-     */
-    CUSTOMER_ACTIONS["PING_EDITOR"] = "ping-editor";
-    CUSTOMER_ACTIONS["CONTENT_CHANGE"] = "content-change";
-    CUSTOMER_ACTIONS["NOOP"] = "noop";
-})(CUSTOMER_ACTIONS || (CUSTOMER_ACTIONS = {}));
-/**
- * Post message to dotcms page editor
- *
- * @export
- * @template T
- * @param {PostMessageProps<T>} message
- */
-export function postMessageToEditor(message) {
-    window.parent.postMessage(message, '*');
-}
-//# sourceMappingURL=postMessageToEditor.js.map

package/src/lib/postMessageToEditor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"postMessageToEditor.js","sourceRoot":"","sources":["../../../../../../libs/sdk/client/src/lib/postMessageToEditor.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,gBAyBX;AAzBD,WAAY,gBAAgB;IACxB;;OAEG;IACH,uCAAmB,CAAA;IACnB;;OAEG;IACH,6CAAyB,CAAA;IACzB;;OAEG;IACH,qDAAiC,CAAA;IACjC;;OAEG;IACH,4CAAwB,CAAA;IACxB;;OAEG;IACH,+CAA2B,CAAA;IAE3B,qDAAiC,CAAA;IAEjC,iCAAa,CAAA;AACjB,CAAC,EAzBW,gBAAgB,KAAhB,gBAAgB,QAyB3B;AAcD;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAc,OAA4B;IACzE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AAC5C,CAAC"}

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

@@ -1,183 +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 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;
-};
-/**
- * `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 declare class DotCmsClient {
-    private config;
-    private requestOptions;
-    constructor(config?: ClientConfig);
-    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: (options: PageApiOptions) => Promise<unknown>;
-    };
-    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: (options?: NavApiOptions) => Promise<unknown>;
-    };
-    private validatePageOptions;
-    private validateNavOptions;
-}
-/**
- * `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 declare 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;
-};
-export {};