hdtrans 0.2.0 → 0.3.0

package/README.md

@@ -19,6 +19,19 @@ try {
 }
 ```
 
+## Version information
+
+```js
+const info = await HdTrans.getInfo();
+console.log(info.version);           // Actual engine build version
+console.log(info.dictionaryVersion); // Loaded base dictionary version
+console.log(info.runtime);           // 'wasm'
+```
+
+`HdTrans.getInfo(options)` accepts the same options as `init()`. It loads the engine and dictionary, then closes its temporary translator; it does not just read package metadata. If loading fails, it rejects. Importing the package alone does not load the engine.
+
+For an existing translator, `translator.getInfo()` returns the same fields synchronously. The existing `version`, `dictionaryVersion` and `runtime` properties remain available. Instance metadata is captured at initialization and remains readable after `close()`. User dictionary and Ehnd changes do not change the base dictionary version. TypeScript users can import the `HdTransInfo` type.
+
 ## Options and JSON
 
 ```js

package/dist/dictionary.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.2.0+f5f87488808d",
+  "version": "0.3.0+b7c02eeae7ae",
   "snapshot": {
     "file": "dicts.hdsnap",
-    "sha256": "22b4f4f5c1850fa38e8945bc3ce63246b39d5772828e3f011dd73a03c9ef9332",
-    "builtinFingerprint": "abd7024cf31fb87862a18c1ca7f15e3678c36d9daf893e4d3a2f712b10785dc2",
-    "dataFingerprint": "bed1d80e02c8755696971fb7b900f101442d750b33e07d90aaa045145d13634d"
+    "sha256": "a5195f84542811f32c3d4a8bd06299b362581f9fcf8667afe9c7aa7c15ca23df",
+    "builtinFingerprint": "6b14e235d8d87e3a331af888aeab1ce4f08134165267f645f340aa744c201db8",
+    "dataFingerprint": "7265d7305c49f8f45bb3ebe5005082c3313802e0c09e970269e9d193449f99f8"
   },
   "files": []
 }

package/dist/dicts.hdsnap

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
 name: package/dist/dicts.hdsnap
-size: 36080311 bytes
-sha256: 22b4f4f5c1850fa38e8945bc3ce63246b39d5772828e3f011dd73a03c9ef9332
+size: 36466687 bytes
+sha256: a5195f84542811f32c3d4a8bd06299b362581f9fcf8667afe9c7aa7c15ca23df

package/dist/dicts.txt

@@ -1 +1 @@
-0.2.0+f5f87488808d
+0.3.0+b7c02eeae7ae

package/dist/index.d.ts

@@ -1,8 +1,10 @@
-import { HdTrans as RuntimeHdTrans, type InitOptions as RuntimeInitOptions } from './runtime.js';
-export type { UserDictPos, UserDictEntry, ChoiceSelection, TranslationChoice, TranslationResult, EhndFiles, } from './runtime.js';
+import { HdTrans as RuntimeHdTrans, type HdTransInfo, type InitOptions as RuntimeInitOptions } from './runtime.js';
+export type { UserDictPos, UserDictEntry, ChoiceSelection, TranslationChoice, TranslationResult, EhndFiles, HdTransInfo, } from './runtime.js';
 export type InitOptions = Pick<RuntimeInitOptions, 'ehnd'>;
 export type HdTrans = RuntimeHdTrans;
 /** Uses the bundled engine and dictionary. Each call returns an independent translator. */
 export declare const HdTrans: Readonly<{
+    /** Loads the bundled engine and dictionary, reads their metadata, then closes the temporary translator. */
+    getInfo(options?: InitOptions): Promise<HdTransInfo>;
     init(options?: InitOptions): Promise<HdTrans>;
 }>;

package/dist/index.js

@@ -12,6 +12,16 @@ async function loadModule() {
 }
 /** Uses the bundled engine and dictionary. Each call returns an independent translator. */
 export const HdTrans = Object.freeze({
+    /** Loads the bundled engine and dictionary, reads their metadata, then closes the temporary translator. */
+    async getInfo(options = {}) {
+        const translator = await HdTrans.init(options);
+        try {
+            return translator.getInfo();
+        }
+        finally {
+            translator.close();
+        }
+    },
     async init(options = {}) {
         modulePromise ??= loadModule().catch((error) => {
             modulePromise = undefined;

package/dist/runtime.d.ts

@@ -13,7 +13,8 @@ export interface ChoiceSelection {
     provenance: string;
     layer: string;
     id: number;
-    /** Rule filename:line, sense table:row, or empty when no source is recorded. */
+    /** Local rule number, global rule file:line, sense table:row, or empty when no
+     *  source is recorded. */
     source: string;
 }
 export interface TranslationChoice {
@@ -58,6 +59,11 @@ export interface WasmModule {
     Translator: new () => Binding;
     version(): string;
 }
+export interface HdTransInfo {
+    readonly version: string;
+    readonly dictionaryVersion: string;
+    readonly runtime: 'wasm';
+}
 export interface InitOptions {
     /** Supply an instantiated module with its dictionary files already staged. */
     module?: WasmModule | Promise<WasmModule>;
@@ -73,6 +79,10 @@ export declare class HdTrans {
     private userDictRaw_;
     private constructor();
     static init(options?: InitOptions): Promise<HdTrans>;
+    /** Loads the engine and dictionaries, reads their metadata, then closes the temporary translator. */
+    static getInfo(options?: InitOptions): Promise<HdTransInfo>;
+    /** Metadata captured at initialization, also available after close(). */
+    getInfo(): HdTransInfo;
     translate(text: string): string;
     translate(text: string, options: {
         json: true;

package/dist/runtime.js

@@ -35,6 +35,24 @@ export class HdTrans {
             throw error;
         }
     }
+    /** Loads the engine and dictionaries, reads their metadata, then closes the temporary translator. */
+    static async getInfo(options = {}) {
+        const translator = await HdTrans.init(options);
+        try {
+            return translator.getInfo();
+        }
+        finally {
+            translator.close();
+        }
+    }
+    /** Metadata captured at initialization, also available after close(). */
+    getInfo() {
+        return {
+            version: this.version,
+            dictionaryVersion: this.dictionaryVersion,
+            runtime: this.runtime,
+        };
+    }
     translate(text, options = {}) {
         const binding = this.binding();
         if (typeof text !== 'string')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdtrans",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Japanese to Korean translation with a bundled WebAssembly engine and dictionary",
   "type": "module",
   "main": "./dist/index.js",