@dotcms/client 0.0.1-beta.34 → 0.0.1-beta.36

package/next.cjs.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var consola = require('consola');
 var transforms = require('./transforms.cjs.js');
 
 class NavigationClient {
@@ -79,7 +80,7 @@ const DEFAULT_PAGE_CONTENTLETS_CONTENT = `
  */
 const buildPageQuery = ({ page, fragments, additionalQueries }) => {
     if (!page) {
-        console.warn('No page query provided. The query will be used by fetching all content with _map. This may mean poor performance in the query. We suggest you provide a detailed query on page attribute.');
+        consola.consola.warn("[DotCMS Client]: No page query was found, so we're loading all content using _map. This might slow things down. For better performance, we recommend adding a specific query in the page attribute.");
     }
     return `
   fragment DotCMSPage on DotPage {
@@ -126,9 +127,22 @@ const buildPageQuery = ({ page, fragments, additionalQueries }) => {
     canEdit
     canLock
     canRead
+    runningExperimentId
     urlContentMap {
       _map
     }
+    host {
+      identifier
+      hostName
+     	googleMap
+      archived
+      contentType
+    }
+    vanityUrl {
+      action
+      forwardTo
+      uri
+    }
     conLanguage {
       id
       language
@@ -136,6 +150,9 @@ const buildPageQuery = ({ page, fragments, additionalQueries }) => {
     }
     template {
       drawed
+      anonymous
+      theme
+      identifier
     }
     containers {
       path
@@ -276,7 +293,6 @@ async function fetchGraphQL({ baseURL, body, headers }) {
     return await response.json();
 }
 
-var _PageClient_instances, _PageClient_getPageFromGraphQL;
 /**
  * Client for interacting with the DotCMS Page API.
  * Provides methods to retrieve and manipulate pages.
@@ -304,7 +320,6 @@ class PageClient {
      * ```
      */
     constructor(config, requestOptions) {
-        _PageClient_instances.add(this);
         this.requestOptions = requestOptions;
         this.siteId = config.siteId || '';
         this.dotcmsUrl = config.dotcmsUrl;
@@ -359,78 +374,66 @@ class PageClient {
      *      });
      * ```
      */
-    get(url, options) {
-        return transforms.__classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_getPageFromGraphQL).call(this, url, options);
-    }
-}
-_PageClient_instances = new WeakSet(), _PageClient_getPageFromGraphQL = 
-/**
- * Private implementation method that fetches page data using GraphQL.
- * This method is used internally by the public get() method.
- *
- * @private
- * @param {string} url - The URL of the page to retrieve
- * @param {DotCMSPageRequestParams} [options] - Options including languageId, mode, and GraphQL parameters
- * @returns {Promise<DotCMSComposedPageResponse<T>>} 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 || {};
-    const { page, content = {}, variables, fragments } = graphql;
-    const contentQuery = buildQuery(content);
-    const completeQuery = buildPageQuery({
-        page,
-        fragments,
-        additionalQueries: contentQuery
-    });
-    const requestVariables = {
-        url,
-        mode,
-        languageId,
-        personaId,
-        fireRules,
-        publishDate,
-        siteId,
-        ...variables
-    };
-    const requestHeaders = this.requestOptions.headers;
-    const requestBody = JSON.stringify({ query: completeQuery, variables: requestVariables });
-    try {
-        const { data, errors } = await fetchGraphQL({
-            baseURL: this.dotcmsUrl,
-            body: requestBody,
-            headers: requestHeaders
+    async get(url, 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({
+            page,
+            fragments,
+            additionalQueries: contentQuery
         });
-        if (errors) {
-            errors.forEach((error) => {
-                throw new Error(error.message);
+        const requestVariables = {
+            // The url is expected to have a leading slash to comply on VanityURL Matching, some frameworks like Angular will not add the leading slash
+            url: url.startsWith('/') ? url : `/${url}`,
+            mode,
+            languageId,
+            personaId,
+            fireRules,
+            publishDate,
+            siteId,
+            ...variables
+        };
+        const requestHeaders = this.requestOptions.headers;
+        const requestBody = JSON.stringify({ query: completeQuery, variables: requestVariables });
+        try {
+            const { data, errors } = await fetchGraphQL({
+                baseURL: this.dotcmsUrl,
+                body: requestBody,
+                headers: requestHeaders
             });
-        }
-        const pageResponse = transforms.graphqlToPageEntity(data);
-        if (!pageResponse) {
-            throw new Error('No page data found');
-        }
-        const contentResponse = mapResponseData(data, Object.keys(content));
-        return {
-            pageAsset: pageResponse,
-            content: contentResponse,
-            graphql: {
-                query: completeQuery,
-                variables: requestVariables
+            if (errors) {
+                errors.forEach((error) => {
+                    throw new Error(error.message);
+                });
             }
-        };
-    }
-    catch (error) {
-        const errorMessage = {
-            error,
-            message: 'Failed to retrieve page data',
-            graphql: {
-                query: completeQuery,
-                variables: requestVariables
+            const pageResponse = transforms.graphqlToPageEntity(data);
+            if (!pageResponse) {
+                throw new Error('No page data found');
             }
-        };
-        throw errorMessage;
+            const contentResponse = mapResponseData(data, Object.keys(content));
+            return {
+                pageAsset: pageResponse,
+                content: contentResponse,
+                graphql: {
+                    query: completeQuery,
+                    variables: requestVariables
+                }
+            };
+        }
+        catch (error) {
+            const errorMessage = {
+                error,
+                message: 'Failed to retrieve page data',
+                graphql: {
+                    query: completeQuery,
+                    variables: requestVariables
+                }
+            };
+            throw errorMessage;
+        }
     }
-};
+}
 
 /**
  * Parses a string into a URL object.
@@ -443,7 +446,7 @@ function parseURL(url) {
         return new URL(url);
     }
     catch {
-        console.error('Invalid URL:', url);
+        consola.consola.error('[DotCMS Client]: Invalid URL:', url);
         return undefined;
     }
 }

package/next.esm.js

@@ -1,4 +1,5 @@
-import { E as ErrorMessages, _ as __classPrivateFieldGet, g as graphqlToPageEntity, C as Content } from './transforms.esm.js';
+import { consola } from 'consola';
+import { E as ErrorMessages, g as graphqlToPageEntity, C as Content } from './transforms.esm.js';
 
 class NavigationClient {
     constructor(config, requestOptions) {
@@ -77,7 +78,7 @@ const DEFAULT_PAGE_CONTENTLETS_CONTENT = `
  */
 const buildPageQuery = ({ page, fragments, additionalQueries }) => {
     if (!page) {
-        console.warn('No page query provided. The query will be used by fetching all content with _map. This may mean poor performance in the query. We suggest you provide a detailed query on page attribute.');
+        consola.warn("[DotCMS Client]: No page query was found, so we're loading all content using _map. This might slow things down. For better performance, we recommend adding a specific query in the page attribute.");
     }
     return `
   fragment DotCMSPage on DotPage {
@@ -124,9 +125,22 @@ const buildPageQuery = ({ page, fragments, additionalQueries }) => {
     canEdit
     canLock
     canRead
+    runningExperimentId
     urlContentMap {
       _map
     }
+    host {
+      identifier
+      hostName
+     	googleMap
+      archived
+      contentType
+    }
+    vanityUrl {
+      action
+      forwardTo
+      uri
+    }
     conLanguage {
       id
       language
@@ -134,6 +148,9 @@ const buildPageQuery = ({ page, fragments, additionalQueries }) => {
     }
     template {
       drawed
+      anonymous
+      theme
+      identifier
     }
     containers {
       path
@@ -274,7 +291,6 @@ async function fetchGraphQL({ baseURL, body, headers }) {
     return await response.json();
 }
 
-var _PageClient_instances, _PageClient_getPageFromGraphQL;
 /**
  * Client for interacting with the DotCMS Page API.
  * Provides methods to retrieve and manipulate pages.
@@ -302,7 +318,6 @@ class PageClient {
      * ```
      */
     constructor(config, requestOptions) {
-        _PageClient_instances.add(this);
         this.requestOptions = requestOptions;
         this.siteId = config.siteId || '';
         this.dotcmsUrl = config.dotcmsUrl;
@@ -357,78 +372,66 @@ class PageClient {
      *      });
      * ```
      */
-    get(url, options) {
-        return __classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_getPageFromGraphQL).call(this, url, options);
-    }
-}
-_PageClient_instances = new WeakSet(), _PageClient_getPageFromGraphQL = 
-/**
- * Private implementation method that fetches page data using GraphQL.
- * This method is used internally by the public get() method.
- *
- * @private
- * @param {string} url - The URL of the page to retrieve
- * @param {DotCMSPageRequestParams} [options] - Options including languageId, mode, and GraphQL parameters
- * @returns {Promise<DotCMSComposedPageResponse<T>>} 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 || {};
-    const { page, content = {}, variables, fragments } = graphql;
-    const contentQuery = buildQuery(content);
-    const completeQuery = buildPageQuery({
-        page,
-        fragments,
-        additionalQueries: contentQuery
-    });
-    const requestVariables = {
-        url,
-        mode,
-        languageId,
-        personaId,
-        fireRules,
-        publishDate,
-        siteId,
-        ...variables
-    };
-    const requestHeaders = this.requestOptions.headers;
-    const requestBody = JSON.stringify({ query: completeQuery, variables: requestVariables });
-    try {
-        const { data, errors } = await fetchGraphQL({
-            baseURL: this.dotcmsUrl,
-            body: requestBody,
-            headers: requestHeaders
+    async get(url, 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({
+            page,
+            fragments,
+            additionalQueries: contentQuery
         });
-        if (errors) {
-            errors.forEach((error) => {
-                throw new Error(error.message);
+        const requestVariables = {
+            // The url is expected to have a leading slash to comply on VanityURL Matching, some frameworks like Angular will not add the leading slash
+            url: url.startsWith('/') ? url : `/${url}`,
+            mode,
+            languageId,
+            personaId,
+            fireRules,
+            publishDate,
+            siteId,
+            ...variables
+        };
+        const requestHeaders = this.requestOptions.headers;
+        const requestBody = JSON.stringify({ query: completeQuery, variables: requestVariables });
+        try {
+            const { data, errors } = await fetchGraphQL({
+                baseURL: this.dotcmsUrl,
+                body: requestBody,
+                headers: requestHeaders
             });
-        }
-        const pageResponse = graphqlToPageEntity(data);
-        if (!pageResponse) {
-            throw new Error('No page data found');
-        }
-        const contentResponse = mapResponseData(data, Object.keys(content));
-        return {
-            pageAsset: pageResponse,
-            content: contentResponse,
-            graphql: {
-                query: completeQuery,
-                variables: requestVariables
+            if (errors) {
+                errors.forEach((error) => {
+                    throw new Error(error.message);
+                });
             }
-        };
-    }
-    catch (error) {
-        const errorMessage = {
-            error,
-            message: 'Failed to retrieve page data',
-            graphql: {
-                query: completeQuery,
-                variables: requestVariables
+            const pageResponse = graphqlToPageEntity(data);
+            if (!pageResponse) {
+                throw new Error('No page data found');
             }
-        };
-        throw errorMessage;
+            const contentResponse = mapResponseData(data, Object.keys(content));
+            return {
+                pageAsset: pageResponse,
+                content: contentResponse,
+                graphql: {
+                    query: completeQuery,
+                    variables: requestVariables
+                }
+            };
+        }
+        catch (error) {
+            const errorMessage = {
+                error,
+                message: 'Failed to retrieve page data',
+                graphql: {
+                    query: completeQuery,
+                    variables: requestVariables
+                }
+            };
+            throw errorMessage;
+        }
     }
-};
+}
 
 /**
  * Parses a string into a URL object.
@@ -441,7 +444,7 @@ function parseURL(url) {
         return new URL(url);
     }
     catch {
-        console.error('Invalid URL:', url);
+        consola.error('[DotCMS Client]: Invalid URL:', url);
         return undefined;
     }
 }

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@dotcms/client",
-  "version": "0.0.1-beta.34",
+  "version": "0.0.1-beta.36",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/dotCMS/core.git#main"
   },
+  "dependencies": {
+    "consola": "^3.4.2"
+  },
   "devDependencies": {
     "@dotcms/types": "next"
   },

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

@@ -15,7 +15,6 @@ import { CollectionBuilder } from './builders/collection/collection';
  *     .sortBy([{ field: 'title', order: 'asc' }])
  *     .query(q => q.field('author').equals('John Doe'))
  *     .depth(1)
- *     .fetch();
  *
  * console.log(response.contentlets);
  * ```
@@ -29,7 +28,6 @@ import { CollectionBuilder } from './builders/collection/collection';
  *     .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));
  * ```
@@ -45,7 +43,6 @@ import { CollectionBuilder } from './builders/collection/collection';
  * const posts = await client.content
  *     .getCollection<BlogPost>('Blog')
  *     .limit(10)
- *     .fetch();
  *
  * posts.contentlets.forEach(post => {
  *     console.log(post.title, post.author, post.summary);

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

@@ -4,7 +4,6 @@ import { DotCMSClientConfig, DotCMSComposedPageResponse, DotCMSExtendedPageRespo
  * Provides methods to retrieve and manipulate pages.
  */
 export declare class PageClient {
-    #private;
     /**
      * Request options including authorization headers.
      * @private

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

@@ -1,4 +1,4 @@
-import { DotCMSGraphQLPageResponse } from '@dotcms/types';
+import { DotCMSGraphQLPageResponse, DotCMSPageAsset } from '@dotcms/types';
 /**
  * Transforms a GraphQL Page response to a Page Entity.
  *
@@ -10,4 +10,4 @@ import { DotCMSGraphQLPageResponse } from '@dotcms/types';
  * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
  * ```
  */
-export declare const graphqlToPageEntity: (graphQLPageResponse: DotCMSGraphQLPageResponse) => any;
+export declare const graphqlToPageEntity: (graphQLPageResponse: DotCMSGraphQLPageResponse) => DotCMSPageAsset | null;

package/transforms.cjs.js

@@ -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);
@@ -1082,8 +1079,9 @@ 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
@@ -1092,20 +1090,22 @@ const graphqlToPageEntity = (graphQLPageResponse) => {
         layout,
         template,
         viewAs,
-        site,
+        vanityUrl,
+        runningExperimentId,
+        site: host,
+        urlContentMap: urlContentMapData,
+        containers: parseContainers(containers),
         page: {
             ...data,
-            ...pageAsset
-        },
-        containers: parseContainers(containers),
-        urlContentMap: urlContentMapData
-    }; // NOTE: This is a rabbit hole and we have to fix this, not in this PR tho.
+            ...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

@@ -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);
@@ -1080,8 +1077,9 @@ 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
@@ -1090,20 +1088,22 @@ const graphqlToPageEntity = (graphQLPageResponse) => {
         layout,
         template,
         viewAs,
-        site,
+        vanityUrl,
+        runningExperimentId,
+        site: host,
+        urlContentMap: urlContentMapData,
+        containers: parseContainers(containers),
         page: {
             ...data,
-            ...pageAsset
-        },
-        containers: parseContainers(containers),
-        urlContentMap: urlContentMapData
-    }; // NOTE: This is a rabbit hole and we have to fix this, not in this PR tho.
+            ...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) => {