superdoc 0.20.0-next.13

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

@@ -0,0 +1,171 @@
+/**
+ * @typedef {Object} ExportParams
+ * @property {Object} node JSON node to translate (from PM schema)
+ * @property {Object} bodyNode The stored body node to restore, if available
+ * @property {Object[]} relationships The relationships to add to the document
+ */
+/**
+ * @typedef {Object} SchemaNode
+ * @property {string} type The name of this node from the prose mirror schema
+ * @property {Array<SchemaNode>} content The child nodes
+ * @property {Object} attrs The node attributes
+ * /
+
+/**
+ * @typedef {Object} XmlReadyNode
+ * @property {string} name The XML tag name
+ * @property {Array<XmlReadyNode>} elements The child nodes
+ * @property {Object} [attributes] The node attributes
+ */
+/**
+ * @typedef {Object.<string, *>} SchemaAttributes
+ * Key value pairs representing the node attributes from prose mirror
+ */
+/**
+ * @typedef {Object.<string, *>} XmlAttributes
+ * Key value pairs representing the node attributes to export to XML format
+ */
+/**
+ * @typedef {Object} MarkType
+ * @property {string} type The mark type
+ * @property {Object} attrs Any attributes for this mark
+ */
+/**
+ * Main export function. It expects the prose mirror data as JSON (ie: a doc node)
+ *
+ * @param {ExportParams} params - The parameters object, containing a node and possibly a body node
+ * @returns {XmlReadyNode} The complete document node in XML-ready format
+ */
+export function exportSchemaToJson(params: ExportParams): XmlReadyNode;
+/**
+ * Translate a paragraph node
+ *
+ * @param {ExportParams} node A prose mirror paragraph node
+ * @returns {XmlReadyNode} JSON of the XML-ready paragraph node
+ */
+export function translateParagraphNode(params: any): XmlReadyNode;
+/**
+ * Helper function to be used for text node translation
+ * Also used for transforming text annotations for the final submit
+ *
+ * @param {String} text Text node's content
+ * @param {Object[]} marks The marks to add to the run properties
+ * @returns {XmlReadyNode} The translated text node
+ */
+export function getTextNodeForExport(text: string, marks: any[], params: any): XmlReadyNode;
+/**
+ * Wrap a text node in a run
+ *
+ * @param {XmlReadyNode} node
+ * @returns {XmlReadyNode} The wrapped run node
+ */
+export function wrapTextInRun(nodeOrNodes: any, marks: any): XmlReadyNode;
+/**
+ * Generate a w:rPr node (run properties) from marks
+ *
+ * @param {Object[]} marks The marks to add to the run properties
+ * @returns
+ */
+export function generateRunProps(marks?: any[]): {
+    name: string;
+    elements: any[];
+};
+/**
+ * Get all marks as a list of MarkType objects
+ *
+ * @param {MarkType[]} marks
+ * @returns
+ */
+export function processOutputMarks(marks?: MarkType[]): any[];
+export function processLinkContentNode(node: any): any;
+/**
+ * Create a new link relationship and add it to the relationships array
+ *
+ * @param {ExportParams} params
+ * @param {string} link The URL of this link
+ * @returns {string} The new relationship ID
+ */
+export function addNewLinkRelationship(params: ExportParams, link: string): string;
+export function translateHardBreak(params: any): {
+    name: string;
+    elements: {
+        name: string;
+        type: string;
+        attributes: {
+            'w:type': string;
+        };
+    }[];
+};
+export class DocxExporter {
+    constructor(converter: any);
+    converter: any;
+    schemaToXml(data: any, debug?: boolean): string;
+    #private;
+}
+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[];
+};
+export type SchemaNode = {
+    /**
+     * The name of this node from the prose mirror schema
+     */
+    type: string;
+    /**
+     * The child nodes
+     */
+    content: Array<SchemaNode>;
+    /**
+     * The node attributes
+     * /
+     *
+     * /**
+     */
+    attrs: any;
+};
+export type XmlReadyNode = {
+    /**
+     * The XML tag name
+     */
+    name: string;
+    /**
+     * The child nodes
+     */
+    elements: Array<XmlReadyNode>;
+    /**
+     * The node attributes
+     */
+    attributes?: any;
+};
+/**
+ * Key value pairs representing the node attributes from prose mirror
+ */
+export type SchemaAttributes = {
+    [x: string]: any;
+};
+/**
+ * Key value pairs representing the node attributes to export to XML format
+ */
+export type XmlAttributes = {
+    [x: string]: any;
+};
+export type MarkType = {
+    /**
+     * The mark type
+     */
+    type: string;
+    /**
+     * Any attributes for this mark
+     */
+    attrs: any;
+};

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

@@ -0,0 +1,2 @@
+export function sanitizeDocxMediaName(value: any, fallback?: string): any;
+export function getFallbackImageNameFromDataUri(src?: string, fallback?: string): string;

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

@@ -0,0 +1,35 @@
+export function inchesToTwips(inches: any): number;
+export function twipsToInches(twips: any): number;
+export function twipsToPixels(twips: any): number;
+export function pixelsToTwips(pixels: any): number;
+export function twipsToLines(twips: any): number;
+export function linesToTwips(lines: any): number;
+export function halfPointToPixels(halfPoints: any): number;
+export function emuToPixels(emu: any): number;
+export function pixelsToEmu(px: any): number;
+export function pixelsToHalfPoints(pixels: any): number;
+export function halfPointToPoints(halfPoints: any): number;
+export function eigthPointsToPixels(eigthPoints: any): number;
+export function pixelsToEightPoints(pixels: any): number;
+export function rotToDegrees(rot: any): number;
+export function degreesToRot(degrees: any): number;
+export function getArrayBufferFromUrl(input: any, isHeadless: any): Promise<ArrayBuffer>;
+export function getContentTypesFromXml(contentTypesXml: any): string[];
+export function getHexColorFromDocxSystem(docxColor: any): string;
+export function isValidHexColor(color: any): boolean;
+export function rgbToHex(rgb: any): string;
+export function ptToTwips(pt: any): number;
+export function twipsToPt(twips: any): number;
+export function getLineHeightValueString(lineHeight: any, defaultUnit: any, lineRule?: string, isObject?: boolean): string | {
+    "line-height"?: undefined;
+} | {
+    "line-height": string;
+};
+export function deobfuscateFont(arrayBuffer: any, guidHex: any): any;
+export function hasSomeParentWithClass(element: any, classname: any): any;
+/**
+ * Get the export value for text indent
+ * @param {string|number} indent - The text indent value to export
+ * @returns {number} - The export value in twips
+ */
+export function getTextIndentExportValue(indent: string | number): number;

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

@@ -0,0 +1,3 @@
+export type Editor = import("../Editor.js").Editor;
+export type RelationshipType = import("./docx-helpers/docx-constants.js").RelationshipType;
+export type XmlRelationshipElement = any;

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

@@ -0,0 +1,12 @@
+export function docxAsXmlFileList2ParsedDocx(docxAsXmlFileList: {
+    name: string;
+    content: string;
+}[]): ParsedDocx;
+export function parseXmlToJson(xml: any): any;
+export function getInitialJSON(parsedDocx: ParsedDocx, fallbackXml?: string): any;
+/**
+ * this should have the `media` as a key for image handling
+ */
+export type ParsedDocx = {
+    [x: string]: XmlNode;
+};

package/dist/super-editor/src/core/super-converter/v2/exporter/commentsExporter.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generate the end node for a comment
+ *
+ * @param {Object} params The export params
+ * @returns {Object} The translated w:commentRangeEnd node for the comment
+ */
+export function translateCommentNode(params: any, type: any): any;
+export function prepareCommentParaIds(comment: any): any;
+export function getCommentDefinition(comment: any, commentId: string, allComments: any, editor: any): any;
+export function getInitials(name: string): string | null;
+export function toIsoNoFractional(unixMillis: number): string;
+export function updateCommentsXml(commentDefs: any[], commentsXml: any): any;
+export function updateCommentsExtendedXml(comments: any, commentsExtendedXml: any): any;
+export function updateCommentsIdsAndExtensible(comments: any, commentsIds: any, extensible: any): any;
+export function updateDocumentRels(): any;
+export function generateConvertedXmlWithCommentFiles(convertedXml: any): any;
+export function getCommentsFilesConverted(converter: any, convertedXml: any): any;
+export function removeCommentsFilesFromConvertedXml(convertedXml: any): any;
+export function generateRelationship(target: string): any;
+export function prepareCommentsXmlFilesForExport({ convertedXml, defs, commentsWithParaIds, exportType }: any): {
+    documentXml: any;
+    relationships: any[];
+};

package/dist/super-editor/src/core/super-converter/v2/exporter/helpers/base-list.definitions.d.ts

@@ -0,0 +1,443 @@
+export namespace baseOrderedListDef {
+    let type: string;
+    let name: string;
+    let attributes: {
+        'w:abstractNumId': string;
+        'w15:restartNumberingAfterBreak': string;
+    };
+    let elements: ({
+        type: string;
+        name: string;
+        attributes: {
+            'w:val': string;
+            'w:ilvl'?: undefined;
+            'w:tplc'?: undefined;
+            'w:tentative'?: undefined;
+        };
+        elements?: undefined;
+    } | {
+        type: string;
+        name: string;
+        attributes: {
+            'w:ilvl': string;
+            'w:tplc': string;
+            'w:val'?: undefined;
+            'w:tentative'?: undefined;
+        };
+        elements: ({
+            type: string;
+            name: string;
+            attributes: {
+                'w:val': string;
+            };
+            elements?: undefined;
+        } | {
+            type: string;
+            name: string;
+            elements: {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:left': string;
+                    'w:hanging': string;
+                };
+            }[];
+            attributes?: undefined;
+        })[];
+    } | {
+        type: string;
+        name: string;
+        attributes: {
+            'w:ilvl': string;
+            'w:tplc': string;
+            'w:tentative': string;
+            'w:val'?: undefined;
+        };
+        elements: ({
+            type: string;
+            name: string;
+            attributes: {
+                'w:val': string;
+            };
+            elements?: undefined;
+        } | {
+            type: string;
+            name: string;
+            elements: {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:left': string;
+                    'w:hanging': string;
+                };
+            }[];
+            attributes?: undefined;
+        })[];
+    })[];
+}
+export namespace baseBulletList {
+    let type_1: string;
+    export { type_1 as type };
+    let name_1: string;
+    export { name_1 as name };
+    let attributes_1: {
+        'w:abstractNumId': string;
+        'w15:restartNumberingAfterBreak': string;
+    };
+    export { attributes_1 as attributes };
+    let elements_1: ({
+        type: string;
+        name: string;
+        attributes: {
+            'w:val': string;
+            'w:ilvl'?: undefined;
+            'w:tplc'?: undefined;
+            'w:tentative'?: undefined;
+        };
+        elements?: undefined;
+    } | {
+        type: string;
+        name: string;
+        attributes: {
+            'w:ilvl': string;
+            'w:tplc': string;
+            'w:val'?: undefined;
+            'w:tentative'?: undefined;
+        };
+        elements: ({
+            type: string;
+            name: string;
+            attributes: {
+                'w:val': string;
+            };
+            elements?: undefined;
+        } | {
+            type: string;
+            name: string;
+            elements: {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:left': string;
+                    'w:hanging': string;
+                };
+            }[];
+            attributes?: undefined;
+        } | {
+            type: string;
+            name: string;
+            elements: {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:ascii': string;
+                    'w:hAnsi': string;
+                    'w:hint': string;
+                };
+            }[];
+            attributes?: undefined;
+        })[];
+    } | {
+        type: string;
+        name: string;
+        attributes: {
+            'w:ilvl': string;
+            'w:tplc': string;
+            'w:tentative': string;
+            'w:val'?: undefined;
+        };
+        elements: ({
+            type: string;
+            name: string;
+            attributes: {
+                'w:val': string;
+            };
+            elements?: undefined;
+        } | {
+            type: string;
+            name: string;
+            elements: {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:left': string;
+                    'w:hanging': string;
+                };
+            }[];
+            attributes?: undefined;
+        } | {
+            type: string;
+            name: string;
+            elements: {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:ascii': string;
+                    'w:hAnsi': string;
+                    'w:cs': string;
+                    'w:hint': string;
+                };
+            }[];
+            attributes?: undefined;
+        })[];
+    } | {
+        type: string;
+        name: string;
+        attributes: {
+            'w:ilvl': string;
+            'w:tplc': string;
+            'w:tentative': string;
+            'w:val'?: undefined;
+        };
+        elements: ({
+            type: string;
+            name: string;
+            attributes: {
+                'w:val': string;
+            };
+            elements?: undefined;
+        } | {
+            type: string;
+            name: string;
+            elements: {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:left': string;
+                    'w:hanging': string;
+                };
+            }[];
+            attributes?: undefined;
+        } | {
+            type: string;
+            name: string;
+            elements: {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:ascii': string;
+                    'w:hAnsi': string;
+                    'w:hint': string;
+                };
+            }[];
+            attributes?: undefined;
+        })[];
+    })[];
+    export { elements_1 as elements };
+}
+export namespace baseNumbering {
+    export namespace declaration {
+        export namespace attributes_2 {
+            let version: string;
+            let encoding: string;
+            let standalone: string;
+        }
+        export { attributes_2 as attributes };
+    }
+    let elements_2: {
+        type: string;
+        name: string;
+        attributes: {
+            'xmlns:wpc': string;
+            'xmlns:cx': string;
+            'xmlns:cx1': string;
+            'xmlns:cx2': string;
+            'xmlns:cx3': string;
+            'xmlns:cx4': string;
+            'xmlns:cx5': string;
+            'xmlns:cx6': string;
+            'xmlns:cx7': string;
+            'xmlns:cx8': string;
+            'xmlns:mc': string;
+            'xmlns:aink': string;
+            'xmlns:am3d': string;
+            'xmlns:o': string;
+            'xmlns:oel': string;
+            'xmlns:r': string;
+            'xmlns:m': string;
+            'xmlns:v': string;
+            'xmlns:wp14': string;
+            'xmlns:wp': string;
+            'xmlns:w10': string;
+            'xmlns:w': string;
+            'xmlns:w14': string;
+            'xmlns:w15': string;
+            'xmlns:w16cex': string;
+            'xmlns:w16cid': string;
+            'xmlns:w16': string;
+            'xmlns:w16du': string;
+            'xmlns:w16sdtdh': string;
+            'xmlns:w16se': string;
+            'xmlns:wpg': string;
+            'xmlns:wpi': string;
+            'xmlns:wne': string;
+            'xmlns:wps': string;
+            'mc:Ignorable': string;
+        };
+        elements: ({
+            type: string;
+            name: string;
+            attributes: {
+                'w:abstractNumId': string;
+                'w15:restartNumberingAfterBreak': string;
+                'w:numId'?: undefined;
+                'w16cid:durableId'?: undefined;
+            };
+            elements: ({
+                type: string;
+                name: string;
+                attributes: {
+                    'w:val': string;
+                    'w:ilvl'?: undefined;
+                    'w:tplc'?: undefined;
+                    'w:tentative'?: undefined;
+                };
+                elements?: undefined;
+            } | {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:ilvl': string;
+                    'w:tplc': string;
+                    'w:val'?: undefined;
+                    'w:tentative'?: undefined;
+                };
+                elements: ({
+                    type: string;
+                    name: string;
+                    attributes: {
+                        'w:val': string;
+                    };
+                    elements?: undefined;
+                } | {
+                    type: string;
+                    name: string;
+                    elements: {
+                        type: string;
+                        name: string;
+                        attributes: {
+                            'w:left': string;
+                            'w:hanging': string;
+                        };
+                    }[];
+                    attributes?: undefined;
+                } | {
+                    type: string;
+                    name: string;
+                    elements: {
+                        type: string;
+                        name: string;
+                        attributes: {
+                            'w:ascii': string;
+                            'w:hAnsi': string;
+                            'w:hint': string;
+                        };
+                    }[];
+                    attributes?: undefined;
+                })[];
+            } | {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:ilvl': string;
+                    'w:tplc': string;
+                    'w:tentative': string;
+                    'w:val'?: undefined;
+                };
+                elements: ({
+                    type: string;
+                    name: string;
+                    attributes: {
+                        'w:val': string;
+                    };
+                    elements?: undefined;
+                } | {
+                    type: string;
+                    name: string;
+                    elements: {
+                        type: string;
+                        name: string;
+                        attributes: {
+                            'w:left': string;
+                            'w:hanging': string;
+                        };
+                    }[];
+                    attributes?: undefined;
+                } | {
+                    type: string;
+                    name: string;
+                    elements: {
+                        type: string;
+                        name: string;
+                        attributes: {
+                            'w:ascii': string;
+                            'w:hAnsi': string;
+                            'w:cs': string;
+                            'w:hint': string;
+                        };
+                    }[];
+                    attributes?: undefined;
+                })[];
+            } | {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:ilvl': string;
+                    'w:tplc': string;
+                    'w:tentative': string;
+                    'w:val'?: undefined;
+                };
+                elements: ({
+                    type: string;
+                    name: string;
+                    attributes: {
+                        'w:val': string;
+                    };
+                    elements?: undefined;
+                } | {
+                    type: string;
+                    name: string;
+                    elements: {
+                        type: string;
+                        name: string;
+                        attributes: {
+                            'w:left': string;
+                            'w:hanging': string;
+                        };
+                    }[];
+                    attributes?: undefined;
+                } | {
+                    type: string;
+                    name: string;
+                    elements: {
+                        type: string;
+                        name: string;
+                        attributes: {
+                            'w:ascii': string;
+                            'w:hAnsi': string;
+                            'w:hint': string;
+                        };
+                    }[];
+                    attributes?: undefined;
+                })[];
+            })[];
+        } | {
+            type: string;
+            name: string;
+            attributes: {
+                'w:numId': string;
+                'w16cid:durableId': string;
+                'w:abstractNumId'?: undefined;
+                'w15:restartNumberingAfterBreak'?: undefined;
+            };
+            elements: {
+                type: string;
+                name: string;
+                attributes: {
+                    'w:val': string;
+                };
+            }[];
+        })[];
+    }[];
+    export { elements_2 as elements };
+}

package/dist/super-editor/src/core/super-converter/v2/exporter/helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./translateChildNodes.js";
+export * from "./base-list.definitions.js";