md-spreadsheet-parser 1.2.1 → 1.3.1

package/README.ja.md

@@ -0,0 +1,180 @@
+# md-spreadsheet-parser (NPM)
+
+<p align="center">
+  <img src="https://img.shields.io/badge/wasm-powered-purple.svg" alt="WASM Powered" />
+  <a href="https://github.com/f-y/md-spreadsheet-parser/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License" />
+  </a>
+  <a href="https://www.npmjs.com/package/md-spreadsheet-parser">
+    <img src="https://img.shields.io/npm/v/md-spreadsheet-parser.svg" alt="npm" />
+  </a>
+  <a href="https://pypi.org/project/md-spreadsheet-parser/">
+    <img src="https://img.shields.io/pypi/v/md-spreadsheet-parser.svg" alt="PyPI" />
+  </a>
+</p>
+
+**md-spreadsheet-parser** は、Node.js用の堅牢なMarkdownテーブルパーサーおよび操作ライブラリです。
+[Pythonコア](https://github.com/f-y/md-spreadsheet-parser) をWebAssemblyにコンパイルして使用しており、Node.jsでネイティブに動作します。
+
+> **🎉 公式GUIエディタが登場: [PengSheets](https://marketplace.visualstudio.com/items?itemName=f-y.peng-sheets)**
+>
+> このライブラリのパワーをそのままに、VS Code上でExcelライクな操作感を実現しました。ソート、フィルタ、快適なナビゲーションなどをGUIで直感的に扱えます。
+>
+> [![Get it on VS Code Marketplace](https://img.shields.io/badge/VS%20Code%20Marketplace-%E3%81%A7%E3%83%80%E3%82%A6%E3%83%B3%E3%83%AD%E3%83%BC%E3%83%89-007ACC?style=for-the-badge&logo=visual-studio-code&logoColor=white)](https://marketplace.visualstudio.com/items?itemName=f-y.peng-sheets)
+
+## 機能
+
+- **🚀 高パフォーマンス**: プリコンパイルされたWASMバイナリ（約160msで初期化）。
+- **💪 堅牢な解析**: GFMテーブル、列の欠落、エスケープされたパイプを正しく処理します。
+- **🛠️ スプレッドシート操作**: セルの編集、行の追加/削除、Markdownの再生成をプログラムで行えます。
+- **🛡️ 型安全な検証**: スキーマ（Plain Object または Zod）に対してテーブルデータを検証します。
+- **📂 ファイルシステムサポート**: 直接ファイルを読み込む機能を提供します。
+
+## インストール
+
+```bash
+npm install md-spreadsheet-parser
+```
+
+## 使い方ガイド
+
+### 1. 基本的な解析 (文字列)
+
+Markdownテーブルの文字列を構造化された `Table` オブジェクトに解析します。
+
+```javascript
+import { parseTable } from 'md-spreadsheet-parser';
+
+const markdown = `
+| Name | Age |
+| --- | --- |
+| Alice | 30 |
+`;
+
+const table = parseTable(markdown);
+console.log(table.rows); // [ [ 'Alice', '30' ] ]
+```
+
+### 2. ファイルシステムの使用
+
+文字列に読み込むことなく、ファイルを直接解析できます。
+
+```javascript
+import { parseWorkbookFromFile, scanTablesFromFile } from 'md-spreadsheet-parser';
+
+// ワークブック全体（複数のシート）を解析
+const workbook = parseWorkbookFromFile('./data.md');
+console.log(`Parsed ${workbook.sheets.length} sheets`);
+
+// Lookup APIを使用して内容を検証
+const sheet = workbook.getSheet('Sheet1');
+if (sheet) {
+    const table = sheet.getTable(0); // 最初のテーブルを取得
+    console.log(table.headers);
+}
+
+// または、ファイル内のすべてのテーブルをスキャン
+const tables = scanTablesFromFile('./readme.md');
+console.log(`Found ${tables.length} tables`);
+```
+
+### 3. プログラムによる編集
+
+テーブルオブジェクトは可変です（内部的にはCoWのような動作）。変更してMarkdownにエクスポートし直すことができます。
+
+```javascript
+import { parseTable } from 'md-spreadsheet-parser';
+
+const table = parseTable("| Item | Price |\n|---|---|\n| Apple | 100 |");
+
+// セルを更新 (行 0, 列 1)
+table.updateCell(0, 1, "150");
+
+// Markdownに戻す
+console.log(table.toMarkdown());
+// | Item | Price |
+// | --- | --- |
+// | Apple | 150 |
+```
+
+### 4. 型安全な検証 (toModels)
+
+文字列ベースのテーブルデータを、型付きオブジェクトに変換できます。
+
+#### 基本的な使用法 (Plain Object Schema)
+コンバータ関数を持つ単純なスキーマオブジェクトを提供できます。
+
+```javascript
+const markdown = `
+| id | active |
+| -- | ------ |
+| 1  | yes    |
+`;
+const table = parseTable(markdown);
+
+// スキーマ定義
+const UserSchema = {
+    id: (val) => Number(val),
+    active: (val) => val === 'yes'
+};
+
+const users = table.toModels(UserSchema);
+console.log(users);
+// [ { id: 1, active: true } ]
+```
+
+#### 高度な使用法 (Zod)
+より堅牢な検証には、[Zod](https://zod.dev/) を使用してください。
+
+```javascript
+import { z } from 'zod';
+
+const UserZodSchema = z.object({
+    id: z.coerce.number(),
+    active: z.string().transform(v => v === 'yes')
+});
+
+const users = table.toModels(UserZodSchema);
+// [ { id: 1, active: true } ]
+```
+
+## API ドキュメント
+
+このパッケージはPythonコアの直接的なラッパーであるため、基本的な概念は同一です。APIの命名規則はJavaScript用に（snake_caseではなくcamelCaseに）適合されています。
+
+- **コアドキュメント**: [Python ユーザーガイド](https://github.com/f-y/md-spreadsheet-parser/blob/main/README.ja.md#使い方)
+- **クックブック**: [一般的なレシピ (日本語)](https://github.com/f-y/md-spreadsheet-parser/blob/main/COOKBOOK.ja.md)
+
+### 主な関数の対応
+
+| Python (Core) | JavaScript (NPM) | 説明 |
+|---|---|---|
+| `parse_table(md)` | `parseTable(md)` | 単一のテーブル文字列を解析 |
+| `parse_workbook(md)` | `parseWorkbook(md)` | ワークブック全体の文字列を解析 |
+| `scan_tables(md)` | `scanTables(md)` | 文字列からすべてのテーブルを抽出 |
+| `parse_workbook_from_file(path)` | `parseWorkbookFromFile(path)` | ファイルをワークブックに解析 |
+| `scan_tables_from_file(path)` | `scanTablesFromFile(path)` | ファイルからテーブルを抽出 |
+| `Table.to_markdown()` | `Table.toMarkdown()` | Markdownを生成 |
+| `Table.update_cell(r, c, v)` | `Table.updateCell(r, c, v)` | 特定のセルを更新 |
+| `Table.to_models(schema)` | `Table.toModels(schema)` | 型付きオブジェクトに変換 |
+| `Workbook.get_sheet(name)` | `Workbook.getSheet(name)` | 名前でシートを取得 |
+| `Sheet.get_table(index)` | `Sheet.getTable(index)` | インデックスでテーブルを取得 |
+
+## 制限事項
+
+以下のPython機能は、NPMパッケージでは **利用できません**:
+
+| 機能 | 理由 |
+|---------|--------|
+| `parse_excel()` / `parseExcel()` | Excelファイルの解析には `openpyxl` が必要ですが、これはWASMと互換性がありません |
+
+Excelファイル操作については、[Pythonパッケージ](https://github.com/f-y/md-spreadsheet-parser) を直接使用するか、COOKBOOKにあるようなテキストベース(CSV/TSV)の操作を使ってください。
+
+## アーキテクチャ
+
+このパッケージは、PythonライブラリをWASMコンポーネントとしてバンドルするために `componentize-py` を使用しています。
+詳細については、[ARCHITECTURE.md](./ARCHITECTURE.md) を参照してください。
+
+## ライセンス
+
+MIT

package/README.md

@@ -14,7 +14,18 @@
 </p>
 
 **md-spreadsheet-parser** is a robust Markdown table parser and manipulator for Node.js.
-It is powered by the [Python Core](https://github.com/f-y/md-spreadsheet-parser) compiled to WebAssembly, ensuring 100% logic parity with the Python version while running natively in Node.js.
+It is powered by the [Python Core](https://github.com/f-y/md-spreadsheet-parser) compiled to WebAssembly, while running natively in Node.js.
+
+> **🎉 Official GUI Editor Released: [PengSheets](https://marketplace.visualstudio.com/items?itemName=f-y.peng-sheets)**
+>
+> We have transformed this library into an Excel-like interface for VS Code. Edit Markdown tables with sort, filter, and easy navigation directly in your editor.
+>
+> [![Get it on VS Code Marketplace](https://img.shields.io/badge/Get%20it%20on-VS%20Code%20Marketplace-007ACC?style=for-the-badge&logo=visual-studio-code&logoColor=white)](https://marketplace.visualstudio.com/items?itemName=f-y.peng-sheets)
+
+Read in Japanese: 日本語版はこちら(
+<a href="https://github.com/f-y/md-spreadsheet-parser/blob/main/packages/npm/README.ja.md">README</a>
+)
+
 
 ## Features
 
@@ -162,7 +173,7 @@ The following Python features are **not available** in the NPM package:
 |---------|--------|
 | `parse_excel()` / `parseExcel()` | Excel file parsing requires `openpyxl`, which is not compatible with WASM |
 
-For Excel file operations, use the [Python package](https://github.com/f-y/md-spreadsheet-parser) directly.
+For Excel file operations, use the [Python package](https://github.com/f-y/md-spreadsheet-parser) directly, or use text-based operations (like TSV/CSV) as described in the COOKBOOK.
 
 ## Architecture
 

package/dist/index.d.ts

@@ -23,7 +23,7 @@ export declare class Table {
     metadata: any | undefined;
     startLine: number | undefined;
     endLine: number | undefined;
-    constructor(data?: Partial<Table>);
+    constructor(data?: Partial<Table> & Record<string, any>);
     toDTO(): any;
     /**
      * Returns a JSON-compatible plain object representation.
@@ -45,8 +45,10 @@ export declare class Table {
 export declare class Sheet {
     name: string | undefined;
     tables: any[] | undefined;
+    sheetType: string | undefined;
+    content: any | undefined;
     metadata: any | undefined;
-    constructor(data?: Partial<Sheet>);
+    constructor(data?: Partial<Sheet> & Record<string, any>);
     toDTO(): any;
     /**
      * Returns a JSON-compatible plain object representation.
@@ -63,8 +65,12 @@ export declare class Sheet {
 }
 export declare class Workbook {
     sheets: any[] | undefined;
+    name: string | undefined;
+    startLine: number | undefined;
+    endLine: number | undefined;
     metadata: any | undefined;
-    constructor(data?: Partial<Workbook>);
+    rootContent: any | undefined;
+    constructor(data?: Partial<Workbook> & Record<string, any>);
     toDTO(): any;
     /**
      * Returns a JSON-compatible plain object representation.
@@ -85,7 +91,7 @@ export declare class ParsingSchema {
     requireOuterPipes: boolean | undefined;
     stripWhitespace: boolean | undefined;
     convertBrToNewline: boolean | undefined;
-    constructor(data?: Partial<ParsingSchema>);
+    constructor(data?: Partial<ParsingSchema> & Record<string, any>);
     toDTO(): any;
 }
 export declare class MultiTableParsingSchema {
@@ -94,18 +100,18 @@ export declare class MultiTableParsingSchema {
     requireOuterPipes: boolean | undefined;
     stripWhitespace: boolean | undefined;
     convertBrToNewline: boolean | undefined;
-    rootMarker: string | undefined;
+    rootMarker: any | undefined;
     sheetHeaderLevel: number | undefined;
     tableHeaderLevel: number | undefined;
     captureDescription: boolean | undefined;
-    constructor(data?: Partial<MultiTableParsingSchema>);
+    constructor(data?: Partial<MultiTableParsingSchema> & Record<string, any>);
     toDTO(): any;
 }
 export declare class ConversionSchema {
     booleanPairs: string | undefined;
     customConverters: string | undefined;
     fieldConverters: string | undefined;
-    constructor(data?: Partial<ConversionSchema>);
+    constructor(data?: Partial<ConversionSchema> & Record<string, any>);
     toDTO(): any;
 }
 export declare class ExcelParsingSchema {
@@ -113,6 +119,6 @@ export declare class ExcelParsingSchema {
     fillMergedHeaders: boolean | undefined;
     delimiter: string | undefined;
     headerSeparator: string | undefined;
-    constructor(data?: Partial<ExcelParsingSchema>);
+    constructor(data?: Partial<ExcelParsingSchema> & Record<string, any>);
     toDTO(): any;
 }

package/dist/index.js

@@ -112,14 +112,17 @@ export function scanTablesIter(source, schema) {
 export class Table {
     constructor(data) {
         if (data) {
-            this.headers = data.headers;
-            this.rows = data.rows;
-            this.alignments = data.alignments;
-            this.name = data.name;
-            this.description = data.description;
-            this.metadata = (typeof data.metadata === 'string') ? JSON.parse(data.metadata) : data.metadata;
-            this.startLine = data.startLine;
-            this.endLine = data.endLine;
+            this.headers = data.headers ?? data.headers;
+            this.rows = data.rows ?? data.rows;
+            this.alignments = data.alignments ?? data.alignments;
+            this.name = data.name ?? data.name;
+            this.description = data.description ?? data.description;
+            {
+                const val = data.metadata ?? data.metadata;
+                this.metadata = (typeof val === 'string') ? JSON.parse(val) : val;
+            }
+            this.startLine = data.startLine ?? data.start_line;
+            this.endLine = data.endLine ?? data.end_line;
         }
     }
     toDTO() {
@@ -227,9 +230,14 @@ export class Table {
 export class Sheet {
     constructor(data) {
         if (data) {
-            this.name = data.name;
-            this.tables = (data.tables || []).map((x) => x instanceof Table ? x : new Table(x));
-            this.metadata = (typeof data.metadata === 'string') ? JSON.parse(data.metadata) : data.metadata;
+            this.name = data.name ?? data.name;
+            this.tables = ((data.tables ?? data.tables) || []).map((x) => x instanceof Table ? x : new Table(x));
+            this.sheetType = data.sheetType ?? data.sheet_type;
+            this.content = data.content ?? data.content;
+            {
+                const val = data.metadata ?? data.metadata;
+                this.metadata = (typeof val === 'string') ? JSON.parse(val) : val;
+            }
         }
     }
     toDTO() {
@@ -248,6 +256,8 @@ export class Sheet {
         return {
             name: this.name,
             tables: (this.tables || []).map((t) => t.json ? t.json : t),
+            sheetType: this.sheetType,
+            content: this.content,
             metadata: this.metadata ?? {},
         };
     }
@@ -302,8 +312,15 @@ export class Sheet {
 export class Workbook {
     constructor(data) {
         if (data) {
-            this.sheets = (data.sheets || []).map((x) => x instanceof Sheet ? x : new Sheet(x));
-            this.metadata = (typeof data.metadata === 'string') ? JSON.parse(data.metadata) : data.metadata;
+            this.sheets = ((data.sheets ?? data.sheets) || []).map((x) => x instanceof Sheet ? x : new Sheet(x));
+            this.name = data.name ?? data.name;
+            this.startLine = data.startLine ?? data.start_line;
+            this.endLine = data.endLine ?? data.end_line;
+            {
+                const val = data.metadata ?? data.metadata;
+                this.metadata = (typeof val === 'string') ? JSON.parse(val) : val;
+            }
+            this.rootContent = data.rootContent ?? data.root_content;
         }
     }
     toDTO() {
@@ -320,8 +337,10 @@ export class Workbook {
      */
     get json() {
         return {
+            name: this.name,
             sheets: (this.sheets || []).map((s) => s.json ? s.json : s),
             metadata: this.metadata ?? {},
+            rootContent: this.rootContent,
         };
     }
     getSheet(name) {
@@ -375,11 +394,11 @@ export class Workbook {
 export class ParsingSchema {
     constructor(data) {
         if (data) {
-            this.columnSeparator = data.columnSeparator;
-            this.headerSeparatorChar = data.headerSeparatorChar;
-            this.requireOuterPipes = data.requireOuterPipes;
-            this.stripWhitespace = data.stripWhitespace;
-            this.convertBrToNewline = data.convertBrToNewline;
+            this.columnSeparator = data.columnSeparator ?? data.column_separator;
+            this.headerSeparatorChar = data.headerSeparatorChar ?? data.header_separator_char;
+            this.requireOuterPipes = data.requireOuterPipes ?? data.require_outer_pipes;
+            this.stripWhitespace = data.stripWhitespace ?? data.strip_whitespace;
+            this.convertBrToNewline = data.convertBrToNewline ?? data.convert_br_to_newline;
         }
     }
     toDTO() {
@@ -390,15 +409,15 @@ export class ParsingSchema {
 export class MultiTableParsingSchema {
     constructor(data) {
         if (data) {
-            this.columnSeparator = data.columnSeparator;
-            this.headerSeparatorChar = data.headerSeparatorChar;
-            this.requireOuterPipes = data.requireOuterPipes;
-            this.stripWhitespace = data.stripWhitespace;
-            this.convertBrToNewline = data.convertBrToNewline;
-            this.rootMarker = data.rootMarker;
-            this.sheetHeaderLevel = data.sheetHeaderLevel;
-            this.tableHeaderLevel = data.tableHeaderLevel;
-            this.captureDescription = data.captureDescription;
+            this.columnSeparator = data.columnSeparator ?? data.column_separator;
+            this.headerSeparatorChar = data.headerSeparatorChar ?? data.header_separator_char;
+            this.requireOuterPipes = data.requireOuterPipes ?? data.require_outer_pipes;
+            this.stripWhitespace = data.stripWhitespace ?? data.strip_whitespace;
+            this.convertBrToNewline = data.convertBrToNewline ?? data.convert_br_to_newline;
+            this.rootMarker = data.rootMarker ?? data.root_marker;
+            this.sheetHeaderLevel = data.sheetHeaderLevel ?? data.sheet_header_level;
+            this.tableHeaderLevel = data.tableHeaderLevel ?? data.table_header_level;
+            this.captureDescription = data.captureDescription ?? data.capture_description;
         }
     }
     toDTO() {
@@ -409,9 +428,15 @@ export class MultiTableParsingSchema {
 export class ConversionSchema {
     constructor(data) {
         if (data) {
-            this.booleanPairs = data.booleanPairs;
-            this.customConverters = (typeof data.customConverters === 'string') ? JSON.parse(data.customConverters) : data.customConverters;
-            this.fieldConverters = (typeof data.fieldConverters === 'string') ? JSON.parse(data.fieldConverters) : data.fieldConverters;
+            this.booleanPairs = data.booleanPairs ?? data.boolean_pairs;
+            {
+                const val = data.customConverters ?? data.custom_converters;
+                this.customConverters = (typeof val === 'string') ? JSON.parse(val) : val;
+            }
+            {
+                const val = data.fieldConverters ?? data.field_converters;
+                this.fieldConverters = (typeof val === 'string') ? JSON.parse(val) : val;
+            }
         }
     }
     toDTO() {
@@ -426,10 +451,10 @@ export class ConversionSchema {
 export class ExcelParsingSchema {
     constructor(data) {
         if (data) {
-            this.headerRows = data.headerRows;
-            this.fillMergedHeaders = data.fillMergedHeaders;
-            this.delimiter = data.delimiter;
-            this.headerSeparator = data.headerSeparator;
+            this.headerRows = data.headerRows ?? data.header_rows;
+            this.fillMergedHeaders = data.fillMergedHeaders ?? data.fill_merged_headers;
+            this.delimiter = data.delimiter ?? data.delimiter;
+            this.headerSeparator = data.headerSeparator ?? data.header_separator;
         }
     }
     toDTO() {

package/dist/interfaces/example-spreadsheet-types.d.ts

@@ -42,9 +42,15 @@ export interface Table {
 export interface Sheet {
   name: string,
   tables: Array<Table>,
+  sheetType?: string,
+  content?: string,
   metadata?: string,
 }
 export interface Workbook {
   sheets: Array<Sheet>,
+  name?: string,
+  startLine?: number,
+  endLine?: number,
   metadata?: string,
+  rootContent?: string,
 }

package/dist/interfaces/wasi-sockets-ip-name-lookup.d.ts

@@ -1,9 +1,9 @@
 /** @module Interface wasi:sockets/ip-name-lookup@0.2.0 **/
 export function resolveAddresses(network: Network, name: string): ResolveAddressStream;
-export type Network = import('./wasi-sockets-network.js').Network;
-export type ErrorCode = import('./wasi-sockets-network.js').ErrorCode;
 export type IpAddress = import('./wasi-sockets-network.js').IpAddress;
+export type ErrorCode = import('./wasi-sockets-network.js').ErrorCode;
 export type Pollable = import('./wasi-io-poll.js').Pollable;
+export type Network = import('./wasi-sockets-network.js').Network;
 
 export class ResolveAddressStream {
   /**