@dotcms/uve 0.0.1-beta.15 → 0.0.1-beta.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/uve",
-  "version": "0.0.1-beta.15",
+  "version": "0.0.1-beta.16",
   "description": "Official JavaScript library for interacting with Universal Visual Editor (UVE)",
   "repository": {
     "type": "git",

package/src/internal.d.ts

@@ -2,3 +2,5 @@ export * from './internal/index';
 export * from './lib/types/editor/internal';
 export * from './lib/types/events/internal';
 export * from './lib/dom/dom.utils';
+export * from './lib/editor/internal';
+export * from './lib/types/block-editor-renderer/internal';

package/src/lib/editor/internal.d.ts

@@ -1,4 +1,5 @@
-import { DotCMSContainerBound } from '@dotcms/uve/internal';
+import { BlockEditorState, DotCMSContainerBound } from '@dotcms/uve/internal';
+import { Block } from '@dotcms/uve/types';
 /**
  * Sets the bounds of the containers in the editor.
  * Retrieves the containers from the DOM and sends their position data to the editor.
@@ -6,3 +7,17 @@ import { DotCMSContainerBound } from '@dotcms/uve/internal';
  * @memberof DotCMSPageEditor
  */
 export declare function setBounds(bounds: DotCMSContainerBound[]): void;
+/**
+ * Validates the structure of a Block Editor block.
+ *
+ * This function checks that:
+ * 1. The blocks parameter is a valid object
+ * 2. The block has a 'doc' type
+ * 3. The block has a valid content array that is not empty
+ *
+ * @param {Block} blocks - The blocks structure to validate
+ * @returns {BlockEditorState} Object containing validation state and any error message
+ * @property {boolean} BlockEditorState.isValid - Whether the blocks structure is valid
+ * @property {string | null} BlockEditorState.error - Error message if invalid, null if valid
+ */
+export declare const isValidBlocks: (blocks: Block) => BlockEditorState;

package/src/lib/types/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 Blocks {
+    /** 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/types/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 Mark {
+    type: string;
+    attrs: Record<string, string>;
+}
+/**
+ * Represents a Content Node used by the Block Editor
+ *
+ * @export
+ * @interface ContentNode
+ */
+export interface ContentNode {
+    /** The type of content node */
+    type: string;
+    /** Child content nodes */
+    content?: ContentNode[];
+    /** Optional attributes for the node */
+    attrs?: Record<string, any>;
+    /** Optional marks applied to text content */
+    marks?: Mark[];
+    /** Optional text content */
+    text?: string;
+}
+/**
+ * Represents a Block in the Block Editor
+ *
+ * @export
+ * @interface Block
+ */
+export interface Block {
+    content?: ContentNode[];
+    type: string;
+}

package/src/types.d.ts

@@ -1,3 +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';