@gukhanmun/stdict-cdb 0.1.0-dev.16 → 0.1.0

package/README.md

@@ -1,10 +1,21 @@
 @gukhanmun/stdict-cdb
 =====================
 
+[![JSR][JSR badge]][JSR]
+[![npm][npm badge]][npm]
+[![License: GPL-3.0-only][GPL badge]][GPL]
+
 Standard Korean Language Dictionary (표준국어대사전, 標準國語大辭典) compiled
 into a Gukhanmun CDB binary and distributed as an npm package. Use this with
 `@gukhanmun/wasm` or `@gukhanmun/napi` when `ko-KR` readings are needed.
 
+[JSR badge]: https://jsr.io/badges/@gukhanmun/stdict-cdb
+[JSR]: https://jsr.io/@gukhanmun/stdict-cdb
+[npm badge]: https://img.shields.io/npm/v/@gukhanmun/stdict-cdb?logo=npm
+[npm]: https://www.npmjs.com/package/@gukhanmun/stdict-cdb
+[GPL badge]: https://img.shields.io/npm/l/%40gukhanmun%2Fstdict-cdb
+[GPL]: https://www.gnu.org/licenses/gpl-3.0.html
+
 
 Installation
 ------------
@@ -31,11 +42,14 @@ console.log(g.convert("漢字를 한글로")); // "한자를 한글로"
 
 `stdictCdb()` returns a `DictionarySource` record (a
 `{ format: "cdb", bytes: Uint8Array }` object). `stdictCdbBytes()` returns only
-the `Uint8Array` when you need the raw bytes. `stdictCdbUrl` is the URL of the
+the `Uint8Array` when you need the raw bytes; pass an explicit `URL` to load a
+relocated copy instead of the bundled one. `stdictCdbUrl` is the URL of the
 binary inside the package, useful for preloading or caching.
 
-On Node.js the bytes are read with `node:fs/promises`. On all other runtimes
-they are fetched with `fetch`.
+`stdictCdbBytes()` picks how to load from the URL scheme, not the runtime: a
+`file:` URL (the usual case for an npm install) is read from disk with
+`node:fs/promises`, while any other scheme (such as the `https:` URL of a Deno
+install from JSR) is fetched with `fetch`.
 
 
 Relation to `@gukhanmun/stdict-fst`

package/dist/index.d.ts

@@ -58,11 +58,22 @@ declare const stdictCdbUrl: URL;
 /**
  * Loads the bundled Standard Korean Language Dictionary as raw bytes.
  *
- * On Node.js uses `node:fs/promises`; on all other runtimes uses `fetch`.
+ * The access strategy is chosen from the URL scheme, not from the host
+ * runtime.  A `file:` URL is read from disk with `node:fs/promises` (Node.js,
+ * Deno, and Bun all provide it, and it is the only option since Node.js's
+ * `fetch` rejects `file:` URLs); any other scheme is retrieved with `fetch`.
  *
+ * Branching on the scheme is what makes a JSR install work on Deno: there
+ * `import.meta.url` (and therefore {@link stdictCdbUrl}) is an `https:` URL,
+ * yet Deno also exposes `process.versions.node`, so a runtime sniff would
+ * wrongly take the `node:fs` path and `readFile` would reject the `https:`
+ * URL with "The URL must be of scheme file".
+ *
+ * @param url Location of the CDB binary to read.  Defaults to the bundled
+ *   {@link stdictCdbUrl}; pass another URL to load a relocated copy.
  * @returns The CDB binary as a `Uint8Array`.
  */
-declare function stdictCdbBytes(): Promise<Uint8Array<ArrayBuffer>>;
+declare function stdictCdbBytes(url?: URL): Promise<Uint8Array<ArrayBuffer>>;
 /**
  * Loads the bundled Standard Korean Language Dictionary as a
  * {@link FileDictionarySource} ready to pass to `load({ dictionaries: [...] })`.

package/dist/index.js

@@ -4,16 +4,30 @@ const stdictCdbUrl = new URL("./stdict.cdb", import.meta.url);
 /**
 * Loads the bundled Standard Korean Language Dictionary as raw bytes.
 *
-* On Node.js uses `node:fs/promises`; on all other runtimes uses `fetch`.
+* The access strategy is chosen from the URL scheme, not from the host
+* runtime.  A `file:` URL is read from disk with `node:fs/promises` (Node.js,
+* Deno, and Bun all provide it, and it is the only option since Node.js's
+* `fetch` rejects `file:` URLs); any other scheme is retrieved with `fetch`.
 *
+* Branching on the scheme is what makes a JSR install work on Deno: there
+* `import.meta.url` (and therefore {@link stdictCdbUrl}) is an `https:` URL,
+* yet Deno also exposes `process.versions.node`, so a runtime sniff would
+* wrongly take the `node:fs` path and `readFile` would reject the `https:`
+* URL with "The URL must be of scheme file".
+*
+* @param url Location of the CDB binary to read.  Defaults to the bundled
+*   {@link stdictCdbUrl}; pass another URL to load a relocated copy.
 * @returns The CDB binary as a `Uint8Array`.
 */
-async function stdictCdbBytes() {
-	if (typeof globalThis.process?.versions?.node === "string") {
-		const buf = await (await import("node:fs/promises")).readFile(stdictCdbUrl);
+async function stdictCdbBytes(url = stdictCdbUrl) {
+	if (url.protocol === "file:") {
+		const buf = await (await import(
+			/* webpackIgnore: true */
+			"node:fs/promises"
+)).readFile(url);
 		return new Uint8Array(buf.buffer, buf.byteOffset, buf.byteLength);
 	}
-	const response = await fetch(stdictCdbUrl);
+	const response = await fetch(url);
 	if (!response.ok) throw new Error(`Failed to fetch stdict CDB: HTTP ${response.status}`);
 	return new Uint8Array(await response.arrayBuffer());
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gukhanmun/stdict-cdb",
-  "version": "0.1.0-dev.16",
+  "version": "0.1.0",
   "description": "Standard Korean Language Dictionary bundled as a CDB binary for @gukhanmun/wasm and @gukhanmun/napi.",
   "type": "module",
   "exports": {
@@ -46,7 +46,7 @@
     "@gukhanmun/types": "*"
   },
   "devDependencies": {
-    "@gukhanmun/types": "0.1.0-dev.16+395401fa8b3429703127c66d1db02c435606d87b"
+    "@gukhanmun/types": "0.1.0"
   },
   "scripts": {
     "build": "tsdown && node -e \"require('node:fs').copyFileSync('stdict.cdb','dist/stdict.cdb')\""