@dotcms/client 1.0.0 → 1.0.1

package/internal.cjs.d.ts

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

package/internal.cjs.default.js

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

package/internal.cjs.js

@@ -1,85 +0,0 @@
-'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

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

package/internal.esm.d.ts

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

package/internal.esm.js

@@ -1,83 +0,0 @@
-/* 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/src/lib/client/client.d.ts

@@ -1,56 +0,0 @@
-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/navigation/navigation-api.d.ts

@@ -1,14 +0,0 @@
-import { DotCMSClientConfig, DotCMSNavigationRequestParams, RequestOptions, DotCMSNavigationItem } from '@dotcms/types';
-export declare class NavigationClient {
-    private requestOptions;
-    private BASE_URL;
-    constructor(config: DotCMSClientConfig, requestOptions: RequestOptions);
-    /**
-     * 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<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?: DotCMSNavigationRequestParams): Promise<DotCMSNavigationItem[]>;
-    private mapToBackendParams;
-}

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

@@ -1,95 +0,0 @@
-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 {
-    /**
-     * Request options including authorization headers.
-     * @private
-     */
-    private requestOptions;
-    /**
-     * Site ID for page requests.
-     * @private
-     */
-    private siteId;
-    /**
-     * DotCMS URL for page requests.
-     * @private
-     */
-    private dotcmsUrl;
-    /**
-     * Creates a new PageClient instance.
-     *
-     * @param {DotCMSClientConfig} config - Configuration options for the DotCMS client
-     * @param {RequestOptions} requestOptions - Options for fetch requests including authorization headers
-     * @example
-     * ```typescript
-     * const pageClient = new PageClient(
-     *   {
-     *     dotcmsUrl: 'https://demo.dotcms.com',
-     *     authToken: 'your-auth-token',
-     *     siteId: 'demo.dotcms.com'
-     *   },
-     *   {
-     *     headers: {
-     *       Authorization: 'Bearer your-auth-token'
-     *     }
-     *   }
-     * );
-     * ```
-     */
-    constructor(config: DotCMSClientConfig, requestOptions: RequestOptions);
-    /**
-     * Retrieves a page from DotCMS using GraphQL.
-     *
-     * @param {string} url - The URL of the page to retrieve
-     * @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<{ page: MyPageWithBanners; content: { blogPosts: { blogTitle: string } } }>(
-     *     '/index',
-     *     {
-     *         languageId: '1',
-     *         mode: 'LIVE',
-     *         graphql: {
-     *             page: `
-     *              containers {
-     *                  containerContentlets {
-     *                      contentlets {
-     *                          ... on 	Banner {
-     *                              ...bannerFragment
-     *                          }
-     *                      }
-     *                  }
-     *              `,
-     *              content: {
-     *                  blogPosts: `
-     *                      BlogCollection(limit: 3) {
-     *                          ...blogFragment
-     *                      }
-     *                  `,
-     *              },
-     *              fragments: [
-     *                  `
-     *                      fragment bannerFragment on Banner {
-     *                          caption
-     *                      }
-     *                  `,
-     *                  `
-     *                      fragment blogFragment on Blog {
-     *                          title
-     *                          urlTitle
-     *                      }
-     *                  `
-     *              ]
-     *          }
-     *      });
-     * ```
-     */
-    get<T extends DotCMSExtendedPageResponse = DotCMSPageResponse>(url: string, options?: DotCMSPageRequestParams): Promise<DotCMSComposedPageResponse<T>>;
-}

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

@@ -1,41 +0,0 @@
-/**
- * Builds a GraphQL query for retrieving page content from DotCMS.
- *
- * @param {string} pageQuery - Custom fragment fields to include in the ClientPage fragment
- * @param {string} additionalQueries - Additional GraphQL queries to include in the main query
- * @returns {string} Complete GraphQL query string for page content
- */
-export declare const buildPageQuery: ({ page, fragments, additionalQueries }: {
-    page?: string;
-    fragments?: string[];
-    additionalQueries?: string;
-}) => string;
-/**
- * Converts a record of query strings into a single GraphQL query string.
- *
- * @param {Record<string, string>} queryData - Object containing named query strings
- * @returns {string} Combined query string or empty string if no queryData provided
- */
-export declare function buildQuery(queryData: Record<string, string>): string;
-/**
- * Filters response data to include only specified keys.
- *
- * @param {Record<string, string>} responseData - Original response data object
- * @param {string[]} keys - Array of keys to extract from the response data
- * @returns {Record<string, string>} New object containing only the specified keys
- */
-export declare function mapResponseData(responseData: Record<string, string>, keys: string[]): Record<string, string>;
-/**
- * Executes a GraphQL query against the DotCMS API.
- *
- * @param {Object} options - Options for the fetch request
- * @param {string} options.body - GraphQL query string
- * @param {Record<string, string>} options.headers - HTTP headers for the request
- * @returns {Promise<any>} Parsed JSON response from the GraphQL API
- * @throws {Error} If the HTTP response is not successful
- */
-export declare function fetchGraphQL({ baseURL, body, headers }: {
-    baseURL: string;
-    body: string;
-    headers: Record<string, string>;
-}): Promise<any>;

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

@@ -1,13 +0,0 @@
-import { DotCMSGraphQLPageResponse, DotCMSPageAsset } from '@dotcms/types';
-/**
- * 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 declare const graphqlToPageEntity: (graphQLPageResponse: DotCMSGraphQLPageResponse) => DotCMSPageAsset | null;