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

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblOverlap/tblOverlap-translator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The NodeTranslator instance for the tblOverlap element.
+ * @type {import('@translator').NodeTranslator}
+ * @see {@link https://ecma-international.org/publications-and-standards/standards/ecma-376/} "Fundamentals And Markup Language Reference", page 440
+ */
+export const translator: import("@translator").NodeTranslator;

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblPr/index.d.ts

@@ -0,0 +1 @@
+export * from "./tblPr-translator.js";

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblPr/tblPr-translator.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The NodeTranslator instance for the w:tblPr element.
+ * @type {import('@translator').NodeTranslator}
+ */
+export const translator: import("@translator").NodeTranslator;

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblStyle/index.d.ts

@@ -0,0 +1 @@
+export * from "./tblStyle-translator.js";

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblStyle/tblStyle-translator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The NodeTranslator instance for the tblStyle element.
+ * @type {import('@translator').NodeTranslator}
+ * @see {@link https://ecma-international.org/publications-and-standards/standards/ecma-376/} "Fundamentals And Markup Language Reference", page 454
+ */
+export const translator: import("@translator").NodeTranslator;

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblStyleColBandSize/index.d.ts

@@ -0,0 +1 @@
+export * from "./tblStyleColBandSize-translator.js";

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblStyleColBandSize/tblStyleColBandSize-translator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The NodeTranslator instance for the tblStyleColBandSize element.
+ * @type {import('@translator').NodeTranslator}
+ * @see {@link https://ecma-international.org/publications-and-standards/standards/ecma-376/} "Fundamentals And Markup Language Reference", page 657
+ */
+export const translator: import("@translator").NodeTranslator;

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblStyleRowBandSize/index.d.ts

@@ -0,0 +1 @@
+export * from "./tblStyleRowBandSize-translator.js";

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblStyleRowBandSize/tblStyleRowBandSize-translator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The NodeTranslator instance for the tblStyleRowBandSize element.
+ * @type {import('@translator').NodeTranslator}
+ * @see {@link https://ecma-international.org/publications-and-standards/standards/ecma-376/} "Fundamentals And Markup Language Reference", page 660
+ */
+export const translator: import("@translator").NodeTranslator;

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblW/index.d.ts

@@ -0,0 +1 @@
+export * from "./tblW-translator.js";

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblW/tblW-translator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The NodeTranslator instance for the tblW element.
+ * @type {import('@translator').NodeTranslator}
+ * @see {@link https://ecma-international.org/publications-and-standards/standards/ecma-376/} "Fundamentals And Markup Language Reference", page 455
+ */
+export const translator: import("@translator").NodeTranslator;

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblpPr/index.d.ts

@@ -0,0 +1 @@
+export * from "./tblpPr-translator.js";

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tblpPr/tblpPr-translator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The NodeTranslator instance for the tblpPr element.
+ * @type {import('@translator').NodeTranslator}
+ * @see {@link https://ecma-international.org/publications-and-standards/standards/ecma-376/} "Fundamentals And Markup Language Reference", page 442
+ */
+export const translator: import("@translator").NodeTranslator;

package/dist/super-editor/src/core/super-converter/v3/handlers/w/tc/helpers/legacy-handle-table-cell-node.d.ts

@@ -2,7 +2,7 @@
  * @param {Object} options
  * @returns {{type: string, content: (*|*[]), attrs: {}}}
  */
-export function handleTableCellNode({ params, node, table, row, rowBorders, styleTag, columnIndex, columnWidth, }: any): {
+export function handleTableCellNode({ params, node, table, row, rowBorders, styleTag, columnIndex, columnWidth, allColumnWidths, }: any): {
     type: string;
     content: (any | any[]);
     attrs: {};

package/dist/super-editor/src/core/super-converter/v3/handlers/w/top/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./top-translator.js";
+export { translator as marginTopTranslator } from "./marginTop-translator.js";

package/dist/super-editor/src/core/super-converter/v3/handlers/w/top/marginTop-translator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The NodeTranslator instance for the top element.
+ * @type {import('@translator').NodeTranslator}
+ * @see {@link https://ecma-international.org/publications-and-standards/standards/ecma-376/} "Fundamentals And Markup Language Reference", page 469
+ */
+export const translator: import("@translator").NodeTranslator;

package/dist/super-editor/src/core/super-converter/v3/handlers/w/top/top-translator.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The NodeTranslator instance for the top element.
+ * @type {import('@translator').NodeTranslator}
+ * @see {@link https://ecma-international.org/publications-and-standards/standards/ecma-376/} "Fundamentals And Markup Language Reference", page 468
+ */
+export const translator: import("@translator").NodeTranslator;

package/dist/super-editor/src/core/super-converter/v3/handlers/wp/anchor/anchor-translator.d.ts

@@ -0,0 +1,6 @@
+/** @type {import('@translator').NodeTranslatorConfig} */
+export const config: import("@translator").NodeTranslatorConfig;
+/**
+ * @type {import('@translator').NodeTranslator}
+ */
+export const translator: import("@translator").NodeTranslator;

package/dist/super-editor/src/core/super-converter/v3/handlers/wp/anchor/helpers/handle-anchor-node.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Anchor image node handler
+ * @param {import('@translator').SCEncoderConfig} params
+ * @returns {Object|null} Handler result
+ */
+export function handleAnchorNode(params: import("@translator").SCEncoderConfig): any | null;

package/dist/super-editor/src/core/super-converter/v3/handlers/wp/anchor/helpers/translate-anchor-node.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Translates anchor image
+ * @param {Object} params - The parameters for translation.
+ * @returns {Object} The XML representation.
+ */
+export function translateAnchorNode(params: any): any;

package/dist/super-editor/src/core/super-converter/v3/handlers/wp/anchor/index.d.ts

@@ -0,0 +1 @@
+export * from "./anchor-translator.js";

package/dist/super-editor/src/core/super-converter/v3/handlers/wp/helpers/decode-image-node-helpers.d.ts

@@ -0,0 +1,18 @@
+export function translateImageNode(params: any): any;
+/**
+ * Decodes image into export XML
+ */
+export type ExportParams = {
+    /**
+     * JSON node to translate (from PM schema)
+     */
+    node: any;
+    /**
+     * The stored body node to restore, if available
+     */
+    bodyNode: any;
+    /**
+     * The relationships to add to the document
+     */
+    relationships: any[];
+};

package/dist/super-editor/src/core/super-converter/v3/handlers/wp/helpers/encode-image-node-helpers.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Encodes image xml into Editor node
+ * @param {Object} params
+ * @returns {Object|null}
+ */
+export function handleImageNode(node: any, params: any, isAnchor: any): any | null;

package/dist/super-editor/src/core/super-converter/v3/handlers/wp/inline/helpers/handle-inline-node.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Inline image node handler
+ * @param {import('@translator').SCEncoderConfig} params
+ * @returns {Object|null} Handler result
+ */
+export function handleInlineNode(params: import("@translator").SCEncoderConfig): any | null;

package/dist/super-editor/src/core/super-converter/v3/handlers/wp/inline/helpers/translate-inline-node.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Translates inline image
+ * @param {Object} params - The parameters for translation.
+ * @returns {Object} The XML representation.
+ */
+export function translateInlineNode(params: any): any;

package/dist/super-editor/src/core/super-converter/v3/handlers/wp/inline/index.d.ts

@@ -0,0 +1 @@
+export * from "./inline-translator.js";

package/dist/super-editor/src/core/super-converter/v3/handlers/wp/inline/inline-translator.d.ts

@@ -0,0 +1,6 @@
+/** @type {import('@translator').NodeTranslatorConfig} */
+export const config: import("@translator").NodeTranslatorConfig;
+/**
+ * @type {import('@translator').NodeTranslator}
+ */
+export const translator: import("@translator").NodeTranslator;

package/dist/super-editor/src/core/super-converter/v3/node-translator/node-translator.d.ts

@@ -21,7 +21,14 @@ export const TranslatorTypes: Readonly<{
  */
 /** @typedef {import('../../v2/importer/types').NodeHandlerParams} SCEncoderConfig */
 /** @typedef {import('../../v2/types').SuperDocNode} SCEncoderResult */
-/** @typedef {{ node: { attrs?: any, marks?: any[], type: string }, children?: any[], relationships?: any[] }} SCDecoderConfig */
+/**
+ * @typedef {Object} SCDecoderConfig
+ * @property {{ attrs?: any, marks?: any[], type: string, content?: any[] }} node
+ * @property {any[]} [children]
+ * @property {any[]} [relationships]
+ * @property {Record<string, any>} [extraParams]
+ * @property {import('../../../Editor.js').Editor} [editor]
+ */
 /** @typedef {{ name: string, attributes?: any, elements: any[] }} SCDecoderResult */
 /**
  * @callback NodeTranslatorEncodeFn
@@ -150,9 +157,12 @@ export type SCDecoderConfig = {
         attrs?: any;
         marks?: any[];
         type: string;
+        content?: any[];
     };
     children?: any[];
     relationships?: any[];
+    extraParams?: Record<string, any>;
+    editor?: import("../../../Editor.js").Editor;
 };
 export type SCDecoderResult = {
     name: string;

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

@@ -1,19 +1,36 @@
 export const BlockNodePluginKey: PluginKey<any>;
+/**
+ * @typedef {import('prosemirror-model').Node} ProseMirrorNode
+ * @typedef {import('prosemirror-state').Transaction} Transaction
+ */
 /**
  * Block node information object
  * @typedef {Object} BlockNodeInfo
- * @property {Object} node - The block node
+ * @property {ProseMirrorNode} node - The block node
  * @property {number} pos - Position in the document
  */
+/**
+ * Configuration options for BlockNode
+ * @typedef {Object} BlockNodeOptions
+ * @category Options
+ */
+/**
+ * Attributes for block nodes
+ * @typedef {Object} BlockNodeAttributes
+ * @category Attributes
+ * @property {string} [sdBlockId] @internal Unique identifier for the block
+ */
 /**
  * @module BlockNode
  * @sidebarTitle Block Node
  * @snippetPath /snippets/extensions/block-node.mdx
  */
 export const BlockNode: Extension;
-export function nodeAllowsSdBlockIdAttr(node: any): boolean;
-export function nodeNeedsSdBlockId(node: any): boolean;
-export function checkForNewBlockNodesInTrs(transactions: ArrayLike<any>): boolean;
+export function nodeAllowsSdBlockIdAttr(node: ProseMirrorNode): boolean;
+export function nodeNeedsSdBlockId(node: ProseMirrorNode): boolean;
+export function checkForNewBlockNodesInTrs(transactions: Transaction[]): boolean;
+export type ProseMirrorNode = import("prosemirror-model").Node;
+export type Transaction = import("prosemirror-state").Transaction;
 /**
  * Block node information object
  */
@@ -21,11 +38,19 @@ export type BlockNodeInfo = {
     /**
      * - The block node
      */
-    node: any;
+    node: ProseMirrorNode;
     /**
      * - Position in the document
      */
     pos: number;
 };
+/**
+ * Configuration options for BlockNode
+ */
+export type BlockNodeOptions = any;
+/**
+ * Attributes for block nodes
+ */
+export type BlockNodeAttributes = any;
 import { PluginKey } from 'prosemirror-state';
 import { Extension } from '@core/Extension.js';

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

@@ -1,3 +1,15 @@
+/**
+ * Configuration options for Bold
+ * @typedef {Object} BoldOptions
+ * @category Options
+ * @property {Object} [htmlAttributes] HTML attributes for the strong element
+ */
+/**
+ * Attributes for bold marks
+ * @typedef {Object} BoldAttributes
+ * @category Attributes
+ * @property {string} [value] Bold weight value ('0' renders as normal)
+ */
 /**
  * @module Bold
  * @sidebarTitle Bold
@@ -6,4 +18,12 @@
  * @shortcut Mod-B | toggleBold | Toggle bold formatting (uppercase)
  */
 export const Bold: Mark;
+/**
+ * Configuration options for Bold
+ */
+export type BoldOptions = any;
+/**
+ * Attributes for bold marks
+ */
+export type BoldAttributes = any;
 import { Mark } from '@core/index.js';

package/dist/super-editor/src/extensions/bookmarks/bookmark-end.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @module BookmarkEnd
+ * @sidebarTitle Bookmarks
+ */
+export const BookmarkEnd: Node;
+import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/bookmarks/index.d.ts

@@ -1 +1,2 @@
-export * from "./bookmarks";
+export { BookmarkStart } from "./bookmark-start.js";
+export { BookmarkEnd } from "./bookmark-end.js";

package/dist/super-editor/src/extensions/bullet-list/bullet-list.d.ts

@@ -1,2 +1,14 @@
 export const BulletList: Node;
+/**
+ * Configuration options for BulletList
+ */
+export type BulletListOptions = any;
+/**
+ * Attributes for bullet list nodes
+ */
+export type BulletListAttributes = any;
+/**
+ * Commands provided by BulletList extension
+ */
+export type BulletListCommands = any;
 import { Node } from '@core/index.js';

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

@@ -3,6 +3,24 @@
  * @typedef {string} ColorValue
  * @description Accepts hex colors (#ff0000), rgb(255,0,0), or named colors (red)
  */
+/**
+ * Configuration options for Color
+ * @typedef {Object} ColorOptions
+ * @category Options
+ * @property {string[]} [types=['textStyle']] Mark types to add color support to
+ */
+/**
+ * Attributes for color marks
+ * @typedef {Object} ColorAttributes
+ * @category Attributes
+ * @property {ColorValue} [color] Text color value
+ * @example
+ * // Apply color to selected text
+ * editor.commands.setColor('#ff0000')
+ *
+ * // Remove color
+ * editor.commands.unsetColor()
+ */
 /**
  * @module Color
  * @sidebarTitle Color
@@ -13,4 +31,12 @@ export const Color: Extension;
  * Color value format
  */
 export type ColorValue = string;
+/**
+ * Configuration options for Color
+ */
+export type ColorOptions = any;
+/**
+ * Attributes for color marks
+ */
+export type ColorAttributes = any;
 import { Extension } from '@core/index.js';

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

@@ -13,6 +13,28 @@
  * @property {ContentBlockSize} [size] - Size and position configuration
  * @property {string} [background] - Background color (hex, rgb, or named color)
  */
+/**
+ * Configuration options for ContentBlock
+ * @typedef {Object} ContentBlockOptions
+ * @category Options
+ * @property {Object} [htmlAttributes] HTML attributes for the block element
+ */
+/**
+ * Attributes for content blocks
+ * @typedef {Object} ContentBlockAttributes
+ * @category Attributes
+ * @property {boolean} [horizontalRule=false] Whether this block is a horizontal rule
+ * @property {ContentBlockSize} [size] Size and position of the content block
+ * @property {string} [background] Background color for the block
+ * @property {Object} [drawingContent] @internal Internal drawing data
+ * @property {Object} [attributes] @internal Additional internal attributes
+ * @example
+ * // Insert a custom content block
+ * editor.commands.insertContentBlock({
+ *   size: { width: '100%', height: 2 },
+ *   background: '#e5e7eb'
+ * })
+ */
 /**
  * @module ContentBlock
  * @sidebarTitle Content Block
@@ -57,4 +79,12 @@ export type ContentBlockConfig = {
      */
     background?: string;
 };
+/**
+ * Configuration options for ContentBlock
+ */
+export type ContentBlockOptions = any;
+/**
+ * Attributes for content blocks
+ */
+export type ContentBlockAttributes = any;
 import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/custom-selection/custom-selection.d.ts

@@ -5,6 +5,18 @@
  * @property {Object|null} preservedSelection - Stored selection
  * @property {boolean} showVisualSelection - Whether to show selection decoration
  */
+/**
+ * Configuration options for CustomSelection
+ * @typedef {Object} CustomSelectionOptions
+ * @category Options
+ * @example
+ * // CustomSelection works automatically
+ * new SuperDoc({
+ *   selector: '#editor',
+ *   document: 'document.docx'
+ *   // Selection handling is built-in
+ * });
+ */
 /**
  * Plugin key for custom selection management
  * @private
@@ -33,5 +45,9 @@ export type SelectionState = {
      */
     showVisualSelection: boolean;
 };
+/**
+ * Configuration options for CustomSelection
+ */
+export type CustomSelectionOptions = any;
 import { PluginKey } from 'prosemirror-state';
 import { Extension } from '@core/Extension.js';

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

@@ -1,7 +1,33 @@
+/**
+ * Configuration options for Document
+ * @typedef {Object} DocumentOptions
+ * @category Options
+ * @example
+ * // Document node is the root - always included
+ * new SuperDoc({
+ *   selector: '#editor',
+ *   document: 'document.docx',
+ *   // Document node wraps all content
+ * });
+ */
+/**
+ * Attributes for document nodes
+ * @typedef {Object} DocumentAttributes
+ * @category Attributes
+ * @property {Object} [attributes] @internal Internal document attributes
+ */
 /**
  * @module Document
  * @sidebarTitle Document
  * @snippetPath /snippets/extensions/document.mdx
  */
 export const Document: Node;
+/**
+ * Configuration options for Document
+ */
+export type DocumentOptions = any;
+/**
+ * Attributes for document nodes
+ */
+export type DocumentAttributes = any;
 import { Node } from '@core/index.js';

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

@@ -1,7 +1,33 @@
+/**
+ * Configuration options for DropCursor
+ * @typedef {Object} DropCursorOptions
+ * @category Options
+ * @property {string} [color='currentColor'] CSS color for the drop cursor indicator
+ * @property {number} [width=2] Width of the drop cursor line in pixels
+ * @property {string} [class] Optional CSS class to apply to the drop cursor element
+ * @example
+ * // Customize drop cursor appearance
+ * const ConfiguredDropCursor = DropCursor.configure({
+ *   color: '#3b82f6',
+ *   width: 3,
+ *   class: 'custom-drop-cursor'
+ * });
+ *
+ * // Use in SuperDoc
+ * new SuperDoc({
+ *   selector: '#editor',
+ *   document: 'document.docx',
+ *   editorExtensions: [ConfiguredDropCursor]
+ * });
+ */
 /**
  * @module DropCursor
  * @sidebarTitle Drop Cursor
  * @snippetPath /snippets/extensions/dropcursor.mdx
  */
 export const DropCursor: Extension;
+/**
+ * Configuration options for DropCursor
+ */
+export type DropCursorOptions = any;
 import { Extension } from '@core/index.js';

package/dist/super-editor/src/extensions/font-family/font-family.d.ts

@@ -3,6 +3,27 @@
  * @typedef {string} FontFamilyValue
  * @description CSS font-family string (e.g., 'Arial', 'Times New Roman', 'sans-serif')
  */
+/**
+ * Configuration options for FontFamily
+ * @typedef {Object} FontFamilyOptions
+ * @category Options
+ * @property {string[]} [types=['textStyle']] Mark types to add font family support to
+ */
+/**
+ * Attributes for font family marks
+ * @typedef {Object} FontFamilyAttributes
+ * @category Attributes
+ * @property {FontFamilyValue} [fontFamily] Font family for text
+ * @example
+ * // Set font family on selected text
+ * editor.commands.setFontFamily('Arial')
+ *
+ * // Change to serif font
+ * editor.commands.setFontFamily('Georgia, serif')
+ *
+ * // Remove custom font
+ * editor.commands.unsetFontFamily()
+ */
 /**
  * @module FontFamily
  * @sidebarTitle Font Family
@@ -13,4 +34,12 @@ export const FontFamily: Extension;
  * Font family value
  */
 export type FontFamilyValue = string;
+/**
+ * Configuration options for FontFamily
+ */
+export type FontFamilyOptions = any;
+/**
+ * Attributes for font family marks
+ */
+export type FontFamilyAttributes = any;
 import { Extension } from '@core/index.js';

package/dist/super-editor/src/extensions/font-size/font-size.d.ts

@@ -18,6 +18,19 @@
  * @typedef {string|number} FontSizeValue
  * @description Size with optional unit (e.g., '12pt', '16px', 14)
  */
+/**
+ * Configuration options for FontSize
+ * @typedef {Object} FontSizeOptions
+ * @category Options
+ * @property {string[]} [types=['textStyle', 'tableCell']] - Node/mark types to add font size support to
+ * @property {FontSizeDefaults} [defaults] - Default size configuration
+ */
+/**
+ * Attributes for font size
+ * @typedef {Object} FontSizeAttributes
+ * @category Attributes
+ * @property {FontSizeValue} [fontSize] - Font size with unit
+ */
 /**
  * @module FontSize
  * @sidebarTitle Font Size
@@ -49,4 +62,12 @@ export type FontSizeDefaults = {
  * Font size value
  */
 export type FontSizeValue = string | number;
+/**
+ * Configuration options for FontSize
+ */
+export type FontSizeOptions = any;
+/**
+ * Attributes for font size
+ */
+export type FontSizeAttributes = any;
 import { Extension } from '@core/index.js';

package/dist/super-editor/src/extensions/format-commands/format-commands.d.ts

@@ -4,6 +4,11 @@
  * @property {string} name - Mark name
  * @property {Object} attrs - Mark attributes
  */
+/**
+ * Configuration options for FormatCommands
+ * @typedef {Object} FormatCommandsOptions
+ * @category Options
+ */
 /**
  * @module FormatCommands
  * @sidebarTitle Format Commands
@@ -24,4 +29,8 @@ export type StoredStyle = {
      */
     attrs: any;
 };
+/**
+ * Configuration options for FormatCommands
+ */
+export type FormatCommandsOptions = any;
 import { Extension } from '@core/index.js';

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

@@ -1,7 +1,16 @@
+/**
+ * Configuration options for Gapcursor
+ * @typedef {Object} GapcursorOptions
+ * @category Options
+ */
 /**
  * @module Gapcursor
  * @sidebarTitle Gap Cursor
  * @snippetPath /snippets/extensions/gapcursor.mdx
  */
 export const Gapcursor: Extension;
+/**
+ * Configuration options for Gapcursor
+ */
+export type GapcursorOptions = any;
 import { Extension } from '@core/index.js';