@panda-lingo/goldendict 0.1.4 → 0.1.7

package/README.md

@@ -17,6 +17,23 @@ view.client = new DictionaryClient({ baseUrl: "/api/v1" });
 await view.lookup("example");
 ```
 
+`baseUrl` is the complete public API mount, including a reverse-proxy prefix
+when one exists. GoldenDict-rooted article resources are rebased through that
+mount, so a host can expose the service at a route such as `/api/v1/mdict`
+without rewriting lookup payloads:
+
+```ts
+view.client = new DictionaryClient({ baseUrl: "/api/v1/mdict" });
+```
+
+Search-first hosts can request bounded prefix suggestions through the same
+client and API base before committing an article lookup:
+
+```ts
+const result = await view.client.suggestions("exam", { limit: 20 });
+console.log(result.suggestions);
+```
+
 Importing the package registers `<goldendict-view>` automatically. Call
 `defineGoldendictView("my-dictionary-view")` when a custom tag name is useful.
 
@@ -64,8 +81,8 @@ it when a particular dictionary requires different behavior. Set
 
 The public API includes:
 
-- `DictionaryClient` for dictionary listing and lookup, plus the backend's
-  explicitly opt-in server-path load operation.
+- `DictionaryClient` for dictionary listing, prefix suggestions, and lookup,
+  plus the backend's explicitly opt-in server-path load operation.
 - `GoldenDictView` and `defineGoldendictView` for framework-independent use.
 - `GoldenDictTheme`, light/dark token presets, and `themeToCss` for branding.
 - `GOLDENDICT_EVENTS` for lookup, active article, collapse, media, external-link,

package/dist/client/dictionary-client.d.ts

@@ -1,4 +1,4 @@
-import type { DictionaryClientOptions, DictionarySummary, LoadDictionaryRequest, LoadDictionaryResponse, LookupOptions, LookupResponse } from "../types";
+import type { DictionaryClientOptions, DictionarySummary, LoadDictionaryRequest, LoadDictionaryResponse, LookupOptions, LookupResponse, SuggestionsOptions, SuggestionsResponse } from "../types";
 export declare class DictionaryApiError extends Error {
     readonly status: number;
     readonly body: unknown;
@@ -13,6 +13,7 @@ export declare class DictionaryClient {
     listDictionaries(signal?: AbortSignal): Promise<DictionarySummary[]>;
     loadDictionary(input: LoadDictionaryRequest, signal?: AbortSignal): Promise<LoadDictionaryResponse>;
     lookup(word: string, options?: LookupOptions): Promise<LookupResponse>;
+    suggestions(prefix: string, options?: SuggestionsOptions): Promise<SuggestionsResponse>;
     private request;
 }
 //# sourceMappingURL=dictionary-client.d.ts.map

package/dist/client/dictionary-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dictionary-client.d.ts","sourceRoot":"","sources":["../../src/client/dictionary-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,iBAAiB,EACjB,qBAAqB,EACrB,sBAAsB,EACtB,aAAa,EACb,cAAc,EACf,MAAM,UAAU,CAAC;AAElB,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;gBAEX,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO;CAM5D;AAiDD,qBAAa,gBAAgB;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IACpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmC;IAC3D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;gBAErC,OAAO,GAAE,uBAA4B;IAW3C,gBAAgB,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAQpE,cAAc,CAClB,KAAK,EAAE,qBAAqB,EAC5B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,sBAAsB,CAAC;IA6B5B,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,cAAc,CAAC;YAsBlE,OAAO;CAoCtB"}
+{"version":3,"file":"dictionary-client.d.ts","sourceRoot":"","sources":["../../src/client/dictionary-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,iBAAiB,EACjB,qBAAqB,EACrB,sBAAsB,EACtB,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,UAAU,CAAC;AAElB,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;gBAEX,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO;CAM5D;AAiDD,qBAAa,gBAAgB;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA0B;IACpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmC;IAC3D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;gBAErC,OAAO,GAAE,uBAA4B;IAW3C,gBAAgB,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAQpE,cAAc,CAClB,KAAK,EAAE,qBAAqB,EAC5B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,sBAAsB,CAAC;IA6B5B,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,cAAc,CAAC;IAsB1E,WAAW,CACf,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,mBAAmB,CAAC;YA2BjB,OAAO;CAoCtB"}

package/dist/index.js

@@ -84,6 +84,28 @@ class v {
       lookupTimeMs: r.lookupTimeMs ?? 0
     };
   }
+  async suggestions(e, o = {}) {
+    const t = e.trim();
+    if (!t)
+      throw new TypeError("Suggestion prefix must not be empty");
+    const n = o.limit ?? 20;
+    if (!Number.isInteger(n) || n < 1 || n > 100)
+      throw new RangeError("Suggestion limit must be an integer between 1 and 100");
+    const a = new URLSearchParams({
+      prefix: t,
+      limit: String(n)
+    });
+    o.dictionaryIds?.length && a.set("dictionary_ids", o.dictionaryIds.join(","));
+    const r = await this.request(
+      `/suggestions?${a.toString()}`,
+      { signal: o.signal }
+    );
+    return {
+      prefix: r.prefix ?? t,
+      suggestions: r.suggestions ?? [],
+      lookupTimeMs: r.lookupTimeMs ?? 0
+    };
+  }
   async request(e, o = {}) {
     const t = await this.fetchImpl(`${this.baseUrl}${e}`, {
       ...o,
@@ -108,7 +130,7 @@ class v {
     return n;
   }
 }
-const U = `<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+const R = `<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!-- Created with Inkscape (http://www.inkscape.org/) -->
 
 <svg
@@ -154,7 +176,7 @@ const U = `<?xml version="1.0" encoding="UTF-8" standalone="no"?>
        sodipodi:nodetypes="cccc" />
   </g>
 </svg>
-`, R = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfmAxMKDTHgIis/AAAAwUlEQVQoz33RsUtCcRTF8U+vJ8/RCAKHdEoc+isachBcMhranQQXt/YIGmxrLAgRac/JFsP+jVqaHVvkuTy0V/08dzzfC/eew2+1FWxRz1KCG42/ZuxeKpWgaeYub++ZStcAsRcddgwdgCPVDC1qOHat7F2dz2xvMwluXeDBWQgomeDSIAp8s1DEh8PIdqUhoOQbFV8h4MojTsxjb9mbNZW13bIwtu9U72dQr7mgeNIPR10z9CwKlzXStfv/eef5uldwrDr7rieveQAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMi0wMy0xOVQxMDoxMzo0OSswMDowMH0jItoAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjItMDMtMTlUMTA6MTM6NDkrMDA6MDAMfppmAAAAAElFTkSuQmCC", F = `<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+`, U = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAQAAAC1+jfqAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfmAxMKDTHgIis/AAAAwUlEQVQoz33RsUtCcRTF8U+vJ8/RCAKHdEoc+isachBcMhranQQXt/YIGmxrLAgRac/JFsP+jVqaHVvkuTy0V/08dzzfC/eew2+1FWxRz1KCG42/ZuxeKpWgaeYub++ZStcAsRcddgwdgCPVDC1qOHat7F2dz2xvMwluXeDBWQgomeDSIAp8s1DEh8PIdqUhoOQbFV8h4MojTsxjb9mbNZW13bIwtu9U72dQr7mgeNIPR10z9CwKlzXStfv/eef5uldwrDr7rieveQAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMi0wMy0xOVQxMDoxMzo0OSswMDowMH0jItoAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjItMDMtMTlUMTA6MTM6NDkrMDA6MDAMfppmAAAAAElFTkSuQmCC", F = `<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!-- Created with Inkscape (http://www.inkscape.org/) -->
 
 <svg
@@ -243,7 +265,7 @@ const U = `<?xml version="1.0" encoding="UTF-8" standalone="no"?>
        sodipodi:nodetypes="cccccccc" />
   </g>
 </svg>
-`, G = `<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+`, N = `<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <svg
    width="24.000002"
    height="24"
@@ -311,7 +333,7 @@ const U = `<?xml version="1.0" encoding="UTF-8" standalone="no"?>
      x="1.1215118e-09"
      y="4.9718442"
      ry="0.64957041" /></svg>
-`, N = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAATrAAAE6wHYKlsNAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAAAcRJREFUOI2lkztvE0EQgL8Z7/rB2T5fCixhQQc00FAjJCRkiTYV/JH0adIgfgJVGn4CKRBUSIjCHYiOBimK7KA4ORw/dofC3Ck2dhpGGu1r5pvZmV0xM/5HXDEZDAbf2u12BkiM0UIImBlmRoyxHBeLBaPRaNzv9++tAJIkyVS1673HzBCRUtfFzEo/d/VAVRERzvf2uDw6AqB6eMhlt1va9Hq9FWgJiDEiIqgqcTwmnp4CUPeearu9EmRjDYp7qiqVNEV3dgCYx8hlniMimBlZlm0GFN0QERoHB7j9/bIGVUDiHCrVfzLQqwDvPSLCZDIhz3MuLi6YTye4eY58fkOnUbkeUERMkoRWq0WaptRqDaYfXvPr3StmP75cX4PZbIb3HoDx6TmttImveZoPn9N+0KfWvbsdYGY45xARvn76zvu3H8m6GS/2dpnefLRsb4Bb2wAhBJxbLoc/hwCcDc9QqVCvuzLy+uPa2IUnu4+p36hz5/5tGkmdxWKBc45Op0MIYXsNClAzTXj28imquqKFzUbA8fHxbzMbi0glhKBmpsuEREQkqmpU1Sgi8eTkJC/8ZNN3FhEHNIHG360pkJvZdN32D0SOwDehr1HXAAAAAElFTkSuQmCC", V = `<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+`, G = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAATrAAAE6wHYKlsNAAAAGXRFWHRTb2Z0d2FyZQB3d3cuaW5rc2NhcGUub3Jnm+48GgAAAcRJREFUOI2lkztvE0EQgL8Z7/rB2T5fCixhQQc00FAjJCRkiTYV/JH0adIgfgJVGn4CKRBUSIjCHYiOBimK7KA4ORw/dofC3Ck2dhpGGu1r5pvZmV0xM/5HXDEZDAbf2u12BkiM0UIImBlmRoyxHBeLBaPRaNzv9++tAJIkyVS1673HzBCRUtfFzEo/d/VAVRERzvf2uDw6AqB6eMhlt1va9Hq9FWgJiDEiIqgqcTwmnp4CUPeearu9EmRjDYp7qiqVNEV3dgCYx8hlniMimBlZlm0GFN0QERoHB7j9/bIGVUDiHCrVfzLQqwDvPSLCZDIhz3MuLi6YTye4eY58fkOnUbkeUERMkoRWq0WaptRqDaYfXvPr3StmP75cX4PZbIb3HoDx6TmttImveZoPn9N+0KfWvbsdYGY45xARvn76zvu3H8m6GS/2dpnefLRsb4Bb2wAhBJxbLoc/hwCcDc9QqVCvuzLy+uPa2IUnu4+p36hz5/5tGkmdxWKBc45Op0MIYXsNClAzTXj28imquqKFzUbA8fHxbzMbi0glhKBmpsuEREQkqmpU1Sgi8eTkJC/8ZNN3FhEHNIHG360pkJvZdN32D0SOwDehr1HXAAAAAElFTkSuQmCC", V = `<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!-- Created with Inkscape (http://www.inkscape.org/) -->
 
 <svg
@@ -725,12 +747,12 @@ function s(i) {
   return `data:image/svg+xml;charset=utf-8,${encodeURIComponent(i)}`;
 }
 const u = {
-  "arrow.svg": s(U),
-  "audio.png": R,
+  "arrow.svg": s(R),
+  "audio.png": U,
   "collapse_article.svg": s(P),
   "collapse_article_hovered.svg": s(F),
-  "collapse_opt.svg": s(G),
-  "document.png": N,
+  "collapse_opt.svg": s(N),
+  "document.png": G,
   "downarrow.svg": s(V),
   "expand_article.svg": s(H),
   "expand_article_hovered.svg": s(O),
@@ -8063,7 +8085,7 @@ function he(i, e) {
 }
 function D(i, e) {
   const o = e.replace(/[?#].*$/, "").replace(/\/+$/, "");
-  return (i === _ || i.startsWith(`${_}/`)) && /(?:^|\/)api\/v1$/i.test(o) ? `${o}${i.slice(_.length)}` : /^[a-z][a-z\d+.-]*:/i.test(e) ? new URL(i, e).toString() : i;
+  return (i === _ || i.startsWith(`${_}/`)) && o !== "" ? `${o}${i.slice(_.length)}` : /^[a-z][a-z\d+.-]*:/i.test(e) ? new URL(i, e).toString() : i;
 }
 function C(i) {
   const e = i.resourceBaseUrl;
@@ -8117,7 +8139,7 @@ function fe(i) {
     ...a?.length ? { dictionaryIds: a } : {}
   } : { kind: "unsafe" };
 }
-function L(i, e) {
+function q(i, e) {
   const o = i.trim();
   if (!o || o === "#")
     return { kind: "anchor", anchor: "" };
@@ -8171,7 +8193,7 @@ function be(i, e, o) {
     const a = i.getAttribute("data-gd-lookup")?.trim();
     if (a && a !== "true" && a !== "1")
       return { kind: "lookup", word: a };
-    const r = L(e, o);
+    const r = q(e, o);
     if (r.kind === "lookup")
       return r;
     const l = i.getAttribute("data-gd-word")?.trim();
@@ -8253,7 +8275,7 @@ function ye(i, e, o) {
       const d = r.getAttribute("href");
       d !== null && ke(
         r,
-        be(r, d, t) ?? L(d, t),
+        be(r, d, t) ?? q(d, t),
         i.dictionaryId
       );
     } else if (r.hasAttribute("href")) {
@@ -8305,7 +8327,7 @@ const ve = {
   radius: "8px",
   spacing: "8px"
 };
-function q(i = "light") {
+function L(i = "light") {
   return i !== "auto" ? i : globalThis.matchMedia?.("(prefers-color-scheme: dark)").matches ? "dark" : "light";
 }
 function c(i, e) {
@@ -8315,7 +8337,7 @@ function k(i) {
   return i.replace(/<\/style/gi, "<\\/style");
 }
 function ze(i = {}) {
-  const e = q(i.mode), o = i.tokens ?? {}, t = e === "dark" ? { ..._e, ...o } : o, n = [
+  const e = L(i.mode), o = i.tokens ?? {}, t = e === "dark" ? { ..._e, ...o } : o, n = [
     c("--gd-font-family", t.fontFamily),
     c("--gd-text-color", t.textColor),
     c("--gd-muted-text-color", t.mutedTextColor),
@@ -8594,7 +8616,7 @@ function De(i, e) {
     "base-uri 'none'"
   ].join("; ");
 }
-function Le() {
+function qe() {
   return `(function(){
     globalThis.__DICT__={name:"GoldenDict",version:"web"};
     const pending=[];
@@ -8623,8 +8645,8 @@ function Le() {
     },true);
   })();`;
 }
-function qe(i, e) {
-  const o = e.theme ?? {}, t = q(o.mode), n = e.layoutMode ?? "responsive", a = e.instanceId.replace(/[^a-zA-Z0-9_-]/g, ""), r = i.articles.map(
+function Le(i, e) {
+  const o = e.theme ?? {}, t = L(o.mode), n = e.layoutMode ?? "responsive", a = e.instanceId.replace(/[^a-zA-Z0-9_-]/g, ""), r = i.articles.map(
     (d) => Te(d, e.apiBaseUrl, e.scriptPolicy)
   ).join(""), l = r ? `${r}<div class="empty-space" aria-hidden="true"></div>` : `<div class="gdnotfound"><p>No translation for <b>${g(i.word)}</b> was found.</p></div>`, m = o.brandName ? `${i.word} — ${o.brandName}` : i.word;
   return `<!doctype html>
@@ -8633,7 +8655,7 @@ function qe(i, e) {
   <meta name="viewport" content="width=device-width,initial-scale=1">
   <meta http-equiv="Content-Security-Policy" content="${g(De(e.scriptPolicy, a))}">
   <title>${g(m)}</title>
-  <script nonce="${a}" data-gd-runtime="compatibility">${Le()}<\/script>
+  <script nonce="${a}" data-gd-runtime="compatibility">${qe()}<\/script>
   <style>${k(de)}</style>
   <style>${k(se(o.preset))}</style>
   ${n === "responsive" ? `<style data-gd-style="responsive">${k(ce)}</style>` : ""}
@@ -8832,7 +8854,7 @@ class z extends HTMLElement {
     this.activeBridgeInstanceId = t;
     const n = this.replaceFrame(!1);
     n.title = e.word ? `Dictionary results for ${e.word}` : "Dictionary article";
-    const a = qe(e, {
+    const a = Le(e, {
       apiBaseUrl: this.clientValue.baseUrl,
       instanceId: t,
       scriptPolicy: this.scriptPolicy,
@@ -8995,13 +9017,13 @@ class z extends HTMLElement {
     return this.dispatchEvent(n), n;
   }
 }
-function Ue(i = "goldendict-view") {
+function Re(i = "goldendict-view") {
   if (!globalThis.customElements)
     return z;
   const e = globalThis.customElements.get(i);
   return e || (globalThis.customElements.define(i, z), z);
 }
-Ue();
+Re();
 export {
   _e as DARK_THEME_TOKENS,
   M as DictionaryApiError,
@@ -9010,11 +9032,11 @@ export {
   me as GOLDENDICT_SCHEME_SUPPORT,
   z as GoldenDictView,
   ve as LIGHT_THEME_TOKENS,
-  L as classifyArticleLink,
-  Ue as defineGoldendictView,
+  q as classifyArticleLink,
+  Re as defineGoldendictView,
   k as escapeStyleText,
   p as resolveResourceUrl,
-  q as resolveThemeMode,
+  L as resolveThemeMode,
   ze as themeToCss
 };
 //# sourceMappingURL=index.js.map