@dotcms/types 0.0.1-beta.25

package/README.md

@@ -0,0 +1,29 @@
+# @dotcms/types
+
+## Overview
+
+This library contains shared TypeScript types and interfaces used across the dotCMS SDK libraries and the Universal Visual Editor. It serves as a central repository for type definitions to ensure consistency and type safety across the ecosystem.
+
+## Purpose
+
+- Establish a single source of truth for common types
+- Maintain consistency across SDK libraries
+- Support the Universal Visual Editor with necessary type definitions
+- Reduce duplication and prevent drift between related interfaces
+
+## Usage
+
+Import types directly from this library:
+
+```typescript
+import { Block, Contentlet } from '@dotcms/types';
+```
+
+## Universal Visual Editor
+
+Types in this library provide the foundation for the Universal Visual Editor, including:
+
+- Component definitions
+- Editor configuration schemas
+- Content type mappings
+- UI element specifications

package/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,126 @@
+'use strict';
+
+/**
+ * Development mode
+ *
+ * @internal
+ */
+const DEVELOPMENT_MODE = 'development';
+/**
+ * Production mode
+ *
+ * @internal
+ */
+const PRODUCTION_MODE = 'production';
+/**
+ * Possible modes of UVE (Universal Visual Editor)
+ * @enum {string}
+ *
+ * @property {string} LIVE - Shows published and future content
+ * @property {string} PREVIEW - Shows published and working content
+ * @property {string} EDIT - Enables content editing functionality in UVE
+ * @property {string} UNKNOWN - Error state, UVE should not remain in this mode
+ */
+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";
+})(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 = {}));
+
+exports.DEVELOPMENT_MODE = DEVELOPMENT_MODE;
+exports.PRODUCTION_MODE = PRODUCTION_MODE;

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.esm.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.esm.js

@@ -0,0 +1,123 @@
+/**
+ * Development mode
+ *
+ * @internal
+ */
+const DEVELOPMENT_MODE = 'development';
+/**
+ * Production mode
+ *
+ * @internal
+ */
+const PRODUCTION_MODE = 'production';
+/**
+ * Possible modes of UVE (Universal Visual Editor)
+ * @enum {string}
+ *
+ * @property {string} LIVE - Shows published and future content
+ * @property {string} PREVIEW - Shows published and working content
+ * @property {string} EDIT - Enables content editing functionality in UVE
+ * @property {string} UNKNOWN - Error state, UVE should not remain in this mode
+ */
+var UVE_MODE;
+(function (UVE_MODE) {
+  UVE_MODE["EDIT"] = "EDIT_MODE";
+  UVE_MODE["PREVIEW"] = "PREVIEW_MODE";
+  UVE_MODE["LIVE"] = "LIVE";
+  UVE_MODE["UNKNOWN"] = "UNKNOWN";
+})(UVE_MODE || (UVE_MODE = {}));
+/**
+ * Actions send to the dotcms editor
+ *
+ * @export
+ * @enum {number}
+ */
+var DotCMSUVEAction;
+(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";
+})(DotCMSUVEAction || (DotCMSUVEAction = {}));
+/**
+ * Available events in the Universal Visual Editor
+ * @enum {string}
+ */
+var UVEEventType;
+(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";
+})(UVEEventType || (UVEEventType = {}));
+
+export { DEVELOPMENT_MODE, DotCMSUVEAction, PRODUCTION_MODE, UVEEventType, UVE_MODE };

package/internal.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/internal";

package/internal.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./internal.cjs.js').default;

package/internal.cjs.js

@@ -0,0 +1,75 @@
+'use strict';
+
+/**
+ * Enum representing the different types of blocks available in the Block Editor
+ *
+ * @export
+ * @enum {string}
+ */
+exports.BlockEditorDefaultBlocks = void 0;
+(function (BlockEditorDefaultBlocks) {
+  /** Represents a paragraph block */
+  BlockEditorDefaultBlocks["PARAGRAPH"] = "paragraph";
+  /** Represents a heading block */
+  BlockEditorDefaultBlocks["HEADING"] = "heading";
+  /** Represents a text block */
+  BlockEditorDefaultBlocks["TEXT"] = "text";
+  /** Represents a bullet/unordered list block */
+  BlockEditorDefaultBlocks["BULLET_LIST"] = "bulletList";
+  /** Represents an ordered/numbered list block */
+  BlockEditorDefaultBlocks["ORDERED_LIST"] = "orderedList";
+  /** Represents a list item within a list block */
+  BlockEditorDefaultBlocks["LIST_ITEM"] = "listItem";
+  /** Represents a blockquote block */
+  BlockEditorDefaultBlocks["BLOCK_QUOTE"] = "blockquote";
+  /** Represents a code block */
+  BlockEditorDefaultBlocks["CODE_BLOCK"] = "codeBlock";
+  /** Represents a hard break (line break) */
+  BlockEditorDefaultBlocks["HARDBREAK"] = "hardBreak";
+  /** Represents a horizontal rule/divider */
+  BlockEditorDefaultBlocks["HORIZONTAL_RULE"] = "horizontalRule";
+  /** Represents a DotCMS image block */
+  BlockEditorDefaultBlocks["DOT_IMAGE"] = "dotImage";
+  /** Represents a DotCMS video block */
+  BlockEditorDefaultBlocks["DOT_VIDEO"] = "dotVideo";
+  /** Represents a table block */
+  BlockEditorDefaultBlocks["TABLE"] = "table";
+  /** Represents a DotCMS content block */
+  BlockEditorDefaultBlocks["DOT_CONTENT"] = "dotContent";
+})(exports.BlockEditorDefaultBlocks || (exports.BlockEditorDefaultBlocks = {}));
+
+/**
+ * Actions received from the dotcms editor
+ *
+ * @export
+ * @enum {number}
+ */
+exports.__DOTCMS_UVE_EVENT__ = void 0;
+(function (__DOTCMS_UVE_EVENT__) {
+  /**
+   * Request to page to reload
+   */
+  __DOTCMS_UVE_EVENT__["UVE_RELOAD_PAGE"] = "uve-reload-page";
+  /**
+   * Request the bounds for the elements
+   */
+  __DOTCMS_UVE_EVENT__["UVE_REQUEST_BOUNDS"] = "uve-request-bounds";
+  /**
+   * Received pong from the editor
+   */
+  __DOTCMS_UVE_EVENT__["UVE_EDITOR_PONG"] = "uve-editor-pong";
+  /**
+   * Received scroll event trigger from the editor
+   */
+  __DOTCMS_UVE_EVENT__["UVE_SCROLL_INSIDE_IFRAME"] = "uve-scroll-inside-iframe";
+  /**
+   * TODO:
+   * Set the page data - This is used to catch the "changes" event.
+   * We must to re-check the name late.
+   */
+  __DOTCMS_UVE_EVENT__["UVE_SET_PAGE_DATA"] = "uve-set-page-data";
+  /**
+   * Copy contentlet inline editing success
+   */
+  __DOTCMS_UVE_EVENT__["UVE_COPY_CONTENTLET_INLINE_EDITING_SUCCESS"] = "uve-copy-contentlet-inline-editing-success";
+})(exports.__DOTCMS_UVE_EVENT__ || (exports.__DOTCMS_UVE_EVENT__ = {}));

package/internal.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './internal.cjs.js';
+export { _default as default } from './internal.cjs.default.js';

package/internal.esm.d.ts

@@ -0,0 +1 @@
+export * from "./src/internal";

package/internal.esm.js

@@ -0,0 +1,75 @@
+/**
+ * Enum representing the different types of blocks available in the Block Editor
+ *
+ * @export
+ * @enum {string}
+ */
+var BlockEditorDefaultBlocks;
+(function (BlockEditorDefaultBlocks) {
+  /** Represents a paragraph block */
+  BlockEditorDefaultBlocks["PARAGRAPH"] = "paragraph";
+  /** Represents a heading block */
+  BlockEditorDefaultBlocks["HEADING"] = "heading";
+  /** Represents a text block */
+  BlockEditorDefaultBlocks["TEXT"] = "text";
+  /** Represents a bullet/unordered list block */
+  BlockEditorDefaultBlocks["BULLET_LIST"] = "bulletList";
+  /** Represents an ordered/numbered list block */
+  BlockEditorDefaultBlocks["ORDERED_LIST"] = "orderedList";
+  /** Represents a list item within a list block */
+  BlockEditorDefaultBlocks["LIST_ITEM"] = "listItem";
+  /** Represents a blockquote block */
+  BlockEditorDefaultBlocks["BLOCK_QUOTE"] = "blockquote";
+  /** Represents a code block */
+  BlockEditorDefaultBlocks["CODE_BLOCK"] = "codeBlock";
+  /** Represents a hard break (line break) */
+  BlockEditorDefaultBlocks["HARDBREAK"] = "hardBreak";
+  /** Represents a horizontal rule/divider */
+  BlockEditorDefaultBlocks["HORIZONTAL_RULE"] = "horizontalRule";
+  /** Represents a DotCMS image block */
+  BlockEditorDefaultBlocks["DOT_IMAGE"] = "dotImage";
+  /** Represents a DotCMS video block */
+  BlockEditorDefaultBlocks["DOT_VIDEO"] = "dotVideo";
+  /** Represents a table block */
+  BlockEditorDefaultBlocks["TABLE"] = "table";
+  /** Represents a DotCMS content block */
+  BlockEditorDefaultBlocks["DOT_CONTENT"] = "dotContent";
+})(BlockEditorDefaultBlocks || (BlockEditorDefaultBlocks = {}));
+
+/**
+ * Actions received from the dotcms editor
+ *
+ * @export
+ * @enum {number}
+ */
+var __DOTCMS_UVE_EVENT__;
+(function (__DOTCMS_UVE_EVENT__) {
+  /**
+   * Request to page to reload
+   */
+  __DOTCMS_UVE_EVENT__["UVE_RELOAD_PAGE"] = "uve-reload-page";
+  /**
+   * Request the bounds for the elements
+   */
+  __DOTCMS_UVE_EVENT__["UVE_REQUEST_BOUNDS"] = "uve-request-bounds";
+  /**
+   * Received pong from the editor
+   */
+  __DOTCMS_UVE_EVENT__["UVE_EDITOR_PONG"] = "uve-editor-pong";
+  /**
+   * Received scroll event trigger from the editor
+   */
+  __DOTCMS_UVE_EVENT__["UVE_SCROLL_INSIDE_IFRAME"] = "uve-scroll-inside-iframe";
+  /**
+   * TODO:
+   * Set the page data - This is used to catch the "changes" event.
+   * We must to re-check the name late.
+   */
+  __DOTCMS_UVE_EVENT__["UVE_SET_PAGE_DATA"] = "uve-set-page-data";
+  /**
+   * Copy contentlet inline editing success
+   */
+  __DOTCMS_UVE_EVENT__["UVE_COPY_CONTENTLET_INLINE_EDITING_SUCCESS"] = "uve-copy-contentlet-inline-editing-success";
+})(__DOTCMS_UVE_EVENT__ || (__DOTCMS_UVE_EVENT__ = {}));
+
+export { BlockEditorDefaultBlocks, __DOTCMS_UVE_EVENT__ };

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@dotcms/types",
+  "version": "0.0.1-beta.25",
+  "keywords": [
+    "dotCMS",
+    "CMS",
+    "Content Management",
+    "UVE",
+    "Universal Visual Editor"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "module": "./index.esm.js",
+      "types": "./index.esm.d.ts",
+      "import": "./index.cjs.mjs",
+      "default": "./index.cjs.js"
+    },
+    "./internal": {
+      "module": "./internal.esm.js",
+      "types": "./internal.esm.d.ts",
+      "import": "./internal.cjs.mjs",
+      "default": "./internal.cjs.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./src/index.d.ts"
+      ],
+      "internal": [
+        "./src/internal.d.ts"
+      ]
+    }
+  },
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js",
+  "types": "./index.esm.d.ts"
+}

package/src/index.d.ts

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

package/src/internal.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/components/block-editor-renderer/internal';
+export * from './lib/events/internal';
+export * from './lib/editor/internal';

package/src/lib/components/block-editor-renderer/internal.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Enum representing the different types of blocks available in the Block Editor
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum BlockEditorDefaultBlocks {
+    /** Represents a paragraph block */
+    PARAGRAPH = "paragraph",
+    /** Represents a heading block */
+    HEADING = "heading",
+    /** Represents a text block */
+    TEXT = "text",
+    /** Represents a bullet/unordered list block */
+    BULLET_LIST = "bulletList",
+    /** Represents an ordered/numbered list block */
+    ORDERED_LIST = "orderedList",
+    /** Represents a list item within a list block */
+    LIST_ITEM = "listItem",
+    /** Represents a blockquote block */
+    BLOCK_QUOTE = "blockquote",
+    /** Represents a code block */
+    CODE_BLOCK = "codeBlock",
+    /** Represents a hard break (line break) */
+    HARDBREAK = "hardBreak",
+    /** Represents a horizontal rule/divider */
+    HORIZONTAL_RULE = "horizontalRule",
+    /** Represents a DotCMS image block */
+    DOT_IMAGE = "dotImage",
+    /** Represents a DotCMS video block */
+    DOT_VIDEO = "dotVideo",
+    /** Represents a table block */
+    TABLE = "table",
+    /** Represents a DotCMS content block */
+    DOT_CONTENT = "dotContent"
+}
+/**
+ * Represents the validation state of a Block Editor instance
+ *
+ * @interface BlockEditorState
+ * @property {boolean} isValid - Whether the blocks structure is valid
+ * @property {string | null} error - Error message if blocks are invalid, null otherwise
+ */
+export interface BlockEditorState {
+    error: string | null;
+}

package/src/lib/components/block-editor-renderer/public.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Represents a Mark used by text content in the Block Editor
+ *
+ * @export
+ * @interface Mark
+ */
+export interface BlockEditorMark {
+    type: string;
+    attrs: Record<string, string>;
+}
+/**
+ * Represents a Content Node used by the Block Editor
+ *
+ * @export
+ * @interface BlockEditorNode
+ */
+export interface BlockEditorNode {
+    /** The type of content node */
+    type: string;
+    /** Child content nodes */
+    content?: BlockEditorNode[];
+    /** Optional attributes for the node */
+    attrs?: Record<string, any>;
+    /** Optional marks applied to text content */
+    marks?: BlockEditorMark[];
+    /** Optional text content */
+    text?: string;
+}
+/**
+ * Represents a Block in the Block Editor
+ *
+ * @export
+ * @interface BlockEditorContent
+ */
+export interface BlockEditorContent {
+    content?: BlockEditorNode[];
+    type: string;
+}