@cj-tech-master/excelts 1.6.3 → 2.0.0

package/dist/cjs/doc/workbook.base.js

@@ -0,0 +1,211 @@
+"use strict";
+/**
+ * WorkbookBase - Platform-independent base class for Workbook
+ *
+ * This file contains all the shared logic between Node.js and Browser versions.
+ * Platform-specific features (xlsx, csv, streaming) are added by subclasses.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkbookBase = void 0;
+const worksheet_1 = require("./worksheet");
+const defined_names_1 = require("./defined-names");
+// =============================================================================
+// WorkbookBase Class
+// =============================================================================
+/**
+ * Base class for Workbook containing all platform-independent functionality.
+ *
+ * Subclasses add:
+ * - Node.js: xlsx (full), csv, streaming (createStreamWriter/Reader)
+ * - Browser: xlsx (buffer only), no csv, no streaming
+ */
+class WorkbookBase {
+    constructor() {
+        this.category = "";
+        this.company = "";
+        this.created = new Date();
+        this.description = "";
+        this.keywords = "";
+        this.manager = "";
+        this.modified = this.created;
+        this.properties = {};
+        this.calcProperties = {};
+        this._worksheets = [];
+        this.subject = "";
+        this.title = "";
+        this.views = [];
+        this.media = [];
+        this.pivotTables = [];
+        this._definedNames = new defined_names_1.DefinedNames();
+    }
+    // ===========================================================================
+    // Worksheet Management
+    // ===========================================================================
+    get nextId() {
+        // Find the next unique spot to add worksheet
+        for (let i = 1; i < this._worksheets.length; i++) {
+            if (!this._worksheets[i]) {
+                return i;
+            }
+        }
+        return this._worksheets.length || 1;
+    }
+    /**
+     * Add a new worksheet and return a reference to it
+     */
+    addWorksheet(name, options) {
+        const id = this.nextId;
+        const lastOrderNo = this._worksheets.reduce((acc, ws) => ((ws && ws.orderNo) > acc ? ws.orderNo : acc), 0);
+        const worksheetOptions = {
+            ...options,
+            id,
+            name,
+            orderNo: lastOrderNo + 1,
+            workbook: this
+        };
+        const worksheet = new worksheet_1.Worksheet(worksheetOptions);
+        this._worksheets[id] = worksheet;
+        return worksheet;
+    }
+    removeWorksheetEx(worksheet) {
+        delete this._worksheets[worksheet.id];
+    }
+    removeWorksheet(id) {
+        const worksheet = this.getWorksheet(id);
+        if (worksheet) {
+            worksheet.destroy();
+        }
+    }
+    /**
+     * Fetch sheet by name or id
+     */
+    getWorksheet(id) {
+        if (id === undefined) {
+            return this._worksheets.find(Boolean);
+        }
+        if (typeof id === "number") {
+            return this._worksheets[id];
+        }
+        if (typeof id === "string") {
+            return this._worksheets.find(worksheet => worksheet && worksheet.name === id);
+        }
+        return undefined;
+    }
+    /**
+     * Return a clone of worksheets in order
+     */
+    get worksheets() {
+        return this._worksheets
+            .slice(1)
+            .sort((a, b) => a.orderNo - b.orderNo)
+            .filter(Boolean);
+    }
+    /**
+     * Iterate over all sheets.
+     *
+     * Note: `workbook.worksheets.forEach` will still work but this is better.
+     */
+    eachSheet(callback) {
+        this.worksheets.forEach(sheet => {
+            callback(sheet, sheet.id);
+        });
+    }
+    // ===========================================================================
+    // Defined Names
+    // ===========================================================================
+    get definedNames() {
+        return this._definedNames;
+    }
+    // ===========================================================================
+    // Themes
+    // ===========================================================================
+    clearThemes() {
+        // Note: themes are not an exposed feature, meddle at your peril!
+        this._themes = undefined;
+    }
+    // ===========================================================================
+    // Images
+    // ===========================================================================
+    /**
+     * Add Image to Workbook and return the id
+     */
+    addImage(image) {
+        const id = this.media.length;
+        this.media.push({ ...image, type: "image" });
+        return id;
+    }
+    getImage(id) {
+        return this.media[Number(id)];
+    }
+    // ===========================================================================
+    // Model (Serialization)
+    // ===========================================================================
+    get model() {
+        return {
+            creator: this.creator || "Unknown",
+            lastModifiedBy: this.lastModifiedBy || "Unknown",
+            lastPrinted: this.lastPrinted,
+            created: this.created,
+            modified: this.modified,
+            properties: this.properties,
+            worksheets: this.worksheets.map(worksheet => worksheet.model),
+            sheets: this.worksheets.map(ws => ws.model).filter(Boolean),
+            definedNames: this._definedNames.model,
+            views: this.views,
+            company: this.company,
+            manager: this.manager,
+            title: this.title,
+            subject: this.subject,
+            keywords: this.keywords,
+            category: this.category,
+            description: this.description,
+            language: this.language,
+            revision: this.revision,
+            contentStatus: this.contentStatus,
+            themes: this._themes,
+            media: this.media,
+            pivotTables: this.pivotTables,
+            calcProperties: this.calcProperties
+        };
+    }
+    set model(value) {
+        this.creator = value.creator;
+        this.lastModifiedBy = value.lastModifiedBy;
+        this.lastPrinted = value.lastPrinted;
+        this.created = value.created;
+        this.modified = value.modified;
+        this.company = value.company;
+        this.manager = value.manager;
+        this.title = value.title;
+        this.subject = value.subject;
+        this.keywords = value.keywords;
+        this.category = value.category;
+        this.description = value.description;
+        this.language = value.language;
+        this.revision = value.revision;
+        this.contentStatus = value.contentStatus;
+        this.properties = value.properties;
+        this.calcProperties = value.calcProperties;
+        this._worksheets = [];
+        value.worksheets.forEach(worksheetModel => {
+            const { id, name, state } = worksheetModel;
+            const orderNo = value.sheets && value.sheets.findIndex(ws => ws.id === id);
+            const worksheet = (this._worksheets[id] = new worksheet_1.Worksheet({
+                id,
+                name,
+                orderNo: orderNo !== -1 ? orderNo : undefined,
+                state,
+                workbook: this
+            }));
+            worksheet.model = worksheetModel;
+        });
+        this._definedNames.model = value.definedNames;
+        this.views = value.views;
+        this._themes = value.themes;
+        this.media = value.media || [];
+        // Handle pivot tables - either newly created or loaded from file
+        // Loaded pivot tables come from loadedPivotTables after reconciliation
+        this.pivotTables = value.pivotTables || value.loadedPivotTables || [];
+    }
+}
+exports.WorkbookBase = WorkbookBase;

package/dist/cjs/doc/workbook.browser.js

@@ -0,0 +1,62 @@
+"use strict";
+/**
+ * Workbook Browser version - No Node.js dependencies
+ *
+ * Extends WorkbookBase with:
+ * - xlsx: Buffer-based operations (load, writeBuffer)
+ * - csv: Buffer-based operations (load, writeString, writeBuffer)
+ * - streaming: NOT supported (throws error)
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Workbook = void 0;
+const workbook_base_1 = require("./workbook.base");
+const xlsx_browser_1 = require("../xlsx/xlsx.browser");
+const csv_browser_1 = require("../csv/csv.browser");
+class Workbook extends workbook_base_1.WorkbookBase {
+    /**
+     * xlsx file format operations
+     * Supports: load (buffer), writeBuffer
+     * NOT supported: readFile, writeFile, read (stream), write (stream)
+     */
+    get xlsx() {
+        if (!this._xlsx) {
+            this._xlsx = new xlsx_browser_1.XLSX(this);
+        }
+        return this._xlsx;
+    }
+    /**
+     * CSV file format operations
+     * Supports: load (string/buffer), writeString, writeBuffer
+     * NOT supported: readFile, writeFile, read (stream), write (stream)
+     */
+    get csv() {
+        if (!this._csv) {
+            this._csv = new csv_browser_1.CSV(this);
+        }
+        return this._csv;
+    }
+    // ===========================================================================
+    // Static Factory Methods - NOT available in browser
+    // TypeScript users: These methods don't exist on this type
+    // JavaScript users: These methods throw helpful errors
+    // ===========================================================================
+    /**
+     * @deprecated Streaming is not available in browser
+     * @throws Error with helpful message
+     */
+    static createStreamWriter(_options) {
+        throw new Error("Streaming workbook writer is not available in browser. " +
+            "Use `new Workbook()` with `xlsx.writeBuffer()` instead, " +
+            "or import from 'excelts' (Node.js) for streaming support.");
+    }
+    /**
+     * @deprecated Streaming is not available in browser
+     * @throws Error with helpful message
+     */
+    static createStreamReader(_input, _options) {
+        throw new Error("Streaming workbook reader is not available in browser. " +
+            "Use `new Workbook()` with `xlsx.load()` instead, " +
+            "or import from 'excelts' (Node.js) for streaming support.");
+    }
+}
+exports.Workbook = Workbook;

package/dist/cjs/doc/workbook.js

@@ -1,207 +1,96 @@
 "use strict";
+/**
+ * Workbook - Node.js version with full functionality
+ *
+ * Extends WorkbookBase with:
+ * - xlsx: Full file/stream/buffer support
+ * - csv: CSV read/write support
+ * - streaming: createStreamWriter/createStreamReader for large files
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Workbook = void 0;
-const worksheet_js_1 = require("./worksheet");
-const defined_names_js_1 = require("./defined-names");
-const xlsx_js_1 = require("../xlsx/xlsx");
-const csv_js_1 = require("../csv/csv");
-// Workbook requirements
-//  Load and Save from file and stream
-//  Access/Add/Delete individual worksheets
-//  Manage String table, Hyperlink table, etc.
-//  Manage scaffolding for contained objects to write to/read from
-class Workbook {
-    constructor() {
-        this.category = "";
-        this.company = "";
-        this.created = new Date();
-        this.description = "";
-        this.keywords = "";
-        this.manager = "";
-        this.modified = this.created;
-        this.properties = {};
-        this.calcProperties = {};
-        this._worksheets = [];
-        this.subject = "";
-        this.title = "";
-        this.views = [];
-        this.media = [];
-        this.pivotTables = [];
-        this._definedNames = new defined_names_js_1.DefinedNames();
-    }
+const workbook_base_1 = require("./workbook.base");
+const xlsx_1 = require("../xlsx/xlsx");
+const csv_1 = require("../csv/csv");
+const workbook_writer_1 = require("../stream/xlsx/workbook-writer");
+const workbook_reader_1 = require("../stream/xlsx/workbook-reader");
+class Workbook extends workbook_base_1.WorkbookBase {
     /**
      * xlsx file format operations
+     * Supports: readFile, writeFile, read (stream), write (stream), load (buffer), writeBuffer
      */
     get xlsx() {
         if (!this._xlsx) {
-            this._xlsx = new xlsx_js_1.XLSX(this);
+            this._xlsx = new xlsx_1.XLSX(this);
         }
         return this._xlsx;
     }
     /**
      * csv file format operations
+     * Supports: readFile, writeFile, read (stream), write (stream)
      */
     get csv() {
         if (!this._csv) {
-            this._csv = new csv_js_1.CSV(this);
+            this._csv = new csv_1.CSV(this);
         }
         return this._csv;
     }
-    get nextId() {
-        // find the next unique spot to add worksheet
-        for (let i = 1; i < this._worksheets.length; i++) {
-            if (!this._worksheets[i]) {
-                return i;
-            }
-        }
-        return this._worksheets.length || 1;
-    }
-    /**
-     * Add a new worksheet and return a reference to it
-     */
-    addWorksheet(name, options) {
-        const id = this.nextId;
-        const lastOrderNo = this._worksheets.reduce((acc, ws) => ((ws && ws.orderNo) > acc ? ws.orderNo : acc), 0);
-        const worksheetOptions = {
-            ...options,
-            id,
-            name,
-            orderNo: lastOrderNo + 1,
-            workbook: this
-        };
-        const worksheet = new worksheet_js_1.Worksheet(worksheetOptions);
-        this._worksheets[id] = worksheet;
-        return worksheet;
-    }
-    removeWorksheetEx(worksheet) {
-        delete this._worksheets[worksheet.id];
-    }
-    removeWorksheet(id) {
-        const worksheet = this.getWorksheet(id);
-        if (worksheet) {
-            worksheet.destroy();
-        }
-    }
-    /**
-     * Fetch sheet by name or id
-     */
-    getWorksheet(id) {
-        if (id === undefined) {
-            return this._worksheets.find(Boolean);
-        }
-        if (typeof id === "number") {
-            return this._worksheets[id];
-        }
-        if (typeof id === "string") {
-            return this._worksheets.find(worksheet => worksheet && worksheet.name === id);
-        }
-        return undefined;
-    }
+    // ===========================================================================
+    // Static Factory Methods for Streaming (Node.js only)
+    // ===========================================================================
     /**
-     * Return a clone of worksheets in order
-     */
-    get worksheets() {
-        // return a clone of _worksheets
-        return this._worksheets
-            .slice(1)
-            .sort((a, b) => a.orderNo - b.orderNo)
-            .filter(Boolean);
-    }
-    /**
-     * Iterate over all sheets.
+     * Create a streaming workbook writer for large files.
+     * This is more memory-efficient than using Workbook for large datasets.
+     *
+     * @param options - Options for the workbook writer
+     * @returns A new WorkbookWriter instance
      *
-     * Note: `workbook.worksheets.forEach` will still work but this is better.
+     * @example
+     * ```ts
+     * const writer = Workbook.createStreamWriter({ filename: "large-file.xlsx" });
+     * const sheet = writer.addWorksheet("Sheet1");
+     * for (let i = 0; i < 1000000; i++) {
+     *   sheet.addRow([i, `Row ${i}`]).commit();
+     * }
+     * await writer.commit();
+     * ```
      */
-    eachSheet(callback) {
-        this.worksheets.forEach(sheet => {
-            callback(sheet, sheet.id);
-        });
-    }
-    get definedNames() {
-        return this._definedNames;
-    }
-    clearThemes() {
-        // Note: themes are not an exposed feature, meddle at your peril!
-        this._themes = undefined;
+    static createStreamWriter(options) {
+        return new workbook_writer_1.WorkbookWriter(options);
     }
     /**
-     * Add Image to Workbook and return the id
+     * Create a streaming workbook reader for large files.
+     * This is more memory-efficient than using Workbook.xlsx.readFile for large datasets.
+     *
+     * @param input - File path or readable stream
+     * @param options - Options for the workbook reader
+     * @returns A new WorkbookReader instance
+     *
+     * @example
+     * ```ts
+     * const reader = Workbook.createStreamReader("large-file.xlsx");
+     * for await (const event of reader) {
+     *   if (event.eventType === "worksheet") {
+     *     const worksheet = event.value;
+     *     for await (const row of worksheet) {
+     *       console.log(row.values);
+     *     }
+     *   }
+     * }
+     * ```
      */
-    addImage(image) {
-        // TODO:  validation?
-        const id = this.media.length;
-        this.media.push({ ...image, type: "image" });
-        return id;
-    }
-    getImage(id) {
-        return this.media[Number(id)];
-    }
-    get model() {
-        return {
-            creator: this.creator || "Unknown",
-            lastModifiedBy: this.lastModifiedBy || "Unknown",
-            lastPrinted: this.lastPrinted,
-            created: this.created,
-            modified: this.modified,
-            properties: this.properties,
-            worksheets: this.worksheets.map(worksheet => worksheet.model),
-            sheets: this.worksheets.map(ws => ws.model).filter(Boolean),
-            definedNames: this._definedNames.model,
-            views: this.views,
-            company: this.company,
-            manager: this.manager,
-            title: this.title,
-            subject: this.subject,
-            keywords: this.keywords,
-            category: this.category,
-            description: this.description,
-            language: this.language,
-            revision: this.revision,
-            contentStatus: this.contentStatus,
-            themes: this._themes,
-            media: this.media,
-            pivotTables: this.pivotTables,
-            calcProperties: this.calcProperties
-        };
-    }
-    set model(value) {
-        this.creator = value.creator;
-        this.lastModifiedBy = value.lastModifiedBy;
-        this.lastPrinted = value.lastPrinted;
-        this.created = value.created;
-        this.modified = value.modified;
-        this.company = value.company;
-        this.manager = value.manager;
-        this.title = value.title;
-        this.subject = value.subject;
-        this.keywords = value.keywords;
-        this.category = value.category;
-        this.description = value.description;
-        this.language = value.language;
-        this.revision = value.revision;
-        this.contentStatus = value.contentStatus;
-        this.properties = value.properties;
-        this.calcProperties = value.calcProperties;
-        this._worksheets = [];
-        value.worksheets.forEach(worksheetModel => {
-            const { id, name, state } = worksheetModel;
-            const orderNo = value.sheets && value.sheets.findIndex(ws => ws.id === id);
-            const worksheet = (this._worksheets[id] = new worksheet_js_1.Worksheet({
-                id,
-                name,
-                orderNo: orderNo !== -1 ? orderNo : undefined,
-                state,
-                workbook: this
-            }));
-            worksheet.model = worksheetModel;
-        });
-        this._definedNames.model = value.definedNames;
-        this.views = value.views;
-        this._themes = value.themes;
-        this.media = value.media || [];
-        // Handle pivot tables - either newly created or loaded from file
-        // Loaded pivot tables come from loadedPivotTables after reconciliation
-        this.pivotTables = value.pivotTables || value.loadedPivotTables || [];
+    static createStreamReader(input, options) {
+        return new workbook_reader_1.WorkbookReader(input, options);
     }
 }
 exports.Workbook = Workbook;
+/**
+ * Streaming workbook writer class for large files.
+ * @example new Workbook.Writer({ filename: "large.xlsx" })
+ */
+Workbook.Writer = workbook_writer_1.WorkbookWriter;
+/**
+ * Streaming workbook reader class for large files.
+ * @example new Workbook.Reader("large.xlsx")
+ */
+Workbook.Reader = workbook_reader_1.WorkbookReader;