@dotcms/client 0.0.1-beta.2 → 0.0.1-beta.4

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

@@ -0,0 +1,165 @@
+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[];
+    };
+}
+/**
+ * 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
+     */
+    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 either REST API or GraphQL.
+     * This method is polymorphic and can handle both REST API and GraphQL requests based on the options provided.
+     *
+     * @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'
+     * });
+     * ```
+     *
+     * @example Using GraphQL
+     * ```typescript
+     * const page = await pageClient.get('/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(url: string, options?: PageRequestParams): Promise<DotCMSPageAsset>;
+    get(url: string, options?: GraphQLPageOptions): Promise<DotCMSGraphQLPageResponse>;
+}
+export {};

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

@@ -0,0 +1,41 @@
+/**
+ * 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/{editor → deprecated/editor}/models/client.model.d.ts

@@ -95,4 +95,17 @@ export interface DotUVE {
     reorderMenu: typeof reorderMenu;
     lastScrollYPosition: number;
 }
+/**
+ * Represents a listener for DotcmsClientListener.
+ *
+ * @typedef {Object} DotcmsClientListener
+ * @property {string} action - The action that triggers the event.
+ * @property {string} event - The name of the event.
+ * @property {function(...args: any[]): void} callback - The callback function to handle the event.
+ */
+export type DotcmsClientListener = {
+    action: string;
+    event: string;
+    callback: (...args: any[]) => void;
+};
 export {};

package/src/lib/{editor → deprecated/editor}/sdk-editor.d.ts

@@ -1,6 +1,6 @@
 import { DotCMSPageEditorConfig, ReorderMenuConfig } from './models/editor.model';
 import { INLINE_EDITING_EVENT_KEY, InlineEditEventData } from './models/inline-event.model';
-import { Contentlet } from '../client/content/shared/types';
+import { Contentlet } from '../../client/content/shared/types';
 /**
  * Updates the navigation in the editor.
  *

package/src/lib/{client → deprecated}/sdk-js-client.d.ts

@@ -1,4 +1,4 @@
-import { Content } from './content/content-api';
+import { Content } from '../client/content/content-api';
 export type ClientOptions = Omit<RequestInit, 'body' | 'method'>;
 export interface ClientConfig {
     /**

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

@@ -1,4 +1,4 @@
-import { PageApiOptions } from '../../client/sdk-js-client';
+import { PageApiOptions } from '../../deprecated/sdk-js-client';
 /**
  * Interface representing the properties for page request parameters.
  *

package/src/next.d.ts

@@ -0,0 +1 @@
+export { createDotCMSClient } from './lib/client/client';

package/src/types.d.ts

@@ -0,0 +1,2 @@
+export { DotCMSPageAsset, DotCMSGraphQLPageResponse } from './lib/client/models/types';
+export { Contentlet } from './lib/client/content/shared/types';