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

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/deprecated/editor/sdk-editor.d.ts

@@ -1,6 +1,6 @@
+import { Contentlet } from '@dotcms/types';
 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';
 /**
  * Updates the navigation in the editor.
  *

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/transforms.cjs.js

@@ -14,7 +14,7 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
 
 
 function __classPrivateFieldGet(receiver, state, kind, f) {
@@ -924,7 +924,6 @@ var _Content_requestOptions, _Content_serverUrl;
  *     .sortBy([{ field: 'title', order: 'asc' }])
  *     .query(q => q.field('author').equals('John Doe'))
  *     .depth(1)
- *     .fetch();
  *
  * console.log(response.contentlets);
  * ```
@@ -938,7 +937,6 @@ var _Content_requestOptions, _Content_serverUrl;
  *     .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));
  * ```
@@ -954,7 +952,6 @@ var _Content_requestOptions, _Content_serverUrl;
  * const posts = await client.content
  *     .getCollection<BlogPost>('Blog')
  *     .limit(10)
- *     .fetch();
  *
  * posts.contentlets.forEach(post => {
  *     console.log(post.title, post.author, post.summary);
@@ -964,7 +961,7 @@ var _Content_requestOptions, _Content_serverUrl;
 class Content {
     /**
      * 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, serverUrl) {
@@ -1064,6 +1061,7 @@ const ErrorMessages = {
     503: 'Service Unavailable. Try again later.'
 };
 
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /**
  * Transforms a GraphQL Page response to a Page Entity.
  *
@@ -1081,26 +1079,33 @@ const graphqlToPageEntity = (graphQLPageResponse) => {
     if (!page) {
         return null;
     }
-    const { layout, template, containers, urlContentMap, viewAs, site, _map, ...pageAsset } = page;
+    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,
-        urlContentMap,
-        site,
+        vanityUrl,
+        runningExperimentId,
+        site: host,
+        urlContentMap: urlContentMapData,
+        containers: parseContainers(containers),
         page: {
             ...data,
-            ...pageAsset
-        },
-        containers: parseContainers(containers)
+            ...typedPageAsset
+        }
     };
 };
 /**
  * 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.
+ * @param {DotCMSGraphQLPageContainer[]} [containers=[]] - The containers array from the GraphQL response.
+ * @returns {DotCMSPageAssetContainers} The parsed containers.
  */
 const parseContainers = (containers = []) => {
     return containers.reduce((acc, container) => {

package/transforms.esm.js

@@ -12,7 +12,7 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
 
 
 function __classPrivateFieldGet(receiver, state, kind, f) {
@@ -922,7 +922,6 @@ var _Content_requestOptions, _Content_serverUrl;
  *     .sortBy([{ field: 'title', order: 'asc' }])
  *     .query(q => q.field('author').equals('John Doe'))
  *     .depth(1)
- *     .fetch();
  *
  * console.log(response.contentlets);
  * ```
@@ -936,7 +935,6 @@ var _Content_requestOptions, _Content_serverUrl;
  *     .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));
  * ```
@@ -952,7 +950,6 @@ var _Content_requestOptions, _Content_serverUrl;
  * const posts = await client.content
  *     .getCollection<BlogPost>('Blog')
  *     .limit(10)
- *     .fetch();
  *
  * posts.contentlets.forEach(post => {
  *     console.log(post.title, post.author, post.summary);
@@ -962,7 +959,7 @@ var _Content_requestOptions, _Content_serverUrl;
 class Content {
     /**
      * 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, serverUrl) {
@@ -1062,6 +1059,7 @@ const ErrorMessages = {
     503: 'Service Unavailable. Try again later.'
 };
 
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /**
  * Transforms a GraphQL Page response to a Page Entity.
  *
@@ -1079,26 +1077,33 @@ const graphqlToPageEntity = (graphQLPageResponse) => {
     if (!page) {
         return null;
     }
-    const { layout, template, containers, urlContentMap, viewAs, site, _map, ...pageAsset } = page;
+    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,
-        urlContentMap,
-        site,
+        vanityUrl,
+        runningExperimentId,
+        site: host,
+        urlContentMap: urlContentMapData,
+        containers: parseContainers(containers),
         page: {
             ...data,
-            ...pageAsset
-        },
-        containers: parseContainers(containers)
+            ...typedPageAsset
+        }
     };
 };
 /**
  * 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.
+ * @param {DotCMSGraphQLPageContainer[]} [containers=[]] - The containers array from the GraphQL response.
+ * @returns {DotCMSPageAssetContainers} The parsed containers.
  */
 const parseContainers = (containers = []) => {
     return containers.reduce((acc, container) => {