@dotcms/client 0.0.1-beta.9 → 1.0.0

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,11 +1,17 @@
 {
   "name": "@dotcms/client",
-  "version": "0.0.1-beta.9",
+  "version": "1.0.0",
   "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"
+  },
+  "devDependencies": {
+    "@dotcms/types": "latest"
+  },
   "scripts": {
     "build": "nx run sdk-client:build:js; cd ../../../../dotCMS/src/main/webapp/html/js/editor-js; rm -rf src package.json *.esm.d.ts"
   },
@@ -24,17 +30,11 @@
       "import": "./index.cjs.mjs",
       "default": "./index.cjs.js"
     },
-    "./next": {
-      "module": "./next.esm.js",
-      "types": "./next.esm.d.ts",
-      "import": "./next.cjs.mjs",
-      "default": "./next.cjs.js"
-    },
-    "./types": {
-      "module": "./types.esm.js",
-      "types": "./types.esm.d.ts",
-      "import": "./types.cjs.mjs",
-      "default": "./types.cjs.js"
+    "./internal": {
+      "module": "./internal.esm.js",
+      "types": "./internal.esm.d.ts",
+      "import": "./internal.cjs.mjs",
+      "default": "./internal.cjs.js"
     }
   },
   "typesVersions": {
@@ -42,11 +42,8 @@
       ".": [
         "./src/index.d.ts"
       ],
-      "next": [
-        "./src/next.d.ts"
-      ],
-      "types": [
-        "./src/types.d.ts"
+      "internal": [
+        "./src/internal.d.ts"
       ]
     }
   },

package/src/index.d.ts

@@ -1,8 +1 @@
-import { CLIENT_ACTIONS, postMessageToEditor } from './lib/deprecated/editor/models/client.model';
-import { CustomClientParams, DotCMSPageEditorConfig, EditorConfig } from './lib/deprecated/editor/models/editor.model';
-import { InlineEditorData, INLINE_EDITING_EVENT_KEY, InlineEditEventData } from './lib/deprecated/editor/models/inline-event.model';
-import { NOTIFY_CLIENT } from './lib/deprecated/editor/models/listeners.model';
-import { destroyEditor, editContentlet, reorderMenu, initEditor, isInsideEditor, updateNavigation, initInlineEditing } from './lib/deprecated/editor/sdk-editor';
-import { ClientConfig, DotCmsClient } from './lib/deprecated/sdk-js-client';
-import { getPageRequestParams, graphqlToPageEntity } from './lib/utils';
-export { destroyEditor, editContentlet, getPageRequestParams, graphqlToPageEntity, initEditor, initInlineEditing, isInsideEditor, postMessageToEditor, reorderMenu, updateNavigation, DotCmsClient, ClientConfig, CustomClientParams, DotCMSPageEditorConfig, EditorConfig, InlineEditEventData, InlineEditorData, CLIENT_ACTIONS, INLINE_EDITING_EVENT_KEY, NOTIFY_CLIENT };
+export { createDotCMSClient } from './lib/client/client';

package/src/internal.d.ts

@@ -0,0 +1 @@
+export { graphqlToPageEntity } from './lib/utils/graphql/transforms';

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

@@ -1,35 +1,7 @@
+import { DotCMSClientConfig } from '@dotcms/types';
 import { Content } from './content/content-api';
 import { NavigationClient } from './navigation/navigation-api';
 import { PageClient } from './page/page-api';
-/**
- * Options for configuring fetch requests, excluding body and method properties.
- */
-export type RequestOptions = Omit<RequestInit, 'body' | 'method'>;
-/**
- * Configuration options for the DotCMS client.
- */
-export interface DotCMSClientConfig {
-    /**
-     * The URL of the dotCMS instance.
-     * Ensure to include the protocol (http or https).
-     * @example `https://demo.dotcms.com`
-     */
-    dotcmsUrl: string;
-    /**
-     * The authentication token for requests.
-     * Obtainable from the dotCMS UI.
-     */
-    authToken: string;
-    /**
-     * The id of the site you want to interact with. Defaults to the default site if not provided.
-     */
-    siteId?: string;
-    /**
-     * Additional options for the fetch request.
-     * @example `{ headers: { 'Content-Type': 'application/json' } }`
-     */
-    requestOptions?: RequestOptions;
-}
 /**
  * Client for interacting with the DotCMS REST API.
  * Provides access to content, page, and navigation functionality.

package/src/lib/client/content/builders/collection/collection.d.ts

@@ -1,5 +1,5 @@
-import { ClientOptions } from '../../../../deprecated/sdk-js-client';
 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.
  *

package/src/lib/client/content/content-api.d.ts

@@ -1,5 +1,5 @@
+import { RequestOptions } from '@dotcms/types';
 import { CollectionBuilder } from './builders/collection/collection';
-import { ClientOptions } from '../../deprecated/sdk-js-client';
 /**
  * Creates a builder to filter and fetch a collection of content items.
  * @param contentType - The content type to retrieve.
@@ -15,7 +15,6 @@ import { ClientOptions } from '../../deprecated/sdk-js-client';
  *     .sortBy([{ field: 'title', order: 'asc' }])
  *     .query(q => q.field('author').equals('John Doe'))
  *     .depth(1)
- *     .fetch();
  *
  * console.log(response.contentlets);
  * ```
@@ -29,7 +28,6 @@ import { ClientOptions } from '../../deprecated/sdk-js-client';
  *     .sortBy([{ field: 'title', order: 'asc' }])
  *     .query(q => q.field('author').equals('John Doe'))
  *     .depth(1)
- *     .fetch()
  *     .then(response => console.log(response.contentlets))
  *     .catch(error => console.error(error));
  * ```
@@ -45,7 +43,6 @@ import { ClientOptions } from '../../deprecated/sdk-js-client';
  * const posts = await client.content
  *     .getCollection<BlogPost>('Blog')
  *     .limit(10)
- *     .fetch();
  *
  * posts.contentlets.forEach(post => {
  *     console.log(post.title, post.author, post.summary);
@@ -56,10 +53,10 @@ export declare class Content {
     #private;
     /**
      * Creates an instance of Content.
-     * @param {ClientOptions} requestOptions - The options for the client request.
+     * @param {RequestOptions} requestOptions - The options for the client request.
      * @param {string} serverUrl - The server URL.
      */
-    constructor(requestOptions: ClientOptions, serverUrl: string);
+    constructor(requestOptions: RequestOptions, serverUrl: string);
     /**
      * Takes a content type and returns a builder to filter and fetch the collection.
      * @param {string} contentType - The content type to get the collection.

package/src/lib/client/content/shared/types.d.ts

@@ -1,3 +1,4 @@
+import { Contentlet } from '@dotcms/types';
 import { Equals } from '../builders/query/lucene-syntax';
 import { QueryBuilder } from '../builders/query/query';
 /**
@@ -21,48 +22,6 @@ export type SortBy = {
  * @returns {Equals} The built query.
  */
 export type BuildQuery = (qb: QueryBuilder) => Equals;
-/**
- * Main fields of a Contentlet (Inherited from the Content Type).
- */
-export interface ContentTypeMainFields {
-    hostName: string;
-    modDate: string;
-    publishDate: string;
-    title: string;
-    baseType: string;
-    inode: string;
-    archived: boolean;
-    ownerName: string;
-    host: string;
-    working: boolean;
-    locked: boolean;
-    stInode: string;
-    contentType: string;
-    live: boolean;
-    owner: string;
-    identifier: string;
-    publishUserName: string;
-    publishUser: string;
-    languageId: number;
-    creationDate: string;
-    url: string;
-    titleImage: string;
-    modUserName: string;
-    hasLiveVersion: boolean;
-    folder: string;
-    hasTitleImage: boolean;
-    sortOrder: number;
-    modUser: string;
-    __icon__: string;
-    contentTypeIcon: string;
-    variant: string;
-}
-/**
- * The contentlet has the main fields and the custom fields of the content type.
- *
- * @template T - The custom fields of the content type.
- */
-export type Contentlet<T> = T & ContentTypeMainFields;
 /**
  * Callback for a fulfilled promise.
  *

package/src/lib/client/navigation/navigation-api.d.ts

@@ -1,20 +1,4 @@
-import { DotCMSClientConfig, RequestOptions } from '../client';
-interface NavRequestParams {
-    /**
-     * The depth of the folder tree to return.
-     * @example
-     * `1` returns only the element specified in the path.
-     * `2` returns the element specified in the path, and if that element is a folder, returns all direct children of that folder.
-     * `3` returns all children and grandchildren of the element specified in the path.
-     */
-    depth?: number;
-    /**
-     * The language ID of content to return.
-     * @example
-     * `1` (or unspecified) returns content in the default language of the site.
-     */
-    languageId?: number;
-}
+import { DotCMSClientConfig, DotCMSNavigationRequestParams, RequestOptions, DotCMSNavigationItem } from '@dotcms/types';
 export declare class NavigationClient {
     private requestOptions;
     private BASE_URL;
@@ -22,10 +6,9 @@ export declare class NavigationClient {
     /**
      * Retrieves information about the dotCMS file and folder tree.
      * @param {NavigationApiOptions} options - The options for the Navigation API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
-     * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
+     * @returns {Promise<DotCMSNavigationItem[]>} - A Promise that resolves to the response from the DotCMS API.
      * @throws {Error} - Throws an error if the options are not valid.
      */
-    get(path: string, params?: NavRequestParams): Promise<unknown>;
+    get(path: string, params?: DotCMSNavigationRequestParams): Promise<DotCMSNavigationItem[]>;
     private mapToBackendParams;
 }
-export {};

package/src/lib/client/page/page-api.d.ts

@@ -1,70 +1,9 @@
-import { DotCMSClientConfig, RequestOptions } from '../client';
-import { DotCMSGraphQLPageResponse, DotCMSPageAsset } from '../models/types';
-/**
- * The parameters for the Page API.
- * @public
- */
-export interface PageRequestParams {
-    /**
-     * The id of the site you want to interact with. Defaults to the one from the config if not provided.
-     */
-    siteId?: string;
-    /**
-     * The mode of the page you want to retrieve. Defaults to the site's default mode if not provided.
-     */
-    mode?: 'EDIT_MODE' | 'PREVIEW_MODE' | 'LIVE';
-    /**
-     * The language id of the page you want to retrieve. Defaults to the site's default language if not provided.
-     */
-    languageId?: number | string;
-    /**
-     * The id of the persona for which you want to retrieve the page.
-     */
-    personaId?: string;
-    /**
-     * Whether to fire the rules set on the page.
-     */
-    fireRules?: boolean | string;
-    /**
-     * Allows access to related content via the Relationship fields of contentlets on a Page; 0 (default).
-     */
-    depth?: 0 | 1 | 2 | 3 | '0' | '1' | '2' | '3';
-    /**
-     * The publish date of the page you want to retrieve.
-     */
-    publishDate?: string;
-    /**
-     * The variant name of the page you want to retrieve.
-     */
-    variantName?: string;
-}
-type StringifyParam<T> = T extends string | number | boolean ? string : never;
-type PageToBackendParamsMapping = {
-    siteId: 'hostId';
-    languageId: 'language_id';
-    personaId: 'com.dotmarketing.persona.id';
-};
-/**
- * The private parameters for the Page API.
- * @internal
- */
-export type BackendPageParams = {
-    [K in keyof PageRequestParams as K extends keyof PageToBackendParamsMapping ? PageToBackendParamsMapping[K] : K]?: StringifyParam<PageRequestParams[K]>;
-};
-export interface GraphQLPageOptions extends PageRequestParams {
-    graphql: {
-        page?: string;
-        content?: Record<string, string>;
-        variables?: Record<string, string>;
-        fragments?: string[];
-    };
-}
+import { DotCMSClientConfig, DotCMSComposedPageResponse, DotCMSExtendedPageResponse, DotCMSPageResponse, DotCMSPageRequestParams, RequestOptions } from '@dotcms/types';
 /**
  * Client for interacting with the DotCMS Page API.
  * Provides methods to retrieve and manipulate pages.
  */
 export declare class PageClient {
-    #private;
     /**
      * Request options including authorization headers.
      * @private
@@ -103,29 +42,22 @@ export declare class PageClient {
      */
     constructor(config: DotCMSClientConfig, requestOptions: RequestOptions);
     /**
-     * Retrieves a page from DotCMS using either REST API or GraphQL.
-     * This method is polymorphic and can handle both REST API and GraphQL requests based on the options provided.
+     * Retrieves a page from DotCMS using GraphQL.
      *
      * @param {string} url - The URL of the page to retrieve
-     * @param {PageRequestParams | GraphQLPageOptions} [options] - Options for the request
-     * @returns {Promise<DotCMSPageAsset | DotCMSGraphQLPageResponse>} A Promise that resolves to the page data
-     *
-     * @example Using REST API with options
-     * ```typescript
-     * const page = await pageClient.get('/about-us', {
-     *   mode: 'PREVIEW_MODE',
-     *   languageId: 1,
-     *   siteId: 'demo.dotcms.com'
-     * });
-     * ```
+     * @param {DotCMSPageRequestParams} [options] - Options for the request
+     * @template T - The type of the page and content, defaults to DotCMSBasicPage and Record<string, unknown> | unknown
+     * @returns {Promise<DotCMSComposedPageResponse<T>>} A Promise that resolves to the page data
      *
      * @example Using GraphQL
      * ```typescript
-     * const page = await pageClient.get('/index', {
-     *      languageId: '1',
-     *      mode: 'LIVE',
-     *      graphql: {
-     *          page: `
+     * const page = await pageClient.get<{ page: MyPageWithBanners; content: { blogPosts: { blogTitle: string } } }>(
+     *     '/index',
+     *     {
+     *         languageId: '1',
+     *         mode: 'LIVE',
+     *         graphql: {
+     *             page: `
      *              containers {
      *                  containerContentlets {
      *                      contentlets {
@@ -157,9 +89,7 @@ export declare class PageClient {
      *              ]
      *          }
      *      });
-     *```
+     * ```
      */
-    get(url: string, options?: PageRequestParams): Promise<DotCMSPageAsset>;
-    get(url: string, options?: GraphQLPageOptions): Promise<DotCMSGraphQLPageResponse>;
+    get<T extends DotCMSExtendedPageResponse = DotCMSPageResponse>(url: string, options?: DotCMSPageRequestParams): Promise<DotCMSComposedPageResponse<T>>;
 }
-export {};

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

@@ -1,14 +1,4 @@
-/**
- * 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;
-}
+import { DotCMSGraphQLPageResponse, DotCMSPageAsset } from '@dotcms/types';
 /**
  * Transforms a GraphQL Page response to a Page Entity.
  *
@@ -20,5 +10,4 @@ interface GraphQLPageResponse {
  * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
  * ```
  */
-export declare const graphqlToPageEntity: (graphQLPageResponse: GraphQLPageResponse) => any;
-export {};
+export declare const graphqlToPageEntity: (graphQLPageResponse: DotCMSGraphQLPageResponse) => DotCMSPageAsset | null;

package/src/lib/utils/index.d.ts

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

package/next.cjs.d.ts

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

package/next.cjs.default.js

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