@dotcms/client 0.0.1-alpha.40 → 0.0.1-alpha.41

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@dotcms/client",
-  "version": "0.0.1-alpha.40",
+  "version": "0.0.1-alpha.41",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/dotCMS/core.git#master"
+    "url": "git+https://github.com/dotCMS/core.git#main"
   },
   "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"
@@ -21,5 +21,17 @@
   "bugs": {
     "url": "https://github.com/dotCMS/core/issues"
   },
-  "homepage": "https://github.com/dotCMS/core/tree/master/core-web/libs/sdk/client/README.md"
-}
+  "homepage": "https://github.com/dotCMS/core/tree/main/core-web/libs/sdk/client/README.md",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "module": "./index.esm.js",
+      "types": "./index.esm.d.ts",
+      "import": "./index.cjs.mjs",
+      "default": "./index.cjs.js"
+    }
+  },
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js",
+  "types": "./index.esm.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1,6 @@
+import { ClientConfig, DotCmsClient } from './lib/client/sdk-js-client';
+import { CUSTOMER_ACTIONS, postMessageToEditor } from './lib/editor/models/client.model';
+import { CustomClientParams, DotCMSPageEditorConfig, EditorConfig } from './lib/editor/models/editor.model';
+import { destroyEditor, initEditor, isInsideEditor, updateNavigation } from './lib/editor/sdk-editor';
+import { getPageRequestParams, graphqlToPageEntity } from './lib/utils';
+export { graphqlToPageEntity, getPageRequestParams, isInsideEditor, DotCmsClient, DotCMSPageEditorConfig, CUSTOMER_ACTIONS, CustomClientParams, postMessageToEditor, EditorConfig, initEditor, updateNavigation, destroyEditor, ClientConfig };

package/src/lib/client/content/builders/collection/{collection.ts → collection.d.ts}

@@ -1,18 +1,5 @@
-import { Equals } from '../../../../query-builder/lucene-syntax';
-import { QueryBuilder } from '../../../../query-builder/sdk-query-builder';
 import { ClientOptions } from '../../../sdk-js-client';
-import { CONTENT_API_URL } from '../../shared/const';
-import {
-    GetCollectionResponse,
-    BuildQuery,
-    SortBy,
-    GetCollectionRawResponse,
-    GetCollectionError,
-    OnFullfilled,
-    OnRejected
-} from '../../shared/types';
-import { sanitizeQueryForContentType } from '../../shared/utils';
-
+import { GetCollectionResponse, BuildQuery, SortBy, GetCollectionError, OnFullfilled, OnRejected } from '../../shared/types';
 /**
  * Creates a Builder to filter and fetch content from the content API for a specific content type.
  *
@@ -20,22 +7,8 @@ import { sanitizeQueryForContentType } from '../../shared/utils';
  * @class CollectionBuilder
  * @template T Represents the type of the content type to fetch. Defaults to unknown.
  */
-export class CollectionBuilder<T = unknown> {
-    #page = 1;
-    #limit = 10;
-    #depth = 0;
-    #render = false;
-    #sortBy?: SortBy[];
-    #contentType: string;
-    #defaultQuery: Equals;
-    #query?: Equals;
-    #rawQuery?: string;
-    #languageId: number | string = 1;
-    #draft = false;
-
-    #serverUrl: string;
-    #requestOptions: ClientOptions;
-
+export declare class CollectionBuilder<T = unknown> {
+    #private;
     /**
      * Creates an instance of CollectionBuilder.
      * @param {ClientOptions} requestOptions Options for the client request.
@@ -43,15 +16,7 @@ export class CollectionBuilder<T = unknown> {
      * @param {string} contentType The content type to fetch.
      * @memberof CollectionBuilder
      */
-    constructor(requestOptions: ClientOptions, serverUrl: string, contentType: string) {
-        this.#requestOptions = requestOptions;
-        this.#serverUrl = serverUrl;
-        this.#contentType = contentType;
-
-        // Build the default query with the contentType field
-        this.#defaultQuery = new QueryBuilder().field('contentType').equals(this.#contentType);
-    }
-
+    constructor(requestOptions: ClientOptions, serverUrl: string, contentType: string);
     /**
      * Returns the sort query in the format: field order, field order, ...
      *
@@ -59,10 +24,7 @@ export class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get sort() {
-        return this.#sortBy?.map((sort) => `${sort.field} ${sort.order}`).join(',');
-    }
-
+    private get sort();
     /**
      * Returns the offset for pagination.
      *
@@ -70,10 +32,7 @@ export class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get offset() {
-        return this.#limit * (this.#page - 1);
-    }
-
+    private get offset();
     /**
      * Returns the full URL for the content API.
      *
@@ -81,10 +40,7 @@ export class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get url() {
-        return `${this.#serverUrl}${CONTENT_API_URL}`;
-    }
-
+    private get url();
     /**
      * Returns the current query built.
      *
@@ -92,10 +48,7 @@ export class CollectionBuilder<T = unknown> {
      * @private
      * @memberof CollectionBuilder
      */
-    private get currentQuery() {
-        return this.#query ?? this.#defaultQuery;
-    }
-
+    private get currentQuery();
     /**
      * Filters the content by the specified language ID.
      *
@@ -110,12 +63,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    language(languageId: number | string): this {
-        this.#languageId = languageId;
-
-        return this;
-    }
-
+    language(languageId: number | string): this;
     /**
      * Setting this to true will server side render (using velocity) any widgets that are returned by the content query.
      *
@@ -124,12 +72,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    render(): this {
-        this.#render = true;
-
-        return this;
-    }
-
+    render(): this;
     /**
      * Sorts the content by the specified fields and orders.
      *
@@ -145,12 +88,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    sortBy(sortBy: SortBy[]): this {
-        this.#sortBy = sortBy;
-
-        return this;
-    }
-
+    sortBy(sortBy: SortBy[]): this;
     /**
      * Sets the maximum amount of content to fetch.
      *
@@ -158,12 +96,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    limit(limit: number): this {
-        this.#limit = limit;
-
-        return this;
-    }
-
+    limit(limit: number): this;
     /**
      * Sets the page number to fetch.
      *
@@ -171,12 +104,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    page(page: number): this {
-        this.#page = page;
-
-        return this;
-    }
-
+    page(page: number): this;
     /**
      * Filters the content by a Lucene query string.
      *
@@ -185,7 +113,6 @@ export class CollectionBuilder<T = unknown> {
      * @memberof CollectionBuilder
      */
     query(query: string): this;
-
     /**
      * Filters the content by building a query using a QueryBuilder function.
      *
@@ -203,33 +130,6 @@ export class CollectionBuilder<T = unknown> {
      * @memberof CollectionBuilder
      */
     query(buildQuery: BuildQuery): this;
-    query(arg: unknown): this {
-        if (typeof arg === 'string') {
-            this.#rawQuery = arg;
-
-            return this;
-        }
-
-        if (typeof arg !== 'function') {
-            throw new Error(
-                `Parameter for query method should be a buildQuery function or a string.\nExample:\nclient.content.getCollection('Activity').query((queryBuilder) => queryBuilder.field('title').equals('Hello World'))\nor\nclient.content.getCollection('Activity').query('+Activity.title:"Hello World"') \nSee documentation for more information.`
-            );
-        }
-
-        const builtQuery = arg(new QueryBuilder());
-
-        // This can be use in Javascript so we cannot rely on the type checking
-        if (builtQuery instanceof Equals) {
-            this.#query = builtQuery.raw(this.currentQuery.build());
-        } else {
-            throw new Error(
-                'Provided query is not valid. A query should end in an equals method call.\nExample:\n(queryBuilder) => queryBuilder.field("title").equals("Hello World")\nSee documentation for more information.'
-            );
-        }
-
-        return this;
-    }
-
     /**
      * Retrieves draft content.
      * @example
@@ -245,12 +145,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    draft(): this {
-        this.#draft = true;
-
-        return this;
-    }
-
+    draft(): this;
     /**
      * Filters the content by a variant ID for [Experiments](https://www.dotcms.com/docs/latest/experiments-and-a-b-testing)
      *
@@ -270,12 +165,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    variant(variantId: string): this {
-        this.#query = this.currentQuery.field('variant').equals(variantId);
-
-        return this;
-    }
-
+    variant(variantId: string): this;
     /**
      * Sets the depth of the relationships of the content.
      * Specifies the depth of related content to return in the results.
@@ -296,16 +186,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {CollectionBuilder} A CollectionBuilder instance.
      * @memberof CollectionBuilder
      */
-    depth(depth: number): this {
-        if (depth < 0 || depth > 3) {
-            throw new Error('Depth value must be between 0 and 3');
-        }
-
-        this.#depth = depth;
-
-        return this;
-    }
-
+    depth(depth: number): this;
     /**
      * Executes the fetch and returns a promise that resolves to the content or rejects with an error.
      *
@@ -324,30 +205,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {Promise<GetCollectionResponse<T> | GetCollectionError>} A promise that resolves to the content or rejects with an error.
      * @memberof CollectionBuilder
      */
-    then(
-        onfulfilled?: OnFullfilled<T>,
-        onrejected?: OnRejected
-    ): Promise<GetCollectionResponse<T> | GetCollectionError> {
-        return this.fetch().then(async (response) => {
-            const data = await response.json();
-            if (response.ok) {
-                const formattedResponse = this.formatResponse<T>(data);
-
-                const finalResponse =
-                    typeof onfulfilled === 'function'
-                        ? onfulfilled(formattedResponse)
-                        : formattedResponse;
-
-                return finalResponse;
-            } else {
-                return {
-                    status: response.status,
-                    ...data
-                };
-            }
-        }, onrejected);
-    }
-
+    then(onfulfilled?: OnFullfilled<T>, onrejected?: OnRejected): Promise<GetCollectionResponse<T> | GetCollectionError>;
     /**
      * Formats the response to the desired format.
      *
@@ -356,25 +214,7 @@ export class CollectionBuilder<T = unknown> {
      * @return {GetCollectionResponse<T>} The formatted response.
      * @memberof CollectionBuilder
      */
-    private formatResponse<T>(data: GetCollectionRawResponse<T>): GetCollectionResponse<T> {
-        const contentlets = data.entity.jsonObjectView.contentlets;
-        const total = data.entity.resultsSize;
-
-        const mappedResponse: GetCollectionResponse<T> = {
-            contentlets,
-            total,
-            page: this.#page,
-            size: contentlets.length
-        };
-
-        return this.#sortBy
-            ? {
-                  ...mappedResponse,
-                  sortedBy: this.#sortBy
-              }
-            : mappedResponse;
-    }
-
+    private formatResponse;
     /**
      * Calls the content API to fetch the content.
      *
@@ -382,35 +222,5 @@ export class CollectionBuilder<T = unknown> {
      * @return {Promise<Response>} The fetch response.
      * @memberof CollectionBuilder
      */
-    private fetch(): Promise<Response> {
-        const finalQuery = this.currentQuery
-            .field('languageId')
-            .equals(this.#languageId.toString())
-            .field('live')
-            .equals((!this.#draft).toString())
-            .build();
-
-        const sanitizedQuery = sanitizeQueryForContentType(finalQuery, this.#contentType);
-
-        const query = this.#rawQuery ? `${sanitizedQuery} ${this.#rawQuery}` : sanitizedQuery;
-
-        return fetch(this.url, {
-            ...this.#requestOptions,
-            method: 'POST',
-            headers: {
-                ...this.#requestOptions.headers,
-                'Content-Type': 'application/json'
-            },
-            body: JSON.stringify({
-                query,
-                render: this.#render,
-                sort: this.sort,
-                limit: this.#limit,
-                offset: this.offset,
-                depth: this.#depth
-                //userId: This exist but we currently don't use it
-                //allCategoriesInfo: This exist but we currently don't use it
-            })
-        });
-    }
+    private fetch;
 }

package/src/lib/client/content/{content-api.ts → content-api.d.ts}

@@ -1,7 +1,5 @@
 import { CollectionBuilder } from './builders/collection/collection';
-
 import { ClientOptions } from '../sdk-js-client';
-
 /**
  * Creates a builder to filter and fetch a collection of content items.
  * @param contentType - The content type to retrieve.
@@ -54,20 +52,14 @@ import { ClientOptions } from '../sdk-js-client';
  * });
  * ```
  */
-export class Content {
-    #requestOptions: ClientOptions;
-    #serverUrl: string;
-
+export declare class Content {
+    #private;
     /**
      * Creates an instance of Content.
      * @param {ClientOptions} requestOptions - The options for the client request.
      * @param {string} serverUrl - The server URL.
      */
-    constructor(requestOptions: ClientOptions, serverUrl: string) {
-        this.#requestOptions = requestOptions;
-        this.#serverUrl = serverUrl;
-    }
-
+    constructor(requestOptions: ClientOptions, 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.
@@ -133,7 +125,5 @@ export class Content {
      * ```
      *
      */
-    getCollection<T = unknown>(contentType: string): CollectionBuilder<T> {
-        return new CollectionBuilder<T>(this.#requestOptions, this.#serverUrl, contentType);
-    }
+    getCollection<T = unknown>(contentType: string): CollectionBuilder<T>;
 }

package/src/lib/client/content/shared/{const.ts → const.d.ts}

@@ -1,15 +1,13 @@
 /**
  * Default variant identifier used in the application.
  */
-export const DEFAULT_VARIANT_ID = 'DEFAULT';
-
+export declare const DEFAULT_VARIANT_ID = "DEFAULT";
 /**
  * Fields that should not be formatted when sanitizing the query.
  * These fields are essential for maintaining the integrity of the content type.
  */
-export const CONTENT_TYPE_MAIN_FIELDS: string[] = ['live', 'variant', 'contentType', 'languageId'];
-
+export declare const CONTENT_TYPE_MAIN_FIELDS: string[];
 /**
  * URL endpoint for the content API search functionality.
  */
-export const CONTENT_API_URL = '/api/content/_search';
+export declare const CONTENT_API_URL = "/api/content/_search";

package/src/lib/client/content/shared/{types.ts → types.d.ts}

@@ -1,6 +1,5 @@
 import { Equals } from '../../../query-builder/lucene-syntax';
 import { QueryBuilder } from '../../../query-builder/sdk-query-builder';
-
 /**
  * Model to sort by fields.
  */
@@ -14,7 +13,6 @@ export type SortBy = {
      */
     order: 'asc' | 'desc';
 };
-
 /**
  * Callback to build a query.
  *
@@ -23,7 +21,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).
  */
@@ -60,14 +57,12 @@ export interface ContentTypeMainFields {
     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.
  *
@@ -76,13 +71,7 @@ export type Contentlet<T> = T & ContentTypeMainFields;
  * @param {GetCollectionResponse<T>} value - The response value.
  * @returns {GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>> | void} The processed response or a promise.
  */
-export type OnFullfilled<T> =
-    | ((
-          value: GetCollectionResponse<T>
-      ) => GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>> | void)
-    | undefined
-    | null;
-
+export type OnFullfilled<T> = ((value: GetCollectionResponse<T>) => GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>> | void) | undefined | null;
 /**
  * Callback for a rejected promise.
  *
@@ -90,11 +79,7 @@ export type OnFullfilled<T> =
  * @param {GetCollectionError} error - The error object.
  * @returns {GetCollectionError | PromiseLike<GetCollectionError> | void} The processed error or a promise.
  */
-export type OnRejected =
-    | ((error: GetCollectionError) => GetCollectionError | PromiseLike<GetCollectionError> | void)
-    | undefined
-    | null;
-
+export type OnRejected = ((error: GetCollectionError) => GetCollectionError | PromiseLike<GetCollectionError> | void) | undefined | null;
 /**
  * Response of the get collection method.
  *
@@ -122,7 +107,6 @@ export interface GetCollectionResponse<T> {
      */
     sortedBy?: SortBy[];
 }
-
 /**
  * Raw response of the get collection method.
  *
@@ -142,7 +126,6 @@ export interface GetCollectionRawResponse<T> {
         resultsSize: number;
     };
 }
-
 /**
  * Error object for the get collection method.
  */

package/src/lib/client/content/shared/{utils.ts → utils.d.ts}

@@ -1,5 +1,3 @@
-import { CONTENT_TYPE_MAIN_FIELDS } from './const';
-
 /**
  * @description
  * Sanitizes the query for the given content type.
@@ -19,10 +17,4 @@ import { CONTENT_TYPE_MAIN_FIELDS } from './const';
  * @param {string} contentType - The content type to be used for formatting the fields.
  * @returns {string} The sanitized query string.
  */
-export function sanitizeQueryForContentType(query: string, contentType: string): string {
-    return query.replace(/\+([^+:]*?):/g, (original, field) => {
-        return !CONTENT_TYPE_MAIN_FIELDS.includes(field) // Fields that are not content type fields
-            ? `+${contentType}.${field}:` // Should have this format: +contentTypeVar.field:
-            : original; // Return the field if it is a content type field
-    });
-}
+export declare function sanitizeQueryForContentType(query: string, contentType: string): string;

package/src/lib/client/models/{index.ts → index.d.ts}

@@ -9,11 +9,4 @@
  * @property {string} 502 - Bad Gateway. Try again later.
  * @property {string} 503 - Service Unavailable. Try again later.
  */
-export const ErrorMessages: Record<number, string> = {
-    401: 'Unauthorized. Check the token and try again.',
-    403: 'Forbidden. Check the permissions and try again.',
-    404: 'Not Found. Check the URL and try again.',
-    500: 'Internal Server Error. Try again later.',
-    502: 'Bad Gateway. Try again later.',
-    503: 'Service Unavailable. Try again later.'
-};
+export declare const ErrorMessages: Record<number, string>;

package/src/lib/client/models/{types.ts → types.d.ts}

@@ -9,6 +9,5 @@
 export type DotcmsClientListener = {
     action: string;
     event: string;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     callback: (...args: any[]) => void;
 };