@harbour-enterprises/superdoc 0.20.0-next.1 → 0.20.0-next.11

package/dist/super-editor/src/extensions/page-number/page-number.d.ts

@@ -1,4 +1,40 @@
+/**
+ * Configuration options for PageNumber
+ * @typedef {Object} PageNumberOptions
+ * @category Options
+ * @property {Object} [htmlAttributes] - HTML attributes for page number elements
+ */
+/**
+ * Attributes for page number nodes
+ * @typedef {Object} PageNumberAttributes
+ * @category Attributes
+ * @property {Array} [marksAsAttrs=null] @internal - Internal marks storage
+ */
+/**
+ * @module PageNumber
+ * @sidebarTitle Page Number
+ * @snippetPath /snippets/extensions/page-number.mdx
+ * @shortcut Mod-Shift-alt-p | addAutoPageNumber | Insert page number
+ */
 export const PageNumber: Node;
+/**
+ * Configuration options for TotalPageCount
+ * @typedef {Object} TotalPageCountOptions
+ * @category Options
+ * @property {Object} [htmlAttributes] - HTML attributes for total page count elements
+ */
+/**
+ * Attributes for total page count nodes
+ * @typedef {Object} TotalPageCountAttributes
+ * @category Attributes
+ * @property {Array} [marksAsAttrs=null] @internal - Internal marks storage
+ */
+/**
+ * @module TotalPageCount
+ * @sidebarTitle Total Page Count
+ * @snippetPath /snippets/extensions/total-page-count.mdx
+ * @shortcut Mod-Shift-alt-c | addTotalPageCount | Insert total page count
+ */
 export const TotalPageCount: Node;
 export class AutoPageNumberNodeView {
     constructor(node: any, getPos: any, decorations: any, editor: any, htmlAttributes?: {});
@@ -10,4 +46,20 @@ export class AutoPageNumberNodeView {
     update(node: any): boolean;
     #private;
 }
+/**
+ * Configuration options for PageNumber
+ */
+export type PageNumberOptions = any;
+/**
+ * Attributes for page number nodes
+ */
+export type PageNumberAttributes = any;
+/**
+ * Configuration options for TotalPageCount
+ */
+export type TotalPageCountOptions = any;
+/**
+ * Attributes for total page count nodes
+ */
+export type TotalPageCountAttributes = any;
 import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/paragraph/paragraph.d.ts

@@ -1,2 +1,51 @@
+/**
+ * Configuration options for Paragraph
+ * @typedef {Object} ParagraphOptions
+ * @category Options
+ * @property {number[]} [headingLevels=[1,2,3,4,5,6]] - Supported heading levels
+ * @property {Object} [htmlAttributes={}] - HTML attributes for paragraph elements
+ */
+/**
+ * Attributes for paragraph nodes
+ * @typedef {Object} ParagraphAttributes
+ * @category Attributes
+ * @property {Object} [spacing] - Paragraph spacing configuration
+ * @property {Object} [extraAttrs={}] - Additional HTML attributes
+ * @property {Array} [marksAttrs] - Text formatting marks
+ * @property {Object} [indent] - Indentation settings
+ * @property {Object} [borders] - Paragraph borders
+ * @property {string} [class] - CSS class name
+ * @property {string} [styleId] - Linked style identifier
+ * @property {Object} [justify] - Text justification
+ * @property {Array} [tabStops] - Tab stop positions
+ * @property {string} [sdBlockId] @internal - Internal block tracking ID
+ * @property {string} [paraId] @internal - Paragraph identifier
+ * @property {string} [textId] @internal - Text identifier
+ * @property {string} [rsidR] @internal - Revision save ID
+ * @property {string} [rsidRDefault] @internal - Default revision save ID
+ * @property {string} [rsidP] @internal - Paragraph revision save ID
+ * @property {string} [rsidRPr] @internal - Run properties revision save ID
+ * @property {string} [rsidDel] @internal - Deletion revision save ID
+ * @property {Object} [attributes] @internal - Internal attributes storage
+ * @property {string} [filename] @internal - Associated filename
+ * @property {boolean} [keepLines] @internal - Keep lines together
+ * @property {boolean} [keepNext] @internal - Keep with next paragraph
+ * @property {Object} [paragraphProperties] @internal - Internal paragraph properties
+ * @property {Object} [dropcap] @internal - Drop cap configuration
+ * @property {string} [pageBreakSource] @internal - Page break source
+ */
+/**
+ * @module Paragraph
+ * @sidebarTitle Paragraph
+ * @snippetPath /snippets/extensions/paragraph.mdx
+ */
 export const Paragraph: OxmlNode;
+/**
+ * Configuration options for Paragraph
+ */
+export type ParagraphOptions = any;
+/**
+ * Attributes for paragraph nodes
+ */
+export type ParagraphAttributes = any;
 import { OxmlNode } from '@core/index.js';

package/dist/super-editor/src/extensions/placeholder/placeholder.d.ts

@@ -1,2 +1,17 @@
+/**
+ * Configuration options for Placeholder
+ * @typedef {Object} PlaceholderOptions
+ * @category Options
+ * @property {string} [placeholder='Type something...'] - Placeholder text to display when editor is empty
+ */
+/**
+ * @module Placeholder
+ * @sidebarTitle Placeholder
+ * @snippetPath /snippets/extensions/placeholder.mdx
+ */
 export const Placeholder: Extension;
+/**
+ * Configuration options for Placeholder
+ */
+export type PlaceholderOptions = any;
 import { Extension } from '@core/Extension.js';

package/dist/super-editor/src/extensions/popover-plugin/popover-plugin.d.ts

@@ -1,2 +1,11 @@
+/**
+ * @module PopoverPlugin
+ * @sidebarTitle Popover Plugin
+ * @snippetPath /snippets/extensions/popover-plugin.mdx
+ */
 export const PopoverPlugin: Extension;
+/**
+ * Configuration options for PopoverPlugin
+ */
+export type PopoverPluginOptions = any;
 import { Extension } from '@core/Extension.js';

package/dist/super-editor/src/extensions/run-item/run-item.d.ts

@@ -1,2 +1,26 @@
+/**
+ * Configuration options for RunItem
+ * @typedef {Object} RunItemOptions
+ * @category Options
+ */
+/**
+ * Attributes for run nodes
+ * @typedef {Object} RunItemAttributes
+ * @category Attributes
+ * @property {Object} [attributes] @internal - Internal attributes storage
+ */
+/**
+ * @module RunItem
+ * @sidebarTitle Run Item
+ * @snippetPath /snippets/extensions/run-item.mdx
+ */
 export const RunItem: Node;
+/**
+ * Configuration options for RunItem
+ */
+export type RunItemOptions = any;
+/**
+ * Attributes for run nodes
+ */
+export type RunItemAttributes = any;
 import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/search/search.d.ts

@@ -1,11 +1,16 @@
 /**
- * Search match Object
+ * Search match object
  * @typedef {Object} SearchMatch
  * @property {string} text - Found text
  * @property {number} from - From position
  * @property {number} to - To position
  * @property {string} id - ID of the search match
  */
+/**
+ * Configuration options for Search
+ * @typedef {Object} SearchOptions
+ * @category Options
+ */
 /**
  * @module Search
  * @sidebarTitle Search
@@ -13,7 +18,7 @@
  */
 export const Search: Extension;
 /**
- * Search match Object
+ * Search match object
  */
 export type SearchMatch = {
     /**
@@ -33,4 +38,8 @@ export type SearchMatch = {
      */
     id: string;
 };
+/**
+ * Configuration options for Search
+ */
+export type SearchOptions = any;
 import { Extension } from '@core/Extension.js';

package/dist/super-editor/src/extensions/shape-container/shape-container.d.ts

@@ -1,2 +1,31 @@
+/**
+ * Configuration options for ShapeContainer
+ * @typedef {Object} ShapeContainerOptions
+ * @category Options
+ * @property {Object} [htmlAttributes] - HTML attributes for shape container elements
+ */
+/**
+ * Attributes for shape container nodes
+ * @typedef {Object} ShapeContainerAttributes
+ * @category Attributes
+ * @property {string} [fillcolor] - Background color for the shape
+ * @property {string} [style] - CSS style string
+ * @property {string} [sdBlockId] @internal - Internal block tracking ID
+ * @property {Object} [wrapAttributes] @internal - Internal wrapper attributes
+ * @property {Object} [attributes] @internal - Internal attributes storage
+ */
+/**
+ * @module ShapeContainer
+ * @sidebarTitle Shape Container
+ * @snippetPath /snippets/extensions/shape-container.mdx
+ */
 export const ShapeContainer: Node;
+/**
+ * Configuration options for ShapeContainer
+ */
+export type ShapeContainerOptions = any;
+/**
+ * Attributes for shape container nodes
+ */
+export type ShapeContainerAttributes = any;
 import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/shape-textbox/shape-textbox.d.ts

@@ -1,2 +1,28 @@
+/**
+ * Configuration options for ShapeTextbox
+ * @typedef {Object} ShapeTextboxOptions
+ * @category Options
+ * @property {Object} [htmlAttributes] - HTML attributes for shape textbox elements
+ */
+/**
+ * Attributes for shape textbox nodes
+ * @typedef {Object} ShapeTextboxAttributes
+ * @category Attributes
+ * @property {string} [sdBlockId] @internal - Internal block tracking ID
+ * @property {Object} [attributes] @internal - Internal attributes storage
+ */
+/**
+ * @module ShapeTextbox
+ * @sidebarTitle Shape Textbox
+ * @snippetPath /snippets/extensions/shape-textbox.mdx
+ */
 export const ShapeTextbox: Node;
+/**
+ * Configuration options for ShapeTextbox
+ */
+export type ShapeTextboxOptions = any;
+/**
+ * Attributes for shape textbox nodes
+ */
+export type ShapeTextboxAttributes = any;
 import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/slash-menu/slash-menu.d.ts

@@ -1,4 +1,13 @@
 export const SlashMenuPluginKey: PluginKey<any>;
+/**
+ * @module SlashMenu
+ * @sidebarTitle Slash Menu
+ * @snippetPath /snippets/extensions/slash-menu.mdx
+ */
 export const SlashMenu: Extension;
+/**
+ * Configuration options for SlashMenu
+ */
+export type SlashMenuOptions = any;
 import { PluginKey } from 'prosemirror-state';
 import { Extension } from '@core/Extension.js';

package/dist/super-editor/src/extensions/strike/strike.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Configuration options for Strike
+ * @typedef {Object} StrikeOptions
+ * @category Options
+ * @property {Object} [htmlAttributes={}] - HTML attributes for strikethrough elements
+ */
 /**
  * @module Strike
  * @sidebarTitle Strike
@@ -5,4 +11,8 @@
  * @shortcut Mod-Shift-s | toggleStrike | Toggle strikethrough formatting
  */
 export const Strike: Mark;
+/**
+ * Configuration options for Strike
+ */
+export type StrikeOptions = any;
 import { Mark } from '@core/index.js';

package/dist/super-editor/src/extensions/structured-content/StructuredContentBlockView.d.ts

@@ -0,0 +1,9 @@
+export class StructuredContentBlockView extends StructuredContentViewBase {
+    createElement(): {
+        element: HTMLDivElement;
+        contentElement: HTMLDivElement;
+    };
+    buildView(): void;
+    updateView(): void;
+}
+import { StructuredContentViewBase } from './StructuredContentViewBase';

package/dist/super-editor/src/extensions/structured-content/StructuredContentInlineView.d.ts

@@ -0,0 +1,9 @@
+export class StructuredContentInlineView extends StructuredContentViewBase {
+    createElement(): {
+        element: HTMLSpanElement;
+        contentElement: HTMLSpanElement;
+    };
+    buildView(): void;
+    updateView(): void;
+}
+import { StructuredContentViewBase } from './StructuredContentViewBase';

package/dist/super-editor/src/extensions/structured-content/StructuredContentViewBase.d.ts

@@ -0,0 +1,24 @@
+export class StructuredContentViewBase {
+    constructor(props: any);
+    node: any;
+    view: any;
+    getPos: any;
+    decorations: any;
+    innerDecorations: any;
+    editor: any;
+    extension: any;
+    htmlAttributes: any;
+    root: any;
+    isDragging: boolean;
+    mount(): void;
+    get dom(): any;
+    get contentDOM(): any;
+    update(node: any, decorations: any, innerDecorations: any): boolean;
+    stopEvent(event: any): boolean;
+    ignoreMutation(mutation: any): boolean;
+    destroy(): void;
+    updateAttributes(attrs: any): any;
+    updateHTMLAttributes(): void;
+    createDragHandle(): HTMLSpanElement;
+    onDragStart(event: any): void;
+}

package/dist/super-editor/src/extensions/structured-content/document-section.d.ts

@@ -1,3 +1,39 @@
+/**
+ * Document section creation options
+ * @typedef {Object} SectionCreate
+ * @property {number} [id] - Unique ID. Auto-increments from existing sections if omitted
+ * @property {string} [title="Document section"] - Label shown in section header
+ * @property {string} [description] - Metadata for tracking (stored in Word's w:tag)
+ * @property {string} [sectionType] - Business classification
+ * @property {boolean} [isLocked=false] - Prevent editing when true
+ * @property {string} [html] - HTML content to insert
+ * @property {Object} [json] - ProseMirror JSON (overrides html if both provided)
+ */
+/**
+ * Update an existing section
+ * @typedef {Object} SectionUpdate
+ * @property {number} id - Target section ID (required)
+ * @property {string} [html] - Replace content with HTML
+ * @property {Object} [json] - Replace content with ProseMirror JSON (overrides html)
+ * @property {Partial<DocumentSectionAttributes>} [attrs] - Update attributes only (preserves content)
+ */
+/**
+ * Configuration options for DocumentSection
+ * @typedef {Object} DocumentSectionOptions
+ * @category Options
+ * @property {Object} [htmlAttributes] - HTML attributes for document sections
+ */
+/**
+ * Attributes for document section nodes
+ * @typedef {Object} DocumentSectionAttributes
+ * @category Attributes
+ * @property {number} [id] - Unique section identifier
+ * @property {string} [title] - Section display label (becomes w:alias in Word)
+ * @property {string} [description] - Additional metadata stored in w:tag
+ * @property {string} [sectionType] - Business type for filtering/logic (e.g., 'legal', 'pricing')
+ * @property {boolean} [isLocked=false] - Lock state (maps to w:lock="sdtContentLocked")
+ * @property {string} [sdBlockId] @internal - Internal block tracking
+ */
 /**
  * @module DocumentSection
  * @sidebarTitle Document Section
@@ -5,32 +41,7 @@
  */
 export const DocumentSection: Node;
 /**
- * Document section attributes
- */
-export type SectionAttributes = {
-    /**
-     * - Unique section identifier
-     */
-    id?: number;
-    /**
-     * - Display label (becomes w:alias in Word)
-     */
-    title?: string;
-    /**
-     * - Additional metadata stored in w:tag
-     */
-    description?: string;
-    /**
-     * - Business type for filtering/logic (e.g., 'legal', 'pricing')
-     */
-    sectionType?: string;
-    /**
-     * - Lock state (maps to w:lock="sdtContentLocked")
-     */
-    isLocked?: boolean;
-};
-/**
- * Create a new document section
+ * Document section creation options
  */
 export type SectionCreate = {
     /**
@@ -81,6 +92,14 @@ export type SectionUpdate = {
     /**
      * - Update attributes only (preserves content)
      */
-    attrs?: Partial<SectionAttributes>;
+    attrs?: Partial<DocumentSectionAttributes>;
 };
+/**
+ * Configuration options for DocumentSection
+ */
+export type DocumentSectionOptions = any;
+/**
+ * Attributes for document section nodes
+ */
+export type DocumentSectionAttributes = any;
 import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/structured-content/structured-content-block.d.ts

@@ -1,2 +1,30 @@
+export const structuredContentClass: "sd-structured-content-block";
+export const structuredContentInnerClass: "sd-structured-content-block__content";
+/**
+ * Configuration options for StructuredContentBlock
+ * @typedef {Object} StructuredContentBlockOptions
+ * @category Options
+ * @property {string} [structuredContentClass='sd-structured-content-block-tag'] - CSS class for the block
+ * @property {Object} [htmlAttributes] - HTML attributes for structured content blocks
+ */
+/**
+ * Attributes for structured content block nodes
+ * @typedef {Object} StructuredContentBlockAttributes
+ * @category Attributes
+ * @property {Object} [sdtPr] @internal - Internal structured document tag properties
+ */
+/**
+ * @module StructuredContentBlock
+ * @sidebarTitle Structured Content Block
+ * @snippetPath /snippets/extensions/structured-content-block.mdx
+ */
 export const StructuredContentBlock: Node;
-import { Node } from '@core/index.js';
+/**
+ * Configuration options for StructuredContentBlock
+ */
+export type StructuredContentBlockOptions = any;
+/**
+ * Attributes for structured content block nodes
+ */
+export type StructuredContentBlockAttributes = any;
+import { Node } from '@core/index';

package/dist/super-editor/src/extensions/structured-content/structured-content.d.ts

@@ -1,2 +1,30 @@
+export const structuredContentClass: "sd-structured-content";
+export const structuredContentInnerClass: "sd-structured-content__content";
+/**
+ * Configuration options for StructuredContent
+ * @typedef {Object} StructuredContentOptions
+ * @category Options
+ * @property {string} [structuredContentClass='sd-structured-content-tag'] - CSS class for the inline element
+ * @property {Object} [htmlAttributes] - HTML attributes for structured content elements
+ */
+/**
+ * Attributes for structured content nodes
+ * @typedef {Object} StructuredContentAttributes
+ * @category Attributes
+ * @property {Object} [sdtPr] @internal - Internal structured document tag properties
+ */
+/**
+ * @module StructuredContent
+ * @sidebarTitle Structured Content
+ * @snippetPath /snippets/extensions/structured-content.mdx
+ */
 export const StructuredContent: Node;
-import { Node } from '@core/index.js';
+/**
+ * Configuration options for StructuredContent
+ */
+export type StructuredContentOptions = any;
+/**
+ * Attributes for structured content nodes
+ */
+export type StructuredContentAttributes = any;
+import { Node } from '@core/index';

package/dist/super-editor/src/extensions/tab/tab.d.ts

@@ -1,2 +1,27 @@
+/**
+ * Configuration options for TabNode
+ * @typedef {Object} TabNodeOptions
+ * @category Options
+ * @property {Object} [htmlAttributes] - HTML attributes for tab elements
+ */
+/**
+ * Attributes for tab nodes
+ * @typedef {Object} TabNodeAttributes
+ * @category Attributes
+ * @property {number} [tabSize] - Width of the tab in pixels
+ */
+/**
+ * @module TabNode
+ * @sidebarTitle Tab
+ * @snippetPath /snippets/extensions/tab.mdx
+ */
 export const TabNode: Node;
+/**
+ * Configuration options for TabNode
+ */
+export type TabNodeOptions = any;
+/**
+ * Attributes for tab nodes
+ */
+export type TabNodeAttributes = any;
 import { Node } from '@core/index.js';