@dotcms/client 0.0.1-alpha.38 → 0.0.1-alpha.39

package/src/lib/query-builder/utils/{index.d.ts → index.ts}

@@ -2,17 +2,19 @@ import { Equals } from '../lucene-syntax/Equals';
 import { Field } from '../lucene-syntax/Field';
 import { NotOperand } from '../lucene-syntax/NotOperand';
 import { Operand } from '../lucene-syntax/Operand';
+
 /**
  * Enum for common Operands
  *
  * @export
  * @enum {number}
  */
-export declare enum OPERAND {
-    OR = "OR",
-    AND = "AND",
-    NOT = "NOT"
+export enum OPERAND {
+    OR = 'OR',
+    AND = 'AND',
+    NOT = 'NOT'
 }
+
 /**
  * This function removes extra spaces from a string.
  *
@@ -25,7 +27,10 @@ export declare enum OPERAND {
  * @param {string} str
  * @return {*}  {string}
  */
-export declare function sanitizeQuery(str: string): string;
+export function sanitizeQuery(str: string): string {
+    return str.replace(/\s{2,}/g, ' ').trim();
+}
+
 /**
  * This function sanitizes a term by adding quotes if it contains spaces.
  * In lucene, a term with spaces should be enclosed in quotes.
@@ -40,7 +45,10 @@ export declare function sanitizeQuery(str: string): string;
  * @param {string} term
  * @return {*}  {string}
  */
-export declare function sanitizePhrases(term: string): string;
+export function sanitizePhrases(term: string): string {
+    return term.includes(' ') ? `"${term}"` : term;
+}
+
 /**
  * This function builds a term to be used in a lucene query.
  * We need to sanitize the term before adding it to the query.
@@ -55,7 +63,12 @@ export declare function sanitizePhrases(term: string): string;
  * @param {string} term
  * @return {*}  {Equals}
  */
-export declare function buildEquals(query: string, term: string): Equals;
+export function buildEquals(query: string, term: string): Equals {
+    const newQuery = query + sanitizePhrases(term);
+
+    return new Equals(newQuery);
+}
+
 /**
  * This function builds a term to be used in a lucene query.
  * We need to sanitize the raw query before adding it to the query.
@@ -71,7 +84,12 @@ export declare function buildEquals(query: string, term: string): Equals;
  * @param {string} raw
  * @return {*}  {Equals}
  */
-export declare function buildRawEquals(query: string, raw: string): Equals;
+export function buildRawEquals(query: string, raw: string): Equals {
+    const newQuery = query + ` ${raw}`;
+
+    return new Equals(sanitizeQuery(newQuery));
+}
+
 /**
  * This function builds a field to be used in a lucene query.
  * We need to format the field before adding it to the query.
@@ -86,7 +104,12 @@ export declare function buildRawEquals(query: string, raw: string): Equals;
  * @param {string} field
  * @return {*}  {Field}
  */
-export declare function buildField(query: string, field: string): Field;
+export function buildField(query: string, field: string): Field {
+    const newQuery = query + ` +${field}:`;
+
+    return new Field(newQuery);
+}
+
 /**
  * This function builds an exclude field to be used in a lucene query.
  * We need to format the field before adding it to the query.
@@ -102,7 +125,12 @@ export declare function buildField(query: string, field: string): Field;
  * @param {string} field
  * @return {*}  {Field}
  */
-export declare function buildExcludeField(query: string, field: string): Field;
+export function buildExcludeField(query: string, field: string): Field {
+    const newQuery = query + ` -${field}:`;
+
+    return new Field(newQuery);
+}
+
 /**
  * This function builds an operand to be used in a lucene query.
  * We need to format the operand before adding it to the query.
@@ -124,7 +152,12 @@ export declare function buildExcludeField(query: string, field: string): Field;
  * @param {OPERAND} operand
  * @return {*}  {Operand}
  */
-export declare function buildOperand(query: string, operand: OPERAND): Operand;
+export function buildOperand(query: string, operand: OPERAND): Operand {
+    const newQuery = query + ` ${operand} `;
+
+    return new Operand(newQuery);
+}
+
 /**
  * This function builds a NOT operand to be used in a lucene query.
  * We need to format the operand before adding it to the query.
@@ -139,4 +172,8 @@ export declare function buildOperand(query: string, operand: OPERAND): Operand;
  * @param {string} query
  * @return {*}  {NotOperand}
  */
-export declare function buildNotOperand(query: string): NotOperand;
+export function buildNotOperand(query: string): NotOperand {
+    const newQuery = query + ` ${OPERAND.NOT} `;
+
+    return new NotOperand(newQuery);
+}

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

@@ -0,0 +1,150 @@
+import { graphqlToPageEntity } from './transforms';
+
+const GRAPHQL_RESPONSE_MOCK = {
+    page: {
+        title: 'test2',
+        url: '/test2',
+        seodescription: null,
+        containers: [
+            {
+                path: '//demo.dotcms.com/application/containers/default/',
+                identifier: '69b3d24d-7e80-4be6-b04a-d352d16493ee',
+                containerStructures: [
+                    {
+                        id: '77ec7720-bad8-431c-a0a3-6443fe87af73'
+                    },
+                    {
+                        id: '1e5372c4-9fff-4793-ad8a-a52558d0d395'
+                    },
+                    {
+                        id: '461b6fad-04a8-49ba-b75b-6634799bc289'
+                    },
+                    {
+                        id: '57b4a9de-4765-4c57-8a05-2a0a317ec546'
+                    },
+                    {
+                        id: '342a83bf-040a-45a2-a4bc-defb0f1bf4eb'
+                    },
+                    {
+                        id: '91a955a0-5c97-4fc3-91dd-f894e2f3dc54'
+                    },
+                    {
+                        id: '71ded7c9deb5b05452824bb42b9aa9d5'
+                    },
+                    {
+                        id: '86a06a2e-ba40-43d4-a3ad-3a870d43bfc1'
+                    },
+                    {
+                        id: '7673e601-26d4-4dbc-b6ad-7028599df656'
+                    },
+                    {
+                        id: '313498a4-5b57-4d9e-8d32-ef2d30f9e867'
+                    }
+                ],
+                containerContentlets: [
+                    {
+                        uuid: 'uuid-1562770692396',
+                        contentlets: [
+                            {
+                                identifier: 'd9444fa005a10d555318d8b014e474d4'
+                            }
+                        ]
+                    }
+                ]
+            }
+        ],
+        host: {
+            hostName: 'demo.dotcms.com'
+        },
+        layout: {
+            title: 'default-template'
+        },
+        template: {
+            identifier: '31f4c794-c769-4929-9d5d-7c383408c65c'
+        },
+        urlContentMap: {
+            identifier: '31f4c794-c769-4929-9d5d-7c383408c74d'
+        },
+        viewAs: {
+            mode: 'LIVE'
+        }
+    }
+};
+
+const MOCK_PAGE_ENTITY = {
+    containers: {
+        '//demo.dotcms.com/application/containers/default/': {
+            container: {
+                identifier: '69b3d24d-7e80-4be6-b04a-d352d16493ee',
+                path: '//demo.dotcms.com/application/containers/default/'
+            },
+            containerStructures: [
+                {
+                    id: '77ec7720-bad8-431c-a0a3-6443fe87af73'
+                },
+                {
+                    id: '1e5372c4-9fff-4793-ad8a-a52558d0d395'
+                },
+                {
+                    id: '461b6fad-04a8-49ba-b75b-6634799bc289'
+                },
+                {
+                    id: '57b4a9de-4765-4c57-8a05-2a0a317ec546'
+                },
+                {
+                    id: '342a83bf-040a-45a2-a4bc-defb0f1bf4eb'
+                },
+                {
+                    id: '91a955a0-5c97-4fc3-91dd-f894e2f3dc54'
+                },
+                {
+                    id: '71ded7c9deb5b05452824bb42b9aa9d5'
+                },
+                {
+                    id: '86a06a2e-ba40-43d4-a3ad-3a870d43bfc1'
+                },
+                {
+                    id: '7673e601-26d4-4dbc-b6ad-7028599df656'
+                },
+                {
+                    id: '313498a4-5b57-4d9e-8d32-ef2d30f9e867'
+                }
+            ],
+            contentlets: {
+                'uuid-1562770692396': [
+                    {
+                        identifier: 'd9444fa005a10d555318d8b014e474d4'
+                    }
+                ]
+            }
+        }
+    },
+    layout: {
+        title: 'default-template'
+    },
+    page: {
+        host: {
+            hostName: 'demo.dotcms.com'
+        },
+        seodescription: null,
+        title: 'test2',
+        url: '/test2'
+    },
+    urlContentMap: {
+        identifier: '31f4c794-c769-4929-9d5d-7c383408c74d'
+    },
+    template: {
+        identifier: '31f4c794-c769-4929-9d5d-7c383408c65c'
+    },
+    viewAs: {
+        mode: 'LIVE'
+    }
+};
+
+describe('GraphQL Parser', () => {
+    it('should return the correct page entity', () => {
+        const pageEntity = graphqlToPageEntity(GRAPHQL_RESPONSE_MOCK);
+
+        expect(pageEntity).toEqual(MOCK_PAGE_ENTITY);
+    });
+});

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/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/index.cjs.d.ts

@@ -1 +0,0 @@
-export * from "./src/index";

package/index.cjs.default.js

@@ -1 +0,0 @@
-exports._default = require('./index.cjs.js').default;