superdoc 0.20.0-next.13

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

@@ -0,0 +1,215 @@
+export type TranslatorTypes = string;
+/**
+ * @enum {string}
+ */
+export const TranslatorTypes: Readonly<{
+    NODE: "node";
+    ATTRIBUTE: "attribute";
+}>;
+/**
+ * @typedef {keyof typeof TranslatorTypes} TranslatorTypeKey
+ * @typedef {typeof TranslatorTypes[TranslatorTypeKey]} TranslatorType
+ * @typedef {string} XmlNodeName
+ * @typedef {string|string[]} SuperDocNodeOrKeyName
+ */
+/**
+ * @typedef {Object} AttrConfig
+ * @property {string} xmlName - The name of the attribute in OOXML
+ * @property {string} sdName - The name of the attribute in SuperDoc
+ * @property {Function} [encode] - Function to encode the attribute from OOXML to SuperDoc
+ * @property {Function} [decode] - Function to decode the attribute from SuperDoc to OOXML
+ */
+/** @typedef {import('../../v2/importer/types').NodeHandlerParams} SCEncoderConfig */
+/** @typedef {import('../../v2/types').SuperDocNode} SCEncoderResult */
+/**
+ * @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
+ * @param {SCEncoderConfig} params
+ * @param {EncodedAttributes} [encodedAttrs]
+ * @returns {import('../../v2/types').SuperDocNode}
+ */
+/**
+ * @callback NodeTranslatorDecodeFn
+ * @param {SCDecoderConfig} params
+ * @param {DecodedAttributes} [decodedAttrs]
+ * @returns {import('../../v2/types').OpenXmlNode}
+ */
+/** @callback MatchesEncodeFn @param {any[]} nodes @param {any} [ctx] @returns {boolean} */
+/** @callback MatchesDecodeFn @param {any} node @param {any} [ctx] @returns {boolean} */
+/**
+ * @typedef {Object} EncodedAttributes
+ */
+/**
+ * @typedef {Object} DecodedAttributes
+ */
+/**
+ * @typedef {Object} NodeTranslatorConfig
+ * @property {string} xmlName - The name of the node in OOXML
+ * @property {SuperDocNodeOrKeyName} sdNodeOrKeyName - The name of the node in SuperDoc
+ * @property {TranslatorType} [type="node"] - The type of the translator.
+ * @property {NodeTranslatorEncodeFn} encode - The function to encode the data.
+ * @property {NodeTranslatorDecodeFn} [decode] - The function to decode the data.
+ * @property {number} [priority] - The priority of the handler.
+ * @property {AttrConfig[]} [attributes] - Attribute handlers list.
+ * @property {MatchesEncodeFn} [matchesEncode] - The function to check if the handler can encode the data.
+ * @property {MatchesDecodeFn} [matchesDecode] - The function to check if the handler can decode the data.
+ */
+export class NodeTranslator {
+    /** @type {typeof TranslatorTypes} */
+    static translatorTypes: typeof TranslatorTypes;
+    /**
+     * Create a new NodeTranslator instance from a configuration object.
+     * @param {NodeTranslatorConfig} config - The configuration object.
+     * @returns {NodeTranslator} The created NodeTranslator instance.
+     */
+    static from(config: NodeTranslatorConfig): NodeTranslator;
+    /**
+     * @param {string} xmlName
+     * @param {SuperDocNodeOrKeyName} sdNodeOrKeyName
+     * @param {NodeTranslatorEncodeFn} encode
+     * @param {NodeTranslatorDecodeFn} decode
+     * @param {number} [priority]
+     * @param {MatchesEncodeFn} [matchesEncode]
+     * @param {MatchesDecodeFn} [matchesDecode]
+     * @param {AttrConfig[]} [attributes]
+     */
+    constructor(xmlName: string, sdNodeOrKeyName: SuperDocNodeOrKeyName, encode: NodeTranslatorEncodeFn, decode: NodeTranslatorDecodeFn, priority?: number, matchesEncode?: MatchesEncodeFn, matchesDecode?: MatchesDecodeFn, attributes?: AttrConfig[]);
+    /** @type {string} */
+    xmlName: string;
+    /** @type {SuperDocNodeOrKeyName} */
+    sdNodeOrKeyName: SuperDocNodeOrKeyName;
+    /** @type {number} */
+    priority: number;
+    /** @type {NodeTranslatorEncodeFn} */
+    encodeFn: NodeTranslatorEncodeFn;
+    /** @type {NodeTranslatorDecodeFn} */
+    decodeFn: NodeTranslatorDecodeFn;
+    /** @type {MatchesEncodeFn} */
+    matchesEncode: MatchesEncodeFn;
+    /** @type {MatchesDecodeFn} */
+    matchesDecode: MatchesDecodeFn;
+    /** @type {AttrConfig[]} */
+    attributes: AttrConfig[];
+    /**
+     * Encode the attributes for the node.
+     * @param {SCEncoderConfig} params
+     * @returns {Object} Encoded attributes object.
+     */
+    encodeAttributes(params: SCEncoderConfig): any;
+    /**
+     * Decode the attributes for the node.
+     * @param {SCDecoderConfig} params
+     * @returns {Object} Decoded attributes object.
+     */
+    decodeAttributes(params: SCDecoderConfig): any;
+    /**
+     * Decode the attributes for the node.
+     * @param {SCDecoderConfig} params
+     * @returns {Object} Decoded attributes object.
+     */
+    decode(params: SCDecoderConfig): any;
+    /**
+     * Encode the attributes for the node.
+     * @param {SCEncoderConfig} params
+     * @returns {Object} Encoded attributes object.
+     */
+    encode(params: SCEncoderConfig): any;
+    /**
+     * Convert the NodeTranslator instance to a string representation.
+     * @returns {string} - The string representation of the NodeTranslator instance.
+     */
+    toString(): string;
+}
+export type TranslatorTypeKey = keyof typeof TranslatorTypes;
+export type TranslatorType = (typeof TranslatorTypes)[TranslatorTypeKey];
+export type XmlNodeName = string;
+export type SuperDocNodeOrKeyName = string | string[];
+export type AttrConfig = {
+    /**
+     * - The name of the attribute in OOXML
+     */
+    xmlName: string;
+    /**
+     * - The name of the attribute in SuperDoc
+     */
+    sdName: string;
+    /**
+     * - Function to encode the attribute from OOXML to SuperDoc
+     */
+    encode?: Function;
+    /**
+     * - Function to decode the attribute from SuperDoc to OOXML
+     */
+    decode?: Function;
+};
+export type SCEncoderConfig = import("../../v2/importer/types").NodeHandlerParams;
+export type SCEncoderResult = import("../../v2/types").SuperDocNode;
+export type SCDecoderConfig = {
+    node: {
+        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;
+    attributes?: any;
+    elements: any[];
+};
+export type NodeTranslatorEncodeFn = (params: SCEncoderConfig, encodedAttrs?: EncodedAttributes) => import("../../v2/types").SuperDocNode;
+export type NodeTranslatorDecodeFn = (params: SCDecoderConfig, decodedAttrs?: DecodedAttributes) => import("../../v2/types").OpenXmlNode;
+export type MatchesEncodeFn = (nodes: any[], ctx?: any) => boolean;
+export type MatchesDecodeFn = (node: any, ctx?: any) => boolean;
+export type EncodedAttributes = any;
+export type DecodedAttributes = any;
+export type NodeTranslatorConfig = {
+    /**
+     * - The name of the node in OOXML
+     */
+    xmlName: string;
+    /**
+     * - The name of the node in SuperDoc
+     */
+    sdNodeOrKeyName: SuperDocNodeOrKeyName;
+    /**
+     * - The type of the translator.
+     */
+    type?: TranslatorType;
+    /**
+     * - The function to encode the data.
+     */
+    encode: NodeTranslatorEncodeFn;
+    /**
+     * - The function to decode the data.
+     */
+    decode?: NodeTranslatorDecodeFn;
+    /**
+     * - The priority of the handler.
+     */
+    priority?: number;
+    /**
+     * - Attribute handlers list.
+     */
+    attributes?: AttrConfig[];
+    /**
+     * - The function to check if the handler can encode the data.
+     */
+    matchesEncode?: MatchesEncodeFn;
+    /**
+     * - The function to check if the handler can decode the data.
+     */
+    matchesDecode?: MatchesDecodeFn;
+};

package/dist/super-editor/src/core/super-converter/zipper.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Take a list of blobs and file names and create a zip file
+ * @param {Array[Blob]} blobs List of blobs to zip
+ * @param {Array[string]} fileNames List of file names to zip
+ * @returns {Promise<Blob>} The zipped file
+ */
+export function createZip(blobs: any, fileNames: any): Promise<Blob>;

package/dist/super-editor/src/core/super-validator/index.d.ts

@@ -0,0 +1 @@
+export * from "./super-validator.js";

package/dist/super-editor/src/core/super-validator/logger/index.d.ts

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

package/dist/super-editor/src/core/super-validator/logger/logger.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Create special debug logger for SuperValidator and validators.
+ * @param {boolean} debug
+ * @param {string[]} [additionalPrefixes]
+ * @returns {import('../types.js').ValidatorLogger}
+ */
+export function createLogger(debug: boolean, additionalPrefixes?: string[]): import("../types.js").ValidatorLogger;

package/dist/super-editor/src/core/super-validator/super-validator.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @typedef {import('./types.js').ElementInfo} ElementInfo
+ * @typedef {import('./types.js').DocumentAnalysis} DocumentAnalysis
+ * @typedef {import('./types.js').ValidatorFunction} ValidatorFunction
+ * @typedef {import('./types.js').ValidatorRequirements} ValidatorRequirements
+ * @typedef {import('./types.js').SuperValidatorOptions} SuperValidatorOptions
+ * @typedef {import('./types.js').Editor} Editor
+ * @typedef {import('./types.js').ValidatorLogger} ValidatorLogger
+ * @typedef {import('./types.js').StateValidator} StateValidator
+ * @typedef {import('prosemirror-model').Mark} Mark
+ * @typedef {import('prosemirror-model').Node} Node
+ */
+/**
+ * Main class for validating XML documents in the Super Editor.
+ */
+export class SuperValidator {
+    /**
+     * Create a SuperValidator instance.
+     * @param {SuperValidatorOptions} options - Options for the validator.
+     */
+    constructor(options: SuperValidatorOptions);
+    dryRun: boolean;
+    debug: boolean;
+    logger: import("./types.js").ValidatorLogger;
+    /**
+     * Validate the active document in the editor. Triggered automatically on editor initialization.
+     * @returns {{ modified: boolean, results: Array<{ key: string, results: string[] }> }}
+     */
+    validateActiveDocument(): {
+        modified: boolean;
+        results: Array<{
+            key: string;
+            results: string[];
+        }>;
+    };
+    /**
+     * Validate the exported document in the editor. Triggered automatically on editor export.
+     * @returns {{ modified: boolean, results: Array<{ key: string, results: string[] }> }}
+     */
+    validateDocumentExport(): {
+        modified: boolean;
+        results: Array<{
+            key: string;
+            results: string[];
+        }>;
+    };
+    #private;
+}
+export type ElementInfo = import("./types.js").ElementInfo;
+export type DocumentAnalysis = import("./types.js").DocumentAnalysis;
+export type ValidatorFunction = import("./types.js").ValidatorFunction;
+export type ValidatorRequirements = import("./types.js").ValidatorRequirements;
+export type SuperValidatorOptions = import("./types.js").SuperValidatorOptions;
+export type Editor = import("./types.js").Editor;
+export type ValidatorLogger = import("./types.js").ValidatorLogger;
+export type StateValidator = import("./types.js").StateValidator;
+export type Mark = import("prosemirror-model").Mark;
+export type Node = import("prosemirror-model").Node;

package/dist/super-editor/src/core/super-validator/types.d.ts

@@ -0,0 +1,61 @@
+export type Editor = import("../Editor.js").Editor;
+export type SuperValidatorOptions = {
+    /**
+     * The editor instance to validate.
+     */
+    editor: Editor;
+    /**
+     * If true, the validator will not modify the document.
+     */
+    dryRun?: boolean;
+    /**
+     * If true, debug information will be logged to the console.
+     */
+    debug?: boolean;
+};
+export type ValidatorLogger = {
+    /**
+     * - Function to log debug messages.
+     */
+    debug: (arg0: string, ...args: any[]) => void;
+    /**
+     * - Function to create a new logger with an additional prefix.
+     */
+    withPrefix: (arg0: string) => ValidatorLogger;
+};
+export type StateValidator = Function;
+export type XmlValidator = Function;
+export type ElementInfo = {
+    node?: import("prosemirror-model").Node;
+    pos: number;
+    /**
+     * - For marks
+     */
+    from?: number;
+    /**
+     * - For marks
+     */
+    to?: number;
+    /**
+     * - For marks
+     */
+    mark?: import("prosemirror-model").Mark;
+};
+export type DocumentAnalysis = Record<string, ElementInfo[]>;
+export type ValidatorRequirements = {
+    /**
+     * - Node types this validator needs
+     */
+    nodes?: string[];
+    /**
+     * - Mark types this validator needs
+     */
+    marks?: string[];
+};
+export type ValidatorFn = (arg0: import("prosemirror-state").Transaction, arg1: DocumentAnalysis) => {
+    modified: boolean;
+    results: string[];
+};
+export type ValidatorFunction = ValidatorFn & {
+    requiredElements?: ValidatorRequirements;
+};

package/dist/super-editor/src/core/super-validator/validators/state/index.d.ts

@@ -0,0 +1,16 @@
+export type StateValidators = {
+    /**
+     * - Validator for image nodes.
+     */
+    imageNodeValidator: import("../../types.js").StateValidator;
+    /**
+     * - Validator for link marks.
+     */
+    linkMarkValidator: import("../../types.js").StateValidator;
+};
+export namespace StateValidators {
+    export { createImageNodeValidator as imageNodeValidator };
+    export { createLinkMarkValidator as linkMarkValidator };
+}
+import { createImageNodeValidator } from './nodes/image/image-validator.js';
+import { createLinkMarkValidator } from './nodes/link/link-validator.js';

package/dist/super-editor/src/core/super-validator/validators/state/nodes/image/image-validator.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @typedef {import('prosemirror-model').Node} Node
+ * @typedef {import('prosemirror-state').Transaction} Transaction
+ * @typedef {import('../../../../types.js').ValidatorLogger} ValidatorLogger
+ * @typedef {import('../../../../types.js').Editor} Editor
+ * @typedef {import('../../../../types.js').ValidatorFunction} ValidatorFunction
+ * @typedef {import('../../../../types.js').ElementInfo} ElementInfo
+ */
+/**
+ * Image node validations
+ *
+ * 1. Ensure that every image node has a valid rId attribute.
+ *
+ * @param {{ editor: Editor, logger: ValidatorLogger }} ctx
+ * @returns {ValidatorFunction}
+ */
+export function createImageNodeValidator({ editor, logger }: {
+    editor: Editor;
+    logger: ValidatorLogger;
+}): ValidatorFunction;
+export type Node = import("prosemirror-model").Node;
+export type Transaction = import("prosemirror-state").Transaction;
+export type ValidatorLogger = import("../../../../types.js").ValidatorLogger;
+export type Editor = import("../../../../types.js").Editor;
+export type ValidatorFunction = import("../../../../types.js").ValidatorFunction;
+export type ElementInfo = import("../../../../types.js").ElementInfo;

package/dist/super-editor/src/core/super-validator/validators/state/nodes/image/index.d.ts

@@ -0,0 +1 @@
+export * from "./image-validator.js";

package/dist/super-editor/src/core/super-validator/validators/state/nodes/image/rules/image-rid.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @typedef {import('prosemirror-state').Transaction} Transaction
+ * @typedef {import('../../../../../types.js').ValidatorLogger} ValidatorLogger
+ * @typedef {import('../../../../../types.js').Editor} Editor
+ * @typedef {import('../../../../../types.js').ElementInfo} ElementInfo
+ */
+/**
+ * Ensure all image nodes have a valid rId attribute.
+ * @param {ElementInfo[]} images
+ * @param {Editor} editor
+ * @param {Transaction} tr
+ * @param {ValidatorLogger} logger
+ * @returns {{ modified: boolean, results: string[] }}
+ */
+export function ensureValidImageRID(images: ElementInfo[], editor: Editor, tr: Transaction, logger: ValidatorLogger): {
+    modified: boolean;
+    results: string[];
+};
+export type Transaction = import("prosemirror-state").Transaction;
+export type ValidatorLogger = import("../../../../../types.js").ValidatorLogger;
+export type Editor = import("../../../../../types.js").Editor;
+export type ElementInfo = import("../../../../../types.js").ElementInfo;

package/dist/super-editor/src/core/super-validator/validators/state/nodes/image/rules/index.d.ts

@@ -0,0 +1 @@
+export * from "./image-rid.js";

package/dist/super-editor/src/core/super-validator/validators/state/nodes/link/index.d.ts

@@ -0,0 +1 @@
+export * from "./link-validator.js";

package/dist/super-editor/src/core/super-validator/validators/state/nodes/link/link-validator.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @typedef {import('prosemirror-state').Transaction} Transaction
+ * @typedef {import('../../../../types.js').ValidatorLogger} ValidatorLogger
+ * @typedef {import('../../../../types.js').Editor} Editor
+ * @typedef {import('../../../../types.js').ValidatorFunction} ValidatorFunction
+ * @typedef {import('../../../../types.js').ElementInfo} ElementInfo
+ */
+/**
+ * Link mark validations
+ *
+ * 1. Ensure that every link mark has a valid rId attribute.
+ *
+ * @param {{ editor: Editor, logger: ValidatorLogger }} ctx
+ * @returns {ValidatorFunction}
+ */
+export function createLinkMarkValidator({ editor, logger }: {
+    editor: Editor;
+    logger: ValidatorLogger;
+}): ValidatorFunction;
+export type Transaction = import("prosemirror-state").Transaction;
+export type ValidatorLogger = import("../../../../types.js").ValidatorLogger;
+export type Editor = import("../../../../types.js").Editor;
+export type ValidatorFunction = import("../../../../types.js").ValidatorFunction;
+export type ElementInfo = import("../../../../types.js").ElementInfo;

package/dist/super-editor/src/core/super-validator/validators/state/nodes/link/rules/index.d.ts

@@ -0,0 +1 @@
+export * from "./link-rid.js";

package/dist/super-editor/src/core/super-validator/validators/state/nodes/link/rules/link-rid.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @typedef {import('prosemirror-state').Transaction} Transaction
+ * @typedef {import('../../../../../types.js').ValidatorLogger} ValidatorLogger
+ * @typedef {import('../../../../../types.js').Editor} Editor
+ * @typedef {import('../../../../../types.js').ValidatorFunction} ValidatorFunction
+ * @typedef {import('../../../../../types.js').ElementInfo} ElementInfo
+ */
+/**
+ * Ensure all link marks have a valid rId attribute.
+ * @param {ElementInfo[]} links
+ * @param {Editor} editor
+ * @param {Transaction} tr
+ * @param {ValidatorLogger} logger
+ * @returns {{ modified: boolean, results: string[] }}
+ */
+export function ensureValidLinkRID(links: ElementInfo[], editor: Editor, tr: Transaction, logger: ValidatorLogger): {
+    modified: boolean;
+    results: string[];
+};
+export type Transaction = import("prosemirror-state").Transaction;
+export type ValidatorLogger = import("../../../../../types.js").ValidatorLogger;
+export type Editor = import("../../../../../types.js").Editor;
+export type ValidatorFunction = import("../../../../../types.js").ValidatorFunction;
+export type ElementInfo = import("../../../../../types.js").ElementInfo;

package/dist/super-editor/src/core/super-validator/validators/xml/index.d.ts

@@ -0,0 +1,12 @@
+export namespace XmlValidators {
+    export { createNumberingValidator as numberingValidator };
+    export { createRelationshipsValidator as relationshipsValidator };
+}
+export type XmlValidator = {
+    /**
+     * - Validator for numbering.xml file.
+     */
+    numberingValidator: import("../../types.js").XmlValidator;
+};
+import { createNumberingValidator } from './numbering/numbering-validator.js';
+import { createRelationshipsValidator } from './relationships/relationships-validator.js';

package/dist/super-editor/src/core/super-validator/validators/xml/numbering/numbering-validator.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @typedef {import('../../../types.js').Editor} Editor
+ * @typedef {import('../../../types.js').ValidatorLogger} ValidatorLogger
+ */
+export function createNumberingValidator({ editor, logger }: {
+    editor: any;
+    logger: any;
+}): () => {
+    results: string[];
+    modified: boolean;
+};
+export type Editor = import("../../../types.js").Editor;
+export type ValidatorLogger = import("../../../types.js").ValidatorLogger;

package/dist/super-editor/src/core/super-validator/validators/xml/relationships/relationships-validator.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Creates a validator for Word document relationships (word/_rels/document.xml.rels)
+ *
+ * This validator ensures the relationships file is properly structured and contains
+ * valid relationship entries that reference existing files and follow Word's conventions.
+ *
+ * @typedef {import('../../../types.js').Editor} Editor
+ * @typedef {import('../../../types.js').ValidatorLogger} ValidatorLogger
+ * @param {Object} params - Validator parameters
+ * @param {Editor} params.editor - The editor instance containing the document
+ * @param {ValidatorLogger} params.logger - Logger for validation messages
+ * @returns {Function} Validator function that returns {results: string[], modified: boolean}
+ */
+export function createRelationshipsValidator({ editor, logger }: {
+    editor: Editor;
+    logger: ValidatorLogger;
+}): Function;
+/**
+ * Creates a validator for Word document relationships (word/_rels/document.xml.rels)
+ *
+ * This validator ensures the relationships file is properly structured and contains
+ * valid relationship entries that reference existing files and follow Word's conventions.
+ */
+export type Editor = import("../../../types.js").Editor;
+/**
+ * Creates a validator for Word document relationships (word/_rels/document.xml.rels)
+ *
+ * This validator ensures the relationships file is properly structured and contains
+ * valid relationship entries that reference existing files and follow Word's conventions.
+ */
+export type ValidatorLogger = import("../../../types.js").ValidatorLogger;

package/dist/super-editor/src/core/types/index.d.ts

@@ -0,0 +1,128 @@
+export type EditorNodeConfig = {
+    /**
+     * The node name.
+     */
+    name: string;
+    /**
+     * The node group.
+     */
+    group?: string;
+    /**
+     * The node options.
+     */
+    options?: any;
+    /**
+     * Whether the node is an atom node.
+     */
+    atom?: boolean;
+    /**
+     * Whether the node is draggable.
+     */
+    draggable?: boolean;
+    /**
+     * Whether the node is isolating.
+     */
+    isolating?: boolean;
+    /**
+     * Whether the node is defining.
+     */
+    defining?: boolean;
+    /**
+     * Whether the node is a top-level node.
+     */
+    topNode?: boolean;
+    /**
+     * The role of the node in a table.
+     */
+    tableRole?: string;
+    /**
+     * ProseMirror string for what content this node accepts.
+     */
+    content?: Function | string;
+    /**
+     * The marks applied to this node.
+     */
+    marks?: string;
+    /**
+     * Whether the node is an inline node.
+     */
+    inline?: boolean;
+    /**
+     * Whether the node is selectable.
+     */
+    selectable?: boolean;
+    /**
+     * The node type.
+     */
+    type?: import("prosemirror-model").NodeType;
+    /**
+     * The editor instance.
+     */
+    editor?: import("../Editor").Editor;
+    /**
+     * The DOM parsing rules.
+     */
+    parseDOM?: Function;
+    /**
+     * The DOM rendering function.
+     */
+    renderDOM?: Function;
+    /**
+     * Function or object to add options to the node.
+     */
+    addOptions?: Function;
+    /**
+     * Function or object to add storage to the node.
+     */
+    addStorage?: Function;
+    /**
+     * Function or object to add attributes to the node.
+     */
+    addAttributes?: Function;
+    /**
+     * Function or object to add commands to the node.
+     */
+    addCommands?: Function;
+    /**
+     * Function or object to add helpers to the node.
+     */
+    addHelpers?: Function;
+    /**
+     * Function or object to add shortcuts to the node.
+     */
+    addShortcuts?: Function;
+    /**
+     * Function or object to add input rules to the node.
+     */
+    addInputRules?: Function;
+    /**
+     * Function to add a custom node view to the node.
+     */
+    addNodeView?: Function;
+    /**
+     * Function to add ProseMirror plugins to the node.
+     */
+    addPmPlugins?: Function;
+    /**
+     * Function to extend the ProseMirror node schema.
+     */
+    extendNodeSchema?: Function;
+};
+export type EditorNodeOptions = any;
+export type EditorNodeStorage = any;
+/**
+ * Config required to construct an OxmlNode
+ * (extends EditorNodeConfig)
+ */
+export type OxmlNodeConfig = EditorNodeConfig & {
+    oXmlName: string;
+    childToAttributes: string[];
+};
+/**
+ * Runtime shape of an OxmlNode instance
+ * (extends EditorNode)
+ */
+export type OxmlNode = import("../Node").Node & {
+    oXmlName: string;
+    readonly validChildren: string[];
+};