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

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

@@ -1,3 +1,53 @@
+/**
+ * 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
+ */
+/**
+ * Table indentation configuration
+ * @typedef {Object} TableIndent
+ * @property {number} width - Indent width in pixels
+ * @property {string} [type='dxa'] - Indent type
+ */
+/**
+ * Cell selection position
+ * @typedef {Object} CellSelectionPosition
+ * @property {number} anchorCell - Starting cell position
+ * @property {number} headCell - Ending cell position
+ */
+/**
+ * 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
+ */
+/**
+ * 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)
+ */
+/**
+ * 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
+ */
 /**
  * @module Table
  * @sidebarTitle Table
@@ -9,129 +59,400 @@
  */
 export const Table: Node;
 /**
- * Table configuration options
+ * Theme color options
  */
-export type TableConfig = {
+export type ThemeColor = "dark1" | "light1" | "dark2" | "light2" | "accent1" | "accent2" | "accent3" | "accent4" | "accent5" | "accent6" | "hyperlink" | "followedHyperlink" | "none" | "background1" | "text1" | "background2" | "text2";
+/**
+ * Shading pattern options
+ */
+export type ShadingPattern = "nil" | "clear" | "solid" | "horzStripe" | "vertStripe" | "reverseDiagStripe" | "diagStripe" | "horzCross" | "diagCross" | "thinHorzStripe" | "thinVertStripe" | "thinReverseDiagStripe" | "thinDiagStripe" | "thinHorzCross" | "thinDiagCross";
+/**
+ * Shading properties
+ */
+export type ShadingProperties = {
     /**
-     * - Number of rows to create
+     * - Shading color (hex without # or "auto" for automatic)
      */
-    rows?: number;
+    color?: string | "auto";
     /**
-     * - Number of columns to create
+     * - Shading fill color (hex without # or "auto" for automatic)
      */
-    cols?: number;
+    fill?: string | "auto";
     /**
-     * - Create first row as header row
+     * - Theme color name
      */
-    withHeaderRow?: boolean;
+    themeColor?: ThemeColor;
+    /**
+     * - Theme fill name
+     */
+    themeFill?: ThemeColor;
+    /**
+     * - Theme fill shade (0-255 in hex format without #)
+     */
+    themeFillShade?: string;
+    /**
+     * - Theme fill tint (0-255 in hex format without #)
+     */
+    themeFillTint?: string;
+    /**
+     * - Theme shade (0-255 in hex format without #)
+     */
+    themeShade?: string;
+    /**
+     * - Theme tint (0-255 in hex format without #)
+     */
+    themeTint?: string;
+    /**
+     * - Shading pattern
+     */
+    val?: ShadingPattern;
 };
 /**
- * Table indentation configuration
+ * Table width options
  */
-export type TableIndent = {
+export type TableMeasurement = {
     /**
-     * - Indent width in pixels
+     * - Width value in twips
      */
-    width: number;
+    value: number;
     /**
-     * - Indent type
+     * - Table width type (dxa=twips, pct=percentage, auto=automatic)
      */
-    type?: string;
+    type?: "dxa" | "pct" | "auto";
+};
+/**
+ * Table look options
+ */
+export type TableLook = {
+    /**
+     * - Specifies that the first column conditional formatting should be applied
+     */
+    firstColumn?: boolean;
+    /**
+     * - Specifies that the first row conditional formatting should be applied
+     */
+    firstRow?: boolean;
+    /**
+     * - Specifies that the last column conditional formatting should be applied
+     */
+    lastColumn?: boolean;
+    /**
+     * - Specifies that the last row conditional formatting should be applied
+     */
+    lastRow?: boolean;
+    /**
+     * - Specifies that no horizontal banding conditional formatting should be applied
+     */
+    noHBand?: boolean;
+    /**
+     * - Specifies that no vertical banding conditional formatting should be applied
+     */
+    noVBand?: boolean;
 };
 /**
- * Table attributes
+ * Floating table properties
  */
-export type TableAttributes = {
+export type FloatingTableProperties = {
+    /**
+     * - Specifies the minimum distance in twips which shall be maintained between the current floating table and the edge of text in the paragraph which is to the left of this floating table.
+     */
+    leftFromText?: number;
+    /**
+     * - Specifies the minimum distance in twips which shall be maintained between the current floating table and the edge of text in the paragraph which is to the right of this floating table.
+     */
+    rightFromText?: number;
+    /**
+     * - Specifies the minimum distance in twips which shall be maintained between the current floating table and the bottom edge of text in the paragraph which is above this floating table.
+     */
+    topFromText?: number;
+    /**
+     * - Specifies the minimum distance in twips which shall be maintained between the current floating table and the top edge of text in the paragraph which is below this floating table.
+     */
+    bottomFromText?: number;
+    /**
+     * - Specifies and absolute horizontal position for the floating table. The position is measured from the horizontal anchor point (horzAnchor) in twips.
+     */
+    tblpX?: number;
+    /**
+     * - Specifies and absolute vertical position for the floating table. The position is measured from the vertical anchor point (vertAnchor) in twips.
+     */
+    tblpY?: number;
+    /**
+     * - Horizontal anchor point for tblpX
+     */
+    horzAnchor?: "margin" | "page" | "text";
+    /**
+     * - Vertical anchor point for tblpY
+     */
+    vertAnchor?: "margin" | "page" | "text";
+    /**
+     * - Specifies a relative horizontal position for the floating table. Supercedes tblpX if both are specified.
+     */
+    tblpXSpec?: "left" | "center" | "right" | "inside" | "outside";
+    /**
+     * - Specifies a relative vertical position for the floating table. Supercedes tblpY if both are specified.
+     */
+    tblpYSpec?: "inline" | "top" | "center" | "bottom" | "inside" | "outside";
+};
+/**
+ * Table border specification
+ */
+export type TableBorderSpec = {
+    /**
+     * - Border style (e.g., 'single', 'double', 'dashed', etc.)
+     */
+    val?: string;
+    /**
+     * - Border color (hex without #, e.g., 'FF0000' for red)
+     */
+    color?: string;
+    /**
+     * - Theme color name
+     */
+    themeColor?: ThemeColor;
+    /**
+     * - Theme tint (0-255 in hex format without #)
+     */
+    themeTint?: string;
+    /**
+     * - Theme shade (0-255 in hex format without #)
+     */
+    themeShade?: string;
+    /**
+     * - Border size in eighths of a point (e.g., 8 = 1pt, 16 = 2pt)
+     */
+    size?: number;
+    /**
+     * - Space in points between border and text
+     */
+    space?: number;
+    /**
+     * - Whether the border has a shadow
+     */
+    shadow?: boolean;
+    /**
+     * - Whether the border is a frame
+     */
+    frame?: boolean;
+};
+/**
+ * Table borders properties
+ */
+export type TableBorders = {
+    /**
+     * - Bottom border specification
+     */
+    bottom?: TableBorderSpec;
+    /**
+     * - End (right in LTR, left in RTL) border specification
+     */
+    end?: TableBorderSpec;
+    /**
+     * - Inside horizontal border specification
+     */
+    insideH?: TableBorderSpec;
+    /**
+     * - Inside vertical border specification
+     */
+    insideV?: TableBorderSpec;
+    /**
+     * - Left border specification
+     */
+    left?: TableBorderSpec;
+    /**
+     * - Right border specification
+     */
+    right?: TableBorderSpec;
+    /**
+     * - Start (left in LTR, right in RTL) border specification
+     */
+    start?: TableBorderSpec;
+    /**
+     * - Top border specification
+     */
+    top?: TableBorderSpec;
+};
+/**
+ * Table cell margin properties
+ */
+export type TableCellMargins = {
+    /**
+     * - Top cell margin
+     */
+    top?: TableMeasurement;
+    /**
+     * - Left cell margin
+     */
+    left?: TableMeasurement;
+    /**
+     * - Bottom cell margin
+     */
+    bottom?: TableMeasurement;
+    /**
+     * - Start cell margin (left in LTR, right in RTL)
+     */
+    start?: TableMeasurement;
+    /**
+     * - End cell margin (right in LTR, left in RTL)
+     */
+    end?: TableMeasurement;
+    /**
+     * - Right cell margin
+     */
+    right?: TableMeasurement;
+};
+/**
+ * Table properties
+ */
+export type TableProperties = {
+    /**
+     * - Specifies that the cells with this table shall be visually represented in a right to left direction
+     */
+    rightToLeft?: boolean;
+    /**
+     * - The alignment of the set of rows which are part of the current table.
+     */
+    justification?: "center" | "end" | "left" | "right" | "start";
+    /**
+     * - Shading properties for the table
+     */
+    shading?: ShadingProperties;
+    /**
+     * - Caption text for the table
+     */
+    caption?: string;
+    /**
+     * - Description text for the table
+     */
+    description?: string;
+    /**
+     * - Cell spacing
+     */
+    tableCellSpacing?: TableMeasurement;
     /**
      * - Table indentation
      */
-    tableIndent?: TableIndent;
+    tableIndent?: TableMeasurement;
     /**
-     * - Table border configuration
+     * - Table layout algorithm
      */
-    borders?: import("./tableHelpers/createTableBorders.js").TableBorders;
+    tableLayout?: "fixed" | "autofit";
     /**
-     * - CSS border-collapse value
+     * - Various boolean flags that affect the rendering of the table
      */
-    borderCollapse?: string;
+    tableLook?: TableLook;
+    /**
+     * - Specifies whether the current table should allow other floating tables to overlap its extents when the tables are displayed in a document
+     */
+    overlap?: "never" | "overlap";
     /**
      * - Reference to table style ID
      */
     tableStyleId?: string;
     /**
-     * - Table layout algorithm
+     * - Number of columns for which the table style is applied
+     */
+    tableStyleColBandSize?: number;
+    /**
+     * - Number of rows for which the table style is applied
+     */
+    tableStyleRowBandSize?: number;
+    /**
+     * - Table width
      */
-    tableLayout?: string;
+    tableWidth?: TableMeasurement;
     /**
-     * - Cell spacing in pixels
+     * - Floating table properties
      */
-    tableCellSpacing?: number;
+    floatingTableProperties?: FloatingTableProperties;
+    /**
+     * - Table border configuration
+     */
+    borders?: TableBorders;
 };
 /**
- * Cell selection position
+ * Column width definition
  */
-export type CellSelectionPosition = {
+export type ColWidth = {
     /**
-     * - Starting cell position
+     * - Column width in twips
      */
-    anchorCell: number;
-    /**
-     * - Ending cell position
-     */
-    headCell: number;
+    col: number;
 };
 /**
- * Column group information
+ * Table grid definition
  */
-export type ColGroupInfo = {
+export type TableGrid = {
     /**
-     * - Column group DOM structure
+     * - Array of column widths in twips
      */
-    colgroup?: any[];
+    colWidths?: ColWidth[];
+};
+/**
+ * Table configuration options
+ */
+export type TableConfig = {
     /**
-     * - Fixed table width or empty string
+     * - Number of rows to create
      */
-    tableWidth?: string;
+    rows?: number;
     /**
-     * - Minimum table width or empty string
+     * - Number of columns to create
      */
-    tableMinWidth?: string;
+    cols?: number;
     /**
-     * - Array of column width values
+     * - Create first row as header row
      */
-    colgroupValues?: number[];
+    withHeaderRow?: boolean;
 };
 /**
- * Position resolution result
+ * Table indentation configuration
  */
-export type CellPosition = {
+export type TableIndent = {
     /**
-     * - Resolved position
+     * - Indent width in pixels
      */
-    $pos: any;
+    width: number;
     /**
-     * - Absolute position
+     * - Indent type
      */
-    pos: number;
+    type?: string;
+};
+/**
+ * Cell selection position
+ */
+export type CellSelectionPosition = {
+    /**
+     * - Starting cell position
+     */
+    anchorCell: number;
     /**
-     * - Depth in document tree
+     * - Ending cell position
      */
-    depth: number;
+    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 from ProseMirror
+     * - Selected rectangle information
      */
     rect: any;
     /**
-     * - Current cell node
+     * - The cell node
      */
-    cell: any;
+    cell: import("prosemirror-model").Node;
     /**
-     * - Cell attributes without span properties
+     * - Cell attributes
      */
     attrs: any;
 };

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';