@dotcms/client 0.0.1-alpha.37 → 0.0.1-alpha.39

package/src/index.d.ts

@@ -1,6 +0,0 @@
-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.d.ts

@@ -1,148 +0,0 @@
-import { ClientOptions } from '../../../sdk-js-client';
-import { GetCollectionResponse, BuildQuery, SortBy, GetCollectionError, OnFullfilled, OnRejected } from '../../shared/types';
-/**
- * Creates a Builder to filter and fetch content from the content API for an specific content type
- *
- * @export
- * @class CollectionBuilder
- * @template T Represents the type of the content type to fetch. Defaults to unknown
- */
-export declare class CollectionBuilder<T = unknown> {
-    #private;
-    constructor(requestOptions: ClientOptions, serverUrl: string, contentType: string);
-    /**
-     * This method returns the sort query in this format: field order, field order, ...
-     *
-     * @readonly
-     * @private
-     * @memberof CollectionBuilder
-     */
-    private get sort();
-    private get offset();
-    private get url();
-    /**
-     * This method returns the current query built
-     *
-     * @readonly
-     * @private
-     * @memberof CollectionBuilder
-     */
-    private get currentQuery();
-    /**
-     * Takes a language id and filters the content by that language.
-     *
-     * The language id defaults to 1
-     *
-     *
-     * @param {number | string} languageId The language id to filter the content by
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
-     * @memberof CollectionBuilder
-     */
-    language(languageId: number | string): this;
-    /**
-     * The retrieved content will have the rendered HTML
-     *
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
-     * @memberof CollectionBuilder
-     */
-    render(): this;
-    /**
-     * Takes an array of constrains to sort the content by field an specific order
-     *
-     * @example
-     * ```javascript
-     * // This will sort the content by title in ascending order
-     * // and by modDate in descending order
-     *  const sortBy = [{ field: 'title', order: 'asc' }, { field: 'modDate', order: 'desc' }]
-     *
-     *  client.content.getCollection("Blog").sortBy(sortBy)
-     *```
-     *
-     * @param {SortBy[]} sortBy Array of constrains to sort the content by
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
-     * @memberof CollectionBuilder
-     */
-    sortBy(sortBy: SortBy[]): this;
-    /**
-     * Takes a number that represents the max amount of content to fetch
-     *
-     * `limit` is set to 10 by default
-     *
-     * @param {number} limit The max amount of content to fetch
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
-     * @memberof CollectionBuilder
-     */
-    limit(limit: number): this;
-    /**
-     * Takes a number that represents the page to fetch
-     *
-     * @param {number} page The page to fetch
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
-     * @memberof CollectionBuilder
-     */
-    page(page: number): this;
-    /**
-     * Takes a string that represents a {@link https://www.dotcms.com/docs/latest/content-search-syntax#Lucene Lucene Query} that is used to filter the content to fetch.
-     *
-     * The string is not validated, so be cautious when using it.
-     *
-     * @param {string} query A {@link https://www.dotcms.com/docs/latest/content-search-syntax#Lucene Lucene Query} String
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
-     * @memberof CollectionBuilder
-     */
-    query(query: string): this;
-    /**
-     * Takes a function that recieves a QueryBuilder to buid a query for content filtering.
-     * @example
-     *```javascript
-     * // This will filter the content by title equals 'Hello World' or 'Hello World 2'
-     * client.content.getCollection("Activity").query((queryBuilder) =>
-     *     queryBuilder.field('title').equals('Hello World').or().equals('Hello World 2')
-     * );
-     *```
-     * @param {BuildQuery} buildQuery A function that receives a QueryBuilder instance and returns a valid query
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
-     * @memberof CollectionBuilder
-     */
-    query(buildQuery: BuildQuery): this;
-    /**
-     * The retrieved content will be draft content
-     *
-     * The default value is false to fetch content that is not on draft
-     *
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
-     * @memberof CollectionBuilder
-     */
-    draft(): this;
-    /**
-     * Takes a string that represents a variant ID of content created with the {@link https://www.dotcms.com/docs/latest/experiments-and-a-b-testing A/B Testing} feature
-     *
-     * `variantId` defaults to "DEFAULT" to fetch content that is not part of an A/B test
-     *
-     * @param {string} variantId A string that represents a variant ID
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
-     * @memberof CollectionBuilder
-     */
-    variant(variantId: string): this;
-    /**
-     * Takes a number that represents the depth of the relationships of a content
-     *
-     * The `depth` is set to 0 by default and the max supported value is 3.
-     *
-     * @param {number} depth The depth of the relationships of a content
-     * @return {CollectionBuilder} CollectionBuilder - A CollectionBuilder instance
-     * @memberof CollectionBuilder
-     */
-    depth(depth: number): this;
-    /**
-     * Executes the fetch and returns a promise that resolves to the content or rejects to an error
-     *
-     * @param {OnFullfilled} [onfulfilled] A callback that is called when the fetch is successful
-     * @param {OnRejected} [onrejected] A callback that is called when the fetch fails
-     * @return {Promise<GetCollectionResponse<T> | GetCollectionError>} A promise that resolves to the content or rejects to an error
-     * @memberof CollectionBuilder
-     */
-    then(onfulfilled?: OnFullfilled<T>, onrejected?: OnRejected): Promise<GetCollectionResponse<T> | GetCollectionError>;
-    private formatResponse;
-    private fetch;
-}

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

@@ -1,78 +0,0 @@
-import { CollectionBuilder } from './builders/collection/collection';
-import { ClientOptions } from '../sdk-js-client';
-/**
- * Content classs exposes the content api methods
- *
- * @export
- * @class Content
- */
-export declare class Content {
-    #private;
-    constructor(requestOptions: ClientOptions, serverUrl: string);
-    /**
-     * Takes a content type and returns a builder to filter and fetch the collection
-     *
-     * @example
-     * ```javascript
-     * // Using await and async
-     * const collectionResponse = await client.content
-     *     .getCollection('Blog')
-     *     .limit(10)
-     *     .page(2)
-     *     .sortBy([{ field: 'title', order: 'asc' }])
-     *     .query((queryBuilder) => queryBuilder.field('author').equals('John Doe'))
-     *     .depth(1);
-     * ```
-     * @example
-     * ```javascript
-     * // Using then and catch
-     * client.content
-     *      .getCollection('Blog')
-     *      .limit(10)
-     *      .page(2)
-     *      .sortBy([{ field: 'title', order: 'asc' }])
-     *      .query((queryBuilder) => queryBuilder.field('author').equals('John Doe'))
-     *      .depth(1)
-     *      .then((response) => {
-     *          console.log(response.contentlets);
-     *      })
-     *      .catch((error) => {
-     *          console.error(error);
-     *      });
-     * ```
-     * @example
-     * ```typescript
-     * // Using an specific type for your content
-     *
-     * type Blog = {
-     *     summary: string;
-     *     author: string;
-     *     title: string;
-     * };
-     *
-     * client.content
-     *     .getCollection<Blog>('Blog')
-     *     .limit(10)
-     *     .page(2)
-     *     .sortBy([{ field: 'title', order: 'asc' }])
-     *     .query((queryBuilder) => queryBuilder.field('author').equals('John Doe'))
-     *     .depth(1)
-     *     .then((response) => {
-     *         response.contentlets.forEach((blog) => {
-     *             console.log(blog.title);
-     *             console.log(blog.author);
-     *             console.log(blog.summary);
-     *         });
-     *     })
-     *     .catch((error) => {
-     *         console.error(error);
-     *     });
-     * ```
-     *
-     * @param {string} contentType The content type to get the collection
-     * @return {CollectionBuilder} CollectionBuilder to filter and fetch the collection
-     * @template T Represents the type of the content type to fetch. Defaults to unknown
-     * @memberof Content
-     */
-    getCollection<T = unknown>(contentType: string): CollectionBuilder<T>;
-}

package/src/lib/client/content/shared/const.d.ts

@@ -1,3 +0,0 @@
-export declare const DEFAULT_VARIANT_ID = "DEFAULT";
-export declare const CONTENT_TYPE_MAIN_FIELDS: string[];
-export declare const CONTENT_API_URL = "/api/content/_search";

package/src/lib/client/content/shared/types.d.ts

@@ -1,62 +0,0 @@
-import { Equals } from '../../../query-builder/lucene-syntax';
-import { QueryBuilder } from '../../../query-builder/sdk-query-builder';
-export type SortBy = {
-    field: string;
-    order: 'asc' | 'desc';
-};
-export type BuildQuery = (qb: QueryBuilder) => Equals;
-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;
-}
-export type Contentlet<T> = T & ContentTypeMainFields;
-export type OnFullfilled<T> = ((value: GetCollectionResponse<T>) => GetCollectionResponse<T> | PromiseLike<GetCollectionResponse<T>> | void) | undefined | null;
-export type OnRejected = ((error: GetCollectionError) => GetCollectionError | PromiseLike<GetCollectionError> | void) | undefined | null;
-export interface GetCollectionResponse<T> {
-    contentlets: Contentlet<T>[];
-    page: number;
-    size: number;
-    total: number;
-    sortedBy?: SortBy[];
-}
-export interface GetCollectionRawResponse<T> {
-    entity: {
-        jsonObjectView: {
-            contentlets: Contentlet<T>[];
-        };
-        resultsSize: number;
-    };
-}
-export interface GetCollectionError {
-    status: number;
-    [key: string]: unknown;
-}

package/src/lib/client/content/shared/utils.d.ts

@@ -1,12 +0,0 @@
-/**
- * Sanitizes the query for the given content type.
- * It replaces the fields that are not contentType fields with the correct format.
- * Example: +field: -> +contentTypeVar.field:
- *
- *
- * @export
- * @param {string} query
- * @param {string} contentType
- * @return {*}  {string}
- */
-export declare function sanitizeQueryForContentType(query: string, contentType: string): string;

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

@@ -1 +0,0 @@
-export declare const ErrorMessages: Record<number, string>;

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

@@ -1,5 +0,0 @@
-export type DotcmsClientListener = {
-    action: string;
-    event: string;
-    callback: (...args: any[]) => void;
-};

package/src/lib/client/sdk-js-client.d.ts

@@ -1,193 +0,0 @@
-import { Content } from './content/content-api';
-export type ClientOptions = Omit<RequestInit, 'body' | 'method'>;
-export interface ClientConfig {
-    /**
-     * The URL of the dotCMS instance.
-     *
-     * @description This is the URL of the dotCMS instance you want to interact with. Ensure to include the protocol (http or https).
-     * @example `https://demo.dotcms.com`
-     * @type {string}
-     * @required
-     */
-    dotcmsUrl: string;
-    /**
-     * The id of the site you want to interact with.
-     *
-     * @description to get the site id, go to the site you want to interact with and copy the id from the History tab
-     *
-     * @type {string}
-     * @required
-     */
-    siteId?: string;
-    /**
-     * The authentication token to use for the requests. If not provided, it will fallback to default site.
-     *
-     * @description you can get the auth token from our UI {@link https://www.dotcms.com/docs/latest/rest-api-authentication#creating-an-api-token-in-the-ui}
-     *
-     * @type {string}
-     * @required
-     */
-    authToken: string;
-    /**
-     * Additional options to pass to the fetch request.
-     *
-     * @description These options will be used in the fetch request. Any option can be specified except for 'body' and 'method' which are omitted.
-     * @example `{ headers: { 'Content-Type': 'application/json' } }`
-     * @type {ClientOptions}
-     * @optional
-     */
-    requestOptions?: ClientOptions;
-}
-type PageApiOptions = {
-    /**
-     * The path of the page you want to retrieve.
-     *
-     * @type {string}
-     */
-    path: string;
-    /**
-     * The id of the site you want to interact with. If not provided, the one from the config will be used.
-     *
-     * @type {number}
-     */
-    siteId?: string;
-    /**
-     * The mode of the page you want to retrieve. If not provided will use the default mode of the site.
-     *
-     * @type {number}
-     */
-    mode?: string;
-    /**
-     * The language id of the page you want to retrieve. If not provided will use the default language of the site.
-     *
-     * @type {number}
-     */
-    language_id?: number;
-    /**
-     * The id of the persona you want to retrieve the page for.
-     *
-     * @type {string}
-     */
-    personaId?: string;
-    /**
-     * If you want to fire the rules set on the page
-     *
-     * @type {boolean}
-     */
-    fireRules?: boolean;
-    /**
-     * Allows access to related content via the Relationship fields of contentlets on a Page; 0 (default)
-     *
-     * @type {number}
-     */
-    depth?: number;
-};
-type NavApiOptions = {
-    /**
-     * The root path to begin traversing the folder tree.
-     *
-     * @example
-     * `/api/v1/nav/` starts from the root of the site
-     * @example
-     * `/about-us` starts from the "About Us" folder
-     *
-     * @type {string}
-     */
-    path: string;
-    /**
-     * The depth of the folder tree to return.
-     * @example
-     * `1` returns only the element specified in the path.
-     * @example
-     * `2` returns the element specified in the path, and if that element is a folder, returns all direct children of that folder.
-     * @example
-     * `3` returns all children and grandchildren of the element specified in the path.
-     *
-     * @type {number}
-     */
-    depth?: number;
-    /**
-     * The language ID of content to return.
-     * @example
-     * `1` (or unspecified) returns content in the default language of the site.
-     *
-     * @link https://www.dotcms.com/docs/latest/system-language-properties#DefaultLanguage
-     * @link https://www.dotcms.com/docs/latest/adding-and-editing-languages#LanguageID
-     * @type {number}
-     */
-    languageId?: number;
-};
-/**
- * `DotCmsClient` is a TypeScript class that provides methods to interact with the DotCMS REST API.
- * It requires a configuration object on instantiation, which includes the DotCMS URL, site ID, and authentication token.
- *
- * @class DotCmsClient
- *
- * @property {ClientConfig} config - The configuration object for the DotCMS client.
- *
- * @method constructor(config: ClientConfig) - Constructs a new instance of the DotCmsClient class.
- *
- * @method page.get(options: PageApiOptions): Promise<unknown> - Retrieves all the elements of any Page in your dotCMS system in JSON format.
- *
- * @method nav.get(options: NavApiOptions = { depth: 0, path: '/', languageId: 1 }): Promise<unknown> - Retrieves information about the dotCMS file and folder tree.
- *
- */
-export declare class DotCmsClient {
-    #private;
-    static instance: DotCmsClient;
-    dotcmsUrl?: string;
-    content: Content;
-    constructor(config?: ClientConfig);
-    page: {
-        /**
-         * `page.get` is an asynchronous method of the `DotCmsClient` class that retrieves all the elements of any Page in your dotCMS system in JSON format.
-         * It takes a `PageApiOptions` object as a parameter and returns a Promise that resolves to the response from the DotCMS API.
-         *
-         * The Page API enables you to retrieve all the elements of any Page in your dotCMS system.
-         * The elements may be retrieved in JSON format.
-         *
-         * @link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas
-         * @async
-         * @param {PageApiOptions} options - The options for the Page API call.
-         * @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: (options: PageApiOptions) => Promise<unknown>;
-    };
-    editor: {
-        /**
-         * `editor.on` is an asynchronous method of the `DotCmsClient` class that allows you to react to actions issued by the UVE.
-         *
-         *  NOTE: This is being used by the development team - This logic is probably varied or moved to another function/object.
-         * @param action - The name of the name emitted by UVE
-         * @param callbackFn - The function to execute when the UVE emits the action
-         */
-        on: (action: string, callbackFn: (payload: unknown) => void) => void;
-        /**
-         * `editor.off` is an synchronous method of the `DotCmsClient` class that allows you to stop listening and reacting to an action issued by UVE.
-         *
-         *  NOTE: This is being used by the development team - This logic is probably varied or moved to another function/object.
-         * @param action
-         */
-        off: (action: string) => void;
-    };
-    nav: {
-        /**
-         * `nav.get` is an asynchronous method of the `DotCmsClient` class that retrieves information about the dotCMS file and folder tree.
-         * It takes a `NavApiOptions` object as a parameter (with default values) and returns a Promise that resolves to the response from the DotCMS API.
-         *
-         * The navigation REST API enables you to retrieve information about the dotCMS file and folder tree through REST API calls.
-         * @link https://www.dotcms.com/docs/latest/navigation-rest-api
-         * @async
-         * @param {NavApiOptions} options - The options for the Nav API call. Defaults to `{ depth: 0, path: '/', languageId: 1 }`.
-         * @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: (options?: NavApiOptions) => Promise<unknown>;
-    };
-    static init(config: ClientConfig): DotCmsClient;
-    static get dotcmsUrl(): string;
-    private validatePageOptions;
-    private validateNavOptions;
-}
-export {};

package/src/lib/editor/listeners/listeners.d.ts

@@ -1,46 +0,0 @@
-import { DotCMSPageEditorSubscription } from '../models/listeners.model';
-declare global {
-    interface Window {
-        lastScrollYPosition: number;
-    }
-}
-/**
- * Represents an array of DotCMSPageEditorSubscription objects.
- * Used to store the subscriptions for the editor and unsubscribe later.
- */
-export declare const subscriptions: DotCMSPageEditorSubscription[];
-/**
- * Listens for editor messages and performs corresding actions based on the received message.
- *
- * @private
- * @memberof DotCMSPageEditor
- */
-export declare function listenEditorMessages(): void;
-/**
- * Listens for pointer move events and extracts information about the hovered contentlet.
- *
- * @private
- * @memberof DotCMSPageEditor
- */
-export declare function listenHoveredContentlet(): void;
-/**
- * Attaches a scroll event listener to the window
- * and sends a message to the editor when the window is scrolled.
- *
- * @private
- * @memberof DotCMSPageEditor
- */
-export declare function scrollHandler(): void;
-/**
- * Restores the scroll position of the window when an iframe is loaded.
- * Only used in VTL Pages.
- * @export
- */
-export declare function preserveScrollOnIframe(): void;
-/**
- * Sends a message to the editor to get the page data.
- * @param {string} pathname - The pathname of the page.
- * @private
- * @memberof DotCMSPageEditor
- */
-export declare function fetchPageDataFromInsideUVE(pathname: string): void;

package/src/lib/editor/sdk-editor-vtl.d.ts

@@ -1,6 +0,0 @@
-declare global {
-    interface Window {
-        lastScrollYPosition: number;
-    }
-}
-export {};

package/src/lib/editor/sdk-editor.d.ts

@@ -1,29 +0,0 @@
-import { DotCMSPageEditorConfig } from './models/editor.model';
-/**
- *
- * Updates the navigation in the editor.
- * @param {string} pathname - The pathname to update the navigation with.
- * @memberof DotCMSPageEditor
- */
-export declare function updateNavigation(pathname: string): void;
-/**
- * Checks if the code is running inside an editor.
- * @returns {boolean} Returns true if the code is running inside an editor, otherwise false.
- */
-export declare function isInsideEditor(): boolean;
-/**
- * Initializes the DotCMS page editor.
- *
- * @param conf - Optional configuration for the editor.
- */
-export declare function initEditor(config: DotCMSPageEditorConfig): void;
-/**
- * Destroys the editor by removing event listeners and disconnecting observers.
- */
-export declare function destroyEditor(): void;
-/**
- * Adds a class to empty contentlets.
- *
- * @export
- */
-export declare function addClassToEmptyContentlets(): void;

package/src/lib/editor/utils/editor.utils.d.ts

@@ -1,83 +0,0 @@
-/**
- * Bound information for a contentlet.
- *
- * @interface ContentletBound
- */
-interface ContentletBound {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    payload: string;
-}
-/**
- * Bound information for a container.
- *
- * @interface ContainerBound
- */
-interface ContainerBound {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    payload: string;
-    contentlets: ContentletBound[];
-}
-/**
- * Calculates the bounding information for each page element within the given containers.
- *
- * @export
- * @param {HTMLDivElement[]} containers
- * @return {*} An array of objects containing the bounding information for each page element.
- */
-export declare function getPageElementBound(containers: HTMLDivElement[]): ContainerBound[];
-/**
- * An array of objects containing the bounding information for each contentlet inside a container.
- *
- * @export
- * @param {DOMRect} containerRect
- * @param {HTMLDivElement[]} contentlets
- * @return {*}
- */
-export declare function getContentletsBound(containerRect: DOMRect, contentlets: HTMLDivElement[]): ContentletBound[];
-/**
- * Get container data from VTLS.
- *
- * @export
- * @param {HTMLElement} container
- * @return {*}
- */
-export declare function getContainerData(container: HTMLElement): {
-    acceptTypes: string;
-    identifier: string;
-    maxContentlets: string;
-    uuid: string;
-};
-/**
- * Get the closest container data from the contentlet.
- *
- * @export
- * @param {Element} element
- * @return {*}
- */
-export declare function getClosestContainerData(element: Element): {
-    acceptTypes: string;
-    identifier: string;
-    maxContentlets: string;
-    uuid: string;
-} | null;
-/**
- * Find the closest contentlet element based on HTMLElement.
- *
- * @export
- * @param {(HTMLElement | null)} element
- * @return {*}
- */
-export declare function findDotElement(element: HTMLElement | null): HTMLElement | null;
-export declare function findDotVTLElement(element: HTMLElement | null): HTMLElement | null;
-export declare function findVTLData(target: HTMLElement): {
-    inode: string | undefined;
-    name: string | undefined;
-}[] | null;
-export declare function scrollIsInBottom(): boolean;
-export {};