@cj-tech-master/excelts 4.1.0 → 4.2.0-canary.20260110034516.0919d4d

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

@@ -27,7 +27,8 @@ const pivot_cache_records_xform_1 = require("./xform/pivot-table/pivot-cache-rec
 const pivot_cache_definition_xform_1 = require("./xform/pivot-table/pivot-cache-definition-xform.js");
 const pivot_table_xform_1 = require("./xform/pivot-table/pivot-table-xform.js");
 const comments_xform_1 = require("./xform/comment/comments-xform.js");
-const vml_notes_xform_1 = require("./xform/comment/vml-notes-xform.js");
+const vml_drawing_xform_1 = require("./xform/drawing/vml-drawing-xform.js");
+const ctrl_prop_xform_1 = require("./xform/drawing/ctrl-prop-xform.js");
 const theme1_1 = require("./xml/theme1.js");
 const rel_type_1 = require("./rel-type.js");
 const stream_buf_1 = require("../utils/stream-buf.js");
@@ -705,7 +706,7 @@ class XLSX {
         model.drawingRels[name] = relationships;
     }
     async _processVmlDrawingEntry(entry, model, name) {
-        const xform = new vml_notes_xform_1.VmlNotesXform();
+        const xform = new vml_drawing_xform_1.VmlDrawingXform();
         const vmlDrawing = await xform.parseStream(entry);
         model.vmlDrawings[(0, ooxml_paths_1.vmlDrawingRelTargetFromWorksheetName)(name)] = vmlDrawing;
     }
@@ -1031,7 +1032,8 @@ class XLSX {
         const worksheetXform = new worksheet_xform_1.WorkSheetXform();
         const relationshipsXform = new relationships_xform_1.RelationshipsXform();
         const commentsXform = new comments_xform_1.CommentsXform();
-        const vmlNotesXform = new vml_notes_xform_1.VmlNotesXform();
+        const vmlDrawingXform = new vml_drawing_xform_1.VmlDrawingXform();
+        const ctrlPropXform = new ctrl_prop_xform_1.CtrlPropXform();
         model.worksheets.forEach((worksheet, index) => {
             const fileIndex = worksheet.fileIndex || index + 1;
             let xmlStream = new xml_stream_1.XmlStream();
@@ -1042,14 +1044,30 @@ class XLSX {
                 relationshipsXform.render(xmlStream, worksheet.rels);
                 zip.append(xmlStream.xml, { name: (0, ooxml_paths_1.worksheetRelsPath)(fileIndex) });
             }
+            // Generate comments XML (separate from VML)
             if (worksheet.comments.length > 0) {
                 xmlStream = new xml_stream_1.XmlStream();
                 commentsXform.render(xmlStream, worksheet);
                 zip.append(xmlStream.xml, { name: (0, ooxml_paths_1.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 xml_stream_1.XmlStream();
-                vmlNotesXform.render(xmlStream, worksheet);
+                vmlDrawingXform.render(xmlStream, {
+                    comments: hasComments ? worksheet.comments : [],
+                    formControls: hasFormControls ? worksheet.formControls : []
+                });
                 zip.append(xmlStream.xml, { name: (0, ooxml_paths_1.vmlDrawingPath)(fileIndex) });
             }
+            // Generate ctrlProp files for form controls
+            if (hasFormControls) {
+                worksheet.formControls.forEach((control) => {
+                    const xml = ctrlPropXform.toXml(control);
+                    zip.append(xml, { name: (0, ooxml_paths_1.ctrlPropPath)(control.ctrlPropId) });
+                });
+            }
         });
     }
     addDrawings(zip, model) {
@@ -1155,6 +1173,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/esm/index.browser.js

@@ -15,6 +15,7 @@ export { Image } from "./modules/excel/image.js";
 export * from "./modules/excel/anchor.js";
 export { Table } from "./modules/excel/table.js";
 export { DataValidations } from "./modules/excel/data-validations.js";
+export { FormCheckbox } from "./modules/excel/form-control.js";
 // =============================================================================
 // Enums
 // =============================================================================

package/dist/esm/index.js

@@ -11,6 +11,7 @@ export { Image } from "./modules/excel/image.js";
 export * from "./modules/excel/anchor.js";
 export { Table } from "./modules/excel/table.js";
 export { DataValidations } from "./modules/excel/data-validations.js";
+export { FormCheckbox } from "./modules/excel/form-control.js";
 // =============================================================================
 // Node.js Only: Streaming Classes
 // These can also be accessed via Workbook.createStreamWriter/createStreamReader

package/dist/esm/modules/excel/form-control.js

@@ -0,0 +1,267 @@
+import { colCache } from "./utils/col-cache.js";
+/**
+ * Form Control Checkbox - Legacy checkbox control compatible with Office 2007+ and WPS/LibreOffice
+ *
+ * Unlike the modern In-Cell Checkbox (which only works in Microsoft 365),
+ * Form Control Checkboxes are floating controls that work in virtually all
+ * spreadsheet applications.
+ */
+// ============================================================================
+// Constants (exported for use by xforms)
+// ============================================================================
+/** EMU (English Metric Units) to pixels conversion factor at 96 DPI */
+export const EMU_PER_PIXEL = 9525;
+/** EMU to points conversion factor */
+export const EMU_PER_POINT = 12700;
+/** Default column offset in EMUs (~15 pixels) */
+const DEFAULT_COL_OFF = 142875;
+/** Default row offset in EMUs (~3 pixels) */
+const DEFAULT_ROW_OFF = 28575;
+/** Default end column offset in EMUs (~29 pixels) */
+const DEFAULT_END_COL_OFF = 276225;
+/** Default end row offset in EMUs (~20 pixels) */
+const DEFAULT_END_ROW_OFF = 190500;
+// ============================================================================
+// FormCheckbox Class
+// ============================================================================
+class FormCheckbox {
+    constructor(worksheet, range, options) {
+        this.worksheet = worksheet;
+        // Parse range to get anchors
+        const { tl, br } = this._parseRange(range);
+        // Generate shape ID (starting from 1025)
+        const existingCount = worksheet.formControls?.length || 0;
+        const shapeId = 1025 + existingCount;
+        // Parse link cell reference
+        let link;
+        if (options?.link) {
+            // Ensure absolute reference format
+            link = this._toAbsoluteRef(options.link);
+        }
+        // Note: ctrlPropId is set later in worksheet-xform.ts prepare() for global uniqueness
+        this.model = {
+            shapeId,
+            ctrlPropId: 0, // Placeholder, set during prepare()
+            tl,
+            br,
+            link,
+            checked: options?.checked ? "Checked" : "Unchecked",
+            text: options?.text ?? "",
+            noThreeD: options?.noThreeD ?? true,
+            print: options?.print ?? false
+        };
+    }
+    /**
+     * Get the checked state
+     */
+    get checked() {
+        return this.model.checked === "Checked";
+    }
+    /**
+     * Set the checked state
+     */
+    set checked(value) {
+        this.model.checked = value ? "Checked" : "Unchecked";
+    }
+    /**
+     * Get the linked cell address
+     */
+    get link() {
+        return this.model.link;
+    }
+    /**
+     * Set the linked cell address
+     */
+    set link(value) {
+        this.model.link = value ? this._toAbsoluteRef(value) : undefined;
+    }
+    /**
+     * Get the label text
+     */
+    get text() {
+        return this.model.text;
+    }
+    /**
+     * Set the label text
+     */
+    set text(value) {
+        this.model.text = value;
+    }
+    /**
+     * Convert cell reference to absolute format (e.g., "A1" -> "$A$1")
+     */
+    _toAbsoluteRef(ref) {
+        // If already absolute, return as-is
+        if (ref.includes("$")) {
+            return ref;
+        }
+        // Parse and convert
+        const addr = colCache.decodeAddress(ref);
+        return `$${colCache.n2l(addr.col)}$${addr.row}`;
+    }
+    /**
+     * Parse range input into anchor positions
+     */
+    _parseRange(range) {
+        let tl;
+        let br;
+        if (typeof range === "string") {
+            // Parse cell reference like "B2" or "B2:D3"
+            const decoded = colCache.decode(range);
+            if ("top" in decoded) {
+                // It's a range like "B2:D3"
+                tl = {
+                    col: decoded.left - 1, // Convert to 0-based
+                    colOff: DEFAULT_COL_OFF,
+                    row: decoded.top - 1,
+                    rowOff: DEFAULT_ROW_OFF
+                };
+                br = {
+                    col: decoded.right - 1,
+                    colOff: DEFAULT_END_COL_OFF,
+                    row: decoded.bottom - 1,
+                    rowOff: DEFAULT_END_ROW_OFF
+                };
+            }
+            else {
+                // Single cell reference - create default size checkbox
+                tl = {
+                    col: decoded.col - 1,
+                    colOff: DEFAULT_COL_OFF,
+                    row: decoded.row - 1,
+                    rowOff: DEFAULT_ROW_OFF
+                };
+                // Default size: about 2 columns wide, 1 row tall
+                br = {
+                    col: decoded.col + 1,
+                    colOff: DEFAULT_END_COL_OFF,
+                    row: decoded.row,
+                    rowOff: DEFAULT_END_ROW_OFF
+                };
+            }
+        }
+        else if ("startCol" in range) {
+            // startCol/startRow/endCol/endRow format (0-based)
+            tl = {
+                col: range.startCol,
+                colOff: range.startColOff ?? DEFAULT_COL_OFF,
+                row: range.startRow,
+                rowOff: range.startRowOff ?? DEFAULT_ROW_OFF
+            };
+            br = {
+                col: range.endCol,
+                colOff: range.endColOff ?? DEFAULT_END_COL_OFF,
+                row: range.endRow,
+                rowOff: range.endRowOff ?? DEFAULT_END_ROW_OFF
+            };
+        }
+        else {
+            // Object format with tl/br
+            if (typeof range.tl === "string") {
+                const decoded = colCache.decodeAddress(range.tl);
+                tl = {
+                    col: decoded.col - 1,
+                    colOff: DEFAULT_COL_OFF,
+                    row: decoded.row - 1,
+                    rowOff: DEFAULT_ROW_OFF
+                };
+            }
+            else {
+                tl = {
+                    col: range.tl.col,
+                    colOff: range.tl.colOff ?? DEFAULT_COL_OFF,
+                    row: range.tl.row,
+                    rowOff: range.tl.rowOff ?? DEFAULT_ROW_OFF
+                };
+            }
+            if (range.br) {
+                if (typeof range.br === "string") {
+                    const decoded = colCache.decodeAddress(range.br);
+                    br = {
+                        col: decoded.col - 1,
+                        colOff: DEFAULT_END_COL_OFF,
+                        row: decoded.row - 1,
+                        rowOff: DEFAULT_END_ROW_OFF
+                    };
+                }
+                else {
+                    br = {
+                        col: range.br.col,
+                        colOff: range.br.colOff ?? DEFAULT_END_COL_OFF,
+                        row: range.br.row,
+                        rowOff: range.br.rowOff ?? DEFAULT_END_ROW_OFF
+                    };
+                }
+            }
+            else {
+                // Default size
+                br = {
+                    col: tl.col + 2,
+                    colOff: DEFAULT_END_COL_OFF,
+                    row: tl.row + 1,
+                    rowOff: DEFAULT_END_ROW_OFF
+                };
+            }
+        }
+        return { tl, br };
+    }
+    // =========================================================================
+    // Instance methods - delegate to static methods
+    // =========================================================================
+    /**
+     * Convert anchor to VML anchor string format
+     * Format: "fromCol, fromColOff, fromRow, fromRowOff, toCol, toColOff, toRow, toRowOff"
+     * VML uses pixels for offsets
+     */
+    getVmlAnchor() {
+        return FormCheckbox.getVmlAnchor(this.model);
+    }
+    /**
+     * Get VML style string for positioning
+     */
+    getVmlStyle() {
+        return FormCheckbox.getVmlStyle(this.model);
+    }
+    /**
+     * Get the numeric checked value for VML (0, 1, or 2)
+     */
+    getVmlCheckedValue() {
+        return FormCheckbox.getVmlCheckedValue(this.model);
+    }
+    // =========================================================================
+    // Static utility methods - can be used with FormCheckboxModel directly
+    // =========================================================================
+    /**
+     * Convert anchor to VML anchor string format from model
+     */
+    static getVmlAnchor(model) {
+        const { tl, br } = model;
+        const tlColOff = Math.round(tl.colOff / EMU_PER_PIXEL);
+        const tlRowOff = Math.round(tl.rowOff / EMU_PER_PIXEL);
+        const brColOff = Math.round(br.colOff / EMU_PER_PIXEL);
+        const brRowOff = Math.round(br.rowOff / EMU_PER_PIXEL);
+        return `${tl.col}, ${tlColOff}, ${tl.row}, ${tlRowOff}, ${br.col}, ${brColOff}, ${br.row}, ${brRowOff}`;
+    }
+    /**
+     * Get VML style string for positioning from model
+     */
+    static getVmlStyle(model) {
+        const marginLeft = Math.round(model.tl.colOff / EMU_PER_POINT);
+        const marginTop = Math.round(model.tl.rowOff / EMU_PER_POINT);
+        return `position:absolute;margin-left:${marginLeft}pt;margin-top:${marginTop}pt;width:96pt;height:18pt;z-index:1;visibility:visible`;
+    }
+    /**
+     * Get the numeric checked value for VML from model (0, 1, or 2)
+     */
+    static getVmlCheckedValue(model) {
+        switch (model.checked) {
+            case "Checked":
+                return 1;
+            case "Mixed":
+                return 2;
+            default:
+                return 0;
+        }
+    }
+}
+export { FormCheckbox };

package/dist/esm/modules/excel/utils/ooxml-paths.js

@@ -209,3 +209,11 @@ export function mediaRelTargetFromRels(filename) {
     // Target from a rels file located under xl/*/_rels (base is one level deeper than xl/)
     return `../media/${filename}`;
 }
+// Form Control (ctrlProps) path functions
+export function ctrlPropPath(id) {
+    return `xl/ctrlProps/ctrlProp${id}.xml`;
+}
+export function ctrlPropRelTargetFromWorksheet(id) {
+    // Target inside xl/worksheets/_rels/sheetN.xml.rels (base: xl/worksheets/)
+    return `../ctrlProps/ctrlProp${id}.xml`;
+}

package/dist/esm/modules/excel/worksheet.js

@@ -6,6 +6,7 @@ import { Enums } from "./enums.js";
 import { Image } from "./image.js";
 import { Table } from "./table.js";
 import { DataValidations } from "./data-validations.js";
+import { FormCheckbox } from "./form-control.js";
 import { Encryptor } from "./utils/encryptor.js";
 import { uint8ArrayToBase64 } from "../../utils/utils.js";
 import { makePivotTable } from "./pivot-table.js";
@@ -92,6 +93,8 @@ class Worksheet {
         this.tables = {};
         this.pivotTables = [];
         this.conditionalFormattings = [];
+        // for form controls (legacy checkboxes, etc.)
+        this.formControls = [];
     }
     get name() {
         return this._name;
@@ -745,6 +748,43 @@ class Worksheet {
         return image && image.imageId;
     }
     // =========================================================================
+    // Form Controls (Legacy Checkboxes)
+    /**
+     * Add a form control checkbox to the worksheet.
+     *
+     * Form control checkboxes are the legacy style that work in Office 2007+,
+     * WPS Office, LibreOffice, and other spreadsheet applications.
+     *
+     * Unlike modern in-cell checkboxes (which only work in Microsoft 365),
+     * form control checkboxes are floating controls positioned over cells.
+     *
+     * @param range - Cell reference (e.g., "B2") or range (e.g., "B2:D3") for positioning
+     * @param options - Checkbox options
+     * @returns The created FormCheckbox instance
+     *
+     * @example
+     * // Simple checkbox at B2
+     * ws.addFormCheckbox("B2");
+     *
+     * // Checkbox with label and linked cell
+     * ws.addFormCheckbox("B2:D3", {
+     *   text: "Accept terms",
+     *   link: "A2",
+     *   checked: false
+     * });
+     */
+    addFormCheckbox(range, options) {
+        const checkbox = new FormCheckbox(this, range, options);
+        this.formControls.push(checkbox);
+        return checkbox;
+    }
+    /**
+     * Get all form control checkboxes in the worksheet
+     */
+    getFormCheckboxes() {
+        return this.formControls;
+    }
+    // =========================================================================
     // Worksheet Protection
     /**
      * Protect the worksheet with optional password and options
@@ -853,7 +893,8 @@ class Worksheet {
             sheetProtection: this.sheetProtection,
             tables: Object.values(this.tables).map(table => table.model),
             pivotTables: this.pivotTables,
-            conditionalFormattings: this.conditionalFormattings
+            conditionalFormattings: this.conditionalFormattings,
+            formControls: this.formControls.map(fc => fc.model)
         };
         // =================================================
         // columns
@@ -919,6 +960,8 @@ class Worksheet {
         }, {});
         this.pivotTables = value.pivotTables;
         this.conditionalFormattings = value.conditionalFormattings;
+        // Form controls are currently write-only (not parsed from XLSX)
+        this.formControls = [];
     }
 }
 export { Worksheet };

package/dist/esm/modules/excel/xlsx/rel-type.js

@@ -15,6 +15,7 @@ const RelType = {
     PivotCacheDefinition: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/pivotCacheDefinition",
     PivotCacheRecords: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/pivotCacheRecords",
     PivotTable: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/pivotTable",
-    FeaturePropertyBag: "http://schemas.microsoft.com/office/2022/11/relationships/FeaturePropertyBag"
+    FeaturePropertyBag: "http://schemas.microsoft.com/office/2022/11/relationships/FeaturePropertyBag",
+    CtrlProp: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/ctrlProp"
 };
 export { RelType };

package/dist/esm/modules/excel/xlsx/xform/core/content-types-xform.js

@@ -1,6 +1,6 @@
 import { XmlStream } from "../../../utils/xml-stream.js";
 import { BaseXform } from "../base-xform.js";
-import { OOXML_PATHS, commentsPathFromName, drawingPath, pivotCacheDefinitionPath, pivotCacheRecordsPath, pivotTablePath, tablePath, toContentTypesPartName, worksheetPath } from "../../../utils/ooxml-paths.js";
+import { OOXML_PATHS, commentsPathFromName, ctrlPropPath, drawingPath, pivotCacheDefinitionPath, pivotCacheRecordsPath, pivotTablePath, tablePath, toContentTypesPartName, worksheetPath } from "../../../utils/ooxml-paths.js";
 // used for rendering the [Content_Types].xml file
 // not used for parsing
 class ContentTypesXform extends BaseXform {
@@ -105,6 +105,22 @@ class ContentTypesXform extends BaseXform {
                 });
             });
         }
+        // Add form control (ctrlProps) content types
+        if (model.formControlRefs) {
+            // Ensure vml extension is declared (may already be declared for comments)
+            if (!model.commentRefs) {
+                xmlStream.leafNode("Default", {
+                    Extension: "vml",
+                    ContentType: "application/vnd.openxmlformats-officedocument.vmlDrawing"
+                });
+            }
+            for (const ctrlPropId of model.formControlRefs) {
+                xmlStream.leafNode("Override", {
+                    PartName: toContentTypesPartName(ctrlPropPath(ctrlPropId)),
+                    ContentType: "application/vnd.ms-excel.controlproperties+xml"
+                });
+            }
+        }
         xmlStream.leafNode("Override", {
             PartName: toContentTypesPartName(OOXML_PATHS.docPropsCore),
             ContentType: "application/vnd.openxmlformats-package.core-properties+xml"

package/dist/esm/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 };