@laisuk/opencc-fmmseg-wasm 0.2.3 → 0.2.5

package/README.md

@@ -38,7 +38,8 @@ npm install @laisuk/opencc-fmmseg-wasm
 
 ```javascript
 import init, {
-    OpenccWasm
+    OpenccWasm,
+    DetofuLevelWasm
 } from "@laisuk/opencc-fmmseg-wasm";
 
 await init();
@@ -47,6 +48,9 @@ const cc = new OpenccWasm("s2t");
 
 console.log(cc.convert("汉字", false));
 // 漢字
+
+console.log(cc.convertDetofu("儼驂騑於上路", false, DetofuLevelWasm.ExtB));
+// 俨骖騑于上路
 ```
 
 ---
@@ -54,16 +58,16 @@ console.log(cc.convert("汉字", false));
 ## Using Config Enums
 
 ```javascript
-import init, {
-    OpenccWasm,
-    OpenccConfigWasm
-} from "@laisuk/opencc-fmmseg-wasm";
-
-await init();
-
-const cc = OpenccWasm.newWithEnum(
-    OpenccConfigWasm.S2t
-);
+import init, {
+    OpenccWasm,
+    OpenccConfigWasm
+} from "@laisuk/opencc-fmmseg-wasm";
+
+await init();
+
+const cc = OpenccWasm.newWithEnum(
+    OpenccConfigWasm.S2t
+);
 
 console.log(cc.convert("汉字", false));
 // 漢字
@@ -138,6 +142,85 @@ cc.convert("汉字", false);
 
 ---
 
+### detofu
+
+Replace tofu-risk rare CJK extension characters with display-compatible fallbacks.
+
+```javascript
+cc.detofu(text, level)
+```
+
+Parameters:
+
+* `text`: input string
+* `level`: `DetofuLevelWasm` threshold for the CJK extension ranges to replace
+
+Returns:
+
+* detofu-safe string
+
+Supported levels:
+
+| Enum                   | CLI value |
+|------------------------|-----------|
+| `DetofuLevelWasm.ExtB` | `ext-b`   |
+| `DetofuLevelWasm.ExtC` | `ext-c`   |
+| `DetofuLevelWasm.ExtD` | `ext-d`   |
+| `DetofuLevelWasm.ExtE` | `ext-e`   |
+| `DetofuLevelWasm.ExtF` | `ext-f`   |
+| `DetofuLevelWasm.ExtG` | `ext-g`   |
+| `DetofuLevelWasm.ExtH` | `ext-h`   |
+| `DetofuLevelWasm.ExtI` | `ext-i`   |
+
+Example:
+
+```javascript
+import init, {
+    OpenccWasm,
+    DetofuLevelWasm
+} from "@laisuk/opencc-fmmseg-wasm";
+
+await init();
+
+const cc = new OpenccWasm("t2s");
+const converted = cc.convert("儼驂騑於上路", false);
+
+console.log(converted);
+// 俨骖𬴂于上路
+
+console.log(cc.detofu(converted, DetofuLevelWasm.ExtB));
+// 俨骖騑于上路
+```
+
+---
+
+### convertDetofu
+
+Convert text and apply detofu in one call.
+
+```javascript
+cc.convertDetofu(text, punctuation, level)
+```
+
+Parameters:
+
+* `text`: input string
+* `punctuation`: whether to convert punctuation variants
+* `level`: `DetofuLevelWasm` threshold for the CJK extension ranges to replace
+
+Returns:
+
+* converted detofu-safe string
+
+Example:
+
+```javascript
+cc.convertDetofu("儼驂騑於上路", false, DetofuLevelWasm.ExtB);
+// 俨骖騑于上路
+```
+
+---
+
 ### setConfig
 
 ```javascript
@@ -316,6 +399,7 @@ The package includes a zero-dependency Node.js CLI:
 
 ```bash
 opencc-fmmseg convert -i input.txt -o output.txt -c s2t -p
+opencc-fmmseg convert -i input.txt -o output.txt -c t2s -p --detofu all
 ```
 
 ```bash
@@ -329,6 +413,9 @@ opencc-fmmseg office -i input.docx -o output.docx -c s2t -p --keep-font
 -o, --output <file>         Output text file
 -c, --config <conversion>   Conversion config
 -p, --punct                 Enable punctuation conversion
+--detofu [level]            Replace tofu-risk rare CJK extension chars after conversion
+                              level: all | ext-b | ext-c | ext-d | ext-e | ext-f | ext-g | ext-h | ext-i
+                              default when omitted value: all
 --in-enc <encoding>         Input encoding
 --out-enc <encoding>        Output encoding
 ```
@@ -356,13 +443,13 @@ If `-o, --output` is omitted, `office` writes:
 
 ---
 
-## TypeScript Support
-
-The package includes generated TypeScript definitions from `wasm-bindgen`.
-
-The WASM-facing enum is exported as `OpenccConfigWasm`, alongside `OpenccWasm`.
-
----
+## TypeScript Support
+
+The package includes generated TypeScript definitions from `wasm-bindgen`.
+
+The WASM-facing enum is exported as `OpenccConfigWasm`, alongside `OpenccWasm`.
+
+---
 
 ## Performance Notes
 

package/bin/opencc.js

@@ -6,6 +6,7 @@ import process from "process";
 
 import init, {
     OpenccWasm,
+    DetofuLevelWasm,
     convert_office_bytes
 } from "../opencc_fmmseg_wasm.js";
 
@@ -53,6 +54,9 @@ Convert options:
   -o, --output <file>         Output text file; stdout if omitted
   -c, --config <conversion>   Conversion config (default: s2t)
   -p, --punct                 Enable punctuation conversion
+  --detofu [level]            Replace tofu-risk rare CJK extension chars after conversion
+                              level: all | ext-b | ext-c | ext-d | ext-e | ext-f | ext-g | ext-h | ext-i
+                              default when omitted value: all
   --in-enc <encoding>         Input encoding (default: utf8)
   --out-enc <encoding>        Output encoding (default: utf8)
 
@@ -73,6 +77,8 @@ Examples:
   npx opencc-fmmseg convert -i a.txt -o b.txt -c s2t
   npx opencc-fmmseg convert -i a.txt -o b.txt -c s2tw -p
   cat a.txt | npx opencc-fmmseg convert -c t2s
+  npx opencc-fmmseg convert -i a.txt -o b.txt -c t2s --detofu
+  npx opencc-fmmseg convert -i a.txt -o b.txt -c t2s --detofu ext-c
 
   npx opencc-fmmseg office -i a.docx -o b.docx -c s2t -p
   npx opencc-fmmseg office -i a.epub -c s2tw --auto-ext
@@ -179,6 +185,56 @@ function applyAutoExt(outputFile, officeFormat, autoExt) {
     return `${outputFile}.${officeFormat}`;
 }
 
+function parseDetofuLevel(value) {
+    if (value === null || value === undefined || value === true) {
+        return DetofuLevelWasm.ExtB; // "all"
+    }
+
+    const normalized = String(value).trim().toLowerCase();
+
+    switch (normalized) {
+        case "":
+        case "all":
+        case "ext-b":
+        case "extb":
+        case "b":
+            return DetofuLevelWasm.ExtB;
+        case "ext-c":
+        case "extc":
+        case "c":
+            return DetofuLevelWasm.ExtC;
+        case "ext-d":
+        case "extd":
+        case "d":
+            return DetofuLevelWasm.ExtD;
+        case "ext-e":
+        case "exte":
+        case "e":
+            return DetofuLevelWasm.ExtE;
+        case "ext-f":
+        case "extf":
+        case "f":
+            return DetofuLevelWasm.ExtF;
+        case "ext-g":
+        case "extg":
+        case "g":
+            return DetofuLevelWasm.ExtG;
+        case "ext-h":
+        case "exth":
+        case "h":
+            return DetofuLevelWasm.ExtH;
+        case "ext-i":
+        case "exti":
+        case "i":
+            return DetofuLevelWasm.ExtI;
+        default:
+            throw new Error(
+                `Invalid detofu level: ${value}. ` +
+                `Valid values: all | ext-b | ext-c | ext-d | ext-e | ext-f | ext-g | ext-h | ext-i`
+            );
+    }
+}
+
 async function runConvert(args) {
     const input = getArg(args, "-i", "--input");
     const output = getArg(args, "-o", "--output");
@@ -187,6 +243,20 @@ async function runConvert(args) {
     const outEnc = getArg(args, null, "--out-enc", "utf8");
     const punct = hasFlag(args, "-p", "--punct");
 
+    const detofuIndex = args.indexOf("--detofu");
+    const detofuEnabled = detofuIndex !== -1;
+    let detofuLevel = null;
+
+    if (detofuEnabled) {
+        const next = args[detofuIndex + 1];
+
+        if (!next || next.startsWith("-")) {
+            detofuLevel = parseDetofuLevel("all");
+        } else {
+            detofuLevel = parseDetofuLevel(next);
+        }
+    }
+
     await ensureWasmInitialized();
 
     const cc = new OpenccWasm(config);
@@ -197,7 +267,11 @@ async function runConvert(args) {
     }
 
     const inputText = readInputText(input, inEnc);
-    const outputText = cc.convert(inputText, punct);
+    let outputText = cc.convert(inputText, punct);
+
+    if (detofuEnabled) {
+        outputText = cc.detofu(outputText, detofuLevel);
+    }
 
     writeOutputText(output, outputText, outEnc);
 
@@ -209,7 +283,8 @@ async function runConvert(args) {
             console.error();
         }
 
-        console.error(`Conversion completed (${config}): ${inFrom} -> ${outTo}`);
+        const suffix = detofuEnabled ? ", detofu" : "";
+        console.error(`Conversion completed (${config}${suffix}): ${inFrom} -> ${outTo}`);
     }
 }
 

package/opencc_fmmseg_wasm.d.ts

@@ -1,6 +1,17 @@
 /* tslint:disable */
 /* eslint-disable */
 
+export enum DetofuLevelWasm {
+    ExtB = 2,
+    ExtC = 3,
+    ExtD = 4,
+    ExtE = 5,
+    ExtF = 6,
+    ExtG = 7,
+    ExtH = 8,
+    ExtI = 9,
+}
+
 export enum OpenccConfigWasm {
     S2t = 1,
     S2tw = 2,
@@ -24,7 +35,9 @@ export class OpenccWasm {
     free(): void;
     [Symbol.dispose](): void;
     convert(text: string, punctuation: boolean): string;
+    convertDetofu(text: string, punctuation: boolean, level: DetofuLevelWasm): string;
     debugPing(): string;
+    detofu(text: string, level: DetofuLevelWasm): string;
     getConfig(): string;
     getConfigId(): number;
     static getSupportedConfigs(): string[];
@@ -45,7 +58,9 @@ export interface InitOutput {
     readonly __wbg_openccwasm_free: (a: number, b: number) => void;
     readonly convert_office_bytes: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number, number];
     readonly openccwasm_convert: (a: number, b: number, c: number, d: number) => [number, number];
+    readonly openccwasm_convertDetofu: (a: number, b: number, c: number, d: number, e: number) => [number, number];
     readonly openccwasm_debugPing: (a: number) => [number, number];
+    readonly openccwasm_detofu: (a: number, b: number, c: number, d: number) => [number, number];
     readonly openccwasm_getConfig: (a: number) => [number, number];
     readonly openccwasm_getConfigId: (a: number) => number;
     readonly openccwasm_getSupportedConfigs: () => [number, number];

package/opencc_fmmseg_wasm.js

@@ -1,5 +1,19 @@
 /* @ts-self-types="./opencc_fmmseg_wasm.d.ts" */
 
+/**
+ * @enum {2 | 3 | 4 | 5 | 6 | 7 | 8 | 9}
+ */
+export const DetofuLevelWasm = Object.freeze({
+    ExtB: 2, "2": "ExtB",
+    ExtC: 3, "3": "ExtC",
+    ExtD: 4, "4": "ExtD",
+    ExtE: 5, "5": "ExtE",
+    ExtF: 6, "6": "ExtF",
+    ExtG: 7, "7": "ExtG",
+    ExtH: 8, "8": "ExtH",
+    ExtI: 9, "9": "ExtI",
+});
+
 /**
  * @enum {1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16}
  */
@@ -58,6 +72,26 @@ export class OpenccWasm {
             wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
         }
     }
+    /**
+     * @param {string} text
+     * @param {boolean} punctuation
+     * @param {DetofuLevelWasm} level
+     * @returns {string}
+     */
+    convertDetofu(text, punctuation, level) {
+        let deferred2_0;
+        let deferred2_1;
+        try {
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            const ret = wasm.openccwasm_convertDetofu(this.__wbg_ptr, ptr0, len0, punctuation, level);
+            deferred2_0 = ret[0];
+            deferred2_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+        }
+    }
     /**
      * @returns {string}
      */
@@ -73,6 +107,25 @@ export class OpenccWasm {
             wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
         }
     }
+    /**
+     * @param {string} text
+     * @param {DetofuLevelWasm} level
+     * @returns {string}
+     */
+    detofu(text, level) {
+        let deferred2_0;
+        let deferred2_1;
+        try {
+            const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len0 = WASM_VECTOR_LEN;
+            const ret = wasm.openccwasm_detofu(this.__wbg_ptr, ptr0, len0, level);
+            deferred2_0 = ret[0];
+            deferred2_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+        }
+    }
     /**
      * @returns {string}
      */

package/package.json

@@ -2,7 +2,7 @@
   "name": "@laisuk/opencc-fmmseg-wasm",
   "type": "module",
   "description": "WebAssembly bindings for opencc-fmmseg, a high-performance OpenCC-compatible Simplified/Traditional Chinese converter.",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "license": "MIT",
   "repository": {
     "type": "git",