@enslo/sd-metadata 1.4.2 → 1.6.0

package/README.ja.md

@@ -117,9 +117,7 @@ fileInput.addEventListener('change', async (e) => {
   if (!file) return;
   
   const arrayBuffer = await file.arrayBuffer();
-  const imageData = new Uint8Array(arrayBuffer);
-  
-  const result = read(imageData);
+  const result = read(arrayBuffer);
   
   if (result.status === 'success') {
     document.getElementById('tool').textContent = result.metadata.software;
@@ -137,12 +135,10 @@ fileInput.addEventListener('change', async (e) => {
 // CDNからインポート
 import { read } from 'https://cdn.jsdelivr.net/npm/@enslo/sd-metadata@latest/dist/index.js';
 
-// 画像を取得してメタデータを読み込み
 const response = await fetch(imageUrl);
 const arrayBuffer = await response.arrayBuffer();
-const imageData = new Uint8Array(arrayBuffer);
+const result = read(arrayBuffer);
 
-const result = read(imageData);
 if (result.status === 'success') {
   console.log('Tool:', result.metadata.software);
   console.log('Prompt:', result.metadata.prompt);
@@ -153,7 +149,7 @@ if (result.status === 'success') {
 > 本番環境では `@latest` の代わりに特定のバージョンを指定してください：
 >
 > ```text
-> https://cdn.jsdelivr.net/npm/@enslo/sd-metadata@1.4.1/dist/index.js
+> https://cdn.jsdelivr.net/npm/@enslo/sd-metadata@1.6.0/dist/index.js
 > ```
 
 ### 応用例
@@ -335,7 +331,7 @@ if (result.status === 'success') {
 
 ## APIリファレンス
 
-### `read(data: Uint8Array): ParseResult`
+### `read(input: Uint8Array | ArrayBuffer): ParseResult`
 
 画像ファイルからメタデータを読み込み、パースします。
 
@@ -350,13 +346,13 @@ if (result.status === 'success') {
 - `{ status: 'invalid', message? }` - 破損または非対応の画像フォーマット
   - `message`: オプションのエラー説明
 
-### `write(data: Uint8Array, metadata: ParseResult): WriteResult`
+### `write(input: Uint8Array | ArrayBuffer, metadata: ParseResult): WriteResult`
 
 画像ファイルにメタデータを書き込みます。
 
 **パラメータ:**
 
-- `data` - ターゲット画像ファイルデータ（PNG、JPEG、またはWebP）
+- `input` - ターゲット画像ファイルデータ（PNG、JPEG、またはWebP）
 - `metadata` - `read()` から得られた `ParseResult`
   - `status: 'success'` または `'empty'` - 直接書き込み可能
   - `status: 'unrecognized'` - 同じフォーマット：そのまま書き込み、異なるフォーマット：warning付きでメタデータ削除
@@ -370,13 +366,13 @@ if (result.status === 'success') {
   - `'conversionFailed'`: メタデータ変換に失敗（例：互換性のないフォーマット）
   - `'writeFailed'`: 画像へのメタデータ埋め込みに失敗
 
-### `writeAsWebUI(data: Uint8Array, metadata: GenerationMetadata): WriteResult`
+### `writeAsWebUI(input: Uint8Array | ArrayBuffer, metadata: GenerationMetadata): WriteResult`
 
 SD WebUI (A1111) フォーマットで画像にメタデータを書き込みます。
 
 **パラメータ:**
 
-- `data` - ターゲット画像ファイルデータ（PNG、JPEG、またはWebP）
+- `input` - ターゲット画像ファイルデータ（PNG、JPEG、またはWebP）
 - `metadata` - 埋め込む生成メタデータ
   - 任意のツールからでも、カスタム作成でも可能
   - 自動的にWebUIフォーマットに変換される

package/README.md

@@ -93,7 +93,6 @@ const { read } = require('@enslo/sd-metadata');
 import { read, write } from '@enslo/sd-metadata';
 import { readFileSync, writeFileSync } from 'fs';
 
-// Read metadata from any supported format
 const imageData = readFileSync('image.png');
 const result = read(imageData);
 
@@ -117,9 +116,7 @@ fileInput.addEventListener('change', async (e) => {
   if (!file) return;
   
   const arrayBuffer = await file.arrayBuffer();
-  const imageData = new Uint8Array(arrayBuffer);
-  
-  const result = read(imageData);
+  const result = read(arrayBuffer);
   
   if (result.status === 'success') {
     document.getElementById('tool').textContent = result.metadata.software;
@@ -137,12 +134,10 @@ For bookmarklets or userscripts (Tampermonkey, Violentmonkey, etc.), load from j
 // Import from CDN
 import { read } from 'https://cdn.jsdelivr.net/npm/@enslo/sd-metadata@latest/dist/index.js';
 
-// Fetch image and read metadata
 const response = await fetch(imageUrl);
 const arrayBuffer = await response.arrayBuffer();
-const imageData = new Uint8Array(arrayBuffer);
+const result = read(arrayBuffer);
 
-const result = read(imageData);
 if (result.status === 'success') {
   console.log('Tool:', result.metadata.software);
   console.log('Prompt:', result.metadata.prompt);
@@ -153,7 +148,7 @@ if (result.status === 'success') {
 > For production use, pin to a specific version instead of `@latest`:
 >
 > ```text
-> https://cdn.jsdelivr.net/npm/@enslo/sd-metadata@1.4.2/dist/index.js
+> https://cdn.jsdelivr.net/npm/@enslo/sd-metadata@1.6.0/dist/index.js
 > ```
 
 ### Advanced Examples
@@ -335,7 +330,7 @@ if (result.status === 'success') {
 
 ## API Reference
 
-### `read(data: Uint8Array): ParseResult`
+### `read(input: Uint8Array | ArrayBuffer): ParseResult`
 
 Reads and parses metadata from an image file.
 
@@ -350,13 +345,13 @@ Reads and parses metadata from an image file.
 - `{ status: 'invalid', message? }` - Corrupted or unsupported image format
   - `message`: Optional error description
 
-### `write(data: Uint8Array, metadata: ParseResult): WriteResult`
+### `write(input: Uint8Array | ArrayBuffer, metadata: ParseResult): WriteResult`
 
 Writes metadata to an image file.
 
 **Parameters:**
 
-- `data` - Target image file data (PNG, JPEG, or WebP)
+- `input` - Target image file data (PNG, JPEG, or WebP)
 - `metadata` - `ParseResult` from `read()`
   - `status: 'success'` or `'empty'` - Can write directly
   - `status: 'unrecognized'` - Same format: writes as-is; Cross-format: drops metadata with warning
@@ -370,13 +365,13 @@ Writes metadata to an image file.
   - `'conversionFailed'`: Metadata conversion failed (e.g., incompatible format)
   - `'writeFailed'`: Failed to embed metadata into the image
 
-### `writeAsWebUI(data: Uint8Array, metadata: GenerationMetadata): WriteResult`
+### `writeAsWebUI(input: Uint8Array | ArrayBuffer, metadata: GenerationMetadata): WriteResult`
 
 Writes metadata to an image in SD WebUI (A1111) format.
 
 **Parameters:**
 
-- `data` - Target image file data (PNG, JPEG, or WebP)
+- `input` - Target image file data (PNG, JPEG, or WebP)
 - `metadata` - Generation metadata to embed
   - Can be from any tool or custom-created
   - Automatically converted to WebUI format

package/dist/index.d.ts

@@ -294,16 +294,26 @@ type ParseResult = {
  * Automatically detects image format and extracts embedded generation metadata.
  */
 
+/** Options for the read function */
+interface ReadOptions {
+    /**
+     * When true, dimensions are taken strictly from metadata only.
+     * When false (default), missing dimensions are extracted from image headers.
+     * @default false
+     */
+    strict?: boolean;
+}
 /**
  * Read and parse metadata from an image
  *
  * Automatically detects the image format (PNG, JPEG, WebP) and parses
  * any embedded generation metadata.
  *
- * @param data - Image file data
+ * @param input - Image file data (Uint8Array or ArrayBuffer)
+ * @param options - Read options
  * @returns Parse result containing metadata and raw data
  */
-declare function read(data: Uint8Array): ParseResult;
+declare function read(input: Uint8Array | ArrayBuffer, options?: ReadOptions): ParseResult;
 
 /**
  * Write API for sd-metadata
@@ -351,11 +361,11 @@ type WriteResult = {
  * if necessary. For unrecognized metadata with cross-format conversion,
  * metadata is dropped and a warning is returned.
  *
- * @param data - Target image file data
+ * @param input - Target image file data (Uint8Array or ArrayBuffer)
  * @param metadata - ParseResult from `read()`
  * @returns New image data with embedded metadata (or warning if metadata was dropped)
  */
-declare function write(data: Uint8Array, metadata: ParseResult): WriteResult;
+declare function write(input: Uint8Array | ArrayBuffer, metadata: ParseResult): WriteResult;
 
 /**
  * WebUI (A1111) format writer for sd-metadata
@@ -377,7 +387,7 @@ declare function write(data: Uint8Array, metadata: ParseResult): WriteResult;
  * - PNG: `parameters` tEXt/iTXt chunk (encoding auto-selected based on content)
  * - JPEG/WebP: Exif UserComment field
  *
- * @param data - Target image file data (PNG, JPEG, or WebP)
+ * @param input - Target image file data (Uint8Array or ArrayBuffer)
  * @param metadata - Generation metadata to embed
  * @returns New image data with embedded metadata, or error
  *
@@ -403,7 +413,7 @@ declare function write(data: Uint8Array, metadata: ParseResult): WriteResult;
  * }
  * ```
  */
-declare function writeAsWebUI(data: Uint8Array, metadata: GenerationMetadata): WriteResult;
+declare function writeAsWebUI(input: Uint8Array | ArrayBuffer, metadata: GenerationMetadata): WriteResult;
 
 /**
  * A1111-format metadata serialization utilities
@@ -477,4 +487,4 @@ declare function formatAsWebUI(metadata: GenerationMetadata): string;
  */
 declare function formatRaw(raw: RawMetadata): string;
 
-export { type CharacterPrompt, type GenerationMetadata, type HiresSettings, type ITXtChunk, type MetadataSegment, type MetadataSegmentSource, type ModelSettings, type ParseResult, type PngTextChunk, type RawMetadata, type SamplingSettings, type TExtChunk, type UpscaleSettings, type WriteResult, type WriteWarning, formatAsWebUI, formatRaw, read, write, writeAsWebUI };
+export { type CharacterPrompt, type ComfyNode, type ComfyNodeGraph, type ComfyNodeInputValue, type ComfyNodeReference, type GenerationMetadata, type HiresSettings, type ITXtChunk, type MetadataSegment, type MetadataSegmentSource, type ModelSettings, type ParseResult, type PngTextChunk, type RawMetadata, type ReadOptions, type SamplingSettings, type TExtChunk, type UpscaleSettings, type WriteResult, type WriteWarning, formatAsWebUI, formatRaw, read, write, writeAsWebUI };