@harbour-enterprises/superdoc 0.20.0-next.8 → 0.20.0-next.9

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,4 +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;
+/**
+ * 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,4 +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;
+/**
+ * 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';

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

@@ -1,140 +1,63 @@
-/**
- * @module Table
- * @sidebarTitle Table
- * @snippetPath /snippets/extensions/table.mdx
- * @shortcut Tab | goToNextCell/addRowAfter | Navigate to next cell or add row
- * @shortcut Shift-Tab | goToPreviousCell | Navigate to previous cell
- * @shortcut Backspace | deleteTableWhenSelected | Delete table when all cells selected
- * @shortcut Delete | deleteTableWhenSelected | Delete table when all cells selected
- */
-export const Table: Node;
 /**
  * Table configuration options
+ * @typedef {Object} TableConfig
+ * @property {number} [rows=3] - Number of rows to create
+ * @property {number} [cols=3] - Number of columns to create
+ * @property {boolean} [withHeaderRow=false] - Create first row as header row
  */
-export type TableConfig = {
-    /**
-     * - Number of rows to create
-     */
-    rows?: number;
-    /**
-     * - Number of columns to create
-     */
-    cols?: number;
-    /**
-     * - Create first row as header row
-     */
-    withHeaderRow?: boolean;
-};
 /**
  * Table indentation configuration
+ * @typedef {Object} TableIndent
+ * @property {number} width - Indent width in pixels
+ * @property {string} [type='dxa'] - Indent type
  */
-export type TableIndent = {
-    /**
-     * - Indent width in pixels
-     */
-    width: number;
-    /**
-     * - Indent type
-     */
-    type?: string;
-};
-/**
- * Table attributes
- */
-export type TableAttributes = {
-    /**
-     * - Table indentation
-     */
-    tableIndent?: TableIndent;
-    /**
-     * - Table border configuration
-     */
-    borders?: import("./tableHelpers/createTableBorders.js").TableBorders;
-    /**
-     * - CSS border-collapse value
-     */
-    borderCollapse?: string;
-    /**
-     * - Reference to table style ID
-     */
-    tableStyleId?: string;
-    /**
-     * - Table layout algorithm
-     */
-    tableLayout?: string;
-    /**
-     * - Cell spacing in pixels
-     */
-    tableCellSpacing?: number;
-};
 /**
  * Cell selection position
+ * @typedef {Object} CellSelectionPosition
+ * @property {number} anchorCell - Starting cell position
+ * @property {number} headCell - Ending cell position
  */
-export type CellSelectionPosition = {
-    /**
-     * - Starting cell position
-     */
-    anchorCell: number;
-    /**
-     * - Ending cell position
-     */
-    headCell: number;
-};
 /**
- * Column group information
+ * Configuration options for Table
+ * @typedef {Object} TableOptions
+ * @category Options
+ * @property {Object} [htmlAttributes={'aria-label': 'Table node'}] - Default HTML attributes for all tables
+ * @property {boolean} [resizable=true] - Enable column resizing functionality
+ * @property {number} [handleWidth=5] - Width of resize handles in pixels
+ * @property {number} [cellMinWidth=10] - Minimum cell width constraint in pixels
+ * @property {boolean} [lastColumnResizable=true] - Allow resizing of the last column
+ * @property {boolean} [allowTableNodeSelection=false] - Enable selecting the entire table node
  */
-export type ColGroupInfo = {
-    /**
-     * - Column group DOM structure
-     */
-    colgroup?: any[];
-    /**
-     * - Fixed table width or empty string
-     */
-    tableWidth?: string;
-    /**
-     * - Minimum table width or empty string
-     */
-    tableMinWidth?: string;
-    /**
-     * - Array of column width values
-     */
-    colgroupValues?: number[];
-};
 /**
- * Position resolution result
+ * Attributes for table nodes
+ * @typedef {Object} TableAttributes
+ * @category Attributes
+ * @property {TableIndent} [tableIndent] - Table indentation configuration
+ * @property {import("./tableHelpers/createTableBorders.js").TableBorders} [borders] - Border styling for this table
+ * @property {string} [borderCollapse='collapse'] - CSS border-collapse property
+ * @property {string} [justification] - Table alignment ('left', 'center', 'right')
+ * @property {number} [tableCellSpacing] - Cell spacing in pixels for this table
+ * @property {string} [sdBlockId] @internal - Internal block tracking ID
+ * @property {string} [tableStyleId] @internal - Internal reference to table style
+ * @property {string} [tableLayout] @internal - CSS table-layout property (advanced usage)
  */
-export type CellPosition = {
-    /**
-     * - Resolved position
-     */
-    $pos: any;
-    /**
-     * - Absolute position
-     */
-    pos: number;
-    /**
-     * - Depth in document tree
-     */
-    depth: number;
-};
 /**
  * Current cell information
+ * @typedef {Object} CurrentCellInfo
+ * @property {Object} rect - Selected rectangle information
+ * @property {import('prosemirror-model').Node} cell - The cell node
+ * @property {Object} attrs - Cell attributes
  */
-export type CurrentCellInfo = {
-    /**
-     * - Selected rectangle from ProseMirror
-     */
-    rect: any;
-    /**
-     * - Current cell node
-     */
-    cell: any;
-    /**
-     * - Cell attributes without span properties
-     */
-    attrs: any;
-};
+/**
+ * @module Table
+ * @sidebarTitle Table
+ * @snippetPath /snippets/extensions/table.mdx
+ * @shortcut Tab | goToNextCell/addRowAfter | Navigate to next cell or add row
+ * @shortcut Shift-Tab | goToPreviousCell | Navigate to previous cell
+ * @shortcut Backspace | deleteTableWhenSelected | Delete table when all cells selected
+ * @shortcut Delete | deleteTableWhenSelected | Delete table when all cells selected
+ */
+export const Table: Node;
 /**
  * Theme color options
  */
@@ -465,4 +388,72 @@ export type TableGrid = {
      */
     colWidths?: ColWidth[];
 };
+/**
+ * Table configuration options
+ */
+export type TableConfig = {
+    /**
+     * - Number of rows to create
+     */
+    rows?: number;
+    /**
+     * - Number of columns to create
+     */
+    cols?: number;
+    /**
+     * - Create first row as header row
+     */
+    withHeaderRow?: boolean;
+};
+/**
+ * Table indentation configuration
+ */
+export type TableIndent = {
+    /**
+     * - Indent width in pixels
+     */
+    width: number;
+    /**
+     * - Indent type
+     */
+    type?: string;
+};
+/**
+ * Cell selection position
+ */
+export type CellSelectionPosition = {
+    /**
+     * - Starting cell position
+     */
+    anchorCell: number;
+    /**
+     * - Ending cell position
+     */
+    headCell: number;
+};
+/**
+ * Configuration options for Table
+ */
+export type TableOptions = any;
+/**
+ * Attributes for table nodes
+ */
+export type TableAttributes = any;
+/**
+ * Current cell information
+ */
+export type CurrentCellInfo = {
+    /**
+     * - Selected rectangle information
+     */
+    rect: any;
+    /**
+     * - The cell node
+     */
+    cell: import("prosemirror-model").Node;
+    /**
+     * - Cell attributes
+     */
+    attrs: any;
+};
 import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/table-cell/table-cell.d.ts

@@ -1,3 +1,36 @@
+/**
+ * Cell margins configuration
+ * @typedef {Object} CellMargins
+ * @property {number} [top] - Top margin in pixels
+ * @property {number} [right] - Right margin in pixels
+ * @property {number} [bottom] - Bottom margin in pixels
+ * @property {number} [left] - Left margin in pixels
+ */
+/**
+ * Cell background configuration
+ * @typedef {Object} CellBackground
+ * @property {string} color - Background color (hex without #)
+ */
+/**
+ * Configuration options for TableCell
+ * @typedef {Object} TableCellOptions
+ * @category Options
+ * @property {Object} [htmlAttributes={'aria-label': 'Table cell node'}] - HTML attributes for table cells
+ */
+/**
+ * Attributes for table cell nodes
+ * @typedef {Object} TableCellAttributes
+ * @category Attributes
+ * @property {number} [colspan=1] - Number of columns this cell spans
+ * @property {number} [rowspan=1] - Number of rows this cell spans
+ * @property {number[]} [colwidth=[100]] - Column widths array in pixels
+ * @property {CellBackground} [background] - Cell background color configuration
+ * @property {string} [verticalAlign] - Vertical content alignment (top, middle, bottom)
+ * @property {CellMargins} [cellMargins] - Internal cell padding
+ * @property {import('./helpers/createCellBorders.js').CellBorders} [borders] - Cell border configuration
+ * @property {string} [widthType='auto'] @internal - Internal width type
+ * @property {string} [widthUnit='px'] @internal - Internal width unit
+ */
 /**
  * @module TableCell
  * @sidebarTitle Table Cell
@@ -34,4 +67,12 @@ export type CellBackground = {
      */
     color: string;
 };
+/**
+ * Configuration options for TableCell
+ */
+export type TableCellOptions = any;
+/**
+ * Attributes for table cell nodes
+ */
+export type TableCellAttributes = any;
 import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/table-header/table-header.d.ts

@@ -1,7 +1,29 @@
+/**
+ * Configuration options for TableHeader
+ * @typedef {Object} TableHeaderOptions
+ * @category Options
+ * @property {Object} [htmlAttributes={'aria-label': 'Table head node'}] - HTML attributes for table headers
+ */
+/**
+ * Attributes for table header nodes
+ * @typedef {Object} TableHeaderAttributes
+ * @category Attributes
+ * @property {number} [colspan=1] - Number of columns this header spans
+ * @property {number} [rowspan=1] - Number of rows this header spans
+ * @property {number[]} [colwidth] - Column widths array in pixels
+ */
 /**
  * @module TableHeader
  * @sidebarTitle Table Header
  * @snippetPath /snippets/extensions/table-header.mdx
  */
 export const TableHeader: Node;
+/**
+ * Configuration options for TableHeader
+ */
+export type TableHeaderOptions = any;
+/**
+ * Attributes for table header nodes
+ */
+export type TableHeaderAttributes = any;
 import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/table-row/table-row.d.ts

@@ -36,6 +36,26 @@
  * @property {number} [wBefore.value] - The width in twenieths of a point (1/1440 of an inch).
  * @property {"auto" | "dxa" | "nil" | "pct"} [wBefore.type] - The type of width.
  */
+/**
+ * Configuration options for TableRow
+ * @typedef {Object} TableRowOptions
+ * @category Options
+ * @property {Object} [htmlAttributes={'aria-label': 'Table row node'}] - HTML attributes for table rows
+ */
+/**
+ * Attributes for table row nodes
+ * @typedef {Object} TableRowAttributes
+ * @category Attributes
+ * @property {number} [rowHeight] - Fixed row height in pixels
+ * @property {boolean} [cantSplit=false] - Indicates row should not split across pages
+ * @property {TableRowProperties} [tableRowProperties] @internal - Internal row properties
+ * @property {string} [rsidDel] @internal - Editing session ID for deletion
+ * @property {string} [rsidR] @internal - Editing session ID for addition
+ * @property {string} [rsidRPr] @internal - Editing session ID for row mark modification
+ * @property {string} [rsidTr] @internal - Editing session ID for properties modification
+ * @property {string} [paraId] @internal - Unique identifier for the row
+ * @property {string} [textId] @internal - Unique identifier for row text
+ */
 /**
  * @module TableRow
  * @sidebarTitle Table Row
@@ -153,4 +173,12 @@ export type TableRowProperties = {
         type?: "auto" | "dxa" | "nil" | "pct";
     };
 };
+/**
+ * Configuration options for TableRow
+ */
+export type TableRowOptions = any;
+/**
+ * Attributes for table row nodes
+ */
+export type TableRowAttributes = any;
 import { Node } from '@core/index.js';

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

@@ -1,2 +1,16 @@
+/**
+ * Configuration options for Text
+ * @typedef {Object} TextOptions
+ * @category Options
+ */
+/**
+ * @module Text
+ * @sidebarTitle Text
+ * @snippetPath /snippets/extensions/text.mdx
+ */
 export const Text: Node;
+/**
+ * Configuration options for Text
+ */
+export type TextOptions = any;
 import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/text-align/text-align.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Configuration options for TextAlign
+ * @typedef {Object} TextAlignOptions
+ * @category Options
+ * @property {string[]} [types=['heading', 'paragraph']] - Node types to apply alignment to
+ * @property {string[]} [alignments=['left', 'center', 'right', 'justify']] - Available alignment options
+ * @property {string} [defaultAlignment='left'] - Default text alignment
+ */
+/**
+ * Attributes for text alignment
+ * @typedef {Object} TextAlignAttributes
+ * @category Attributes
+ * @property {string} [textAlign='left'] - Text alignment value (left, center, right, justify)
+ */
 /**
  * @module TextAlign
  * @sidebarTitle Text Align
@@ -8,4 +22,12 @@
  * @shortcut Mod-Shift-j | setTextAlign('justify') | Justify text
  */
 export const TextAlign: Extension;
+/**
+ * Configuration options for TextAlign
+ */
+export type TextAlignOptions = any;
+/**
+ * Attributes for text alignment
+ */
+export type TextAlignAttributes = any;
 import { Extension } from '@core/index.js';

package/dist/super-editor/src/extensions/text-indent/text-indent.d.ts

@@ -1,7 +1,17 @@
 /**
- * Text indent configuration
- * @typedef {Object} IndentConfig
- * @property {string} indent - Indent value with unit (e.g., '0.5in', '1cm')
+ * Configuration options for TextIndent
+ * @typedef {Object} TextIndentOptions
+ * @category Options
+ * @property {string[]} [types=['heading', 'paragraph']] - Node types to apply indentation to
+ * @property {Object} [defaults] - Default indentation settings
+ * @property {string} [defaults.unit='in'] - Default unit for indentation (in, cm, px, etc.)
+ * @property {number} [defaults.increment=0.125] - Default increment/decrement value
+ */
+/**
+ * Attributes for text indentation
+ * @typedef {Object} TextIndentAttributes
+ * @category Attributes
+ * @property {string} [textIndent] - Text indentation value with unit (e.g., '0.5in')
  */
 /**
  * @module TextIndent
@@ -10,12 +20,11 @@
  */
 export const TextIndent: Extension;
 /**
- * Text indent configuration
+ * Configuration options for TextIndent
+ */
+export type TextIndentOptions = any;
+/**
+ * Attributes for text indentation
  */
-export type IndentConfig = {
-    /**
-     * - Indent value with unit (e.g., '0.5in', '1cm')
-     */
-    indent: string;
-};
+export type TextIndentAttributes = any;
 import { Extension } from '@core/index.js';

package/dist/super-editor/src/extensions/text-style/text-style.d.ts

@@ -1,7 +1,27 @@
+/**
+ * Configuration options for TextStyle
+ * @typedef {Object} TextStyleOptions
+ * @category Options
+ * @property {Object} [htmlAttributes={}] - Custom HTML attributes to apply to text style spans
+ */
+/**
+ * Attributes for text style marks
+ * @typedef {Object} TextStyleAttributes
+ * @category Attributes
+ * @property {string} [styleId] - Style identifier for referencing predefined styles
+ */
 /**
  * @module TextStyle
  * @sidebarTitle Text Style
  * @snippetPath /snippets/extensions/text-style.mdx
  */
 export const TextStyle: Mark;
+/**
+ * Configuration options for TextStyle
+ */
+export type TextStyleOptions = any;
+/**
+ * Attributes for text style marks
+ */
+export type TextStyleAttributes = any;
 import { Mark } from '@core/index.js';