@gukhanmun/loanwords-fst 0.4.0-dev.236 → 0.4.0-dev.248

package/dist/index.d.ts

@@ -1,77 +1,6 @@
-//#region ../types/dist/index.d.ts
-
-/**
- * Specifies a dictionary loaded from a binary file or URL.
- *
- * The `data` field accepts:
- * - A `BufferSource` (`ArrayBuffer` or `ArrayBufferView`) — supported in all
- *   environments.
- * - A `URL` — resolved via `fetch` in browsers; via `node:fs/promises`
- *   in Node.js, Deno 2.0+, and Bun.
- * - A `string` — treated as a filesystem path; supported in Node.js,
- *   Deno 2.0+, and Bun only.  Throws in browser environments.
- *
- * At runtime, a `FileDictionarySource` is distinguished from other values by
- * the absence of an `entries` property (`"entries" in source` selects a
- * {@link MapDictionarySource}).
- */
-interface FileDictionarySource {
-  /**
-   * The binary dictionary data or a reference to where it can be loaded.
-   *
-   * Pass a `BufferSource` for data already in memory, a `URL` for a remote
-   * or local URL (resolved via `fetch` or `readFile`), or a path `string`
-   * for filesystem paths (Node.js / Deno 2.0+ / Bun only).
-   */
-  readonly data: ArrayBuffer | ArrayBufferView | URL | string;
-  /**
-   * The on-disk format of the dictionary file.
-   *
-   * - `"fst"` — Gukhanmun FST file (`*.gukfst`); preferred for small
-   *   WebAssembly bundles.  Supported in all runtimes.
-   * - `"cdb"` — Gukhanmun CDB-trie file (`*.gukcdb`); preferred when code
-   *   auditability or trivial mmap support matters.  Requires a filesystem
-   *   or in-memory bytes; supported in Node-API and (with `from_bytes`) in
-   *   WASM builds that include the `cdb` feature.
-   *
-   * The `"tsv"` format is reserved and never accepted.  Pass entries in memory
-   * through {@link MapDictionarySource} instead of compiling a table.
-   */
-  readonly format: "fst" | "cdb";
-}
-/**
- * A dictionary built from entries computed at runtime, such as per-document
- * reading overrides.
- *
- * Use this instead of compiling a TSV file with `gukhanmun-mkdict` when the
- * entries do not exist on disk, for example in a browser, an edge runtime, or a
- * site generator that derives entries per document.
- *
- * A source is distinguished from a {@link FileDictionarySource} by the presence
- * of an `entries` property.
- *
- * @example
- * ```ts
- * import { stdictFst } from "@gukhanmun/stdict-fst";
- * const g = await load({
- *   dictionaries: [
- *     {
- *       entries: [
- *         { hanja: "高橋", reading: "다카하시" },
- *         { hanja: "東京", reading: "도쿄", preference: 10 },
- *         { hanja: "年代", reading: "연대", suffixReading: "년대" },
- *       ],
- *     },
- *     await stdictFst(),
- *   ],
- * });
- * ```
- */
-//#endregion
-//#region index.d.ts
-
+import { FileDictionarySource, FileDictionarySource as FileDictionarySource$1, SourceRole } from "@gukhanmun/types";
 /** URL of the bundled NIKL loanword examples FST binary. */
-declare const loanwordsFstUrl: URL;
+export declare const loanwordsFstUrl: URL;
 /**
  * Loads the bundled NIKL loanword examples as raw bytes.
  *
@@ -90,13 +19,12 @@ declare const loanwordsFstUrl: URL;
  *   {@link loanwordsFstUrl}; pass another URL to load a relocated copy.
  * @returns The FST binary as a `Uint8Array`.
  */
-declare function loanwordsFstBytes(url?: URL): Promise<Uint8Array<ArrayBuffer>>;
+export declare function loanwordsFstBytes(url?: URL): Promise<Uint8Array<ArrayBuffer>>;
 /**
  * Loads the bundled NIKL loanword examples as a
  * {@link FileDictionarySource} ready to pass to `load({ dictionaries: [...] })`.
  *
- * @returns A `FileDictionarySource` with `format: "fst"`.
+ * @returns A `FileDictionarySource` with `format: "fst"` and `role: "loanword"`.
  */
-declare function loanwordsFst(): Promise<FileDictionarySource>;
-//#endregion
-export { type FileDictionarySource, loanwordsFst, loanwordsFstBytes, loanwordsFstUrl };
+export declare function loanwordsFst(): Promise<FileDictionarySource$1>;
+export type { FileDictionarySource, SourceRole };

package/dist/index.js

@@ -1,4 +1,4 @@
-//#region index.ts
+// index.ts
 /** URL of the bundled NIKL loanword examples FST binary. */
 const loanwordsFstUrl = new URL("./loanwords.fst", import.meta.url);
 /**
@@ -35,13 +35,13 @@ async function loanwordsFstBytes(url = loanwordsFstUrl) {
 * Loads the bundled NIKL loanword examples as a
 * {@link FileDictionarySource} ready to pass to `load({ dictionaries: [...] })`.
 *
-* @returns A `FileDictionarySource` with `format: "fst"`.
+* @returns A `FileDictionarySource` with `format: "fst"` and `role: "loanword"`.
 */
 async function loanwordsFst() {
 	return {
 		data: await loanwordsFstBytes(),
-		format: "fst"
+		format: "fst",
+		role: "loanword"
 	};
 }
-//#endregion
 export { loanwordsFst, loanwordsFstBytes, loanwordsFstUrl };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gukhanmun/loanwords-fst",
-  "version": "0.4.0-dev.236",
+  "version": "0.4.0-dev.248",
   "description": "NIKL loanword examples bundled as an FST binary for @gukhanmun/wasm and @gukhanmun/napi.",
   "type": "module",
   "exports": {
@@ -57,7 +57,7 @@
     "@gukhanmun/types": "*"
   },
   "devDependencies": {
-    "@gukhanmun/types": "0.4.0-dev.236+75afc34"
+    "@gukhanmun/types": "0.4.0-dev.248+36997e7"
   },
   "scripts": {
     "build": "tsdown && node -e \"require('node:fs').copyFileSync('loanwords.fst','dist/loanwords.fst')\"",