@cj-tech-master/excelts 4.0.4 → 4.1.0-canary.20260110033117.75bcac1

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

@@ -0,0 +1,181 @@
+import { XmlStream } from "../../../utils/xml-stream.js";
+import { BaseXform } from "../base-xform.js";
+import { VmlShapeXform } from "../comment/vml-shape-xform.js";
+import { FormCheckbox } from "../../../form-control.js";
+class VmlDrawingXform extends BaseXform {
+    constructor() {
+        super();
+        this.map = {
+            "v:shape": new VmlShapeXform()
+        };
+        this.model = { comments: [], formControls: [] };
+    }
+    get tag() {
+        return "xml";
+    }
+    /**
+     * Render VML drawing containing both notes and form controls
+     */
+    render(xmlStream, model) {
+        const renderModel = model || this.model;
+        const hasComments = renderModel.comments && renderModel.comments.length > 0;
+        const hasFormControls = renderModel.formControls && renderModel.formControls.length > 0;
+        xmlStream.openXml(XmlStream.StdDocAttributes);
+        xmlStream.openNode(this.tag, VmlDrawingXform.DRAWING_ATTRIBUTES);
+        // Shape layout - shared by both notes and form controls
+        xmlStream.openNode("o:shapelayout", { "v:ext": "edit" });
+        xmlStream.leafNode("o:idmap", { "v:ext": "edit", data: 1 });
+        xmlStream.closeNode();
+        // Shapetype 202 for notes/comments
+        if (hasComments) {
+            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();
+        }
+        // Shapetype 201 for form control checkboxes
+        if (hasFormControls) {
+            xmlStream.openNode("v:shapetype", {
+                id: "_x0000_t201",
+                coordsize: "21600,21600",
+                "o:spt": "201",
+                path: "m,l,21600r21600,l21600,xe"
+            });
+            xmlStream.leafNode("v:stroke", { joinstyle: "miter" });
+            xmlStream.leafNode("v:path", {
+                shadowok: "f",
+                "o:extrusionok": "f",
+                strokeok: "f",
+                fillok: "f",
+                "o:connecttype": "rect"
+            });
+            xmlStream.leafNode("o:lock", { "v:ext": "edit", shapetype: "t" });
+            xmlStream.closeNode();
+        }
+        // Render comment shapes
+        if (hasComments) {
+            const comments = renderModel.comments;
+            for (let i = 0; i < comments.length; i++) {
+                this.map["v:shape"].render(xmlStream, comments[i], i);
+            }
+        }
+        // Render form control shapes
+        if (hasFormControls) {
+            for (const control of renderModel.formControls) {
+                this._renderCheckboxShape(xmlStream, control);
+            }
+        }
+        xmlStream.closeNode();
+    }
+    /**
+     * Render a checkbox form control shape
+     */
+    _renderCheckboxShape(xmlStream, control) {
+        const shapeAttrs = {
+            id: `_x0000_s${control.shapeId}`,
+            type: "#_x0000_t201",
+            style: FormCheckbox.getVmlStyle(control),
+            "o:insetmode": "auto",
+            fillcolor: "buttonFace [67]",
+            strokecolor: "windowText [64]",
+            "o:preferrelative": "t",
+            filled: "f",
+            stroked: "f"
+        };
+        xmlStream.openNode("v:shape", shapeAttrs);
+        // Fill element
+        xmlStream.leafNode("v:fill", { "o:detectmouseclick": "t" });
+        // Lock element
+        xmlStream.leafNode("o:lock", { "v:ext": "edit", text: "t" });
+        // Textbox for label
+        if (control.text) {
+            xmlStream.openNode("v:textbox", {
+                style: "mso-direction-alt:auto",
+                "o:singleclick": "t"
+            });
+            xmlStream.openNode("div", { style: "text-align:left" });
+            xmlStream.openNode("font", { face: "Tahoma", size: "160", color: "auto" });
+            xmlStream.writeText(control.text);
+            xmlStream.closeNode(); // font
+            xmlStream.closeNode(); // div
+            xmlStream.closeNode(); // v:textbox
+        }
+        // ClientData - the core of the checkbox control
+        xmlStream.openNode("x:ClientData", { ObjectType: "Checkbox" });
+        // Anchor position
+        xmlStream.openNode("x:Anchor");
+        xmlStream.writeText(FormCheckbox.getVmlAnchor(control));
+        xmlStream.closeNode();
+        // Print settings
+        xmlStream.leafNode("x:PrintObject", undefined, control.print ? "True" : "False");
+        xmlStream.leafNode("x:AutoFill", undefined, "False");
+        xmlStream.leafNode("x:AutoLine", undefined, "False");
+        xmlStream.leafNode("x:TextVAlign", undefined, "Center");
+        // Linked cell
+        if (control.link) {
+            xmlStream.leafNode("x:FmlaLink", undefined, control.link);
+        }
+        // 3D appearance
+        if (control.noThreeD) {
+            xmlStream.leafNode("x:NoThreeD");
+        }
+        // Checked state (0 = unchecked, 1 = checked, 2 = mixed)
+        xmlStream.leafNode("x:Checked", undefined, String(FormCheckbox.getVmlCheckedValue(control)));
+        xmlStream.closeNode(); // x:ClientData
+        xmlStream.closeNode(); // v:shape
+    }
+    // Parsing - delegate to VmlShapeXform for notes
+    parseOpen(node) {
+        if (this.parser) {
+            this.parser.parseOpen(node);
+            return true;
+        }
+        switch (node.name) {
+            case this.tag:
+                this.reset();
+                this.model = {
+                    comments: [],
+                    formControls: []
+                };
+                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:
+                return true;
+        }
+    }
+}
+VmlDrawingXform.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 { VmlDrawingXform };

package/dist/esm/modules/excel/xlsx/xform/sheet/cell-xform.js

@@ -189,6 +189,11 @@ class CellXform extends BaseXform {
                 xmlStream.addAttribute("t", "b");
                 xmlStream.leafNode("v", null, model.value ? "1" : "0");
                 break;
+            case Enums.ValueType.Checkbox:
+                // Checkboxes are stored as boolean values
+                xmlStream.addAttribute("t", "b");
+                xmlStream.leafNode("v", null, model.value ? "1" : "0");
+                break;
             case Enums.ValueType.Error:
                 xmlStream.addAttribute("t", "e");
                 xmlStream.leafNode("v", null, model.value.error);

package/dist/esm/modules/excel/xlsx/xform/sheet/worksheet-xform.js

@@ -26,7 +26,7 @@ import { ColBreaksXform } from "./col-breaks-xform.js";
 import { HeaderFooterXform } from "./header-footer-xform.js";
 import { ConditionalFormattingsXform } from "./cf/conditional-formattings-xform.js";
 import { ExtLstXform } from "./ext-lst-xform.js";
-import { commentsRelTargetFromWorksheet, drawingRelTargetFromWorksheet, mediaRelTargetFromRels, pivotTableRelTargetFromWorksheet, tableRelTargetFromWorksheet, vmlDrawingRelTargetFromWorksheet } from "../../../utils/ooxml-paths.js";
+import { commentsRelTargetFromWorksheet, ctrlPropRelTargetFromWorksheet, drawingRelTargetFromWorksheet, mediaRelTargetFromRels, pivotTableRelTargetFromWorksheet, tableRelTargetFromWorksheet, vmlDrawingRelTargetFromWorksheet } from "../../../utils/ooxml-paths.js";
 const mergeRule = (rule, extRule) => {
     Object.keys(extRule).forEach(key => {
         const value = rule[key];
@@ -275,6 +275,29 @@ class WorkSheetXform extends BaseXform {
                 Target: pivotTableRelTargetFromWorksheet(pivotTable.tableNumber)
             });
         });
+        // prepare form controls (legacy checkboxes)
+        // Form controls share the VML file with comments, but need separate ctrlProp relationships
+        if (model.formControls && model.formControls.length > 0) {
+            // If no comments, we need to add the VML drawing relationship for form controls
+            if (model.comments.length === 0) {
+                rels.push({
+                    Id: nextRid(rels),
+                    Type: RelType.VmlDrawing,
+                    Target: vmlDrawingRelTargetFromWorksheet(model.id)
+                });
+            }
+            // Add ctrlProp relationships for each form control
+            for (const control of model.formControls) {
+                const globalCtrlPropId = options.formControlRefs.length + 1;
+                control.ctrlPropId = globalCtrlPropId;
+                rels.push({
+                    Id: nextRid(rels),
+                    Type: RelType.CtrlProp,
+                    Target: ctrlPropRelTargetFromWorksheet(globalCtrlPropId)
+                });
+                options.formControlRefs.push(globalCtrlPropId);
+            }
+        }
         // prepare ext items
         this.map.extLst.prepare(model, options);
     }

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

@@ -52,6 +52,17 @@ class StyleXform extends BaseXform {
         if (model.protection) {
             this.map.protection.render(xmlStream, model.protection);
         }
+        // Add checkbox extLst if needed
+        if (model.checkbox && model.xfComplementIndex !== undefined) {
+            xmlStream.openNode("extLst");
+            xmlStream.openNode("ext", {
+                "xmlns:xfpb": "http://schemas.microsoft.com/office/spreadsheetml/2022/featurepropertybag",
+                uri: "{C7286773-470A-42A8-94C5-96B5CB345126}"
+            });
+            xmlStream.leafNode("xfpb:xfComplement", { i: model.xfComplementIndex });
+            xmlStream.closeNode();
+            xmlStream.closeNode();
+        }
         xmlStream.closeNode();
     }
     parseOpen(node) {

package/dist/esm/modules/excel/xlsx/xform/style/styles-xform.js

@@ -82,6 +82,7 @@ class StylesXform extends BaseXform {
         this._addFill({ type: "pattern", pattern: "none" });
         this._addFill({ type: "pattern", pattern: "gray125" });
         this.weakMap = new WeakMap();
+        this._hasCheckboxes = false;
     }
     render(xmlStream, model) {
         const renderModel = model || this.model;
@@ -222,12 +223,15 @@ class StylesXform extends BaseXform {
             // default (zero) font
             this._addFont({ size: 11, color: { theme: 1 }, name: "Calibri", family: 2, scheme: "minor" });
         }
-        // if we have seen this style object before, assume it has the same styleId
-        if (this.weakMap && this.weakMap.has(model)) {
+        const type = cellType || Enums.ValueType.Number;
+        // If we have seen this style object before, assume it has the same styleId.
+        // Do not cache by object identity for checkbox cells because the styleId must
+        // include checkbox-specific extLst, and the same style object may be reused
+        // for non-checkbox cells.
+        if (type !== Enums.ValueType.Checkbox && this.weakMap && this.weakMap.has(model)) {
             return this.weakMap.get(model);
         }
         const style = {};
-        const type = cellType || Enums.ValueType.Number;
         if (model.numFmt) {
             style.numFmtId = this._addNumFmtStr(model.numFmt);
         }
@@ -258,8 +262,17 @@ class StylesXform extends BaseXform {
         if (model.protection) {
             style.protection = model.protection;
         }
+        if (type === Enums.ValueType.Checkbox) {
+            // Checkbox rendering relies on style extensions (extLst) and workbook-level parts.
+            // Force applyAlignment="1" (without emitting an <alignment/> node) by providing
+            // an empty alignment object when none is specified.
+            this._hasCheckboxes = true;
+            style.alignment = style.alignment || {};
+            style.checkbox = true;
+            style.xfComplementIndex = 0;
+        }
         const styleId = this._addStyle(style);
-        if (this.weakMap) {
+        if (type !== Enums.ValueType.Checkbox && this.weakMap) {
             this.weakMap.set(model, styleId);
         }
         return styleId;
@@ -322,6 +335,10 @@ class StylesXform extends BaseXform {
     getDxfStyle(id) {
         return this.model.dxfs[id];
     }
+    // Check if workbook uses checkbox feature
+    get hasCheckboxes() {
+        return !!this._hasCheckboxes;
+    }
     // =========================================================================
     // Private Interface
     _addStyle(style) {
@@ -457,12 +474,19 @@ class StylesXformMock extends StylesXform {
     // the styleId is returned. Note: cellType is used when numFmt not defined
     addStyleModel(model, cellType) {
         switch (cellType) {
+            case Enums.ValueType.Checkbox:
+                // Checkbox rendering relies on style extensions (extLst) and workbook-level parts.
+                // The mock style manager intentionally does not build those structures.
+                throw new Error("Checkbox cells require styles to be enabled (useStyles: true)");
             case Enums.ValueType.Date:
                 return this.dateStyleId;
             default:
                 return 0;
         }
     }
+    get hasCheckboxes() {
+        return false;
+    }
     get dateStyleId() {
         if (!this._dateStyleId) {
             const dateStyle = {

package/dist/esm/modules/excel/xlsx/xlsx.browser.js

@@ -17,13 +17,15 @@ import { ContentTypesXform } from "./xform/core/content-types-xform.js";
 import { AppXform } from "./xform/core/app-xform.js";
 import { WorkbookXform } from "./xform/book/workbook-xform.js";
 import { WorkSheetXform } from "./xform/sheet/worksheet-xform.js";
+import { FeaturePropertyBagXform } from "./xform/core/feature-property-bag-xform.js";
 import { DrawingXform } from "./xform/drawing/drawing-xform.js";
 import { TableXform } from "./xform/table/table-xform.js";
 import { PivotCacheRecordsXform } from "./xform/pivot-table/pivot-cache-records-xform.js";
 import { PivotCacheDefinitionXform } from "./xform/pivot-table/pivot-cache-definition-xform.js";
 import { PivotTableXform } from "./xform/pivot-table/pivot-table-xform.js";
 import { CommentsXform } from "./xform/comment/comments-xform.js";
-import { VmlNotesXform } from "./xform/comment/vml-notes-xform.js";
+import { VmlDrawingXform } from "./xform/drawing/vml-drawing-xform.js";
+import { CtrlPropXform } from "./xform/drawing/ctrl-prop-xform.js";
 import { theme1Xml } from "./xml/theme1.js";
 import { RelType } from "./rel-type.js";
 import { StreamBuf } from "../utils/stream-buf.js";
@@ -31,7 +33,7 @@ import { bufferToString, base64ToUint8Array } from "../../../utils/utils.js";
 import { StreamingZip, ZipDeflateFile } from "../../archive/streaming-zip.js";
 import { ZipParser } from "../../archive/index.js";
 import { PassThrough, concatUint8Arrays } from "../../stream/index.js";
-import { commentsPath, commentsRelTargetFromWorksheetName, drawingPath, drawingRelsPath, OOXML_REL_TARGETS, pivotTableRelTargetFromWorksheetName, pivotCacheDefinitionRelTargetFromWorkbook, getCommentsIndexFromPath, getDrawingNameFromPath, getDrawingNameFromRelsPath, getMediaFilenameFromPath, mediaPath, getPivotCacheDefinitionNameFromPath, getPivotCacheDefinitionNameFromRelsPath, getPivotCacheRecordsNameFromPath, getPivotTableNameFromPath, getPivotTableNameFromRelsPath, pivotCacheDefinitionPath, pivotCacheDefinitionRelsPath, pivotCacheDefinitionRelTargetFromPivotTable, pivotCacheRecordsPath, pivotCacheRecordsRelTarget, pivotTablePath, pivotTableRelsPath, getTableNameFromPath, tablePath, tableRelTargetFromWorksheetName, themePath, getThemeNameFromPath, getVmlDrawingNameFromPath, getWorksheetNoFromWorksheetPath, getWorksheetNoFromWorksheetRelsPath, isBinaryEntryPath, normalizeZipPath, OOXML_PATHS, vmlDrawingRelTargetFromWorksheetName, vmlDrawingPath, worksheetPath, worksheetRelsPath } from "../utils/ooxml-paths.js";
+import { commentsPath, commentsRelTargetFromWorksheetName, ctrlPropPath, drawingPath, drawingRelsPath, OOXML_REL_TARGETS, pivotTableRelTargetFromWorksheetName, pivotCacheDefinitionRelTargetFromWorkbook, getCommentsIndexFromPath, getDrawingNameFromPath, getDrawingNameFromRelsPath, getMediaFilenameFromPath, mediaPath, getPivotCacheDefinitionNameFromPath, getPivotCacheDefinitionNameFromRelsPath, getPivotCacheRecordsNameFromPath, getPivotTableNameFromPath, getPivotTableNameFromRelsPath, pivotCacheDefinitionPath, pivotCacheDefinitionRelsPath, pivotCacheDefinitionRelTargetFromPivotTable, pivotCacheRecordsPath, pivotCacheRecordsRelTarget, pivotTablePath, pivotTableRelsPath, getTableNameFromPath, tablePath, tableRelTargetFromWorksheetName, themePath, getThemeNameFromPath, getVmlDrawingNameFromPath, getWorksheetNoFromWorksheetPath, getWorksheetNoFromWorksheetRelsPath, isBinaryEntryPath, normalizeZipPath, OOXML_PATHS, vmlDrawingRelTargetFromWorksheetName, vmlDrawingPath, worksheetPath, worksheetRelsPath } from "../utils/ooxml-paths.js";
 class StreamingZipWriterAdapter {
     constructor(options) {
         this.events = new Map();
@@ -203,6 +205,7 @@ class XLSX {
         this.addTables(zip, model);
         this.addPivotTables(zip, model);
         await Promise.all([this.addThemes(zip, model), this.addStyles(zip, model)]);
+        await this.addFeaturePropertyBag(zip, model);
         await this.addMedia(zip, model);
         await Promise.all([this.addApp(zip, model), this.addCore(zip, model)]);
         await this.addWorkbook(zip, model);
@@ -700,7 +703,7 @@ class XLSX {
         model.drawingRels[name] = relationships;
     }
     async _processVmlDrawingEntry(entry, model, name) {
-        const xform = new VmlNotesXform();
+        const xform = new VmlDrawingXform();
         const vmlDrawing = await xform.parseStream(entry);
         model.vmlDrawings[vmlDrawingRelTargetFromWorksheetName(name)] = vmlDrawing;
     }
@@ -971,6 +974,14 @@ class XLSX {
                 Target: OOXML_REL_TARGETS.workbookSharedStrings
             });
         }
+        // Add FeaturePropertyBag relationship if checkboxes are used
+        if (model.hasCheckboxes) {
+            relationships.push({
+                Id: `rId${count++}`,
+                Type: XLSX.RelType.FeaturePropertyBag,
+                Target: OOXML_REL_TARGETS.workbookFeaturePropertyBag
+            });
+        }
         (model.pivotTables || []).forEach((pivotTable) => {
             pivotTable.rId = `rId${count++}`;
             relationships.push({
@@ -992,6 +1003,13 @@ class XLSX {
         const xml = xform.toXml(relationships);
         zip.append(xml, { name: OOXML_PATHS.xlWorkbookRels });
     }
+    async addFeaturePropertyBag(zip, model) {
+        if (!model.hasCheckboxes) {
+            return;
+        }
+        const xform = new FeaturePropertyBagXform();
+        zip.append(xform.toXml({}), { name: OOXML_PATHS.xlFeaturePropertyBag });
+    }
     async addSharedStrings(zip, model) {
         if (model.sharedStrings && model.sharedStrings.count) {
             zip.append(model.sharedStrings.xml, { name: OOXML_PATHS.xlSharedStrings });
@@ -1011,7 +1029,8 @@ class XLSX {
         const worksheetXform = new WorkSheetXform();
         const relationshipsXform = new RelationshipsXform();
         const commentsXform = new CommentsXform();
-        const vmlNotesXform = new VmlNotesXform();
+        const vmlDrawingXform = new VmlDrawingXform();
+        const ctrlPropXform = new CtrlPropXform();
         model.worksheets.forEach((worksheet, index) => {
             const fileIndex = worksheet.fileIndex || index + 1;
             let xmlStream = new XmlStream();
@@ -1022,14 +1041,30 @@ class XLSX {
                 relationshipsXform.render(xmlStream, worksheet.rels);
                 zip.append(xmlStream.xml, { name: worksheetRelsPath(fileIndex) });
             }
+            // Generate comments XML (separate from VML)
             if (worksheet.comments.length > 0) {
                 xmlStream = new XmlStream();
                 commentsXform.render(xmlStream, worksheet);
                 zip.append(xmlStream.xml, { name: commentsPath(fileIndex) });
+            }
+            // Generate unified VML drawing (contains both notes and form controls)
+            const hasComments = worksheet.comments.length > 0;
+            const hasFormControls = worksheet.formControls && worksheet.formControls.length > 0;
+            if (hasComments || hasFormControls) {
                 xmlStream = new XmlStream();
-                vmlNotesXform.render(xmlStream, worksheet);
+                vmlDrawingXform.render(xmlStream, {
+                    comments: hasComments ? worksheet.comments : [],
+                    formControls: hasFormControls ? worksheet.formControls : []
+                });
                 zip.append(xmlStream.xml, { name: vmlDrawingPath(fileIndex) });
             }
+            // Generate ctrlProp files for form controls
+            if (hasFormControls) {
+                worksheet.formControls.forEach((control) => {
+                    const xml = ctrlPropXform.toXml(control);
+                    zip.append(xml, { name: ctrlPropPath(control.ctrlPropId) });
+                });
+            }
         });
     }
     addDrawings(zip, model) {
@@ -1135,6 +1170,7 @@ class XLSX {
         };
         worksheetOptions.drawings = model.drawings = [];
         worksheetOptions.commentRefs = model.commentRefs = [];
+        worksheetOptions.formControlRefs = model.formControlRefs = [];
         let tableCount = 0;
         model.tables = [];
         model.worksheets.forEach((worksheet) => {
@@ -1146,6 +1182,8 @@ class XLSX {
             });
             worksheetXform.prepare(worksheet, worksheetOptions);
         });
+        // ContentTypesXform expects this flag
+        model.hasCheckboxes = model.styles.hasCheckboxes;
     }
 }
 XLSX.RelType = RelType;