@dotcms/client 1.0.1 → 1.0.2

package/internal.cjs.d.ts

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

package/internal.cjs.default.js

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

package/internal.cjs.js

@@ -0,0 +1,85 @@
+'use strict';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * 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);
+ * ```
+ */
+const graphqlToPageEntity = (graphQLPageResponse) => {
+    const { page } = graphQLPageResponse;
+    // If there is no page, return null
+    if (!page) {
+        return null;
+    }
+    const { layout, template, containers, urlContentMap, viewAs, host, vanityUrl, runningExperimentId, _map, ...pageAsset } = page;
+    const data = (_map || {});
+    const typedPageAsset = pageAsset;
+    // To prevent type errors, we cast the urlContentMap to an object
+    const urlContentMapObject = urlContentMap;
+    // Extract the _map data from the urlContentMap object
+    const urlContentMapData = urlContentMapObject?.['_map'];
+    return {
+        layout,
+        template,
+        viewAs,
+        vanityUrl,
+        runningExperimentId,
+        site: host,
+        urlContentMap: urlContentMapData,
+        containers: parseContainers(containers),
+        page: {
+            ...data,
+            ...typedPageAsset
+        }
+    };
+};
+/**
+ * Parses the containers from the GraphQL response.
+ *
+ * @param {DotCMSGraphQLPageContainer[]} [containers=[]] - The containers array from the GraphQL response.
+ * @returns {DotCMSPageAssetContainers} The parsed containers.
+ */
+const parseContainers = (containers = []) => {
+    return containers.reduce((acc, container) => {
+        const { path, identifier, containerStructures, containerContentlets, ...rest } = container;
+        const key = (path || identifier);
+        acc[key] = {
+            containerStructures,
+            container: {
+                path,
+                identifier,
+                ...rest
+            },
+            contentlets: parseContentletsToUuidMap(containerContentlets)
+        };
+        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 = []) => {
+    return containerContentlets.reduce((acc, containerContentlet) => {
+        const { uuid, contentlets } = containerContentlet;
+        // TODO: This is a temporary solution, we need to find a better way to handle this.
+        acc[uuid] = contentlets.map(({ _map = {}, ...rest }) => {
+            return {
+                ..._map,
+                ...rest
+            };
+        });
+        return acc;
+    }, {});
+};
+
+exports.graphqlToPageEntity = graphqlToPageEntity;

package/internal.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './internal.cjs.js';
+export { _default as default } from './internal.cjs.default.js';

package/internal.esm.d.ts

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

package/internal.esm.js

@@ -0,0 +1,83 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * 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);
+ * ```
+ */
+const graphqlToPageEntity = (graphQLPageResponse) => {
+    const { page } = graphQLPageResponse;
+    // If there is no page, return null
+    if (!page) {
+        return null;
+    }
+    const { layout, template, containers, urlContentMap, viewAs, host, vanityUrl, runningExperimentId, _map, ...pageAsset } = page;
+    const data = (_map || {});
+    const typedPageAsset = pageAsset;
+    // To prevent type errors, we cast the urlContentMap to an object
+    const urlContentMapObject = urlContentMap;
+    // Extract the _map data from the urlContentMap object
+    const urlContentMapData = urlContentMapObject?.['_map'];
+    return {
+        layout,
+        template,
+        viewAs,
+        vanityUrl,
+        runningExperimentId,
+        site: host,
+        urlContentMap: urlContentMapData,
+        containers: parseContainers(containers),
+        page: {
+            ...data,
+            ...typedPageAsset
+        }
+    };
+};
+/**
+ * Parses the containers from the GraphQL response.
+ *
+ * @param {DotCMSGraphQLPageContainer[]} [containers=[]] - The containers array from the GraphQL response.
+ * @returns {DotCMSPageAssetContainers} The parsed containers.
+ */
+const parseContainers = (containers = []) => {
+    return containers.reduce((acc, container) => {
+        const { path, identifier, containerStructures, containerContentlets, ...rest } = container;
+        const key = (path || identifier);
+        acc[key] = {
+            containerStructures,
+            container: {
+                path,
+                identifier,
+                ...rest
+            },
+            contentlets: parseContentletsToUuidMap(containerContentlets)
+        };
+        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 = []) => {
+    return containerContentlets.reduce((acc, containerContentlet) => {
+        const { uuid, contentlets } = containerContentlet;
+        // TODO: This is a temporary solution, we need to find a better way to handle this.
+        acc[uuid] = contentlets.map(({ _map = {}, ...rest }) => {
+            return {
+                ..._map,
+                ...rest
+            };
+        });
+        return acc;
+    }, {});
+};
+
+export { graphqlToPageEntity };

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@dotcms/client",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "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,13 +24,27 @@
   ],
   "exports": {
     "./package.json": "./package.json",
-    ".": "./src/index.ts",
-    "./internal": "./src/internal.ts"
+    ".": {
+      "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"
+    }
   },
   "typesVersions": {
     "*": {
-      ".": ["./src/index.d.ts"],
-      "internal": ["./src/internal.d.ts"]
+      ".": [
+        "./src/index.d.ts"
+      ],
+      "internal": [
+        "./src/internal.d.ts"
+      ]
     }
   },
   "author": "dotcms <dev@dotcms.com>",
@@ -38,5 +52,8 @@
   "bugs": {
     "url": "https://github.com/dotCMS/core/issues"
   },
-  "homepage": "https://github.com/dotCMS/core/tree/main/core-web/libs/sdk/client/README.md"
+  "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"
 }

package/src/lib/client/client.d.ts

@@ -0,0 +1,56 @@
+import { DotCMSClientConfig } from '@dotcms/types';
+import { Content } from './content/content-api';
+import { NavigationClient } from './navigation/navigation-api';
+import { PageClient } from './page/page-api';
+/**
+ * Client for interacting with the DotCMS REST API.
+ * Provides access to content, page, and navigation functionality.
+ */
+declare class DotCMSClient {
+    private config;
+    private 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);
+    /**
+     * Creates request options with authentication headers.
+     *
+     * @param config - The client configuration
+     * @returns Request options with authorization headers
+     */
+    private createAuthenticatedRequestOptions;
+}
+/**
+ * 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 declare const createDotCMSClient: (clientConfig: DotCMSClientConfig) => DotCMSClient;
+export {};

package/src/lib/client/content/builders/collection/{collection.ts → collection.d.ts}

@@ -1,19 +1,5 @@
-import { CONTENT_API_URL } from '../../shared/const';
-import {
-    GetCollectionResponse,
-    BuildQuery,
-    SortBy,
-    GetCollectionRawResponse,
-    GetCollectionError,
-    OnFullfilled,
-    OnRejected
-} from '../../shared/types';
-import { sanitizeQueryForContentType } from '../../shared/utils';
-import { Equals } from '../query/lucene-syntax';
-import { QueryBuilder } from '../query/query';
-
+import { GetCollectionResponse, BuildQuery, SortBy, GetCollectionError, OnFullfilled, OnRejected } from '../../shared/types';
 export type ClientOptions = Omit<RequestInit, 'body' | 'method'>;
-
 /**
  * Creates a Builder to filter and fetch content from the content API for a specific content type.
  *
@@ -21,22 +7,8 @@ export type ClientOptions = Omit<RequestInit, 'body' | 'method'>;
  * @class CollectionBuilder
  * @template T Represents the type of the content type to fetch. Defaults to unknown.
  */
-export class CollectionBuilder<T = unknown> {
-    #page = 1;
-    #limit = 10;
-    #depth = 0;
-    #render = false;
-    #sortBy?: SortBy[];
-    #contentType: string;
-    #defaultQuery: Equals;
-    #query?: Equals;
-    #rawQuery?: string;
-    #languageId: number | string = 1;
-    #draft = false;
-
-    #serverUrl: string;
-    #requestOptions: ClientOptions;
-
+export declare class CollectionBuilder<T = unknown> {
+    #private;
     /**
      * Creates an instance of CollectionBuilder.
      * @param {ClientOptions} requestOptions Options for the client request.
@@ -44,15 +16,7 @@ export class CollectionBuilder<T = unknown> {
      * @param {string} contentType The content type to fetch.
      * @memberof CollectionBuilder
      */
-    constructor(requestOptions: ClientOptions, serverUrl: string, contentType: string) {
-        this.#requestOptions = requestOptions;
-        this.#serverUrl = serverUrl;
-        this.#contentType = contentType;
-
-        // Build the default query with the contentType field
-        this.#defaultQuery = new QueryBuilder().field('contentType').equals(this.#contentType);
-    }
-
+    constructor(requestOptions: ClientOptions, serverUrl: string, contentType: string);
     /**
      * Returns the sort query in the format: field order, field order, ...
      *
@@ -60,10 +24,7 @@ export class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get sort() {
-        return this.#sortBy?.map((sort) => `${sort.field} ${sort.order}`).join(',');
-    }
-
+    private get sort();
     /**
      * Returns the offset for pagination.
      *
@@ -71,10 +32,7 @@ export class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get offset() {
-        return this.#limit * (this.#page - 1);
-    }
-
+    private get offset();
     /**
      * Returns the full URL for the content API.
      *
@@ -82,10 +40,7 @@ export class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get url() {
-        return `${this.#serverUrl}${CONTENT_API_URL}`;
-    }
-
+    private get url();
     /**
      * Returns the current query built.
      *
@@ -93,10 +48,7 @@ export class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get currentQuery() {
-        return this.#query ?? this.#defaultQuery;
-    }
-
+    private get currentQuery();
     /**
      * Filters the content by the specified language ID.
      *
@@ -111,12 +63,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    language(languageId: number | string): this {
-        this.#languageId = languageId;
-
-        return this;
-    }
-
+    language(languageId: number | string): this;
     /**
      * Setting this to true will server side render (using velocity) any widgets that are returned by the content query.
      *
@@ -125,12 +72,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    render(): this {
-        this.#render = true;
-
-        return this;
-    }
-
+    render(): this;
     /**
      * Sorts the content by the specified fields and orders.
      *
@@ -146,12 +88,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    sortBy(sortBy: SortBy[]): this {
-        this.#sortBy = sortBy;
-
-        return this;
-    }
-
+    sortBy(sortBy: SortBy[]): this;
     /**
      * Sets the maximum amount of content to fetch.
      *
@@ -159,12 +96,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    limit(limit: number): this {
-        this.#limit = limit;
-
-        return this;
-    }
-
+    limit(limit: number): this;
     /**
      * Sets the page number to fetch.
      *
@@ -172,12 +104,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    page(page: number): this {
-        this.#page = page;
-
-        return this;
-    }
-
+    page(page: number): this;
     /**
      * Filters the content by a Lucene query string.
      *
@@ -186,7 +113,6 @@ export class CollectionBuilder<T = unknown> {
      * @memberof CollectionBuilder
      */
     query(query: string): this;
-
     /**
      * Filters the content by building a query using a QueryBuilder function.
      *
@@ -204,33 +130,6 @@ export class CollectionBuilder<T = unknown> {
      * @memberof CollectionBuilder
      */
     query(buildQuery: BuildQuery): this;
-    query(arg: unknown): this {
-        if (typeof arg === 'string') {
-            this.#rawQuery = arg;
-
-            return this;
-        }
-
-        if (typeof arg !== 'function') {
-            throw new Error(
-                `Parameter for query method should be a buildQuery function or a string.\nExample:\nclient.content.getCollection('Activity').query((queryBuilder) => queryBuilder.field('title').equals('Hello World'))\nor\nclient.content.getCollection('Activity').query('+Activity.title:"Hello World"') \nSee documentation for more information.`
-            );
-        }
-
-        const builtQuery = arg(new QueryBuilder());
-
-        // This can be use in Javascript so we cannot rely on the type checking
-        if (builtQuery instanceof Equals) {
-            this.#query = builtQuery.raw(this.currentQuery.build());
-        } else {
-            throw new Error(
-                'Provided query is not valid. A query should end in an equals method call.\nExample:\n(queryBuilder) => queryBuilder.field("title").equals("Hello World")\nSee documentation for more information.'
-            );
-        }
-
-        return this;
-    }
-
     /**
      * Retrieves draft content.
      * @example
@@ -246,12 +145,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    draft(): this {
-        this.#draft = true;
-
-        return this;
-    }
-
+    draft(): this;
     /**
      * Filters the content by a variant ID for [Experiments](https://www.dotcms.com/docs/latest/experiments-and-a-b-testing)
      *
@@ -271,12 +165,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    variant(variantId: string): this {
-        this.#query = this.currentQuery.field('variant').equals(variantId);
-
-        return this;
-    }
-
+    variant(variantId: string): this;
     /**
      * Sets the depth of the relationships of the content.
      * Specifies the depth of related content to return in the results.
@@ -297,16 +186,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    depth(depth: number): this {
-        if (depth < 0 || depth > 3) {
-            throw new Error('Depth value must be between 0 and 3');
-        }
-
-        this.#depth = depth;
-
-        return this;
-    }
-
+    depth(depth: number): this;
     /**
      * Executes the fetch and returns a promise that resolves to the content or rejects with an error.
      *
@@ -325,30 +205,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {Promise<GetCollectionResponse<T> | GetCollectionError>} A promise that resolves to the content or rejects with an error.
      * @memberof CollectionBuilder
      */
-    then(
-        onfulfilled?: OnFullfilled<T>,
-        onrejected?: OnRejected
-    ): Promise<GetCollectionResponse<T> | GetCollectionError> {
-        return this.fetch().then(async (response) => {
-            const data = await response.json();
-            if (response.ok) {
-                const formattedResponse = this.formatResponse<T>(data);
-
-                const finalResponse =
-                    typeof onfulfilled === 'function'
-                        ? onfulfilled(formattedResponse)
-                        : formattedResponse;
-
-                return finalResponse;
-            } else {
-                return {
-                    status: response.status,
-                    ...data
-                };
-            }
-        }, onrejected);
-    }
-
+    then(onfulfilled?: OnFullfilled<T>, onrejected?: OnRejected): Promise<GetCollectionResponse<T> | GetCollectionError>;
     /**
      * Formats the response to the desired format.
      *
@@ -357,25 +214,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {GetCollectionResponse<T>} The formatted response.
      * @memberof CollectionBuilder
      */
-    private formatResponse<T>(data: GetCollectionRawResponse<T>): GetCollectionResponse<T> {
-        const contentlets = data.entity.jsonObjectView.contentlets;
-        const total = data.entity.resultsSize;
-
-        const mappedResponse: GetCollectionResponse<T> = {
-            contentlets,
-            total,
-            page: this.#page,
-            size: contentlets.length
-        };
-
-        return this.#sortBy
-            ? {
-                  ...mappedResponse,
-                  sortedBy: this.#sortBy
-              }
-            : mappedResponse;
-    }
-
+    private formatResponse;
     /**
      * Calls the content API to fetch the content.
      *
@@ -383,35 +222,5 @@ export class CollectionBuilder<T = unknown> {
      * @return {Promise<Response>} The fetch response.
      * @memberof CollectionBuilder
      */
-    private fetch(): Promise<Response> {
-        const finalQuery = this.currentQuery
-            .field('languageId')
-            .equals(this.#languageId.toString())
-            .field('live')
-            .equals((!this.#draft).toString())
-            .build();
-
-        const sanitizedQuery = sanitizeQueryForContentType(finalQuery, this.#contentType);
-
-        const query = this.#rawQuery ? `${sanitizedQuery} ${this.#rawQuery}` : sanitizedQuery;
-
-        return fetch(this.url, {
-            ...this.#requestOptions,
-            method: 'POST',
-            headers: {
-                ...this.#requestOptions.headers,
-                'Content-Type': 'application/json'
-            },
-            body: JSON.stringify({
-                query,
-                render: this.#render,
-                sort: this.sort,
-                limit: this.#limit,
-                offset: this.offset,
-                depth: this.#depth
-                //userId: This exist but we currently don't use it
-                //allCategoriesInfo: This exist but we currently don't use it
-            })
-        });
-    }
+    private fetch;
 }