@gukhanmun/wasm 0.1.0-dev.0 → 0.1.0-dev.12

package/README.md

@@ -0,0 +1,75 @@
+@gukhanmun/wasm
+===============
+
+WebAssembly implementation of the Gukhanmun hanja-to-hangul converter. Runs in
+any WebAssembly-capable environment: browsers, Deno 2.0+, Node.js 20+, and Bun
+1.0+.
+
+
+Installation
+------------
+
+~~~~ sh
+npm install @gukhanmun/wasm
+~~~~
+
+For Deno:
+
+~~~~ ts
+import { load } from "jsr:@gukhanmun/wasm";
+~~~~
+
+
+Usage
+-----
+
+The `load()` factory initializes the WASM module on the first call and caches
+it for all subsequent calls. Dictionary data must be supplied explicitly
+because the WASM bundle does not embed any dictionary.
+
+~~~~ ts
+import { load } from "@gukhanmun/wasm";
+import { stdictFst } from "@gukhanmun/stdict-fst";
+
+const g = await load({ dictionaries: [await stdictFst()] });
+console.log(g.convert("漢字를 한글로")); // "한자를 한글로"
+~~~~
+
+### Streaming
+
+~~~~ ts
+const stream = g.convertStream("text/html");
+const writer = stream.writable.getWriter();
+const reader = stream.readable.getReader();
+
+await writer.write("<p>漢字</p>");
+await writer.close();
+
+const { value } = await reader.read();
+console.log(value); // "<p>한자</p>"
+~~~~
+
+### North Korean preset
+
+~~~~ ts
+const g = await load({
+  preset: "ko-kp",
+  dictionaries: [],
+});
+console.log(g.convert("來日")); // "래일"
+~~~~
+
+
+Relation to `@gukhanmun/napi`
+-----------------------------
+
+Both packages implement the same `Gukhanmun` interface from `@gukhanmun/types`.
+`@gukhanmun/wasm` works in all environments including browsers;
+`@gukhanmun/napi` uses a native Node.js addon and is faster for server-side
+workloads.
+
+
+License
+-------
+
+GPL-3.0-only.

package/dist/wasm/deno/README.md

@@ -0,0 +1,45 @@
+gukhanmun-wasm
+==============
+
+WebAssembly binding for Gukhanmun, generated with `wasm-bindgen`. Exposes
+`WasmGukhanmun` (an owning converter instance) and `WasmStream` (a streaming
+handle for chunked input) to JavaScript.
+
+This crate is the Rust side of the `@gukhanmun/wasm` npm package. End users
+interact with the TypeScript wrapper, not with this crate directly.
+
+
+Exposed types
+-------------
+
+`WasmGukhanmun` wraps a `gukhanmun::Converter` and exposes:
+
+ -  `WasmGukhanmun.load(options_json, dicts)`: static factory; `options_json` is
+    a JSON-serialized `GukhanmunOptions` object and `dicts` is a JavaScript
+    array of `{ format, bytes }` records.
+ -  `convert(input, format)`: one-shot conversion. `format` is either a MIME
+    type string (`"text/plain"`, `"text/html"`, `"text/markdown"`) or a
+    `{ format, gfm }` object for Markdown.
+ -  `openStream(format)`/`streamPush(handle, chunk)`/`streamFinish(handle)`:
+    chunked streaming API; `handle` is a `WasmStream` returned by `openStream`.
+
+Options and errors are passed as JSON strings so that the TypeScript wrapper
+can reconstruct typed values without depending on wasm-bindgen's JS glue for
+every field.
+
+
+Build notes
+-----------
+
+The WASM binary is compiled with `release_max_level_off`, which strips all
+`tracing` calls from the release artifact. This keeps the binary size small
+and avoids a dependency on `console.log` at runtime.
+
+`wasm-opt` is run as a post-processing step by `wasm-pack` to reduce the
+binary further.
+
+
+License
+-------
+
+GPL-3.0-only. See `LICENSE` at the repository root.

package/dist/wasm/nodejs/README.md

@@ -0,0 +1,45 @@
+gukhanmun-wasm
+==============
+
+WebAssembly binding for Gukhanmun, generated with `wasm-bindgen`. Exposes
+`WasmGukhanmun` (an owning converter instance) and `WasmStream` (a streaming
+handle for chunked input) to JavaScript.
+
+This crate is the Rust side of the `@gukhanmun/wasm` npm package. End users
+interact with the TypeScript wrapper, not with this crate directly.
+
+
+Exposed types
+-------------
+
+`WasmGukhanmun` wraps a `gukhanmun::Converter` and exposes:
+
+ -  `WasmGukhanmun.load(options_json, dicts)`: static factory; `options_json` is
+    a JSON-serialized `GukhanmunOptions` object and `dicts` is a JavaScript
+    array of `{ format, bytes }` records.
+ -  `convert(input, format)`: one-shot conversion. `format` is either a MIME
+    type string (`"text/plain"`, `"text/html"`, `"text/markdown"`) or a
+    `{ format, gfm }` object for Markdown.
+ -  `openStream(format)`/`streamPush(handle, chunk)`/`streamFinish(handle)`:
+    chunked streaming API; `handle` is a `WasmStream` returned by `openStream`.
+
+Options and errors are passed as JSON strings so that the TypeScript wrapper
+can reconstruct typed values without depending on wasm-bindgen's JS glue for
+every field.
+
+
+Build notes
+-----------
+
+The WASM binary is compiled with `release_max_level_off`, which strips all
+`tracing` calls from the release artifact. This keeps the binary size small
+and avoids a dependency on `console.log` at runtime.
+
+`wasm-opt` is run as a post-processing step by `wasm-pack` to reduce the
+binary further.
+
+
+License
+-------
+
+GPL-3.0-only. See `LICENSE` at the repository root.

package/dist/wasm/nodejs/package.json

@@ -18,4 +18,4 @@
   "main": "gukhanmun_wasm.js",
   "homepage": "https://github.com/dahlia/gukhanmun",
   "types": "gukhanmun_wasm.d.ts"
-}
+}

package/dist/wasm/web/README.md

@@ -0,0 +1,45 @@
+gukhanmun-wasm
+==============
+
+WebAssembly binding for Gukhanmun, generated with `wasm-bindgen`. Exposes
+`WasmGukhanmun` (an owning converter instance) and `WasmStream` (a streaming
+handle for chunked input) to JavaScript.
+
+This crate is the Rust side of the `@gukhanmun/wasm` npm package. End users
+interact with the TypeScript wrapper, not with this crate directly.
+
+
+Exposed types
+-------------
+
+`WasmGukhanmun` wraps a `gukhanmun::Converter` and exposes:
+
+ -  `WasmGukhanmun.load(options_json, dicts)`: static factory; `options_json` is
+    a JSON-serialized `GukhanmunOptions` object and `dicts` is a JavaScript
+    array of `{ format, bytes }` records.
+ -  `convert(input, format)`: one-shot conversion. `format` is either a MIME
+    type string (`"text/plain"`, `"text/html"`, `"text/markdown"`) or a
+    `{ format, gfm }` object for Markdown.
+ -  `openStream(format)`/`streamPush(handle, chunk)`/`streamFinish(handle)`:
+    chunked streaming API; `handle` is a `WasmStream` returned by `openStream`.
+
+Options and errors are passed as JSON strings so that the TypeScript wrapper
+can reconstruct typed values without depending on wasm-bindgen's JS glue for
+every field.
+
+
+Build notes
+-----------
+
+The WASM binary is compiled with `release_max_level_off`, which strips all
+`tracing` calls from the release artifact. This keeps the binary size small
+and avoids a dependency on `console.log` at runtime.
+
+`wasm-opt` is run as a post-processing step by `wasm-pack` to reduce the
+binary further.
+
+
+License
+-------
+
+GPL-3.0-only. See `LICENSE` at the repository root.

package/dist/wasm/web/package.json

@@ -22,4 +22,4 @@
   "sideEffects": [
     "./snippets/*"
   ]
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gukhanmun/wasm",
-  "version": "0.1.0-dev.0",
+  "version": "0.1.0-dev.12",
   "description": "WebAssembly implementation of the Gukhanmun hanja-to-hangul converter.",
   "type": "module",
   "exports": {
@@ -45,7 +45,7 @@
     "@gukhanmun/types": "*"
   },
   "devDependencies": {
-    "@gukhanmun/types": "0.1.0-dev.0"
+    "@gukhanmun/types": "0.1.0-dev.12+2585cf2de491fd0f8b06f35e0c83fe8a779280cc"
   },
   "scripts": {
     "build": "tsdown && node -e \"const fs=require('node:fs'),p=require('node:path');fs.cpSync('wasm','dist/wasm',{recursive:true,force:true,filter:(s)=>p.basename(s)!=='.gitignore'})\""