@dotcms/uve 0.0.1-beta.2 → 0.0.1-beta.21

package/src/lib/types/page/public.d.ts

@@ -0,0 +1,485 @@
+export interface DotCMSPageAsset {
+    canCreateTemplate?: boolean;
+    containers: {
+        [key: string]: DotCMSPageAssetContainer;
+    };
+    layout: DotCMSLayout;
+    page: DotCMSPage;
+    site: DotCMSSite;
+    template: DotCMSTemplate;
+    viewAs?: DotCMSViewAs;
+    vanityUrl?: DotCMSVanityUrl;
+    params?: Record<string, unknown>;
+}
+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 {};

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

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

package/src/script/utils.d.ts

@@ -0,0 +1,53 @@
+import { DotCMSUVEConfig } from '../lib/types/editor/public';
+/**
+ * Sets up scroll event handlers for the window to notify the editor about scroll events.
+ * Adds listeners for both 'scroll' and 'scrollend' events, sending appropriate messages
+ * to the editor when these events occur.
+ */
+export declare function scrollHandler(): {
+    destroyScrollHandler: () => void;
+};
+/**
+ * Adds 'empty-contentlet' class to contentlet elements that have no height.
+ * This helps identify and style empty contentlets in the editor view.
+ *
+ * @remarks
+ * The function queries all elements with data-dot-object="contentlet" attribute
+ * and checks their clientHeight. If an element has no height (clientHeight = 0),
+ * it adds the 'empty-contentlet' class to that element.
+ */
+export declare function addClassToEmptyContentlets(): void;
+/**
+ * Registers event handlers for various UVE (Universal Visual Editor) events.
+ *
+ * This function sets up subscriptions for:
+ * - Page reload events that refresh the window
+ * - Bounds request events to update editor boundaries
+ * - Iframe scroll events to handle smooth scrolling within bounds
+ * - Contentlet hover events to notify the editor
+ *
+ * @remarks
+ * For scroll events, the function includes logic to prevent scrolling beyond
+ * the top or bottom boundaries of the iframe, which helps maintain proper
+ * scroll event handling.
+ */
+export declare function registerUVEEvents(): {
+    subscriptions: import("../lib/types/editor/public").UVEEventSubscription[];
+};
+/**
+ * Notifies the editor that the UVE client is ready to receive messages.
+ *
+ * This function sends a message to the editor indicating that the client-side
+ * initialization is complete and it's ready to handle editor interactions.
+ *
+ * @remarks
+ * This is typically called after all UVE event handlers and DOM listeners
+ * have been set up successfully.
+ */
+export declare function setClientIsReady(config?: DotCMSUVEConfig): void;
+/**
+ * Listen for block editor inline event.
+ */
+export declare function listenBlockEditorInlineEvent(): {
+    destroyListenBlockEditorInlineEvent: () => void;
+};

package/src/types.d.ts

@@ -0,0 +1,4 @@
+export * from './lib/types/editor/public';
+export * from './lib/types/events/public';
+export * from './lib/types/block-editor-renderer/public';
+export * from './lib/types/page/public';

package/types.cjs.d.ts

@@ -1 +1 @@
-export * from "./src/public/types";
+export * from "./src/types";

package/types.cjs.js

@@ -11,8 +11,101 @@
  */
 exports.UVE_MODE = void 0;
 (function (UVE_MODE) {
-    UVE_MODE["EDIT"] = "EDIT_MODE";
-    UVE_MODE["PREVIEW"] = "PREVIEW_MODE";
-    UVE_MODE["LIVE"] = "LIVE";
-    UVE_MODE["UNKNOWN"] = "UNKNOWN";
+  UVE_MODE["EDIT"] = "EDIT_MODE";
+  UVE_MODE["PREVIEW"] = "PREVIEW_MODE";
+  UVE_MODE["LIVE"] = "LIVE";
+  UVE_MODE["UNKNOWN"] = "UNKNOWN";
 })(exports.UVE_MODE || (exports.UVE_MODE = {}));
+/**
+ * Actions send to the dotcms editor
+ *
+ * @export
+ * @enum {number}
+ */
+exports.DotCMSUVEAction = void 0;
+(function (DotCMSUVEAction) {
+  /**
+   * Tell the dotcms editor that page change
+   */
+  DotCMSUVEAction["NAVIGATION_UPDATE"] = "set-url";
+  /**
+   * Send the element position of the rows, columnsm containers and contentlets
+   */
+  DotCMSUVEAction["SET_BOUNDS"] = "set-bounds";
+  /**
+   * Send the information of the hovered contentlet
+   */
+  DotCMSUVEAction["SET_CONTENTLET"] = "set-contentlet";
+  /**
+   * Tell the editor that the page is being scrolled
+   */
+  DotCMSUVEAction["IFRAME_SCROLL"] = "scroll";
+  /**
+   * Tell the editor that the page has stopped scrolling
+   */
+  DotCMSUVEAction["IFRAME_SCROLL_END"] = "scroll-end";
+  /**
+   * Ping the editor to see if the page is inside the editor
+   */
+  DotCMSUVEAction["PING_EDITOR"] = "ping-editor";
+  /**
+   * Tell the editor to init the inline editing editor.
+   */
+  DotCMSUVEAction["INIT_INLINE_EDITING"] = "init-inline-editing";
+  /**
+   * Tell the editor to open the Copy-contentlet dialog
+   * To copy a content and then edit it inline.
+   */
+  DotCMSUVEAction["COPY_CONTENTLET_INLINE_EDITING"] = "copy-contentlet-inline-editing";
+  /**
+   * Tell the editor to save inline edited contentlet
+   */
+  DotCMSUVEAction["UPDATE_CONTENTLET_INLINE_EDITING"] = "update-contentlet-inline-editing";
+  /**
+   * Tell the editor to trigger a menu reorder
+   */
+  DotCMSUVEAction["REORDER_MENU"] = "reorder-menu";
+  /**
+   * Tell the editor to send the page info to iframe
+   */
+  DotCMSUVEAction["GET_PAGE_DATA"] = "get-page-data";
+  /**
+   * Tell the editor an user send a graphql query
+   */
+  DotCMSUVEAction["CLIENT_READY"] = "client-ready";
+  /**
+   * Tell the editor to edit a contentlet
+   */
+  DotCMSUVEAction["EDIT_CONTENTLET"] = "edit-contentlet";
+  /**
+   * Tell the editor to do nothing
+   */
+  DotCMSUVEAction["NOOP"] = "noop";
+})(exports.DotCMSUVEAction || (exports.DotCMSUVEAction = {}));
+/**
+ * Available events in the Universal Visual Editor
+ * @enum {string}
+ */
+exports.UVEEventType = void 0;
+(function (UVEEventType) {
+  /**
+   * Triggered when page data changes from the editor
+   */
+  UVEEventType["CONTENT_CHANGES"] = "changes";
+  /**
+   * Triggered when the page needs to be reloaded
+   */
+  UVEEventType["PAGE_RELOAD"] = "page-reload";
+  /**
+   * Triggered when the editor requests container bounds
+   */
+  UVEEventType["REQUEST_BOUNDS"] = "request-bounds";
+  /**
+   * Triggered when scroll action is needed inside the iframe
+   */
+  UVEEventType["IFRAME_SCROLL"] = "iframe-scroll";
+  /**
+   * Triggered when a contentlet is hovered
+   */
+  UVEEventType["CONTENTLET_HOVERED"] = "contentlet-hovered";
+})(exports.UVEEventType || (exports.UVEEventType = {}));

package/types.esm.d.ts

@@ -1 +1 @@
-export * from "./src/public/types";
+export * from "./src/types";