@cj-tech-master/excelts 4.1.0 → 4.2.0

package/dist/browser/modules/excel/xlsx/xform/drawing/ctrl-prop-xform.d.ts

@@ -0,0 +1,22 @@
+import { BaseXform } from "@excel/xlsx/xform/base-xform";
+import type { FormCheckboxModel } from "@excel/form-control";
+/**
+ * Control Properties Xform - Generates ctrlProp*.xml for form controls
+ *
+ * Each form control (checkbox, button, etc.) has an associated ctrlProp file
+ * that stores its properties like objectType, checked state, and linked cell.
+ */
+declare class CtrlPropXform extends BaseXform {
+    model: FormCheckboxModel;
+    get tag(): string;
+    render(xmlStream: any, model?: FormCheckboxModel): void;
+    /**
+     * Generate XML string directly (convenience method)
+     * Uses render() internally to ensure consistency
+     */
+    toXml(model: FormCheckboxModel): string;
+    parseOpen(): boolean;
+    parseText(): void;
+    parseClose(): boolean;
+}
+export { CtrlPropXform };

package/dist/browser/modules/excel/xlsx/xform/drawing/ctrl-prop-xform.js

@@ -0,0 +1,52 @@
+import { XmlStream } from "../../../utils/xml-stream.js";
+import { BaseXform } from "../base-xform.js";
+/**
+ * Control Properties Xform - Generates ctrlProp*.xml for form controls
+ *
+ * Each form control (checkbox, button, etc.) has an associated ctrlProp file
+ * that stores its properties like objectType, checked state, and linked cell.
+ */
+class CtrlPropXform extends BaseXform {
+    get tag() {
+        return "formControlPr";
+    }
+    render(xmlStream, model) {
+        const renderModel = model || this.model;
+        const attrs = {
+            xmlns: "http://schemas.microsoft.com/office/spreadsheetml/2009/9/main",
+            objectType: "CheckBox",
+            checked: renderModel.checked,
+            lockText: "1"
+        };
+        // Add linked cell reference
+        if (renderModel.link) {
+            attrs.fmlaLink = renderModel.link;
+        }
+        // Add noThreeD for flat appearance
+        if (renderModel.noThreeD) {
+            attrs.noThreeD = "1";
+        }
+        xmlStream.openXml({ version: "1.0", encoding: "UTF-8", standalone: "yes" });
+        xmlStream.leafNode(this.tag, attrs);
+    }
+    /**
+     * Generate XML string directly (convenience method)
+     * Uses render() internally to ensure consistency
+     */
+    toXml(model) {
+        const xmlStream = new XmlStream();
+        this.render(xmlStream, model);
+        return xmlStream.xml;
+    }
+    // Parsing not implemented - form controls are write-only for now
+    parseOpen() {
+        return true;
+    }
+    parseText() {
+        // Not implemented
+    }
+    parseClose() {
+        return false;
+    }
+}
+export { CtrlPropXform };

package/dist/browser/modules/excel/xlsx/xform/drawing/vml-drawing-xform.d.ts

@@ -0,0 +1,44 @@
+import { BaseXform } from "@excel/xlsx/xform/base-xform";
+import { type FormCheckboxModel } from "@excel/form-control";
+/**
+ * Unified VML Drawing Xform - Combines Notes (comments) and Form Controls
+ *
+ * Excel uses a single VML file per worksheet that can contain:
+ * - Comment/note shapes (shapetype 202)
+ * - Form control shapes (checkbox shapetype 201, etc.)
+ *
+ * This unified xform renders both into a single VML file.
+ */
+interface VmlDrawingModel {
+    /** Comment/note shapes */
+    comments?: any[];
+    /** Form control checkboxes */
+    formControls?: FormCheckboxModel[];
+}
+declare class VmlDrawingXform extends BaseXform {
+    map: {
+        [key: string]: any;
+    };
+    parser: any;
+    model: VmlDrawingModel;
+    constructor();
+    get tag(): string;
+    /**
+     * Render VML drawing containing both notes and form controls
+     */
+    render(xmlStream: any, model?: VmlDrawingModel): void;
+    /**
+     * Render a checkbox form control shape
+     */
+    private _renderCheckboxShape;
+    parseOpen(node: any): boolean;
+    parseText(text: string): void;
+    parseClose(name: string): boolean;
+    static DRAWING_ATTRIBUTES: {
+        "xmlns:v": string;
+        "xmlns:o": string;
+        "xmlns:x": string;
+    };
+}
+export { VmlDrawingXform };
+export type { VmlDrawingModel };

package/dist/browser/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/browser/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/browser/modules/excel/xlsx/xlsx.browser.d.ts

@@ -93,6 +93,7 @@ declare class XLSX {
         PivotCacheRecords: string;
         PivotTable: string;
         FeaturePropertyBag: string;
+        CtrlProp: string;
     };
     constructor(workbook: Workbook);
     /**

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

@@ -24,7 +24,8 @@ import { PivotCacheRecordsXform } from "./xform/pivot-table/pivot-cache-records-
 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";
@@ -32,7 +33,7 @@ import { bufferToString, base64ToUint8Array } from "../../../utils/utils.browser
 import { StreamingZip, ZipDeflateFile } from "../../archive/streaming-zip.js";
 import { ZipParser } from "../../archive/index.browser.js";
 import { PassThrough, concatUint8Arrays } from "../../stream/index.browser.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();
@@ -702,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;
     }
@@ -1028,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();
@@ -1039,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) {
@@ -1152,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) => {

package/dist/cjs/index.js

@@ -17,7 +17,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CsvFormatterStream = exports.CsvParserStream = exports.WorksheetReader = exports.WorksheetWriter = exports.WorkbookReader = exports.WorkbookWriter = exports.DataValidations = exports.Table = exports.Image = exports.Range = exports.Cell = exports.Column = exports.Row = exports.Worksheet = exports.Workbook = void 0;
+exports.CsvFormatterStream = exports.CsvParserStream = exports.WorksheetReader = exports.WorksheetWriter = exports.WorkbookReader = exports.WorkbookWriter = exports.FormCheckbox = exports.DataValidations = exports.Table = exports.Image = exports.Range = exports.Cell = exports.Column = exports.Row = exports.Worksheet = exports.Workbook = void 0;
 var workbook_1 = require("./modules/excel/workbook.js");
 Object.defineProperty(exports, "Workbook", { enumerable: true, get: function () { return workbook_1.Workbook; } });
 var worksheet_1 = require("./modules/excel/worksheet.js");
@@ -37,6 +37,8 @@ var table_1 = require("./modules/excel/table.js");
 Object.defineProperty(exports, "Table", { enumerable: true, get: function () { return table_1.Table; } });
 var data_validations_1 = require("./modules/excel/data-validations.js");
 Object.defineProperty(exports, "DataValidations", { enumerable: true, get: function () { return data_validations_1.DataValidations; } });
+var form_control_1 = require("./modules/excel/form-control.js");
+Object.defineProperty(exports, "FormCheckbox", { enumerable: true, get: function () { return form_control_1.FormCheckbox; } });
 // =============================================================================
 // Node.js Only: Streaming Classes
 // These can also be accessed via Workbook.createStreamWriter/createStreamReader