@dotcms/client 0.0.1-alpha.38 → 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/editor/listeners/listeners.d.ts

@@ -1,50 +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 corresponding 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
- * @example
- * ```ts
- * preserveScrollOnIframe();
- * ```
- */
-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,54 +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
- * @example
- * updateNavigation('/home'); // Sends a message to the editor to update the navigation to '/home'
- */
-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.
- * @example
- * ```ts
- * if (isInsideEditor()) {
- *     console.log('Running inside the editor');
- * } else {
- *     console.log('Running outside the editor');
- * }
- * ```
- */
-export declare function isInsideEditor(): boolean;
-/**
- * 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/utils/graphql/transforms.d.ts

@@ -1,24 +0,0 @@
-/**
- * Represents the response from a GraphQL query for a page.
- *
- * @interface GraphQLPageResponse
- * @property {Record<string, unknown>} page - The main page data.
- * @property {unknown} [key: string] - Additional properties that may be included in the response.
- */
-interface GraphQLPageResponse {
-    page: Record<string, unknown>;
-    [key: string]: unknown;
-}
-/**
- * Transforms a GraphQL Page response to a Page Entity.
- *
- * @param {GraphQLPageResponse} graphQLPageResponse - The GraphQL Page response object.
- * @returns {object|null} The transformed Page Entity or null if the page is not present.
- *
- * @example
- * ```ts
- * const pageEntity = graphqlToPageEntity(graphQLPageResponse);
- * ```
- */
-export declare const graphqlToPageEntity: (graphQLPageResponse: GraphQLPageResponse) => any;
-export {};

package/src/lib/utils/page/common-utils.d.ts

@@ -1,33 +0,0 @@
-import { PageApiOptions } from '../../client/sdk-js-client';
-/**
- * Interface representing the properties for page request parameters.
- *
- * @export
- * @interface PageRequestParamsProps
- */
-export interface PageRequestParamsProps {
-    /**
-     * The API endpoint path.
-     * @type {string}
-     */
-    path: string;
-    /**
-     * The query parameters for the API request.
-     * Can be an object with key-value pairs or a URLSearchParams instance.
-     * @type {{ [key: string]: unknown } | URLSearchParams}
-     */
-    params: {
-        [key: string]: unknown;
-    } | URLSearchParams;
-}
-/**
- * Generates the page request parameters to be used in the API call.
- *
- * @param {PageRequestParamsProps} PageRequestParamsProps - The properties for the page request.
- * @returns {PageApiOptions} The options for the page API.
- * @example
- * ```ts
- * const pageApiOptions = getPageRequestParams({ path: '/api/v1/page', params: queryParams });
- * ```
- */
-export declare const getPageRequestParams: ({ path, params }: PageRequestParamsProps) => PageApiOptions;