@dotcms/client 0.0.1-beta.20 → 0.0.1-beta.21

package/README.md

@@ -95,13 +95,13 @@ The @dotcms/client package is compatible with the following browsers:
 ### ES Modules
 
 ```javascript
-import { dotCMSCreateClient } from '@dotcms/client';
+import { createDotCMSClient } from '@dotcms/client/next';
 ```
 
 ### CommonJS
 
 ```javascript
-const { dotCMSCreateClient } = require('@dotcms/client');
+const { createDotCMSClient } = require('@dotcms/client/next');
 ```
 
 ### Initialization
@@ -109,7 +109,7 @@ const { dotCMSCreateClient } = require('@dotcms/client');
 First, initialize the client with your dotCMS instance details.
 
 ```javascript
-const client = dotCMSCreateClient({
+const client = createDotCMSClient({
     dotcmsUrl: 'https://your-dotcms-instance.com',
     authToken: 'your-auth-token',
     siteId: 'your-site-id'

package/next.cjs.js

@@ -125,6 +125,9 @@ const buildPageQuery = ({ page, fragments, additionalQueries }) => {
     canEdit
     canLock
     canRead
+    urlContentMap {
+      _map
+    }
     conLanguage {
       id
       language
@@ -190,8 +193,8 @@ const buildPageQuery = ({ page, fragments, additionalQueries }) => {
 
   ${fragments ? fragments.join('\n\n') : ''}
 
-  query PageContent($url: String!, $languageId: String, $mode: String) {
-    page: page(url: $url, languageId: $languageId, pageMode: $mode) {
+  query PageContent($url: String!, $languageId: String, $mode: String, $personaId: String, $fireRules: Boolean, $publishDate: String, $siteId: String) {
+    page: page(url: $url, languageId: $languageId, pageMode: $mode, persona: $personaId, fireRules: $fireRules, publishDate: $publishDate, site: $siteId) {
       ...DotCMSPage
       ${page ? '...ClientPage' : ''}
     }
@@ -330,7 +333,14 @@ async function _PageClient_getPageFromAPI(path, params) {
     if (!path) {
         throw new Error("The 'path' parameter is required for the Page API");
     }
-    const normalizedParams = transforms.__classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_mapToBackendParams).call(this, params || {});
+    // 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
@@ -344,7 +354,10 @@ async function _PageClient_getPageFromAPI(path, params) {
         };
         throw error;
     }
-    return response.json().then((data) => data.entity);
+    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 = 
 /**
  * Retrieves a personalized page with associated content and navigation.
@@ -398,7 +411,7 @@ async function _PageClient_getPageFromAPI(path, params) {
  * ```
  */
 async function _PageClient_getPageFromGraphQL(url, options) {
-    const { languageId = '1', mode = 'LIVE', graphql = {} } = options || {};
+    const { languageId = '1', mode = 'LIVE', siteId = this.siteId, fireRules = false, personaId, publishDate, graphql = {} } = options || {};
     const { page, content = {}, variables, fragments } = graphql;
     const contentQuery = buildQuery(content);
     const completeQuery = buildPageQuery({
@@ -410,6 +423,10 @@ async function _PageClient_getPageFromGraphQL(url, options) {
         url,
         mode,
         languageId,
+        personaId,
+        fireRules,
+        publishDate,
+        siteId,
         ...variables
     };
     const requestHeaders = this.requestOptions.headers;
@@ -433,21 +450,26 @@ async function _PageClient_getPageFromGraphQL(url, options) {
         return {
             page: pageResponse,
             content: contentResponse,
-            errors
+            graphql: {
+                query: completeQuery,
+                variables: requestVariables
+            }
         };
     }
     catch (error) {
         const errorMessage = {
             error,
             message: 'Failed to retrieve page data',
-            query: completeQuery,
-            variables: requestVariables
+            graphql: {
+                query: completeQuery,
+                variables: requestVariables
+            }
         };
         throw errorMessage;
     }
 }, _PageClient_mapToBackendParams = function _PageClient_mapToBackendParams(params) {
     const backendParams = {
-        hostId: params.siteId || this.siteId,
+        hostId: params.siteId,
         mode: params.mode,
         language_id: params.languageId ? String(params.languageId) : undefined,
         'com.dotmarketing.persona.id': params.personaId,

package/next.esm.js

@@ -123,6 +123,9 @@ const buildPageQuery = ({ page, fragments, additionalQueries }) => {
     canEdit
     canLock
     canRead
+    urlContentMap {
+      _map
+    }
     conLanguage {
       id
       language
@@ -188,8 +191,8 @@ const buildPageQuery = ({ page, fragments, additionalQueries }) => {
 
   ${fragments ? fragments.join('\n\n') : ''}
 
-  query PageContent($url: String!, $languageId: String, $mode: String) {
-    page: page(url: $url, languageId: $languageId, pageMode: $mode) {
+  query PageContent($url: String!, $languageId: String, $mode: String, $personaId: String, $fireRules: Boolean, $publishDate: String, $siteId: String) {
+    page: page(url: $url, languageId: $languageId, pageMode: $mode, persona: $personaId, fireRules: $fireRules, publishDate: $publishDate, site: $siteId) {
       ...DotCMSPage
       ${page ? '...ClientPage' : ''}
     }
@@ -328,7 +331,14 @@ async function _PageClient_getPageFromAPI(path, params) {
     if (!path) {
         throw new Error("The 'path' parameter is required for the Page API");
     }
-    const normalizedParams = __classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_mapToBackendParams).call(this, params || {});
+    // 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
@@ -342,7 +352,10 @@ async function _PageClient_getPageFromAPI(path, params) {
         };
         throw error;
     }
-    return response.json().then((data) => data.entity);
+    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 = 
 /**
  * Retrieves a personalized page with associated content and navigation.
@@ -396,7 +409,7 @@ async function _PageClient_getPageFromAPI(path, params) {
  * ```
  */
 async function _PageClient_getPageFromGraphQL(url, options) {
-    const { languageId = '1', mode = 'LIVE', graphql = {} } = options || {};
+    const { languageId = '1', mode = 'LIVE', siteId = this.siteId, fireRules = false, personaId, publishDate, graphql = {} } = options || {};
     const { page, content = {}, variables, fragments } = graphql;
     const contentQuery = buildQuery(content);
     const completeQuery = buildPageQuery({
@@ -408,6 +421,10 @@ async function _PageClient_getPageFromGraphQL(url, options) {
         url,
         mode,
         languageId,
+        personaId,
+        fireRules,
+        publishDate,
+        siteId,
         ...variables
     };
     const requestHeaders = this.requestOptions.headers;
@@ -431,21 +448,26 @@ async function _PageClient_getPageFromGraphQL(url, options) {
         return {
             page: pageResponse,
             content: contentResponse,
-            errors
+            graphql: {
+                query: completeQuery,
+                variables: requestVariables
+            }
         };
     }
     catch (error) {
         const errorMessage = {
             error,
             message: 'Failed to retrieve page data',
-            query: completeQuery,
-            variables: requestVariables
+            graphql: {
+                query: completeQuery,
+                variables: requestVariables
+            }
         };
         throw errorMessage;
     }
 }, _PageClient_mapToBackendParams = function _PageClient_mapToBackendParams(params) {
     const backendParams = {
-        hostId: params.siteId || this.siteId,
+        hostId: params.siteId,
         mode: params.mode,
         language_id: params.languageId ? String(params.languageId) : undefined,
         'com.dotmarketing.persona.id': params.personaId,

package/package.json

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

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

@@ -63,6 +63,8 @@ export interface DotCMSPageAsset<T = unknown> {
     urlContentMap?: T extends {
         urlContentMap: infer U;
     } ? Contentlet<U> : Contentlet<T>;
+    /** The parameters used to fetch the page */
+    params?: Record<string, unknown>;
 }
 export interface DotPageAssetLayoutRow {
     identifier: number;
@@ -566,5 +568,9 @@ export interface DotCMSGraphQLPageResponse<TContent = Record<string, any>> {
     page: DotCMSBasicGraphQLPage;
     content?: TContent;
     errors?: DotCMSGraphQLError;
+    graphql: {
+        query: string;
+        variables: Record<string, unknown>;
+    };
 }
 export {};

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

@@ -51,7 +51,14 @@ type PageToBackendParamsMapping = {
 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>;

package/transforms.cjs.js

@@ -1083,17 +1083,21 @@ const graphqlToPageEntity = (graphQLPageResponse) => {
     }
     const { layout, template, containers, urlContentMap, viewAs, site, _map, ...pageAsset } = page;
     const data = (_map || {});
+    // 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,
         page: {
             ...data,
             ...pageAsset
         },
-        containers: parseContainers(containers)
+        containers: parseContainers(containers),
+        urlContentMap: urlContentMapData
     };
 };
 /**

package/transforms.esm.js

@@ -1081,17 +1081,21 @@ const graphqlToPageEntity = (graphQLPageResponse) => {
     }
     const { layout, template, containers, urlContentMap, viewAs, site, _map, ...pageAsset } = page;
     const data = (_map || {});
+    // 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,
         page: {
             ...data,
             ...pageAsset
         },
-        containers: parseContainers(containers)
+        containers: parseContainers(containers),
+        urlContentMap: urlContentMapData
     };
 };
 /**