@cj-tech-master/excelts 3.1.0 → 4.0.0-canary.20260103013222.0e5d37f

package/dist/esm/modules/excel/xlsx/xform/book/workbook-xform.js

@@ -0,0 +1,234 @@
+import { colCache } from "../../../utils/col-cache.js";
+import { XmlStream } from "../../../utils/xml-stream.js";
+import { BaseXform } from "../base-xform.js";
+import { StaticXform } from "../static-xform.js";
+import { ListXform } from "../list-xform.js";
+import { DefinedNamesXform } from "./defined-name-xform.js";
+import { WorksheetXform } from "./sheet-xform.js";
+import { WorkbookViewXform } from "./workbook-view-xform.js";
+import { WorkbookPropertiesXform } from "./workbook-properties-xform.js";
+import { WorkbookCalcPropertiesXform } from "./workbook-calc-properties-xform.js";
+import { WorkbookPivotCacheXform } from "./workbook-pivot-cache-xform.js";
+class WorkbookXform extends BaseXform {
+    constructor() {
+        super();
+        this.map = {
+            fileVersion: WorkbookXform.STATIC_XFORMS.fileVersion,
+            workbookPr: new WorkbookPropertiesXform(),
+            bookViews: new ListXform({
+                tag: "bookViews",
+                count: false,
+                childXform: new WorkbookViewXform()
+            }),
+            sheets: new ListXform({ tag: "sheets", count: false, childXform: new WorksheetXform() }),
+            definedNames: new ListXform({
+                tag: "definedNames",
+                count: false,
+                childXform: new DefinedNamesXform()
+            }),
+            calcPr: new WorkbookCalcPropertiesXform(),
+            pivotCaches: new ListXform({
+                tag: "pivotCaches",
+                count: false,
+                childXform: new WorkbookPivotCacheXform()
+            })
+        };
+    }
+    prepare(model) {
+        model.sheets = model.worksheets;
+        // collate all the print areas from all of the sheets and add them to the defined names
+        const printAreas = [];
+        let index = 0; // sheets is sparse array - calc index manually
+        model.sheets.forEach((sheet) => {
+            if (sheet.pageSetup && sheet.pageSetup.printArea) {
+                sheet.pageSetup.printArea.split("&&").forEach((printArea) => {
+                    const printAreaComponents = printArea.split(":");
+                    const definedName = {
+                        name: "_xlnm.Print_Area",
+                        ranges: [`'${sheet.name}'!$${printAreaComponents[0]}:$${printAreaComponents[1]}`],
+                        localSheetId: index
+                    };
+                    printAreas.push(definedName);
+                });
+            }
+            if (sheet.pageSetup &&
+                (sheet.pageSetup.printTitlesRow || sheet.pageSetup.printTitlesColumn)) {
+                const ranges = [];
+                if (sheet.pageSetup.printTitlesColumn) {
+                    const titlesColumns = sheet.pageSetup.printTitlesColumn.split(":");
+                    ranges.push(`'${sheet.name}'!$${titlesColumns[0]}:$${titlesColumns[1]}`);
+                }
+                if (sheet.pageSetup.printTitlesRow) {
+                    const titlesRows = sheet.pageSetup.printTitlesRow.split(":");
+                    ranges.push(`'${sheet.name}'!$${titlesRows[0]}:$${titlesRows[1]}`);
+                }
+                const definedName = {
+                    name: "_xlnm.Print_Titles",
+                    ranges,
+                    localSheetId: index
+                };
+                printAreas.push(definedName);
+            }
+            index++;
+        });
+        if (printAreas.length) {
+            model.definedNames = model.definedNames.concat(printAreas);
+        }
+        (model.media || []).forEach((medium, i) => {
+            // assign name
+            medium.name = medium.type + (i + 1);
+        });
+    }
+    render(xmlStream, model) {
+        xmlStream.openXml(XmlStream.StdDocAttributes);
+        xmlStream.openNode("workbook", WorkbookXform.WORKBOOK_ATTRIBUTES);
+        this.map.fileVersion.render(xmlStream);
+        this.map.workbookPr.render(xmlStream, model.properties);
+        this.map.bookViews.render(xmlStream, model.views);
+        this.map.sheets.render(xmlStream, model.sheets);
+        this.map.definedNames.render(xmlStream, model.definedNames);
+        this.map.calcPr.render(xmlStream, model.calcProperties);
+        this.map.pivotCaches.render(xmlStream, model.pivotTables);
+        xmlStream.closeNode();
+    }
+    parseOpen(node) {
+        if (this.parser) {
+            this.parser.parseOpen(node);
+            return true;
+        }
+        switch (node.name) {
+            case "workbook":
+                return true;
+            default:
+                this.parser = this.map[node.name];
+                if (this.parser) {
+                    this.parser.parseOpen(node);
+                }
+                return true;
+        }
+    }
+    parseText(text) {
+        if (this.parser) {
+            this.parser.parseText(text);
+        }
+    }
+    parseClose(name) {
+        if (this.parser) {
+            if (!this.parser.parseClose(name)) {
+                this.parser = undefined;
+            }
+            return true;
+        }
+        switch (name) {
+            case "workbook":
+                this.model = {
+                    sheets: this.map.sheets.model,
+                    properties: this.map.workbookPr.model || {},
+                    views: this.map.bookViews.model,
+                    calcProperties: {}
+                };
+                if (this.map.definedNames.model) {
+                    this.model.definedNames = this.map.definedNames.model;
+                }
+                if (this.map.pivotCaches.model && this.map.pivotCaches.model.length > 0) {
+                    this.model.pivotCaches = this.map.pivotCaches.model;
+                }
+                return false;
+            default:
+                // not quite sure how we get here!
+                return true;
+        }
+    }
+    reconcile(model) {
+        const rels = (model.workbookRels || []).reduce((map, rel) => {
+            map[rel.Id] = rel;
+            return map;
+        }, {});
+        // reconcile sheet ids, rIds and names
+        const worksheets = [];
+        let worksheet;
+        let index = 0;
+        (model.sheets || []).forEach((sheet) => {
+            const rel = rels[sheet.rId];
+            if (!rel) {
+                return;
+            }
+            // if rel.Target start with `[space]/xl/` or `/xl/` , then it will be replaced with `''` and spliced behind `xl/`,
+            // otherwise it will be spliced directly behind `xl/`. i.g.
+            worksheet = model.worksheetHash[`xl/${rel.Target.replace(/^(\s|\/xl\/)+/, "")}`];
+            // If there are "chartsheets" in the file, rel.Target will
+            // come out as chartsheets/sheet1.xml or similar here, and
+            // that won't be in model.worksheetHash.
+            // As we don't have the infrastructure to support chartsheets,
+            // we will ignore them for now:
+            if (worksheet) {
+                worksheet.name = sheet.name;
+                worksheet.id = sheet.id;
+                worksheet.state = sheet.state;
+                worksheets[index++] = worksheet;
+            }
+        });
+        // reconcile print areas
+        const definedNames = [];
+        if (model.definedNames) {
+            model.definedNames.forEach((definedName) => {
+                if (definedName.name === "_xlnm.Print_Area") {
+                    worksheet = worksheets[definedName.localSheetId];
+                    if (worksheet) {
+                        if (!worksheet.pageSetup) {
+                            worksheet.pageSetup = {};
+                        }
+                        const range = colCache.decodeEx(definedName.ranges[0]);
+                        worksheet.pageSetup.printArea = worksheet.pageSetup.printArea
+                            ? `${worksheet.pageSetup.printArea}&&${range.dimensions}`
+                            : range.dimensions;
+                    }
+                }
+                else if (definedName.name === "_xlnm.Print_Titles") {
+                    worksheet = worksheets[definedName.localSheetId];
+                    if (worksheet) {
+                        if (!worksheet.pageSetup) {
+                            worksheet.pageSetup = {};
+                        }
+                        const rangeString = definedName.ranges.join(",");
+                        const dollarRegex = /\$/g;
+                        const rowRangeRegex = /\$\d+:\$\d+/;
+                        const rowRangeMatches = rangeString.match(rowRangeRegex);
+                        if (rowRangeMatches && rowRangeMatches.length) {
+                            const range = rowRangeMatches[0];
+                            worksheet.pageSetup.printTitlesRow = range.replace(dollarRegex, "");
+                        }
+                        const columnRangeRegex = /\$[A-Z]+:\$[A-Z]+/;
+                        const columnRangeMatches = rangeString.match(columnRangeRegex);
+                        if (columnRangeMatches && columnRangeMatches.length) {
+                            const range = columnRangeMatches[0];
+                            worksheet.pageSetup.printTitlesColumn = range.replace(dollarRegex, "");
+                        }
+                    }
+                }
+                else {
+                    definedNames.push(definedName);
+                }
+            });
+        }
+        model.definedNames = definedNames;
+        // used by sheets to build their image models
+        model.media.forEach((media, i) => {
+            media.index = i;
+        });
+    }
+}
+WorkbookXform.WORKBOOK_ATTRIBUTES = {
+    xmlns: "http://schemas.openxmlformats.org/spreadsheetml/2006/main",
+    "xmlns:r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
+    "xmlns:mc": "http://schemas.openxmlformats.org/markup-compatibility/2006",
+    "mc:Ignorable": "x15",
+    "xmlns:x15": "http://schemas.microsoft.com/office/spreadsheetml/2010/11/main"
+};
+WorkbookXform.STATIC_XFORMS = {
+    fileVersion: new StaticXform({
+        tag: "fileVersion",
+        $: { appName: "xl", lastEdited: 5, lowestEdited: 5, rupBuild: 9303 }
+    })
+};
+export { WorkbookXform };

package/dist/esm/modules/excel/xlsx/xform/comment/comment-xform.js

@@ -0,0 +1,76 @@
+import { RichTextXform } from "../strings/rich-text-xform.js";
+import { BaseXform } from "../base-xform.js";
+class CommentXform extends BaseXform {
+    constructor(model) {
+        super();
+        this.model = model || { type: "note", note: { texts: [] }, ref: "" };
+    }
+    get tag() {
+        return "r";
+    }
+    get richTextXform() {
+        if (!this._richTextXform) {
+            this._richTextXform = new RichTextXform();
+        }
+        return this._richTextXform;
+    }
+    render(xmlStream, model) {
+        const renderModel = model || this.model;
+        xmlStream.openNode("comment", {
+            ref: renderModel.ref,
+            authorId: 0
+        });
+        xmlStream.openNode("text");
+        if (renderModel && renderModel.note && renderModel.note.texts) {
+            renderModel.note.texts.forEach(text => {
+                this.richTextXform.render(xmlStream, text);
+            });
+        }
+        xmlStream.closeNode();
+        xmlStream.closeNode();
+    }
+    parseOpen(node) {
+        if (this.parser) {
+            this.parser.parseOpen(node);
+            return true;
+        }
+        switch (node.name) {
+            case "comment":
+                this.model = {
+                    type: "note",
+                    note: {
+                        texts: []
+                    },
+                    ...node.attributes
+                };
+                return true;
+            case "r":
+                this.parser = this.richTextXform;
+                this.parser.parseOpen(node);
+                return true;
+            default:
+                return false;
+        }
+    }
+    parseText(text) {
+        if (this.parser) {
+            this.parser.parseText(text);
+        }
+    }
+    parseClose(name) {
+        switch (name) {
+            case "comment":
+                return false;
+            case "r":
+                this.model.note.texts.push(this.parser.model);
+                this.parser = undefined;
+                return true;
+            default:
+                if (this.parser) {
+                    this.parser.parseClose(name);
+                }
+                return true;
+        }
+    }
+}
+export { CommentXform };

package/dist/esm/modules/excel/xlsx/xform/comment/comments-xform.js

@@ -0,0 +1,72 @@
+import { XmlStream } from "../../../utils/xml-stream.js";
+import { BaseXform } from "../base-xform.js";
+import { CommentXform } from "./comment-xform.js";
+class CommentsXform extends BaseXform {
+    constructor() {
+        super();
+        this.map = {
+            comment: new CommentXform()
+        };
+        this.model = { comments: [] };
+    }
+    render(xmlStream, model) {
+        const renderModel = model || this.model;
+        xmlStream.openXml(XmlStream.StdDocAttributes);
+        xmlStream.openNode("comments", CommentsXform.COMMENTS_ATTRIBUTES);
+        // authors
+        // TODO: support authors properly
+        xmlStream.openNode("authors");
+        xmlStream.leafNode("author", null, "Author");
+        xmlStream.closeNode();
+        // comments
+        xmlStream.openNode("commentList");
+        renderModel.comments.forEach(comment => {
+            this.map.comment.render(xmlStream, comment);
+        });
+        xmlStream.closeNode();
+        xmlStream.closeNode();
+    }
+    parseOpen(node) {
+        if (this.parser) {
+            this.parser.parseOpen(node);
+            return true;
+        }
+        switch (node.name) {
+            case "commentList":
+                this.model = {
+                    comments: []
+                };
+                return true;
+            case "comment":
+                this.parser = this.map.comment;
+                this.parser.parseOpen(node);
+                return true;
+            default:
+                return false;
+        }
+    }
+    parseText(text) {
+        if (this.parser) {
+            this.parser.parseText(text);
+        }
+    }
+    parseClose(name) {
+        switch (name) {
+            case "commentList":
+                return false;
+            case "comment":
+                this.model.comments.push(this.parser.model);
+                this.parser = undefined;
+                return true;
+            default:
+                if (this.parser) {
+                    this.parser.parseClose(name);
+                }
+                return true;
+        }
+    }
+}
+CommentsXform.COMMENTS_ATTRIBUTES = {
+    xmlns: "http://schemas.openxmlformats.org/spreadsheetml/2006/main"
+};
+export { CommentsXform };

package/dist/esm/modules/excel/xlsx/xform/comment/style/vml-position-xform.js

@@ -0,0 +1,34 @@
+import { BaseXform } from "../../base-xform.js";
+class VmlPositionXform extends BaseXform {
+    constructor(model) {
+        super();
+        this._model = model || {};
+        this.model = {};
+    }
+    get tag() {
+        return (this._model && this._model.tag) || "";
+    }
+    render(xmlStream, model, type) {
+        if (type && model === type[2]) {
+            xmlStream.leafNode(this.tag);
+        }
+        else if (type && this.tag === "x:SizeWithCells" && model === type[1]) {
+            xmlStream.leafNode(this.tag);
+        }
+    }
+    parseOpen(node) {
+        switch (node.name) {
+            case this.tag:
+                this.model = {};
+                this.model[this.tag] = true;
+                return true;
+            default:
+                return false;
+        }
+    }
+    parseText() { }
+    parseClose() {
+        return false;
+    }
+}
+export { VmlPositionXform };

package/dist/esm/modules/excel/xlsx/xform/comment/style/vml-protection-xform.js

@@ -0,0 +1,30 @@
+import { BaseXform } from "../../base-xform.js";
+class VmlProtectionXform extends BaseXform {
+    constructor(model) {
+        super();
+        this._model = model || {};
+        this.text = "";
+    }
+    get tag() {
+        return (this._model && this._model.tag) || "";
+    }
+    render(xmlStream, model) {
+        xmlStream.leafNode(this.tag, null, model);
+    }
+    parseOpen(node) {
+        switch (node.name) {
+            case this.tag:
+                this.text = "";
+                return true;
+            default:
+                return false;
+        }
+    }
+    parseText(text) {
+        this.text = text;
+    }
+    parseClose() {
+        return false;
+    }
+}
+export { VmlProtectionXform };

package/dist/esm/modules/excel/xlsx/xform/comment/vml-anchor-xform.js

@@ -0,0 +1,55 @@
+import { BaseXform } from "../base-xform.js";
+// render the triangle in the cell for the comment
+class VmlAnchorXform extends BaseXform {
+    constructor() {
+        super();
+        this.text = "";
+    }
+    get tag() {
+        return "x:Anchor";
+    }
+    getAnchorRect(anchor) {
+        const l = Math.floor(anchor.left);
+        const lf = Math.floor((anchor.left - l) * 68);
+        const t = Math.floor(anchor.top);
+        const tf = Math.floor((anchor.top - t) * 18);
+        const r = Math.floor(anchor.right);
+        const rf = Math.floor((anchor.right - r) * 68);
+        const b = Math.floor(anchor.bottom);
+        const bf = Math.floor((anchor.bottom - b) * 18);
+        return [l, lf, t, tf, r, rf, b, bf];
+    }
+    getDefaultRect(ref) {
+        const l = ref.col;
+        const lf = 6;
+        const t = Math.max(ref.row - 2, 0);
+        const tf = 14;
+        const r = l + 2;
+        const rf = 2;
+        const b = t + 4;
+        const bf = 16;
+        return [l, lf, t, tf, r, rf, b, bf];
+    }
+    render(xmlStream, model) {
+        const rect = model.anchor
+            ? this.getAnchorRect(model.anchor)
+            : this.getDefaultRect(model.refAddress);
+        xmlStream.leafNode("x:Anchor", null, rect.join(", "));
+    }
+    parseOpen(node) {
+        switch (node.name) {
+            case this.tag:
+                this.text = "";
+                return true;
+            default:
+                return false;
+        }
+    }
+    parseText(text) {
+        this.text = text;
+    }
+    parseClose() {
+        return false;
+    }
+}
+export { VmlAnchorXform };

package/dist/esm/modules/excel/xlsx/xform/comment/vml-client-data-xform.js

@@ -0,0 +1,82 @@
+import { BaseXform } from "../base-xform.js";
+import { VmlAnchorXform } from "./vml-anchor-xform.js";
+import { VmlProtectionXform } from "./style/vml-protection-xform.js";
+import { VmlPositionXform } from "./style/vml-position-xform.js";
+const POSITION_TYPE = ["twoCells", "oneCells", "absolute"];
+class VmlClientDataXform extends BaseXform {
+    constructor() {
+        super();
+        this.map = {
+            "x:Anchor": new VmlAnchorXform(),
+            "x:Locked": new VmlProtectionXform({ tag: "x:Locked" }),
+            "x:LockText": new VmlProtectionXform({ tag: "x:LockText" }),
+            "x:SizeWithCells": new VmlPositionXform({ tag: "x:SizeWithCells" }),
+            "x:MoveWithCells": new VmlPositionXform({ tag: "x:MoveWithCells" })
+        };
+        this.model = { anchor: [], protection: {}, editAs: "" };
+    }
+    get tag() {
+        return "x:ClientData";
+    }
+    render(xmlStream, model) {
+        const { protection, editAs } = model.note;
+        xmlStream.openNode(this.tag, { ObjectType: "Note" });
+        this.map["x:MoveWithCells"].render(xmlStream, editAs, POSITION_TYPE);
+        this.map["x:SizeWithCells"].render(xmlStream, editAs, POSITION_TYPE);
+        this.map["x:Anchor"].render(xmlStream, model);
+        this.map["x:Locked"].render(xmlStream, protection.locked);
+        xmlStream.leafNode("x:AutoFill", null, "False");
+        this.map["x:LockText"].render(xmlStream, protection.lockText);
+        xmlStream.leafNode("x:Row", null, model.refAddress.row - 1);
+        xmlStream.leafNode("x:Column", null, model.refAddress.col - 1);
+        xmlStream.closeNode();
+    }
+    parseOpen(node) {
+        switch (node.name) {
+            case this.tag:
+                this.reset();
+                this.model = {
+                    anchor: [],
+                    protection: {},
+                    editAs: ""
+                };
+                break;
+            default:
+                this.parser = this.map[node.name];
+                if (this.parser) {
+                    this.parser.parseOpen(node);
+                }
+                break;
+        }
+        return true;
+    }
+    parseText(text) {
+        if (this.parser) {
+            this.parser.parseText(text);
+        }
+    }
+    parseClose(name) {
+        if (this.parser) {
+            if (!this.parser.parseClose(name)) {
+                this.parser = undefined;
+            }
+            return true;
+        }
+        switch (name) {
+            case this.tag:
+                this.normalizeModel();
+                return false;
+            default:
+                return true;
+        }
+    }
+    normalizeModel() {
+        const position = Object.assign({}, this.map["x:MoveWithCells"].model, this.map["x:SizeWithCells"].model);
+        const len = Object.keys(position).length;
+        this.model.editAs = POSITION_TYPE[len];
+        this.model.anchor = this.map["x:Anchor"].text;
+        this.model.protection.locked = this.map["x:Locked"].text;
+        this.model.protection.lockText = this.map["x:LockText"].text;
+    }
+}
+export { VmlClientDataXform };

package/dist/esm/modules/excel/xlsx/xform/comment/vml-notes-xform.js

@@ -0,0 +1,96 @@
+import { XmlStream } from "../../../utils/xml-stream.js";
+import { BaseXform } from "../base-xform.js";
+import { VmlShapeXform } from "./vml-shape-xform.js";
+// This class is (currently) single purposed to insert the triangle
+// drawing icons on commented cells
+class VmlNotesXform extends BaseXform {
+    constructor() {
+        super();
+        this.map = {
+            "v:shape": new VmlShapeXform()
+        };
+        this.model = { comments: [] };
+    }
+    get tag() {
+        return "xml";
+    }
+    render(xmlStream, model) {
+        const renderModel = model || this.model;
+        xmlStream.openXml(XmlStream.StdDocAttributes);
+        xmlStream.openNode(this.tag, VmlNotesXform.DRAWING_ATTRIBUTES);
+        xmlStream.openNode("o:shapelayout", { "v:ext": "edit" });
+        xmlStream.leafNode("o:idmap", { "v:ext": "edit", data: 1 });
+        xmlStream.closeNode();
+        xmlStream.openNode("v:shapetype", {
+            id: "_x0000_t202",
+            coordsize: "21600,21600",
+            "o:spt": 202,
+            path: "m,l,21600r21600,l21600,xe"
+        });
+        xmlStream.leafNode("v:stroke", { joinstyle: "miter" });
+        xmlStream.leafNode("v:path", { gradientshapeok: "t", "o:connecttype": "rect" });
+        xmlStream.closeNode();
+        renderModel.comments.forEach((item, index) => {
+            this.map["v:shape"].render(xmlStream, item, index);
+        });
+        xmlStream.closeNode();
+    }
+    parseOpen(node) {
+        if (this.parser) {
+            this.parser.parseOpen(node);
+            return true;
+        }
+        switch (node.name) {
+            case this.tag:
+                this.reset();
+                this.model = {
+                    comments: []
+                };
+                break;
+            default:
+                this.parser = this.map[node.name];
+                if (this.parser) {
+                    this.parser.parseOpen(node);
+                }
+                break;
+        }
+        return true;
+    }
+    parseText(text) {
+        if (this.parser) {
+            this.parser.parseText(text);
+        }
+    }
+    parseClose(name) {
+        if (this.parser) {
+            if (!this.parser.parseClose(name)) {
+                this.model.comments.push(this.parser.model);
+                this.parser = undefined;
+            }
+            return true;
+        }
+        switch (name) {
+            case this.tag:
+                return false;
+            default:
+                // could be some unrecognised tags
+                return true;
+        }
+    }
+    reconcile(model, options) {
+        model.anchors.forEach((anchor) => {
+            if (anchor.br) {
+                this.map["xdr:twoCellAnchor"].reconcile(anchor, options);
+            }
+            else {
+                this.map["xdr:oneCellAnchor"].reconcile(anchor, options);
+            }
+        });
+    }
+}
+VmlNotesXform.DRAWING_ATTRIBUTES = {
+    "xmlns:v": "urn:schemas-microsoft-com:vml",
+    "xmlns:o": "urn:schemas-microsoft-com:office:office",
+    "xmlns:x": "urn:schemas-microsoft-com:office:excel"
+};
+export { VmlNotesXform };