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

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) {
@@ -8,7 +9,7 @@ class NavigationClient {
     /**
      * Retrieves information about the dotCMS file and folder tree.
      * @param {NavigationApiOptions} options - The options for the Navigation API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
-     * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
+     * @returns {Promise<DotCMSNavigationItem[]>} - A Promise that resolves to the response from the DotCMS API.
      * @throws {Error} - Throws an error if the options are not valid.
      */
     async get(path, params) {
@@ -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 {
@@ -97,6 +98,7 @@ const buildPageQuery = ({ page, fragments, additionalQueries }) => {
     friendlyName
     workingInode
     url
+    pageURI
     hasLiveVersion
     deleted
     pageUrl
@@ -123,6 +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
@@ -130,6 +148,9 @@ const buildPageQuery = ({ page, fragments, additionalQueries }) => {
     }
     template {
       drawed
+      anonymous
+      theme
+      identifier
     }
     containers {
       path
@@ -171,7 +192,24 @@ const buildPageQuery = ({ page, fragments, additionalQueries }) => {
     viewAs {
       visitor {
         persona {
+          modDate
+          inode
           name
+          identifier
+          keyTag
+          photo {
+            versionPath
+          }
+        }
+      }
+      persona {
+        modDate
+        inode
+        name
+        identifier
+        keyTag
+        photo {
+         versionPath
         }
       }
       language {
@@ -188,8 +226,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' : ''}
     }
@@ -253,7 +291,6 @@ async function fetchGraphQL({ baseURL, body, headers }) {
     return await response.json();
 }
 
-var _PageClient_instances, _PageClient_isGraphQLRequest, _PageClient_getPageFromAPI, _PageClient_getPageFromGraphQL, _PageClient_mapToBackendParams;
 /**
  * Client for interacting with the DotCMS Page API.
  * Provides methods to retrieve and manipulate pages.
@@ -281,181 +318,120 @@ class PageClient {
      * ```
      */
     constructor(config, requestOptions) {
-        _PageClient_instances.add(this);
         this.requestOptions = requestOptions;
         this.siteId = config.siteId || '';
         this.dotcmsUrl = config.dotcmsUrl;
     }
-    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);
-    }
-}
-_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");
-    }
-    // Remove leading and trailing slashes from the path.
-    // Add a leading slash if it's missing.
-    const pagePath = `/${path.replace(/^\/+/, '').replace(/\/+/g, '/')}${path.endsWith('/') ? '/' : ''}`;
-    const pageParams = __classPrivateFieldGet(this, _PageClient_instances, "m", _PageClient_mapToBackendParams).call(this, params || {});
-    const urlParams = new URLSearchParams(pageParams).toString();
-    const url = `${this.dotcmsUrl}/api/v1/page/json${pagePath}${urlParams ? `?${urlParams}` : ''}`;
-    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);
-}, _PageClient_getPageFromGraphQL = 
-/**
- * Retrieves a personalized page with associated content and navigation.
- *
- * @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
- *           }
- *         }
- *       }
- *     `
- *   }
- * });
- * ```
- */
-async function _PageClient_getPageFromGraphQL(url, options) {
-    const { languageId = '1', mode = 'LIVE', graphql = {} } = options || {};
-    const { page, content = {}, variables, fragments } = graphql;
-    const contentQuery = buildQuery(content);
-    const completeQuery = buildPageQuery({
-        page,
-        fragments,
-        additionalQueries: contentQuery
-    });
-    const requestVariables = {
-        url,
-        mode,
-        languageId,
-        ...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
+    /**
+     * 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
+     *                      }
+     *                  `
+     *              ]
+     *          }
+     *      });
+     * ```
+     */
+    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
             });
+            if (errors) {
+                errors.forEach((error) => {
+                    throw new Error(error.message);
+                });
+            }
+            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
+                }
+            };
         }
-        const pageResponse = graphqlToPageEntity(data);
-        if (!pageResponse) {
-            throw new Error('No page data found');
+        catch (error) {
+            const errorMessage = {
+                error,
+                message: 'Failed to retrieve page data',
+                graphql: {
+                    query: completeQuery,
+                    variables: requestVariables
+                }
+            };
+            throw errorMessage;
         }
-        const contentResponse = mapResponseData(data, Object.keys(content));
-        return {
-            page: pageResponse,
-            content: contentResponse,
-            errors
-        };
-    }
-    catch (error) {
-        const errorMessage = {
-            error,
-            message: 'Failed to retrieve page data',
-            query: completeQuery,
-            variables: requestVariables
-        };
-        throw errorMessage;
     }
-}, _PageClient_mapToBackendParams = function _PageClient_mapToBackendParams(params) {
-    const backendParams = {
-        hostId: params.siteId || this.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));
-};
+}
 
 /**
  * Parses a string into a URL object.
@@ -468,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,17 @@
 {
   "name": "@dotcms/client",
-  "version": "0.0.1-beta.4",
+  "version": "0.0.1-beta.40",
   "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"
+  },
   "scripts": {
     "build": "nx run sdk-client:build:js; cd ../../../../dotCMS/src/main/webapp/html/js/editor-js; rm -rf src package.json *.esm.d.ts"
   },
@@ -29,12 +35,6 @@
       "types": "./next.esm.d.ts",
       "import": "./next.cjs.mjs",
       "default": "./next.cjs.js"
-    },
-    "./types": {
-      "module": "./types.esm.js",
-      "types": "./types.esm.d.ts",
-      "import": "./types.cjs.mjs",
-      "default": "./types.cjs.js"
     }
   },
   "typesVersions": {
@@ -44,9 +44,6 @@
       ],
       "next": [
         "./src/next.d.ts"
-      ],
-      "types": [
-        "./src/types.d.ts"
       ]
     }
   },

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.
@@ -15,7 +15,6 @@ import { ClientOptions } from '../../deprecated/sdk-js-client';
  *     .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 { ClientOptions } from '../../deprecated/sdk-js-client';
  *     .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 { ClientOptions } from '../../deprecated/sdk-js-client';
  * const posts = await client.content
  *     .getCollection<BlogPost>('Blog')
  *     .limit(10)
- *     .fetch();
  *
  * posts.contentlets.forEach(post => {
  *     console.log(post.title, post.author, post.summary);
@@ -56,10 +53,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, DotCMSNavigationItem } from '@dotcms/types';
 export declare class NavigationClient {
     private requestOptions;
     private BASE_URL;
@@ -22,10 +6,9 @@ export declare class NavigationClient {
     /**
      * Retrieves information about the dotCMS file and folder tree.
      * @param {NavigationApiOptions} options - The options for the Navigation API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
-     * @returns {Promise<unknown>} - A Promise that resolves to the response from the DotCMS API.
+     * @returns {Promise<DotCMSNavigationItem[]>} - 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<DotCMSNavigationItem[]>;
     private mapToBackendParams;
 }
-export {};