@dotcms/client 0.0.1-beta.28 → 0.0.1-beta.29

package/README.md

@@ -127,11 +127,30 @@ const pageData = await client.page.get('/your-page-path', {
 });
 ```
 
+
+### Warning
+
+If you are updating from a version that is lower than `0.0.1-beta.29`, be aware that the response from the `client.page.get` method changed the access to the page value from `page` to `pageAsset`.
+This change was made to avoid redundancy on access inside of `page` object.
+
+#### Before
+
+```javascript
+const { page } = await client.page.get("/")
+```
+
+#### After
+
+```javascript
+const { pageAsset } = await client.page.get("/")
+```
+
+
 #### Example with all options
 
 ```javascript
 // Fetching a page with all available options
-const { page, content } = await client.page.get('/about-us', {
+const { pageAsset, content } = await client.page.get('/about-us', {
     languageId: '1',                 // Language ID (optional)
     siteId: 'demo.dotcms.com',       // Site ID (optional, defaults to the one provided during initialization)
     mode: 'PREVIEW_MODE',            // ADMIN_MODE, PREVIEW_MODE, or LIVE_MODE (optional)
@@ -172,7 +191,7 @@ const { page, content } = await client.page.get('/about-us', {
 });
 
 // Access page data
-console.log(page.containers);
+console.log(pageAsset.containers);
 
 // Access content data
 console.log(content.blogPosts);

package/next.cjs.js

@@ -276,7 +276,7 @@ async function fetchGraphQL({ baseURL, body, headers }) {
     return await response.json();
 }
 
-var _PageClient_instances, _PageClient_isGraphQLRequest, _PageClient_getPageFromAPI, _PageClient_getPageFromGraphQL, _PageClient_mapToBackendParams;
+var _PageClient_instances, _PageClient_getPageFromGraphQL;
 /**
  * Client for interacting with the DotCMS Page API.
  * Provides methods to retrieve and manipulate pages.
@@ -309,124 +309,69 @@ class PageClient {
         this.siteId = config.siteId || '';
         this.dotcmsUrl = config.dotcmsUrl;
     }
+    /**
+     * 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(url, options) {
-        if (!options) {
-            return transforms.__classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_getPageFromAPI).call(this, url);
-        }
-        if (transforms.__classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_isGraphQLRequest).call(this, options)) {
-            return transforms.__classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_getPageFromGraphQL).call(this, url, options);
-        }
-        return transforms.__classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_getPageFromAPI).call(this, url, options);
+        return transforms.__classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_getPageFromGraphQL).call(this, url, options);
     }
 }
-_PageClient_instances = new WeakSet(), _PageClient_isGraphQLRequest = function _PageClient_isGraphQLRequest(options) {
-    return 'graphql' in options;
-}, _PageClient_getPageFromAPI = 
-/**
- * Retrieves all the elements of a Page in your dotCMS system in JSON format.
- *
- * @param {string} path - The path of the page to retrieve
- * @param {PageRequestParams} params - The options for the Page API call
- * @returns {Promise<unknown>} A Promise that resolves to the page data
- * @throws {Error} Throws an error if the path parameter is missing or if the fetch request fails
- * @example
- * ```typescript
- * // Get a page with default parameters
- * const homePage = await pageClient.get('/');
- *
- * // Get a page with specific language and mode
- * const aboutPage = await pageClient.get('/about-us', {
- *   languageId: 2,
- *   mode: 'PREVIEW_MODE'
- * });
- *
- * // Get a page with persona targeting
- * const productPage = await pageClient.get('/products', {
- *   personaId: 'persona-123',
- *   depth: 2
- * });
- * ```
- */
-async function _PageClient_getPageFromAPI(path, params) {
-    if (!path) {
-        throw new Error("The 'path' parameter is required for the Page API");
-    }
-    // If the siteId is not provided, use the one from the config
-    const completedParams = {
-        ...(params ?? {}),
-        siteId: params?.siteId || this.siteId
-    };
-    // Map the public parameters to the one used by the API
-    const normalizedParams = transforms.__classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_mapToBackendParams).call(this, completedParams || {});
-    // Build the query params
-    const queryParams = new URLSearchParams(normalizedParams).toString();
-    // If the path starts with a slash, remove it to avoid double slashes in the final URL
-    // Because the page path is part of api url path
-    const pagePath = path.startsWith('/') ? path.slice(1) : path;
-    const url = `${this.dotcmsUrl}/api/v1/page/json/${pagePath}?${queryParams}`;
-    const response = await fetch(url, this.requestOptions);
-    if (!response.ok) {
-        const error = {
-            status: response.status,
-            message: transforms.ErrorMessages[response.status] || response.statusText
-        };
-        throw error;
-    }
-    return response.json().then((data) => ({
-        ...data.entity,
-        params: completedParams // We retrieve the params from the API response, to make the same fetch on UVE
-    }));
-}, _PageClient_getPageFromGraphQL = 
+_PageClient_instances = new WeakSet(), _PageClient_getPageFromGraphQL = 
 /**
- * Retrieves a personalized page with associated content and navigation.
+ * Private implementation method that fetches page data using GraphQL.
+ * This method is used internally by the public get() method.
  *
- * @param {Object} options - Options for the personalized page request
- * @param {string} options.url - The URL of the page to retrieve
- * @param {string} options.languageId - The language ID for the page content
- * @param {string} options.mode - The rendering mode for the page
- * @param {string} options.pageFragment - GraphQL fragment for page data
- * @param {Record<string, string>} options.content - Content queries to include
- * @param {Record<string, string>} options.nav - Navigation queries to include
- * @returns {Promise<Object>} A Promise that resolves to the personalized page data with content and navigation
- * @example
- * ```typescript
- * // Get a personalized page with content and navigation
- * const personalizedPage = await pageClient.getPageFromGraphQL({
- *   url: '/about-us',
- *   languageId: '1',
- *   mode: 'LIVE',
- *   pageFragment: `
- *     fragment PageFields on Page {
- *       title
- *       description
- *       modDate
- *     }
- *   `,
- *   content: {
- *     blogs: `
- *       search(query: "+contentType: blog", limit: 3) {
- *         title
- *         ...on Blog {
- *             author {
- *                 title
- *             }
- *         }
-                            }
- *   nav: {
- *     mainNav: `
- *       query MainNav {
- *         Nav(identifier: "main-nav") {
- *           title
- *           items {
- *             label
- *             url
- *           }
- *         }
- *       }
- *     `
- *   }
- * });
- * ```
+ * @private
+ * @param {string} url - The URL of the page to retrieve
+ * @param {DotCMSPageRequestParams} [options] - Options including languageId, mode, and GraphQL parameters
+ * @returns {Promise<DotCMSPageResponse>} A Promise that resolves to the page data
  */
 async function _PageClient_getPageFromGraphQL(url, options) {
     const { languageId = '1', mode = 'LIVE', siteId = this.siteId, fireRules = false, personaId, publishDate, graphql = {} } = options || {};
@@ -466,7 +411,7 @@ async function _PageClient_getPageFromGraphQL(url, options) {
         }
         const contentResponse = mapResponseData(data, Object.keys(content));
         return {
-            page: pageResponse,
+            pageAsset: pageResponse,
             content: contentResponse,
             graphql: {
                 query: completeQuery,
@@ -485,18 +430,6 @@ async function _PageClient_getPageFromGraphQL(url, options) {
         };
         throw errorMessage;
     }
-}, _PageClient_mapToBackendParams = function _PageClient_mapToBackendParams(params) {
-    const backendParams = {
-        hostId: params.siteId,
-        mode: params.mode,
-        language_id: params.languageId ? String(params.languageId) : undefined,
-        'com.dotmarketing.persona.id': params.personaId,
-        fireRules: params.fireRules ? String(params.fireRules) : undefined,
-        depth: params.depth ? String(params.depth) : undefined,
-        publishDate: params.publishDate
-    };
-    // Remove undefined values
-    return Object.fromEntries(Object.entries(backendParams).filter(([_, value]) => value !== undefined));
 };
 
 /**

package/next.esm.js

@@ -274,7 +274,7 @@ async function fetchGraphQL({ baseURL, body, headers }) {
     return await response.json();
 }
 
-var _PageClient_instances, _PageClient_isGraphQLRequest, _PageClient_getPageFromAPI, _PageClient_getPageFromGraphQL, _PageClient_mapToBackendParams;
+var _PageClient_instances, _PageClient_getPageFromGraphQL;
 /**
  * Client for interacting with the DotCMS Page API.
  * Provides methods to retrieve and manipulate pages.
@@ -307,124 +307,69 @@ class PageClient {
         this.siteId = config.siteId || '';
         this.dotcmsUrl = config.dotcmsUrl;
     }
+    /**
+     * 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(url, options) {
-        if (!options) {
-            return __classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_getPageFromAPI).call(this, url);
-        }
-        if (__classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_isGraphQLRequest).call(this, options)) {
-            return __classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_getPageFromGraphQL).call(this, url, options);
-        }
-        return __classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_getPageFromAPI).call(this, url, options);
+        return __classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_getPageFromGraphQL).call(this, url, options);
     }
 }
-_PageClient_instances = new WeakSet(), _PageClient_isGraphQLRequest = function _PageClient_isGraphQLRequest(options) {
-    return 'graphql' in options;
-}, _PageClient_getPageFromAPI = 
-/**
- * Retrieves all the elements of a Page in your dotCMS system in JSON format.
- *
- * @param {string} path - The path of the page to retrieve
- * @param {PageRequestParams} params - The options for the Page API call
- * @returns {Promise<unknown>} A Promise that resolves to the page data
- * @throws {Error} Throws an error if the path parameter is missing or if the fetch request fails
- * @example
- * ```typescript
- * // Get a page with default parameters
- * const homePage = await pageClient.get('/');
- *
- * // Get a page with specific language and mode
- * const aboutPage = await pageClient.get('/about-us', {
- *   languageId: 2,
- *   mode: 'PREVIEW_MODE'
- * });
- *
- * // Get a page with persona targeting
- * const productPage = await pageClient.get('/products', {
- *   personaId: 'persona-123',
- *   depth: 2
- * });
- * ```
- */
-async function _PageClient_getPageFromAPI(path, params) {
-    if (!path) {
-        throw new Error("The 'path' parameter is required for the Page API");
-    }
-    // If the siteId is not provided, use the one from the config
-    const completedParams = {
-        ...(params ?? {}),
-        siteId: params?.siteId || this.siteId
-    };
-    // Map the public parameters to the one used by the API
-    const normalizedParams = __classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_mapToBackendParams).call(this, completedParams || {});
-    // Build the query params
-    const queryParams = new URLSearchParams(normalizedParams).toString();
-    // If the path starts with a slash, remove it to avoid double slashes in the final URL
-    // Because the page path is part of api url path
-    const pagePath = path.startsWith('/') ? path.slice(1) : path;
-    const url = `${this.dotcmsUrl}/api/v1/page/json/${pagePath}?${queryParams}`;
-    const response = await fetch(url, this.requestOptions);
-    if (!response.ok) {
-        const error = {
-            status: response.status,
-            message: ErrorMessages[response.status] || response.statusText
-        };
-        throw error;
-    }
-    return response.json().then((data) => ({
-        ...data.entity,
-        params: completedParams // We retrieve the params from the API response, to make the same fetch on UVE
-    }));
-}, _PageClient_getPageFromGraphQL = 
+_PageClient_instances = new WeakSet(), _PageClient_getPageFromGraphQL = 
 /**
- * Retrieves a personalized page with associated content and navigation.
+ * Private implementation method that fetches page data using GraphQL.
+ * This method is used internally by the public get() method.
  *
- * @param {Object} options - Options for the personalized page request
- * @param {string} options.url - The URL of the page to retrieve
- * @param {string} options.languageId - The language ID for the page content
- * @param {string} options.mode - The rendering mode for the page
- * @param {string} options.pageFragment - GraphQL fragment for page data
- * @param {Record<string, string>} options.content - Content queries to include
- * @param {Record<string, string>} options.nav - Navigation queries to include
- * @returns {Promise<Object>} A Promise that resolves to the personalized page data with content and navigation
- * @example
- * ```typescript
- * // Get a personalized page with content and navigation
- * const personalizedPage = await pageClient.getPageFromGraphQL({
- *   url: '/about-us',
- *   languageId: '1',
- *   mode: 'LIVE',
- *   pageFragment: `
- *     fragment PageFields on Page {
- *       title
- *       description
- *       modDate
- *     }
- *   `,
- *   content: {
- *     blogs: `
- *       search(query: "+contentType: blog", limit: 3) {
- *         title
- *         ...on Blog {
- *             author {
- *                 title
- *             }
- *         }
-                            }
- *   nav: {
- *     mainNav: `
- *       query MainNav {
- *         Nav(identifier: "main-nav") {
- *           title
- *           items {
- *             label
- *             url
- *           }
- *         }
- *       }
- *     `
- *   }
- * });
- * ```
+ * @private
+ * @param {string} url - The URL of the page to retrieve
+ * @param {DotCMSPageRequestParams} [options] - Options including languageId, mode, and GraphQL parameters
+ * @returns {Promise<DotCMSPageResponse>} A Promise that resolves to the page data
  */
 async function _PageClient_getPageFromGraphQL(url, options) {
     const { languageId = '1', mode = 'LIVE', siteId = this.siteId, fireRules = false, personaId, publishDate, graphql = {} } = options || {};
@@ -464,7 +409,7 @@ async function _PageClient_getPageFromGraphQL(url, options) {
         }
         const contentResponse = mapResponseData(data, Object.keys(content));
         return {
-            page: pageResponse,
+            pageAsset: pageResponse,
             content: contentResponse,
             graphql: {
                 query: completeQuery,
@@ -483,18 +428,6 @@ async function _PageClient_getPageFromGraphQL(url, options) {
         };
         throw errorMessage;
     }
-}, _PageClient_mapToBackendParams = function _PageClient_mapToBackendParams(params) {
-    const backendParams = {
-        hostId: params.siteId,
-        mode: params.mode,
-        language_id: params.languageId ? String(params.languageId) : undefined,
-        'com.dotmarketing.persona.id': params.personaId,
-        fireRules: params.fireRules ? String(params.fireRules) : undefined,
-        depth: params.depth ? String(params.depth) : undefined,
-        publishDate: params.publishDate
-    };
-    // Remove undefined values
-    return Object.fromEntries(Object.entries(backendParams).filter(([_, value]) => value !== undefined));
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/client",
-  "version": "0.0.1-beta.28",
+  "version": "0.0.1-beta.29",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",

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/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.
@@ -56,10 +56,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 } from '@dotcms/types';
 export declare class NavigationClient {
     private requestOptions;
     private BASE_URL;
@@ -25,7 +9,6 @@ export declare class NavigationClient {
      * @returns {Promise<unknown>} - 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<unknown>;
     private mapToBackendParams;
 }
-export {};

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

@@ -1,71 +1,4 @@
-import { DotCMSPageAsset, DotCMSGraphQLPageResponse } from '@dotcms/types';
-import { DotCMSClientConfig, RequestOptions } from '../client';
-/**
- * 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]>;
-};
-/**
- * The options for the GraphQL Page API.
- * @public
- */
-export interface GraphQLPageOptions extends PageRequestParams {
-    /**
-     * The GraphQL options for the page.
-     */
-    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.
@@ -110,29 +43,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 {
@@ -164,9 +90,7 @@ export declare class PageClient {
      *              ]
      *          }
      *      });
-     *```
+     * ```
      */
-    get<T extends DotCMSPageAsset | DotCMSGraphQLPageResponse = DotCMSPageAsset>(url: string, options?: PageRequestParams): Promise<T>;
-    get<T extends DotCMSPageAsset | DotCMSGraphQLPageResponse = DotCMSGraphQLPageResponse>(url: string, options?: GraphQLPageOptions): Promise<T>;
+    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/transforms.cjs.js

@@ -964,7 +964,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) {
@@ -1099,7 +1099,7 @@ const graphqlToPageEntity = (graphQLPageResponse) => {
         },
         containers: parseContainers(containers),
         urlContentMap: urlContentMapData
-    };
+    }; // NOTE: This is a rabbit hole and we have to fix this, not in this PR tho.
 };
 /**
  * Parses the containers from the GraphQL response.

package/transforms.esm.js

@@ -962,7 +962,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) {
@@ -1097,7 +1097,7 @@ const graphqlToPageEntity = (graphQLPageResponse) => {
         },
         containers: parseContainers(containers),
         urlContentMap: urlContentMapData
-    };
+    }; // NOTE: This is a rabbit hole and we have to fix this, not in this PR tho.
 };
 /**
  * Parses the containers from the GraphQL response.