@dotcms/client 0.0.1-beta.9 → 1.0.0

package/src/lib/deprecated/editor/models/editor.model.d.ts

@@ -1,62 +0,0 @@
-/**
- * @description Custom client parameters for fetching data.
- */
-export type CustomClientParams = {
-    depth: string;
-};
-/**
- * @description Union type for fetch configurations.
- * @typedef {GraphQLFetchConfig | PageAPIFetchConfig} DotCMSFetchConfig
- */
-export type EditorConfig = {
-    params: CustomClientParams;
-} | {
-    query: string;
-};
-/**
- * Represents the configuration options for the DotCMS page editor.
- * @export
- * @interface DotCMSPageEditorConfig
- */
-export interface DotCMSPageEditorConfig {
-    /**
-     * The pathname of the page being edited. Optional.
-     * @type {string}
-     */
-    pathname: string;
-    /**
-     *
-     * @type {DotCMSFetchConfig}
-     * @memberof DotCMSPageEditorConfig
-     * @description The configuration custom params for data fetching on Edit Mode.
-     * @example <caption>Example with Custom GraphQL query</caption>
-     * const config: DotCMSPageEditorConfig = {
-     *   editor: { query: 'query { ... }' }
-     * };
-     *
-     * @example <caption>Example usage with Custom Page API parameters</caption>
-     * const config: DotCMSPageEditorConfig = {
-     *   editor: { params: { depth: '2' } }
-     * };
-     */
-    editor?: EditorConfig;
-    /**
-     * The reload function to call when the page is reloaded.
-     * @deprecated In future implementation we will be listening for the changes from the editor to update the page state so reload will not be needed.
-     * @type {Function}
-     */
-    onReload?: () => void;
-}
-/**
- * Configuration for reordering a menu.
- */
-export interface ReorderMenuConfig {
-    /**
-     * The starting level of the menu to be reordered.
-     */
-    startLevel: number;
-    /**
-     * The depth of the menu levels to be reordered.
-     */
-    depth: number;
-}

package/src/lib/deprecated/editor/models/inline-event.model.d.ts

@@ -1,9 +0,0 @@
-export type INLINE_EDITING_EVENT_KEY = 'BLOCK_EDITOR' | 'WYSIWYG';
-export interface InlineEditorData {
-    inode: string;
-    language: number;
-    contentType: string;
-    fieldName: string;
-    content: Record<string, unknown>;
-}
-export type InlineEditEventData = InlineEditorData;

package/src/lib/deprecated/editor/models/listeners.model.d.ts

@@ -1,55 +0,0 @@
-/**
- * Actions received from the dotcms editor
- *
- * @export
- * @enum {number}
- */
-export declare enum NOTIFY_CLIENT {
-    /**
-     * Request to page to reload
-     */
-    UVE_RELOAD_PAGE = "uve-reload-page",
-    /**
-     * Request the bounds for the elements
-     */
-    UVE_REQUEST_BOUNDS = "uve-request-bounds",
-    /**
-     * Received pong from the editor
-     */
-    UVE_EDITOR_PONG = "uve-editor-pong",
-    /**
-     * Received scroll event trigger from the editor
-     */
-    UVE_SCROLL_INSIDE_IFRAME = "uve-scroll-inside-iframe",
-    /**
-     * Set the page data
-     */
-    UVE_SET_PAGE_DATA = "uve-set-page-data",
-    /**
-     * Copy contentlet inline editing success
-     */
-    UVE_COPY_CONTENTLET_INLINE_EDITING_SUCCESS = "uve-copy-contentlet-inline-editing-success"
-}
-type ListenerCallbackMessage = (event: MessageEvent) => void;
-type ListenerCallbackPointer = (event: PointerEvent) => void;
-/**
- * Listener for the dotcms editor
- *
- * @interface DotCMSPageEditorListener
- */
-interface DotCMSPageEditorListener {
-    type: 'listener';
-    event: string;
-    callback: ListenerCallbackMessage | ListenerCallbackPointer;
-}
-/**
- * Observer for the dotcms editor
- *
- * @interface DotCMSPageEditorObserver
- */
-interface DotCMSPageEditorObserver {
-    type: 'observer';
-    observer: MutationObserver;
-}
-export type DotCMSPageEditorSubscription = DotCMSPageEditorListener | DotCMSPageEditorObserver;
-export {};

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,92 +0,0 @@
-import { DotCMSPageEditorConfig, ReorderMenuConfig } from './models/editor.model';
-import { INLINE_EDITING_EVENT_KEY, InlineEditEventData } from './models/inline-event.model';
-import { Contentlet } from '../../client/content/shared/types';
-/**
- * Updates the navigation in the editor.
- *
- * @param {string} pathname - The pathname to update the navigation with.
- * @memberof DotCMSPageEditor
- * @example
- * updateNavigation('/home'); // Sends a message to the editor to update the navigation to '/home'
- */
-export declare function updateNavigation(pathname: string): void;
-/**
- * You can use this function to edit a contentlet in the editor.
- *
- * Calling this function inside the editor, will prompt the UVE to open a dialog to edit the contentlet.
- *
- * @export
- * @template T
- * @param {Contentlet<T>} contentlet - The contentlet to edit.
- */
-export declare function editContentlet<T>(contentlet: Contentlet<T>): void;
-/**
- * Initializes the inline editing in the editor.
- *
- * @export
- * @param {INLINE_EDITING_EVENT_KEY} type
- * @param {InlineEditEventData} eventData
- * @return {*}
- *
- *  * @example
- * ```html
- * <div onclick="initInlineEditing('BLOCK_EDITOR', { inode, languageId, contentType, fieldName, content })">
- *      ${My Content}
- * </div>
- * ```
- */
-export declare function initInlineEditing(type: INLINE_EDITING_EVENT_KEY, data?: InlineEditEventData): void;
-export declare function reorderMenu(config?: ReorderMenuConfig): void;
-/**
- * @deprecated Use `getUVEState` function on {@link https://npmjs.com/package/@dotcms/uve|@dotcms/uve} instead, this function will be removed on future versions.
- *
- * Checks if the code is running inside the DotCMS Universal Visual Editor (UVE).
- *
- * The function checks three conditions:
- * 1. If window is defined (for SSR environments)
- * 2. If the page is not in preview mode
- * 3. If the current window is embedded in a parent frame
- *
- * @returns {boolean} Returns true if running inside the UVE editor, false if running standalone or in preview mode
- * @example
- * ```ts
- * // Check if code is running in editor before initializing editor-specific features
- * if (isInsideEditor()) {
- *     initEditor(config);
- * } else {
- *     initStandaloneMode();
- * }
- * ```
- */
-export declare function isInsideEditor(): boolean;
-export declare function initDotUVE(): void;
-/**
- * Initializes the DotCMS page editor.
- *
- * @param {DotCMSPageEditorConfig} config - Optional configuration for the editor.
- * @example
- * ```ts
- * const config = { pathname: '/home' };
- * initEditor(config); // Initializes the editor with the provided configuration
- * ```
- */
-export declare function initEditor(config: DotCMSPageEditorConfig): void;
-/**
- * Destroys the editor by removing event listeners and disconnecting observers.
- *
- * @example
- * ```ts
- * destroyEditor(); // Cleans up the editor by removing all event listeners and disconnecting observers
- * ```
- */
-export declare function destroyEditor(): void;
-/**
- * Adds a style class to empty contentlets.
- *
- * @export
- * @example
- * ```ts
- * addClassToEmptyContentlets(); // Adds the 'empty-contentlet' class to all contentlets that have no height
- * ```
- */
-export declare function addClassToEmptyContentlets(): void;

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

@@ -1,159 +0,0 @@
-/**
- * Bound information for a contentlet.
- *
- * @interface ContentletBound
- * @property {number} x - The x-coordinate of the contentlet.
- * @property {number} y - The y-coordinate of the contentlet.
- * @property {number} width - The width of the contentlet.
- * @property {number} height - The height of the contentlet.
- * @property {string} payload - The payload data of the contentlet in JSON format.
- */
-interface ContentletBound {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    payload: string;
-}
-/**
- * Bound information for a container.
- *
- * @interface ContainerBound
- * @property {number} x - The x-coordinate of the container.
- * @property {number} y - The y-coordinate of the container.
- * @property {number} width - The width of the container.
- * @property {number} height - The height of the container.
- * @property {string} payload - The payload data of the container in JSON format.
- * @property {ContentletBound[]} contentlets - An array of contentlets within the container.
- */
-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 - An array of HTMLDivElement representing the containers.
- * @return {ContainerBound[]} An array of objects containing the bounding information for each page element.
- * @example
- * ```ts
- * const containers = document.querySelectorAll('.container');
- * const bounds = getPageElementBound(containers);
- * console.log(bounds);
- * ```
- */
-export declare function getPageElementBound(containers: HTMLDivElement[]): ContainerBound[];
-/**
- * Calculates the bounding information for each contentlet inside a container.
- *
- * @export
- * @param {DOMRect} containerRect - The bounding rectangle of the container.
- * @param {HTMLDivElement[]} contentlets - An array of HTMLDivElement representing the contentlets.
- * @return {ContentletBound[]} An array of objects containing the bounding information for each contentlet.
- * @example
- * ```ts
- * const containerRect = container.getBoundingClientRect();
- * const contentlets = container.querySelectorAll('.contentlet');
- * const bounds = getContentletsBound(containerRect, contentlets);
- * console.log(bounds); // Element bounds within the container
- * ```
- */
-export declare function getContentletsBound(containerRect: DOMRect, contentlets: HTMLDivElement[]): ContentletBound[];
-/**
- * Get container data from VTLS.
- *
- * @export
- * @param {HTMLElement} container - The container element.
- * @return {object} An object containing the container data.
- * @example
- * ```ts
- * const container = document.querySelector('.container');
- * const data = getContainerData(container);
- * console.log(data);
- * ```
- */
-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 - The contentlet element.
- * @return {object | null} An object containing the closest container data or null if no container is found.
- * @example
- * ```ts
- * const contentlet = document.querySelector('.contentlet');
- * const data = getClosestContainerData(contentlet);
- * console.log(data);
- * ```
- */
-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 - The starting element.
- * @return {HTMLElement | null} The closest contentlet element or null if not found.
- * @example
- * const element = document.querySelector('.some-element');
- * const contentlet = findDotElement(element);
- * console.log(contentlet);
- */
-export declare function findDotElement(element: HTMLElement | null): HTMLElement | null;
-/**
- * Find the closest VTL file element based on HTMLElement.
- *
- * @export
- * @param {HTMLElement | null} element - The starting element.
- * @return {HTMLElement | null} The closest VTL file element or null if not found.
- * @example
- * const element = document.querySelector('.some-element');
- * const vtlFile = findDotVTLElement(element);
- * console.log(vtlFile);
- */
-export declare function findDotVTLElement(element: HTMLElement | null): HTMLElement | null;
-/**
- * Find VTL data within a target element.
- *
- * @export
- * @param {HTMLElement} target - The target element to search within.
- * @return {Array<{ inode: string, name: string }> | null} An array of objects containing VTL data or null if none found.
- * @example
- * ```ts
- * const target = document.querySelector('.target-element');
- * const vtlData = findVTLData(target);
- * console.log(vtlData);
- * ```
- */
-export declare function findVTLData(target: HTMLElement): {
-    inode: string | undefined;
-    name: string | undefined;
-}[] | null;
-/**
- * Check if the scroll position is at the bottom of the page.
- *
- * @export
- * @return {boolean} True if the scroll position is at the bottom, otherwise false.
- * @example
- * ```ts
- * if (scrollIsInBottom()) {
- *     console.log('Scrolled to the bottom');
- * }
- * ```
- */
-export declare function scrollIsInBottom(): boolean;
-export {};

package/src/lib/deprecated/editor/utils/traditional-vtl.utils.d.ts

@@ -1,4 +0,0 @@
-/**
- * Listen for block editor inline event.
- */
-export declare const listenBlockEditorInlineEvent: () => void;

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

@@ -1,276 +0,0 @@
-import { Content } from '../client/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. If not  provided, it will use the default site.
-     *
-     * More information here: {@link https://www.dotcms.com/docs/latest/multi-site-management}
-     *
-     * @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}
-     * @optional
-     */
-    siteId?: string;
-    /**
-     * The authentication token to use for the requests.
-     *
-     * @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;
-}
-export 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.
-     *
-     * More information here: {@link https://www.dotcms.com/docs/latest/multi-site-management}
-     * @type {string}
-     * @optional
-     */
-    siteId?: string;
-    /**
-     * The mode of the page you want to retrieve. If not provided, will use the default mode of the site.
-     *
-     * More information here: {@link https://www.dotcms.com/docs/latest/page-viewing-modes}
-     * @type {string}
-     * @optional
-     */
-    mode?: 'EDIT_MODE' | 'PREVIEW_MODE' | 'LIVE';
-    /**
-     * The language id of the page you want to retrieve. If not provided, will use the default language of the site.
-     * @type {number}
-     * @optional
-     */
-    language_id?: number;
-    /**
-     * The id of the persona you want to retrieve the page for.
-     *
-     * More information here: {@link https://www.dotcms.com/docs/latest/personas}
-     * @type {string}
-     * @optional
-     */
-    personaId?: string;
-    /**
-     * If you want to fire the rules set on the page.
-     *
-     * More information here: {@link https://www.dotcms.com/docs/latest/adding-rules-to-pages}
-     *
-     * @type {boolean}
-     * @optional
-     */
-    fireRules?: boolean;
-    /**
-     * Allows access to related content via the Relationship fields of contentlets on a Page; 0 (default).
-     * @type {number}
-     * @optional
-     */
-    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}
-     * @optional
-     */
-    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}
-     * @optional
-     */
-    languageId?: number;
-};
-/**
- * `DotCmsClient` is a TypeScript class that provides methods to interact with the DotCMS REST API.
- * DotCMS is a hybrid-headless CMS and digital experience platform.
- *
- * @class DotCmsClient
- * @property {ClientConfig} config - The configuration object for the DotCMS client.
- * @property {Content} content - Provides methods to interact with content in DotCMS.
- *
- * @method constructor(config: ClientConfig) - Constructs a new instance of the DotCmsClient class.
- *
- * @method page.get(options: PageApiOptions): Promise<PageApiResponse> - Retrieves all the elements of any Page in your dotCMS system in JSON format.
- * The Page API enables you to retrieve page information, layout, template, content blocks, and more.
- * @see {@link https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas}
- *
- * @method nav.get(options: NavApiOptions = { depth: 0, path: '/', languageId: 1 }): Promise<NavApiResponse> - Retrieves information about the dotCMS file and folder tree.
- * The Navigation API allows you to fetch the site structure and menu items.
- * @see {@link https://www.dotcms.com/docs/latest/navigation-rest-api}
- *
- * @method content.get(options: ContentApiOptions): Promise<ContentApiResponse> - Retrieves content items based on specified criteria.
- * The Content API allows you to query and retrieve content by ID, inode, or using Lucene queries.
- * @see {@link https://www.dotcms.com/docs/latest/content-api-retrieval-and-querying}
- *
- * @method editor.on(action: string, callbackFn: (payload: unknown) => void) - Allows you to react to actions issued by the Universal Visual Editor (UVE).
- * @method editor.off(action: string) - Stops listening to an action issued by UVE.
- *
- * @static
- * @method init(config: ClientConfig): DotCmsClient - Initializes and returns a DotCmsClient instance.
- * @method dotcmsUrl: string - Retrieves the DotCMS URL from the instance configuration.
- *
- * @example <caption>Basic usage</caption>
- * ```javascript
- * const client = DotCmsClient.init({ dotcmsUrl: 'https://demo.dotcms.com', authToken: 'your-auth-token' });
- *
- * // Get a page
- * client.page.get({ path: '/about-us' }).then(response => console.log(response));
- *
- * // Get navigation
- * client.nav.get({ path: '/about-us', depth: 2 }).then(response => console.log(response));
- *
- * // Get content
- * client.content.get({ query: '+contentType:Blog +languageId:1', limit: 10 }).then(response => console.log(response));
- *
- * // Listen to editor changes
- * client.editor.on('changes', (payload) => console.log('Changes detected:', payload));
- * ```
- */
-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.
-         * @example
-         * ```ts
-         * const client = new DotCmsClient({ dotcmsUrl: 'https://your.dotcms.com', authToken: 'your-auth-token', siteId: 'your-site-id' });
-         * client.page.get({ path: '/about-us' }).then(response => console.log(response));
-         * ```
-         */
-        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 {string} action - The name of the action emitted by UVE.
-         * @param {function} callbackFn - The function to execute when the UVE emits the action.
-         * @example
-         * ```ts
-         * client.editor.on('changes', (payload) => {
-         *     console.log('Changes detected:', payload);
-         * });
-         * ```
-         */
-        on: (action: string, callbackFn: (payload: unknown) => void) => void;
-        /**
-         * `editor.off` is a 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 {string} action - The name of the action to stop listening to.
-         * @example
-         * ```ts
-         * client.editor.off('changes');
-         * ```
-         */
-        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.
-         * @example
-         * ```ts
-         * const client = new DotCmsClient({ dotcmsUrl: 'https://your.dotcms.com', authToken: 'your-auth-token', siteId: 'your-site-id' }});
-         * client.nav.get({ path: '/about-us', depth: 2 }).then(response => console.log(response));
-         * ```
-         */
-        get: (options?: NavApiOptions) => Promise<unknown>;
-    };
-    /**
-     * Initializes the DotCmsClient instance with the provided configuration.
-     * If an instance already exists, it returns the existing instance.
-     *
-     * @param {ClientConfig} config - The configuration object for the DotCMS client.
-     * @returns {DotCmsClient} - The initialized DotCmsClient instance.
-     * @example
-     * ```ts
-     * const client = DotCmsClient.init({ dotcmsUrl: 'https://demo.dotcms.com', authToken: 'your-auth-token' });
-     * ```
-     */
-    static init(config: ClientConfig): DotCmsClient;
-    /**
-     * Retrieves the DotCMS URL from the instance configuration.
-     *
-     * @returns {string} - The DotCMS URL.
-     */
-    static get dotcmsUrl(): string;
-    /**
-     * Throws an error if the path is not valid.
-     *
-     * @returns {string} - The authentication token.
-     */
-    private validatePageOptions;
-    /**
-     * Throws an error if the path is not valid.
-     *
-     *  @returns {string} - The authentication token.
-     */
-    private validateNavOptions;
-}
-export {};