@dotcms/client
Version:
Official JavaScript library for interacting with DotCMS REST APIs.
68 lines (67 loc) • 1.84 kB
TypeScript
/**
* @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;
}
export declare enum UVE_MODE {
EDIT = "edit",
PREVIEW = "preview",
LIVE = "live"
}