@leuria/web-embed 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,18 @@
+# @leuria/web-embed
+
+A small embedding model that runs in the page, as a Leuria provider: search by meaning for visitors whose own AI can't embed. It uses [Transformers.js](https://huggingface.co/docs/transformers.js) in a Web Worker, so the page stays responsive.
+
+```ts
+import { bridge, browserAI, createLeuria } from "@leuria/client"
+import { pageEmbedder } from "@leuria/web-embed"
+
+const ai = createLeuria({ providers: [bridge(), browserAI(), pageEmbedder()] })
+// Later, from a click (the visitor agrees to the download):
+await ai.connect("page-embed")
+```
+
+- **Asks first.** Until the visitor agrees, the provider is `needs-action` with `action: "download"`. The model and its runtime are about 40 MB, downloaded once and kept in the browser's cache. `autoLoad: true` skips the question.
+- **Default model:** `Xenova/bge-small-en-v1.5` (English, made for search), with the query instruction from its model card. Choose another with `model` (and `queryPrefix`).
+- **Where files come from:** Hugging Face by default; set `remoteHost` to serve the model from your own site. Texts never leave the page.
+
+Apache-2.0.

package/dist/cdn.d.ts

@@ -0,0 +1,19 @@
+import { P as PageEmbedderOptions, a as PageEmbedder } from './provider-B9byklKg.js';
+import '@leuria/client';
+
+/**
+ * @leuria/web-embed/cdn: the same page model, with its runtime
+ * (Transformers.js) loaded from a CDN when the visitor asks for it,
+ * instead of bundled with the page. For sites whose bundler can't pack
+ * Transformers.js, such as Docusaurus.
+ *
+ *   import { pageEmbedder } from "@leuria/web-embed/cdn"
+ */
+
+/** The Transformers.js this package is tested with. */
+declare const TRANSFORMERS_URL = "https://cdn.jsdelivr.net/npm/@huggingface/transformers@4.3.0/+esm";
+declare function pageEmbedder(options?: PageEmbedderOptions & {
+    transformersUrl?: string;
+}): PageEmbedder;
+
+export { PageEmbedder, PageEmbedderOptions, TRANSFORMERS_URL, pageEmbedder };

package/dist/cdn.js

@@ -0,0 +1,43 @@
+import {
+  PageEmbedder
+} from "./chunk-2AKWJO6K.js";
+
+// src/cdn.ts
+var TRANSFORMERS_URL = "https://cdn.jsdelivr.net/npm/@huggingface/transformers@4.3.0/+esm";
+function workerSource(from) {
+  return `import { env, pipeline } from ${JSON.stringify(from)};
+let extractor = null;
+self.onmessage = async ({ data }) => {
+	const { id, type } = data;
+	try {
+		if (type === "load") {
+			env.allowLocalModels = false;
+			if (data.remoteHost) env.remoteHost = data.remoteHost;
+			extractor ??= await pipeline("feature-extraction", data.model, {
+				dtype: "q8",
+				progress_callback: (event) => {
+					if (event.status !== "progress_total") return;
+					const progress = event.total ? (event.loaded ?? 0) / event.total : (event.progress ?? 0) / 100;
+					self.postMessage({ id, type: "progress", progress });
+				},
+			});
+			self.postMessage({ id, type: "done" });
+		} else if (type === "embed") {
+			const output = await extractor(data.texts, { pooling: "mean", normalize: true });
+			self.postMessage({ id, type: "done", vectors: output.tolist() });
+		}
+	} catch (error) {
+		self.postMessage({ id, type: "error", message: error instanceof Error ? error.message : String(error) });
+	}
+};
+`;
+}
+function pageEmbedder(options = {}) {
+  const source = workerSource(options.transformersUrl ?? TRANSFORMERS_URL);
+  return new PageEmbedder(() => new Worker(URL.createObjectURL(new Blob([source], { type: "text/javascript" })), { type: "module" }), options);
+}
+export {
+  PageEmbedder,
+  TRANSFORMERS_URL,
+  pageEmbedder
+};

package/dist/chunk-2AKWJO6K.js

@@ -0,0 +1,123 @@
+// src/provider.ts
+import { BaseProvider } from "@leuria/client";
+var ModelWorker = class {
+  worker;
+  next = 0;
+  waiting = /* @__PURE__ */ new Map();
+  constructor(create) {
+    this.worker = create();
+    this.worker.onmessage = ({ data }) => {
+      const call = this.waiting.get(data.id);
+      if (!call) return;
+      if (data.type === "progress") call.progress?.(data.progress);
+      else {
+        this.waiting.delete(data.id);
+        if (data.type === "done") call.resolve(data.vectors);
+        else call.reject(new Error(data.message));
+      }
+    };
+  }
+  call(message, progress) {
+    const id = this.next++;
+    return new Promise((resolve, reject) => {
+      this.waiting.set(id, { resolve, reject, progress });
+      this.worker.postMessage({ ...message, id });
+    });
+  }
+  terminate() {
+    this.worker.terminate();
+    for (const call of this.waiting.values()) call.reject(new Error("The model was stopped."));
+    this.waiting.clear();
+  }
+};
+var CACHE = "transformers-cache";
+var BATCH = 16;
+var PageEmbedder = class extends BaseProvider {
+  /** `createWorker` starts the model's worker: bundled with the page, or with its runtime from a CDN. */
+  constructor(createWorker, options = {}) {
+    super(options.id ?? "page-embed", options.label ?? "A model in this page", "device", { status: "unknown", capabilities: [] });
+    this.createWorker = createWorker;
+    this.options = options;
+    this.model = options.model ?? "Xenova/bge-small-en-v1.5";
+    this.queryPrefix = options.queryPrefix ?? (/bge-.*en|mxbai-embed/i.test(this.model) ? "Represent this sentence for searching relevant passages: " : "");
+  }
+  createWorker;
+  offers = ["embed"];
+  model;
+  queryPrefix;
+  options;
+  loading = null;
+  worker = null;
+  async detect() {
+    if (typeof WebAssembly === "undefined" || typeof Worker === "undefined") {
+      this.setState({ status: "unavailable", capabilities: [], detail: "This browser can't run the model" });
+      return;
+    }
+    if (this.worker || this.options.autoLoad || await this.cached()) {
+      this.ready();
+      return;
+    }
+    if (this.loading) return;
+    this.setState({
+      status: "needs-action",
+      action: "download",
+      capabilities: [],
+      detail: `A search model for this page must be downloaded first (${this.options.size ?? "about 40 MB"})`
+    });
+  }
+  /** Download the model (call it from a click). */
+  async connect() {
+    await this.load();
+  }
+  async embed({ texts: input, kind, signal }) {
+    const worker = await this.load();
+    const texts = kind === "query" && this.queryPrefix ? input.map((t) => this.queryPrefix + t) : input;
+    const vectors = [];
+    for (let i = 0; i < texts.length; i += BATCH) {
+      if (signal?.aborted) throw signal.reason ?? new Error("Aborted");
+      vectors.push(...await worker.call({ type: "embed", texts: texts.slice(i, i + BATCH) }) ?? []);
+    }
+    return { vectors, model: this.model };
+  }
+  async createSession() {
+    throw new Error("This model only embeds.");
+  }
+  ready() {
+    this.setState({ status: "ready", action: void 0, progress: void 0, capabilities: ["embed"], embedModel: this.model, detail: void 0 });
+  }
+  load() {
+    this.loading ??= (async () => {
+      const cached = await this.cached();
+      if (!cached) this.setState({ status: "downloading", progress: 0, capabilities: [], detail: "The page's search model is downloading" });
+      const worker = new ModelWorker(this.createWorker);
+      try {
+        await worker.call({ type: "load", model: this.model, remoteHost: this.options.remoteHost }, (progress) => {
+          if (!cached) this.setState({ progress: Math.min(1, Math.max(0, progress)) });
+        });
+        this.worker = worker;
+        this.ready();
+        return worker;
+      } catch (error) {
+        worker.terminate();
+        this.loading = null;
+        this.setState({ status: "needs-action", action: "download", progress: void 0, capabilities: [], detail: "The search model couldn't be downloaded. Try again." });
+        throw error;
+      }
+    })();
+    return this.loading;
+  }
+  /** The model's files are already in the browser's cache. */
+  async cached() {
+    try {
+      if (typeof caches === "undefined") return false;
+      const cache = await caches.open(CACHE);
+      return (await cache.keys()).some((request) => request.url.includes(`/${this.model}/`) && request.url.endsWith(".onnx"));
+    } catch {
+      return false;
+    }
+  }
+};
+
+export {
+  PageEmbedder
+};

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import { P as PageEmbedderOptions, a as PageEmbedder } from './provider-B9byklKg.js';
+import '@leuria/client';
+
+/**
+ * @leuria/web-embed: a small embedding model that runs in the page, for
+ * visitors whose own AI can't embed. Put it after `bridge()`:
+ *
+ *   const ai = createLeuria({ providers: [bridge(), browserAI(), pageEmbedder()] })
+ *
+ * The model and its runtime (about 40 MB) are downloaded once, when the visitor asks for
+ * it (`ai.connect("page-embed")`, from a click), then kept in the
+ * browser's cache. Texts never leave the page.
+ */
+
+declare function pageEmbedder(options?: PageEmbedderOptions): PageEmbedder;
+
+export { PageEmbedder, PageEmbedderOptions, pageEmbedder };

package/dist/index.js

@@ -0,0 +1,12 @@
+import {
+  PageEmbedder
+} from "./chunk-2AKWJO6K.js";
+
+// src/index.ts
+function pageEmbedder(options) {
+  return new PageEmbedder(() => new Worker(new URL("./worker.js", import.meta.url), { type: "module" }), options);
+}
+export {
+  PageEmbedder,
+  pageEmbedder
+};

package/dist/provider-B9byklKg.d.ts

@@ -0,0 +1,38 @@
+import { BaseProvider, EmbedRequest, EmbedResult, ProviderSession } from '@leuria/client';
+
+interface PageEmbedderOptions {
+    id?: string;
+    label?: string;
+    /** A Transformers.js feature-extraction model. Default `Xenova/bge-small-en-v1.5` (384 dimensions, English, made for search). */
+    model?: string;
+    /** Rough download size, said to the visitor before they agree. Default "about 40 MB". */
+    size?: string;
+    /** Put before each query (models trained for search want one). Default: the one from the model card for BGE and mxbai models, none otherwise. */
+    queryPrefix?: string;
+    /** Download without asking, on the first `embed`. Default false. */
+    autoLoad?: boolean;
+    /** Where the model files come from. Default Hugging Face (`https://huggingface.co/`); host them yourself to keep every request on your site. */
+    remoteHost?: string;
+}
+declare class PageEmbedder extends BaseProvider {
+    private readonly createWorker;
+    readonly offers: readonly ["embed"];
+    readonly model: string;
+    private readonly queryPrefix;
+    private readonly options;
+    private loading;
+    private worker;
+    /** `createWorker` starts the model's worker: bundled with the page, or with its runtime from a CDN. */
+    constructor(createWorker: () => Worker, options?: PageEmbedderOptions);
+    detect(): Promise<void>;
+    /** Download the model (call it from a click). */
+    connect(): Promise<void>;
+    embed({ texts: input, kind, signal }: EmbedRequest): Promise<EmbedResult>;
+    createSession(): Promise<ProviderSession>;
+    private ready;
+    private load;
+    /** The model's files are already in the browser's cache. */
+    private cached;
+}
+
+export { type PageEmbedderOptions as P, PageEmbedder as a };

package/dist/worker.js

@@ -0,0 +1,31 @@
+// The page model runs here, off the page's main thread, so the page stays
+// responsive while it downloads and embeds. Plain JavaScript: bundlers pick
+// it up through `new URL("./worker.js", import.meta.url)`, from source or
+// from dist.
+import { env, pipeline } from "@huggingface/transformers";
+
+let extractor = null;
+
+self.onmessage = async ({ data }) => {
+	const { id, type } = data;
+	try {
+		if (type === "load") {
+			env.allowLocalModels = false;
+			if (data.remoteHost) env.remoteHost = data.remoteHost;
+			extractor ??= await pipeline("feature-extraction", data.model, {
+				dtype: "q8",
+				progress_callback: (event) => {
+					if (event.status !== "progress_total") return;
+					const progress = event.total ? (event.loaded ?? 0) / event.total : (event.progress ?? 0) / 100;
+					self.postMessage({ id, type: "progress", progress });
+				},
+			});
+			self.postMessage({ id, type: "done" });
+		} else if (type === "embed") {
+			const output = await extractor(data.texts, { pooling: "mean", normalize: true });
+			self.postMessage({ id, type: "done", vectors: output.tolist() });
+		}
+	} catch (error) {
+		self.postMessage({ id, type: "error", message: error instanceof Error ? error.message : String(error) });
+	}
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@leuria/web-embed",
+  "version": "0.1.0",
+  "description": "A small embedding model that runs in the page (Transformers.js), as a Leuria provider: search by meaning for visitors without their own model.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leur-ia/leuria.git",
+    "directory": "packages/web-embed"
+  },
+  "homepage": "https://leuria.dev",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./cdn": {
+      "types": "./dist/cdn.d.ts",
+      "import": "./dist/cdn.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@huggingface/transformers": "^4.3.0"
+  },
+  "peerDependencies": {
+    "@leuria/client": "^0.1.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.4.0",
+    "typescript": "^5.9.0",
+    "@leuria/client": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsup && cp src/worker.js dist/worker.js",
+    "check": "tsc --noEmit"
+  }
+}