@dotcms/client 0.0.1-beta.9 → 1.0.0

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

@@ -1,516 +0,0 @@
-export interface DotCMSPageAsset {
-    canCreateTemplate?: boolean;
-    containers: {
-        [key: string]: DotCMSPageAssetContainer;
-    };
-    layout: DotCMSLayout;
-    page: DotCMSPage;
-    site: DotCMSSite;
-    template: DotCMSTemplate;
-    viewAs?: DotCMSViewAs;
-    vanityUrl?: DotCMSVanityUrl;
-}
-export interface DotPageAssetLayoutRow {
-    identifier: number;
-    value?: string;
-    id?: string;
-    columns: DotPageAssetLayoutColumn[];
-    styleClass?: string;
-}
-export interface DotCMSVanityUrl {
-    pattern: string;
-    vanityUrlId: string;
-    url: string;
-    siteId: string;
-    languageId: number;
-    forwardTo: string;
-    response: number;
-    order: number;
-    temporaryRedirect: boolean;
-    permanentRedirect: boolean;
-    forward: boolean;
-}
-export interface DotPageAssetLayoutColumn {
-    preview: boolean;
-    containers: DotCMSColumnContainer[];
-    widthPercent: number;
-    width: number;
-    leftOffset: number;
-    left: number;
-    styleClass?: string;
-}
-export interface DotCMSColumnContainer {
-    identifier: string;
-    uuid: string;
-    historyUUIDs: string[];
-}
-export interface DotCMSPageAssetContainer {
-    container: DotCMSContainer;
-    containerStructures: DotCMSContainerStructure[];
-    contentlets: {
-        [key: string]: DotCMSContentlet[];
-    };
-}
-export interface DotCMSContainer {
-    identifier: string;
-    uuid: string;
-    iDate: number;
-    type: string;
-    owner?: string;
-    inode: string;
-    source: string;
-    title: string;
-    friendlyName: string;
-    modDate: number;
-    modUser: string;
-    sortOrder: number;
-    showOnMenu: boolean;
-    code?: string;
-    maxContentlets: number;
-    useDiv: boolean;
-    sortContentletsBy?: string;
-    preLoop: string;
-    postLoop: string;
-    staticify: boolean;
-    luceneQuery?: string;
-    notes: string;
-    languageId?: number;
-    path?: string;
-    live: boolean;
-    locked: boolean;
-    working: boolean;
-    deleted: boolean;
-    name: string;
-    archived: boolean;
-    permissionId: string;
-    versionId: string;
-    versionType: string;
-    permissionType: string;
-    categoryId: string;
-    idate: number;
-    new: boolean;
-    acceptTypes: string;
-    contentlets: DotCMSContentlet[];
-    parentPermissionable: DotCMSSiteParentPermissionable;
-}
-export interface DotCMSContentlet {
-    archived: boolean;
-    baseType: string;
-    deleted?: boolean;
-    binary?: string;
-    binaryContentAsset?: string;
-    binaryVersion?: string;
-    contentType: string;
-    file?: string;
-    folder: string;
-    hasLiveVersion?: boolean;
-    hasTitleImage: boolean;
-    host: string;
-    hostName: string;
-    identifier: string;
-    inode: string;
-    image?: any;
-    languageId: number;
-    language?: string;
-    live: boolean;
-    locked: boolean;
-    mimeType?: string;
-    modDate: string;
-    modUser: string;
-    modUserName: string;
-    owner: string;
-    sortOrder: number;
-    stInode: string;
-    title: string;
-    titleImage: string;
-    text?: string;
-    url: string;
-    working: boolean;
-    body?: string;
-    contentTypeIcon?: string;
-    variant?: string;
-    __icon__?: string;
-    [key: string]: any;
-}
-export interface DotcmsNavigationItem {
-    code?: any;
-    folder: string;
-    children?: DotcmsNavigationItem[];
-    host: string;
-    languageId: number;
-    href: string;
-    title: string;
-    type: string;
-    hash: number;
-    target: string;
-    order: number;
-}
-interface DotCMSTemplate {
-    iDate: number;
-    type: string;
-    owner: string;
-    inode: string;
-    identifier: string;
-    source: string;
-    title: string;
-    friendlyName: string;
-    modDate: number;
-    modUser: string;
-    sortOrder: number;
-    showOnMenu: boolean;
-    image: string;
-    drawed: boolean;
-    drawedBody: string;
-    theme: string;
-    anonymous: boolean;
-    template: boolean;
-    name: string;
-    live: boolean;
-    archived: boolean;
-    locked: boolean;
-    working: boolean;
-    permissionId: string;
-    versionId: string;
-    versionType: string;
-    deleted: boolean;
-    permissionType: string;
-    categoryId: string;
-    idate: number;
-    new: boolean;
-    canEdit: boolean;
-}
-interface DotCMSPage {
-    template: string;
-    modDate: number;
-    metadata: string;
-    cachettl: string;
-    pageURI: string;
-    title: string;
-    type: string;
-    showOnMenu: string;
-    httpsRequired: boolean;
-    inode: string;
-    disabledWYSIWYG: any[];
-    seokeywords: string;
-    host: string;
-    lastReview: number;
-    working: boolean;
-    locked: boolean;
-    stInode: string;
-    friendlyName: string;
-    live: boolean;
-    owner: string;
-    identifier: string;
-    nullProperties: any[];
-    friendlyname: string;
-    pagemetadata: string;
-    languageId: number;
-    url: string;
-    seodescription: string;
-    modUserName: string;
-    folder: string;
-    deleted: boolean;
-    sortOrder: number;
-    modUser: string;
-    pageUrl: string;
-    workingInode: string;
-    shortyWorking: string;
-    canEdit: boolean;
-    canRead: boolean;
-    canLock: boolean;
-    lockedOn: number;
-    lockedBy: string;
-    lockedByName: string;
-    liveInode: string;
-    shortyLive: string;
-}
-interface DotCMSViewAs {
-    language: {
-        id: number;
-        languageCode: string;
-        countryCode: string;
-        language: string;
-        country: string;
-    };
-    mode: string;
-}
-interface DotCMSLayout {
-    pageWidth: string;
-    width: string;
-    layout: string;
-    title: string;
-    header: boolean;
-    footer: boolean;
-    body: DotPageAssetLayoutBody;
-    sidebar: DotPageAssetLayoutSidebar;
-}
-interface DotCMSContainerStructure {
-    id: string;
-    structureId: string;
-    containerInode: string;
-    containerId: string;
-    code: string;
-    contentTypeVar: string;
-}
-interface DotPageAssetLayoutSidebar {
-    preview: boolean;
-    containers: DotCMSContainer[];
-    location: string;
-    widthPercent: number;
-    width: string;
-}
-interface DotPageAssetLayoutBody {
-    rows: DotPageAssetLayoutRow[];
-}
-interface DotCMSSite {
-    lowIndexPriority: boolean;
-    name: string;
-    default: boolean;
-    aliases: string;
-    parent: boolean;
-    tagStorage: string;
-    systemHost: boolean;
-    inode: string;
-    versionType: string;
-    structureInode: string;
-    hostname: string;
-    hostThumbnail?: any;
-    owner: string;
-    permissionId: string;
-    permissionType: string;
-    type: string;
-    identifier: string;
-    modDate: number;
-    host: string;
-    live: boolean;
-    indexPolicy: string;
-    categoryId: string;
-    actionId?: any;
-    new: boolean;
-    archived: boolean;
-    locked: boolean;
-    disabledWysiwyg: any[];
-    modUser: string;
-    working: boolean;
-    titleImage: {
-        present: boolean;
-    };
-    folder: string;
-    htmlpage: boolean;
-    fileAsset: boolean;
-    vanityUrl: boolean;
-    keyValue: boolean;
-    structure?: DotCMSSiteStructure;
-    title: string;
-    languageId: number;
-    indexPolicyDependencies: string;
-    contentTypeId: string;
-    versionId: string;
-    lastReview: number;
-    nextReview?: any;
-    reviewInterval?: any;
-    sortOrder: number;
-    contentType: DotCMSSiteContentType;
-}
-interface DotCMSSiteContentType {
-    owner?: any;
-    parentPermissionable: DotCMSSiteParentPermissionable;
-    permissionId: string;
-    permissionType: string;
-}
-export interface DotCMSSiteParentPermissionable {
-    Inode: string;
-    Identifier: string;
-    permissionByIdentifier: boolean;
-    type: string;
-    owner?: any;
-    identifier: string;
-    permissionId: string;
-    parentPermissionable?: any;
-    permissionType: string;
-    inode: string;
-    childrenPermissionable?: any;
-    variantId?: string;
-}
-interface DotCMSSiteStructure {
-    iDate: number;
-    type: string;
-    owner?: any;
-    inode: string;
-    identifier: string;
-    name: string;
-    description: string;
-    defaultStructure: boolean;
-    reviewInterval?: any;
-    reviewerRole?: any;
-    pagedetail?: any;
-    structureType: number;
-    fixed: boolean;
-    system: boolean;
-    velocityVarName: string;
-    urlMapPattern?: any;
-    host: string;
-    folder: string;
-    publishDateVar?: any;
-    expireDateVar?: any;
-    modDate: number;
-    fields: DotCMSSiteField[];
-    widget: boolean;
-    detailPage?: any;
-    fieldsBySortOrder: DotCMSSiteField[];
-    form: boolean;
-    htmlpageAsset: boolean;
-    content: boolean;
-    fileAsset: boolean;
-    persona: boolean;
-    permissionId: string;
-    permissionType: string;
-    live: boolean;
-    categoryId: string;
-    idate: number;
-    new: boolean;
-    archived: boolean;
-    locked: boolean;
-    modUser: string;
-    working: boolean;
-    title: string;
-    versionId: string;
-    versionType: string;
-}
-interface DotCMSSiteField {
-    iDate: number;
-    type: string;
-    owner?: any;
-    inode: string;
-    identifier: string;
-    structureInode: string;
-    fieldName: string;
-    fieldType: string;
-    fieldRelationType?: any;
-    fieldContentlet: string;
-    required: boolean;
-    velocityVarName: string;
-    sortOrder: number;
-    values?: any;
-    regexCheck?: any;
-    hint?: any;
-    defaultValue?: any;
-    indexed: boolean;
-    listed: boolean;
-    fixed: boolean;
-    readOnly: boolean;
-    searchable: boolean;
-    unique: boolean;
-    modDate: number;
-    dataType: string;
-    live: boolean;
-    categoryId: string;
-    idate: number;
-    new: boolean;
-    archived: boolean;
-    locked: boolean;
-    modUser: string;
-    working: boolean;
-    permissionId: string;
-    parentPermissionable?: any;
-    permissionType: string;
-    title: string;
-    versionId: string;
-    versionType: string;
-}
-/**
- * Represents a basic page structure returned from GraphQL queries
- */
-export interface DotCMSBasicGraphQLPage {
-    publishDate: string;
-    type: string;
-    httpsRequired: boolean;
-    inode: string;
-    path: string;
-    identifier: string;
-    hasTitleImage: boolean;
-    sortOrder: number;
-    extension: string;
-    canRead: boolean;
-    pageURI: string;
-    canEdit: boolean;
-    archived: boolean;
-    friendlyName: string;
-    workingInode: string;
-    url: string;
-    hasLiveVersion: boolean;
-    deleted: boolean;
-    pageUrl: string;
-    shortyWorking: string;
-    mimeType: string;
-    locked: boolean;
-    stInode: string;
-    contentType: string;
-    creationDate: string;
-    liveInode: string;
-    name: string;
-    shortyLive: string;
-    modDate: string;
-    title: string;
-    baseType: string;
-    working: boolean;
-    canLock: boolean;
-    live: boolean;
-    isContentlet: boolean;
-    statusIcons: string;
-    conLanguage: {
-        id: number;
-        language: string;
-        languageCode: string;
-    };
-    template: {
-        drawed: boolean;
-    };
-    containers: {
-        path?: string;
-        identifier: string;
-        maxContentlets?: number;
-        containerStructures?: {
-            contentTypeVar: string;
-        }[];
-        containerContentlets?: {
-            uuid: string;
-            contentlets: DotCMSContentlet[];
-        }[];
-    };
-    layout: DotCMSLayout;
-    viewAs: DotCMSViewAs;
-}
-export interface DotCMSPageGraphQLContainer {
-    path: string;
-    identifier: string;
-    maxContentlets?: number;
-    containerStructures: DotCMSContainerStructure[];
-    containerContentlets: DotCMSPageContainerContentlets[];
-}
-export interface DotCMSPageContainerContentlets {
-    uuid: string;
-    contentlets: DotCMSContentlet[];
-}
-export interface DotCMSGraphQLError {
-    message: string;
-    locations: {
-        line: number;
-        column: number;
-    }[];
-    extensions: {
-        classification: string;
-    };
-}
-/**
- * Represents the complete response from a GraphQL page query
- *
- * @template TContent - The type of the content data
- * @template TNav - The type of the navigation data
- */
-export interface DotCMSGraphQLPageResponse<TContent = Record<string, any>> {
-    page: DotCMSBasicGraphQLPage;
-    content?: TContent;
-    errors?: DotCMSGraphQLError;
-}
-export {};

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

@@ -1,45 +0,0 @@
-import { DotCMSPageEditorSubscription } from '../models/listeners.model';
-/**
- * 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/deprecated/editor/models/client.model.d.ts

@@ -1,111 +0,0 @@
-import { editContentlet, initInlineEditing, reorderMenu } from '../sdk-editor';
-declare global {
-    interface Window {
-        dotUVE: DotUVE;
-    }
-}
-export declare const INITIAL_DOT_UVE: DotUVE;
-/**
- * Actions send to the dotcms editor
- *
- * @export
- * @enum {number}
- */
-export declare enum CLIENT_ACTIONS {
-    /**
-     * Tell the dotcms editor that page change
-     */
-    NAVIGATION_UPDATE = "set-url",
-    /**
-     * Send the element position of the rows, columnsm containers and contentlets
-     */
-    SET_BOUNDS = "set-bounds",
-    /**
-     * Send the information of the hovered contentlet
-     */
-    SET_CONTENTLET = "set-contentlet",
-    /**
-     * Tell the editor that the page is being scrolled
-     */
-    IFRAME_SCROLL = "scroll",
-    /**
-     * Tell the editor that the page has stopped scrolling
-     */
-    IFRAME_SCROLL_END = "scroll-end",
-    /**
-     * Ping the editor to see if the page is inside the editor
-     */
-    PING_EDITOR = "ping-editor",
-    /**
-     * Tell the editor to init the inline editing editor.
-     */
-    INIT_INLINE_EDITING = "init-inline-editing",
-    /**
-     * Tell the editor to open the Copy-contentlet dialog
-     * To copy a content and then edit it inline.
-     */
-    COPY_CONTENTLET_INLINE_EDITING = "copy-contentlet-inline-editing",
-    /**
-     * Tell the editor to save inline edited contentlet
-     */
-    UPDATE_CONTENTLET_INLINE_EDITING = "update-contentlet-inline-editing",
-    /**
-     * Tell the editor to trigger a menu reorder
-     */
-    REORDER_MENU = "reorder-menu",
-    /**
-     * Tell the editor to send the page info to iframe
-     */
-    GET_PAGE_DATA = "get-page-data",
-    /**
-     * Tell the editor an user send a graphql query
-     */
-    CLIENT_READY = "client-ready",
-    /**
-     * Tell the editor to edit a contentlet
-     */
-    EDIT_CONTENTLET = "edit-contentlet",
-    /**
-     * Tell the editor to do nothing
-     */
-    NOOP = "noop"
-}
-/**
- * Post message props
- *
- * @export
- * @template T
- * @interface PostMessageProps
- */
-type PostMessageProps<T> = {
-    action: CLIENT_ACTIONS;
-    payload?: T;
-};
-/**
- * Post message to dotcms page editor
- *
- * @export
- * @template T
- * @param {PostMessageProps<T>} message
- */
-export declare function postMessageToEditor<T = unknown>(message: PostMessageProps<T>): void;
-export interface DotUVE {
-    editContentlet: typeof editContentlet;
-    initInlineEditing: typeof initInlineEditing;
-    reorderMenu: typeof reorderMenu;
-    lastScrollYPosition: number;
-}
-/**
- * Represents a listener for DotcmsClientListener.
- *
- * @typedef {Object} DotcmsClientListener
- * @property {string} action - The action that triggers the event.
- * @property {string} event - The name of the event.
- * @property {function(...args: any[]): void} callback - The callback function to handle the event.
- */
-export type DotcmsClientListener = {
-    action: string;
-    event: string;
-    callback: (...args: any[]) => void;
-};
-export {};