xlkit 1.2.0 → 1.2.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 xlkit contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 xlkit contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,57 @@
+# xlkit
+
+<p align="center">
+  <img src="logo.png" alt="xlkit logo" width="200">
+</p>
+
+**Declarative Excel generation library** - See the final Excel structure from your code
+
+[Documentation](https://yn1323.github.io/xlkit/)
+
+Built on top of ExcelJS, providing a more intuitive and declarative API.
+
+## Comparison with ExcelJS
+
+| Aspect | ExcelJS (Imperative) | xlkit (Declarative) |
+|--------|---------------------|---------------------|
+| Style | Operate cells one by one | Declare the final structure |
+| Clarity | Hard to see the result from code | Easy to see the result from code |
+| Analogy | jQuery | React |
+
+## Installation
+
+```bash
+npm install xlkit
+# or
+pnpm add xlkit
+# or
+yarn add xlkit
+```
+
+## Quick Start
+
+```typescript
+import { xlkit } from "xlkit";
+
+const output = await xlkit()
+  .sheet("Sales")
+  .table({
+    preset: "basic",
+    columns: [
+      { key: "name", label: "Product" },
+      { key: "price", label: "Price" },
+      { key: "quantity", label: "Quantity" },
+    ],
+    data: [
+      { name: "Apple", price: 100, quantity: 50 },
+      { name: "Orange", price: 80, quantity: 100 },
+    ],
+  })
+  .getNode();
+
+await output.saveToFile("report.xlsx");
+```
+
+## License
+
+MIT

package/dist/index.cjs

@@ -38,9 +38,6 @@ module.exports = __toCommonJS(index_exports);
 // src/engine/writer.ts
 var import_exceljs = __toESM(require("exceljs"), 1);
 
-// src/engine/sheet-writer.ts
-var import_node_fs = require("fs");
-
 // src/styles/converter.ts
 function convertToExcelJSStyle(style) {
   if (!style) return {};
@@ -238,7 +235,7 @@ var TABLE_PRESETS = {
 function getPreset(presetName) {
   const preset = TABLE_PRESETS[presetName];
   if (!preset) {
-    throw new Error(`\u4E0D\u660E\u306A\u30D7\u30EA\u30BB\u30C3\u30C8\u540D: ${presetName}`);
+    throw new Error(`Unknown preset name: ${presetName}`);
   }
   return preset;
 }
@@ -262,6 +259,14 @@ function isSpaceBlock(block) {
   return block.type === "space";
 }
 
+// src/utils/buffer.ts
+function isBuffer(value) {
+  return typeof Buffer !== "undefined" && Buffer.isBuffer(value);
+}
+function isUrl(value) {
+  return value.startsWith("http://") || value.startsWith("https://");
+}
+
 // src/types/column.ts
 function isLeafColumn(column) {
   return "key" in column;
@@ -392,21 +397,21 @@ var SheetWriter = class {
   /**
    * SheetStateを書き込む
    */
-  writeSheet(sheetState) {
+  async writeSheet(sheetState) {
     for (const block of sheetState.blocks) {
-      this.writeBlock(block);
+      await this.writeBlock(block);
     }
   }
   /**
    * ブロックを書き込む
    */
-  writeBlock(block) {
+  async writeBlock(block) {
     if (isTableBlock(block)) {
       this.writeTable(block.options);
     } else if (isTextBlock(block)) {
       this.writeText(block.input);
     } else if (isImageBlock(block)) {
-      this.writeImage(block.options);
+      await this.writeImage(block.options);
     } else if (isSpaceBlock(block)) {
       this.writeSpace(block.lines);
     }
@@ -639,13 +644,20 @@ var SheetWriter = class {
   /**
    * 画像を書き込む
    */
-  writeImage(options) {
+  async writeImage(options) {
     const { source, width = 100, height = 100, row, col = 0 } = options;
     let imageBuffer;
-    if (Buffer.isBuffer(source)) {
+    if (isBuffer(source)) {
       imageBuffer = source;
+    } else if (isUrl(source)) {
+      const response = await fetch(source);
+      imageBuffer = await response.arrayBuffer();
     } else {
-      imageBuffer = (0, import_node_fs.readFileSync)(source);
+      if (typeof window !== "undefined") {
+        throw new Error("File path is not supported in browser. Use URL or Buffer.");
+      }
+      const fs = require("fs");
+      imageBuffer = fs.readFileSync(source);
     }
     const imageId = this.workbook.addImage({
       buffer: imageBuffer,
@@ -674,7 +686,7 @@ async function writeWorkbook(state) {
   for (const sheetState of state.sheets) {
     const worksheet = workbook.addWorksheet(sheetState.name);
     const writer = new SheetWriter(workbook, worksheet);
-    writer.writeSheet(sheetState);
+    await writer.writeSheet(sheetState);
   }
   return workbook;
 }
@@ -730,30 +742,32 @@ var EXCEL_LIMITS = {
 };
 function validateSheetName(name) {
   if (name.length > EXCEL_LIMITS.SHEET_NAME_MAX_LENGTH) {
-    throw new Error("\u30B7\u30FC\u30C8\u540D\u306F31\u6587\u5B57\u4EE5\u5185\u3067\u3042\u308B\u5FC5\u8981\u304C\u3042\u308A\u307E\u3059");
+    throw new Error("Sheet name must be 31 characters or less");
   }
   for (const char of EXCEL_LIMITS.SHEET_NAME_INVALID_CHARS) {
     if (name.includes(char)) {
-      throw new Error(`\u30B7\u30FC\u30C8\u540D\u306B\u4F7F\u7528\u3067\u304D\u306A\u3044\u6587\u5B57\u304C\u542B\u307E\u308C\u3066\u3044\u307E\u3059: ${char}`);
+      throw new Error(`Sheet name contains invalid character: ${char}`);
     }
   }
   if (name.trim().length === 0) {
-    throw new Error("\u30B7\u30FC\u30C8\u540D\u3092\u7A7A\u767D\u306E\u307F\u306B\u3059\u308B\u3053\u3068\u306F\u3067\u304D\u307E\u305B\u3093");
+    throw new Error("Sheet name cannot be only whitespace");
   }
 }
 function validateDataSize(rowCount, columnCount) {
   if (rowCount > EXCEL_LIMITS.MAX_ROWS) {
-    throw new Error("\u30C7\u30FC\u30BF\u884C\u6570\u304CExcel\u306E\u4E0A\u9650(1,048,576\u884C)\u3092\u8D85\u3048\u3066\u3044\u307E\u3059");
+    throw new Error("Row count exceeds Excel limit (1,048,576 rows)");
   }
   if (columnCount > EXCEL_LIMITS.MAX_COLUMNS) {
-    throw new Error("\u5217\u6570\u304CExcel\u306E\u4E0A\u9650(16,384\u5217)\u3092\u8D85\u3048\u3066\u3044\u307E\u3059");
+    throw new Error("Column count exceeds Excel limit (16,384 columns)");
   }
 }
 
 // src/schemas/image.ts
 var import_zod = require("zod");
 var imageSourceSchema = import_zod.z.union([
-  import_zod.z.instanceof(Buffer),
+  import_zod.z.custom((val) => isBuffer(val), {
+    message: "Expected Buffer"
+  }),
   import_zod.z.string().url(),
   // URL形式
   import_zod.z.string().min(1)
@@ -893,7 +907,7 @@ var SheetBuilder = class {
    */
   space(lines = 1) {
     if (lines <= 0) {
-      throw new Error("space() \u306E\u5F15\u6570\u306F\u6B63\u306E\u6574\u6570\u3067\u3042\u308B\u5FC5\u8981\u304C\u3042\u308A\u307E\u3059");
+      throw new Error("space() argument must be a positive integer");
     }
     const block = { type: "space", lines };
     this.sheetState.blocks.push(block);
@@ -934,7 +948,7 @@ var WorkbookBuilder = class {
     const sheetName = name ?? `Sheet${this.state.sheets.length + 1}`;
     validateSheetName(sheetName);
     if (this.state.sheets.some((s) => s.name === sheetName)) {
-      throw new Error(`\u30B7\u30FC\u30C8\u540D "${sheetName}" \u306F\u65E2\u306B\u5B58\u5728\u3057\u307E\u3059`);
+      throw new Error(`Sheet name "${sheetName}" already exists`);
     }
     const sheetState = { name: sheetName, blocks: [] };
     this.state.sheets.push(sheetState);
@@ -1145,7 +1159,7 @@ var WorkbookReader = class {
   sheet(name) {
     const worksheet = this.workbook.getWorksheet(name);
     if (!worksheet) {
-      throw new Error(`\u30B7\u30FC\u30C8 "${name}" \u304C\u898B\u3064\u304B\u308A\u307E\u305B\u3093`);
+      throw new Error(`Sheet "${name}" not found`);
     }
     return new SheetReader(worksheet);
   }
@@ -1155,7 +1169,7 @@ var WorkbookReader = class {
   sheetAt(index) {
     const worksheet = this.workbook.worksheets[index];
     if (!worksheet) {
-      throw new Error(`\u30A4\u30F3\u30C7\u30C3\u30AF\u30B9 ${index} \u306E\u30B7\u30FC\u30C8\u304C\u898B\u3064\u304B\u308A\u307E\u305B\u3093`);
+      throw new Error(`Sheet at index ${index} not found`);
     }
     return new SheetReader(worksheet);
   }
@@ -1168,7 +1182,7 @@ var WorkbookReader = class {
 };
 async function read(source) {
   const workbook = new import_exceljs2.default.Workbook();
-  if (Buffer.isBuffer(source)) {
+  if (isBuffer(source)) {
     await workbook.xlsx.load(source);
   } else {
     await workbook.xlsx.readFile(source);