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

package/dist/super-editor/src/extensions/line-break/line-break.d.ts

@@ -1,13 +1,56 @@
+/**
+ * Configuration options for LineBreak
+ * @typedef {Object} LineBreakOptions
+ * @category Options
+ */
+/**
+ * Attributes for line break nodes
+ * @typedef {Object} LineBreakAttributes
+ * @category Attributes
+ * @property {string} [lineBreakType] @internal Type of line break - passthrough in this node
+ * @property {string} [clear] @internal Clear attribute - passthrough in this node
+ */
 /**
  * @module LineBreak
  * @sidebarTitle Line Break
  * @snippetPath /snippets/extensions/line-break.mdx
  */
 export const LineBreak: Node;
+/**
+ * Configuration options for HardBreak
+ * @typedef {Object} HardBreakOptions
+ * @category Options
+ * @property {Object} [htmlAttributes] - HTML attributes for the break element
+ */
+/**
+ * Attributes for hard break nodes
+ * @typedef {Object} HardBreakAttributes
+ * @category Attributes
+ * @property {string} [pageBreakSource] @internal Source of the page break
+ * @property {string} [pageBreakType] @internal Type of page break
+ * @property {string} [lineBreakType] @internal Type of line break - passthrough in this node
+ * @property {string} [clear] @internal Clear attribute - passthrough in this node
+ */
 /**
  * @module HardBreak
  * @sidebarTitle Hard Break
  * @snippetPath /snippets/extensions/hard-break.mdx
  */
 export const HardBreak: Node;
+/**
+ * Configuration options for LineBreak
+ */
+export type LineBreakOptions = any;
+/**
+ * Attributes for line break nodes
+ */
+export type LineBreakAttributes = any;
+/**
+ * Configuration options for HardBreak
+ */
+export type HardBreakOptions = any;
+/**
+ * Attributes for hard break nodes
+ */
+export type HardBreakAttributes = any;
 import { Node } from '@core/index.js';

package/dist/super-editor/src/extensions/line-height/line-height.d.ts

@@ -3,6 +3,20 @@
  * @typedef {string|number} LineHeightValue
  * @description Line height as number (1.5) or string with unit ('1.5em', '24px')
  */
+/**
+ * Configuration options for LineHeight
+ * @typedef {Object} LineHeightOptions
+ * @category Options
+ * @property {string[]} [types=['heading', 'paragraph']] - Block types to add line height support to
+ * @property {Object} [defaults] - Default configuration
+ * @property {string} [defaults.unit=''] - Default unit for line height values
+ */
+/**
+ * Attributes for line height
+ * @typedef {Object} LineHeightAttributes
+ * @category Attributes
+ * @property {LineHeightValue} [lineHeight] - Line height value
+ */
 /**
  * @module LineHeight
  * @sidebarTitle Line Height
@@ -13,4 +27,12 @@ export const LineHeight: Extension;
  * Line height value
  */
 export type LineHeightValue = string | number;
+/**
+ * Configuration options for LineHeight
+ */
+export type LineHeightOptions = any;
+/**
+ * Attributes for line height
+ */
+export type LineHeightAttributes = any;
 import { Extension } from '@core/index.js';

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

@@ -1,3 +1,39 @@
+/**
+ * Target frame options
+ * @typedef {'_top' | '_self' | '_parent' | '_blank' | string} TargetFrameOptions
+ */
+/**
+ * Configuration options for Link
+ * @typedef {Object} LinkOptions
+ * @category Options
+ * @property {string[]} [protocols=['http', 'https']] - Allowed URL protocols
+ * @property {Object} [htmlAttributes] - HTML attributes for link elements
+ * @property {string} [htmlAttributes.target=null] - Default link target
+ * @property {string} [htmlAttributes.rel='noopener noreferrer nofollow'] - Default rel attribute
+ * @property {string} [htmlAttributes.class=null] - CSS class
+ * @property {string} [htmlAttributes.title=null] - Title attribute
+ */
+/**
+ * Attributes for link marks
+ * @typedef {Object} LinkAttributes
+ * @category Attributes
+ * @property {string} [href] - URL or anchor reference
+ * @property {TargetFrameOptions} [target='_blank'] - Link target window
+ * @property {string} [rel='noopener noreferrer nofollow'] - Relationship attributes
+ * @property {string} [text] - Display text for the link
+ * @property {string} [name] - Anchor name for internal references
+ * @property {boolean} [history=true] - Whether to add to viewed hyperlinks list
+ * @property {string} [anchor] - Bookmark target name (ignored if rId and href specified)
+ * @property {string} [docLocation] - Location in target hyperlink
+ * @property {string} [tooltip] - Tooltip for the link
+ * @property {string} [rId] @internal Word relationship ID for internal links
+ */
+/**
+ * Link options for setLink command
+ * @typedef {Object} SetLinkOptions
+ * @property {string} [href] - URL for the link
+ * @property {string} [text] - Display text (uses selection if omitted)
+ */
 /**
  * @module Link
  * @sidebarTitle Link
@@ -6,36 +42,28 @@
  */
 export const Link: Mark;
 /**
- * Link attributes
+ * Target frame options
  */
-export type LinkAttributes = {
-    /**
-     * - URL or anchor reference
-     */
-    href: string;
-    /**
-     * - Link target
-     */
-    target?: string;
-    /**
-     * - Relationship attributes
-     */
-    rel?: string;
+export type TargetFrameOptions = "_top" | "_self" | "_parent" | "_blank" | string;
+/**
+ * Configuration options for Link
+ */
+export type LinkOptions = any;
+/**
+ * Attributes for link marks
+ */
+export type LinkAttributes = any;
+/**
+ * Link options for setLink command
+ */
+export type SetLinkOptions = {
     /**
-     * - Word relationship ID for internal links
+     * - URL for the link
      */
-    rId?: string;
+    href?: string;
     /**
-     * - Display text for the link
+     * - Display text (uses selection if omitted)
      */
     text?: string;
-    /**
-     * - Anchor name for internal references
-     */
-    name?: string;
 };
-/**
- * Target frame options
- */
-export type TargetFrameOptions = "_top" | "_self" | "_parent" | "_blank" | string;
 import { Mark } from '@core/index.js';

package/dist/super-editor/src/extensions/linked-styles/linked-styles.d.ts

@@ -5,6 +5,11 @@
  * @property {string} type - Style type ('paragraph' or 'character')
  * @property {Object} definition - Style definition from Word
  */
+/**
+ * Configuration options for LinkedStyles
+ * @typedef {Object} LinkedStylesOptions
+ * @category Options
+ */
 /**
  * @module LinkedStyles
  * @sidebarTitle Linked Styles
@@ -28,4 +33,8 @@ export type LinkedStyle = {
      */
     definition: any;
 };
+/**
+ * Configuration options for LinkedStyles
+ */
+export type LinkedStylesOptions = any;
 import { Extension } from '@core/Extension.js';

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

@@ -1,2 +1,50 @@
+/**
+ * Configuration options for ListItem
+ * @typedef {Object} ListItemOptions
+ * @category Options
+ * @property {Object} [htmlAttributes] - HTML attributes for list item elements
+ * @property {string} [bulletListTypeName='bulletList'] - Name of bullet list node type
+ * @property {string} [orderedListTypeName='orderedList'] - Name of ordered list node type
+ */
+/**
+ * Attributes for list item nodes
+ * @typedef {Object} ListItemAttributes
+ * @category Attributes
+ * @property {string} [markerType] - Virtual attribute for marker display
+ * @property {string} [lvlText] - Level text template for numbering
+ * @property {string} [listNumberingType] - Numbering format type
+ * @property {Array} [listLevel] - List level hierarchy
+ * @property {string} [lvlJc] - Level justification (left, right, center)
+ * @property {Object} [listParagraphProperties] - Indentation and spacing info
+ * @property {Object} [listRunProperties] - Run properties for list item
+ * @property {string} [numId] - Numbering definition ID
+ * @property {string} [numPrType='inline'] - Numbering properties type
+ * @property {string} [level] - Current nesting level
+ * @property {Object} [attributes] - Additional attributes
+ * @property {Object} [spacing] - Spacing configuration
+ * @property {Object} [indent] - Indentation settings
+ * @property {Object} [markerStyle] - Marker styling
+ * @property {string} [styleId] - Linked style ID
+ * @property {string} [customFormat] - Custom numbering format
+ * @property {string} [importedFontFamily] - Font family from import
+ * @property {string} [importedFontSize] - Font size from import
+ */
+/**
+ * @module ListItem
+ * @sidebarTitle List Item
+ * @snippetPath /snippets/extensions/list-item.mdx
+ * @shortcut Enter | splitListItem | Split list item at cursor
+ * @shortcut Shift-Enter | createParagraphNear | Create paragraph in list
+ * @shortcut Tab | increaseListIndent | Increase list indentation
+ * @shortcut Shift-Tab | decreaseListIndent | Decrease list indentation
+ */
 export const ListItem: Node;
+/**
+ * Configuration options for ListItem
+ */
+export type ListItemOptions = any;
+/**
+ * Attributes for list item nodes
+ */
+export type ListItemAttributes = any;
 import { Node } from '@core/index.js';

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

@@ -1,2 +1,28 @@
+/**
+ * Configuration options for Mention
+ * @typedef {Object} MentionOptions
+ * @category Options
+ * @property {Object} [htmlAttributes] - HTML attributes for mention elements
+ */
+/**
+ * Attributes for mention nodes
+ * @typedef {Object} MentionAttributes
+ * @category Attributes
+ * @property {string} [name=null] - Display name of the mentioned person
+ * @property {string} [email=null] - Email address of the mentioned person
+ */
+/**
+ * @module Mention
+ * @sidebarTitle Mention
+ * @snippetPath /snippets/extensions/mention.mdx
+ */
 export const Mention: Node;
+/**
+ * Configuration options for Mention
+ */
+export type MentionOptions = any;
+/**
+ * Attributes for mention nodes
+ */
+export type MentionAttributes = any;
 import { Node } from '@core/index.js';

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

@@ -1,4 +1,18 @@
+/**
+ * Configuration options for NodeResizer
+ * @typedef {Object} NodeResizerOptions
+ * @category Options
+ */
 export const NodeResizerKey: PluginKey<any>;
+/**
+ * @module NodeResizer
+ * @sidebarTitle Node Resizer
+ * @snippetPath /snippets/extensions/node-resizer.mdx
+ */
 export const NodeResizer: Extension;
+/**
+ * Configuration options for NodeResizer
+ */
+export type NodeResizerOptions = any;
 import { PluginKey } from 'prosemirror-state';
 import { Extension } from '@core/Extension.js';

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

@@ -1,2 +1,37 @@
+/**
+ * Configuration options for OrderedList
+ * @typedef {Object} OrderedListOptions
+ * @category Options
+ * @property {string} [itemTypeName='listItem'] - Name of list item node type
+ * @property {Object} [htmlAttributes] - HTML attributes for ordered list elements
+ * @property {boolean} [keepMarks=true] - Whether to preserve marks when creating lists
+ * @property {boolean} [keepAttributes=false] - Whether to preserve attributes
+ * @property {Array<string>} [listStyleTypes=['decimal', 'lowerAlpha', 'lowerRoman']] - Available list style types
+ */
+/**
+ * Attributes for ordered list nodes
+ * @typedef {Object} OrderedListAttributes
+ * @category Attributes
+ * @property {number} [order=1] - Starting number for the list
+ * @property {string} [sdBlockId] - Block identifier for tracking
+ * @property {string} [syncId] - Synchronization identifier
+ * @property {string} [listId] - List identifier
+ * @property {string} [list-style-type='decimal'] - List style type (decimal, lowerAlpha, lowerRoman)
+ * @property {Object} [attributes] - Additional attributes
+ */
+/**
+ * @module OrderedList
+ * @sidebarTitle Ordered List
+ * @snippetPath /snippets/extensions/ordered-list.mdx
+ * @shortcut Mod-Shift-7 | toggleOrderedList | Toggle ordered list
+ */
 export const OrderedList: Node;
+/**
+ * Configuration options for OrderedList
+ */
+export type OrderedListOptions = any;
+/**
+ * Attributes for ordered list nodes
+ */
+export type OrderedListAttributes = any;
 import { Node } from '@core/index.js';

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