@gukhanmun/opendict-fst 0.4.0-dev.236 → 0.4.0-dev.245

package/dist/index.d.ts

@@ -1,83 +1,12 @@
-//#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 } from "@gukhanmun/types";
 /** URL of the bundled Open Korean Dictionary 일반어 FST binary. */
-declare const opendictGeneralFstUrl: URL;
+export declare const opendictGeneralFstUrl: URL;
 /** URL of the bundled Open Korean Dictionary 북한어 FST binary. */
-declare const opendictNorthKoreanFstUrl: URL;
+export declare const opendictNorthKoreanFstUrl: URL;
 /** URL of the bundled Open Korean Dictionary 방언 FST binary. */
-declare const opendictDialectFstUrl: URL;
+export declare const opendictDialectFstUrl: URL;
 /** URL of the bundled Open Korean Dictionary 옛말 FST binary. */
-declare const opendictArchaicFstUrl: URL;
+export declare const opendictArchaicFstUrl: URL;
 /**
  * Loads an Open Korean Dictionary FST binary as raw bytes.
  *
@@ -88,7 +17,7 @@ declare const opendictArchaicFstUrl: URL;
  * @param url Location of the FST binary to read.
  * @returns The FST binary as a `Uint8Array`.
  */
-declare function opendictFstBytes(url: URL): Promise<Uint8Array>;
+export declare function opendictFstBytes(url: URL): Promise<Uint8Array>;
 /**
  * Loads the bundled Open Korean Dictionary 일반어 FST binary as raw bytes.
  *
@@ -96,7 +25,7 @@ declare function opendictFstBytes(url: URL): Promise<Uint8Array>;
  *   {@link opendictGeneralFstUrl}.
  * @returns The FST binary as a `Uint8Array`.
  */
-declare function opendictGeneralFstBytes(url?: URL): Promise<Uint8Array>;
+export declare function opendictGeneralFstBytes(url?: URL): Promise<Uint8Array>;
 /**
  * Loads the bundled Open Korean Dictionary 북한어 FST binary as raw bytes.
  *
@@ -104,7 +33,7 @@ declare function opendictGeneralFstBytes(url?: URL): Promise<Uint8Array>;
  *   {@link opendictNorthKoreanFstUrl}.
  * @returns The FST binary as a `Uint8Array`.
  */
-declare function opendictNorthKoreanFstBytes(url?: URL): Promise<Uint8Array>;
+export declare function opendictNorthKoreanFstBytes(url?: URL): Promise<Uint8Array>;
 /**
  * Loads the bundled Open Korean Dictionary 방언 FST binary as raw bytes.
  *
@@ -112,7 +41,7 @@ declare function opendictNorthKoreanFstBytes(url?: URL): Promise<Uint8Array>;
  *   {@link opendictDialectFstUrl}.
  * @returns The FST binary as a `Uint8Array`.
  */
-declare function opendictDialectFstBytes(url?: URL): Promise<Uint8Array>;
+export declare function opendictDialectFstBytes(url?: URL): Promise<Uint8Array>;
 /**
  * Loads the bundled Open Korean Dictionary 옛말 FST binary as raw bytes.
  *
@@ -120,30 +49,29 @@ declare function opendictDialectFstBytes(url?: URL): Promise<Uint8Array>;
  *   {@link opendictArchaicFstUrl}.
  * @returns The FST binary as a `Uint8Array`.
  */
-declare function opendictArchaicFstBytes(url?: URL): Promise<Uint8Array>;
+export declare function opendictArchaicFstBytes(url?: URL): Promise<Uint8Array>;
 /**
  * Loads the bundled Open Korean Dictionary 일반어 dictionary.
  *
  * @returns A `FileDictionarySource` with `format: "fst"`.
  */
-declare function opendictGeneralFst(): Promise<FileDictionarySource>;
+export declare function opendictGeneralFst(): Promise<FileDictionarySource$1>;
 /**
  * Loads the bundled Open Korean Dictionary 북한어 dictionary.
  *
  * @returns A `FileDictionarySource` with `format: "fst"`.
  */
-declare function opendictNorthKoreanFst(): Promise<FileDictionarySource>;
+export declare function opendictNorthKoreanFst(): Promise<FileDictionarySource$1>;
 /**
  * Loads the bundled Open Korean Dictionary 방언 dictionary.
  *
  * @returns A `FileDictionarySource` with `format: "fst"`.
  */
-declare function opendictDialectFst(): Promise<FileDictionarySource>;
+export declare function opendictDialectFst(): Promise<FileDictionarySource$1>;
 /**
  * Loads the bundled Open Korean Dictionary 옛말 dictionary.
  *
  * @returns A `FileDictionarySource` with `format: "fst"`.
  */
-declare function opendictArchaicFst(): Promise<FileDictionarySource>;
-//#endregion
-export { type FileDictionarySource, opendictArchaicFst, opendictArchaicFstBytes, opendictArchaicFstUrl, opendictDialectFst, opendictDialectFstBytes, opendictDialectFstUrl, opendictFstBytes, opendictGeneralFst, opendictGeneralFstBytes, opendictGeneralFstUrl, opendictNorthKoreanFst, opendictNorthKoreanFstBytes, opendictNorthKoreanFstUrl };
+export declare function opendictArchaicFst(): Promise<FileDictionarySource$1>;
+export type { FileDictionarySource };

package/dist/index.js

@@ -1,4 +1,4 @@
-//#region index.ts
+// index.ts
 /** URL of the bundled Open Korean Dictionary 일반어 FST binary. */
 const opendictGeneralFstUrl = new URL("./general.fst", import.meta.url);
 /** URL of the bundled Open Korean Dictionary 북한어 FST binary. */
@@ -117,5 +117,4 @@ async function opendictArchaicFst() {
 		format: "fst"
 	};
 }
-//#endregion
 export { opendictArchaicFst, opendictArchaicFstBytes, opendictArchaicFstUrl, opendictDialectFst, opendictDialectFstBytes, opendictDialectFstUrl, opendictFstBytes, opendictGeneralFst, opendictGeneralFstBytes, opendictGeneralFstUrl, opendictNorthKoreanFst, opendictNorthKoreanFstBytes, opendictNorthKoreanFstUrl };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gukhanmun/opendict-fst",
-  "version": "0.4.0-dev.236",
+  "version": "0.4.0-dev.245",
   "description": "Open Korean Dictionary categories bundled as FST binaries for @gukhanmun/wasm and @gukhanmun/napi.",
   "type": "module",
   "exports": {
@@ -61,7 +61,7 @@
     "@gukhanmun/types": "*"
   },
   "devDependencies": {
-    "@gukhanmun/types": "0.4.0-dev.236+75afc34"
+    "@gukhanmun/types": "0.4.0-dev.245+223a736"
   },
   "scripts": {
     "prebuild": "mise run -C ../.. opendict-fst-data",