@desert-ant-labs/emo 0.6.0 → 0.6.2

package/README.md

@@ -1,8 +1,13 @@
 # @desert-ant-labs/emo
 
+**On-device emoji suggestion for Node and the browser. TypeScript-native, offline, multilingual, no inference runtime.**
+
 On-device emoji suggestions from text. Suggests the best-matching emoji for short
 tasks, calendar entries, notes, or message drafts across **23 languages**, fully
-in-process, no inference runtime.
+in-process, no inference runtime. Emo does emoji prediction (text-to-emoji), useful
+for a keyboard, an autocomplete, or any text field. It runs in TypeScript and
+JavaScript, in Node and in the browser. Emo suggests emoji from text; it is not an
+emoji picker.
 
 ```ts
 import { suggestions } from "@desert-ant-labs/emo";
@@ -112,6 +117,14 @@ emoji for each task on-device. Run it with `node server.js` from that folder and
 
 Published at [`desert-ant-labs/emo`](https://huggingface.co/desert-ant-labs/emo) on Hugging Face.
 
+## Other platforms
+
+Same model, native on each platform:
+
+- [`emo-swift`](https://github.com/Desert-Ant-Labs/emo-swift): Swift for iOS and macOS
+- [`emo-kotlin`](https://github.com/Desert-Ant-Labs/emo-kotlin): Kotlin for Android and the JVM
+- Model weights and card: [`desert-ant-labs/emo`](https://huggingface.co/desert-ant-labs/emo)
+
 ## License
 
 [Desert Ant Labs Source-Available License](https://license.desertant.ai/1.0). Free for

package/dist/index.browser.d.ts

@@ -7,7 +7,9 @@ export { loadModel, type EmoEnv, type FileCache } from "./hub.js";
 /** Loading configuration. Mutate before the first call, or pass overrides to {@link load}. */
 export declare const env: EmoEnv;
 /** Loads the model from the Hugging Face Hub (cached in Cache Storage). */
-export declare function load(options?: Partial<EmoEnv>): Promise<EmoModel>;
+export declare function load(options?: Partial<EmoEnv> & {
+    usageKey?: string;
+}): Promise<EmoModel>;
 /**
  * Returns emoji suggestions for a phrase, most likely first. The model is loaded
  * (and cached) lazily on first call. Empty input returns `[]`.

package/dist/index.browser.js

@@ -1,3 +1,4 @@
+import { initUsage } from "@desert-ant-labs/desert-ant-web";
 import { webCache } from "./cache-web.js";
 import { DEFAULT_HOST, DEFAULT_REPO, DEFAULT_REVISION, loadModel } from "./hub.js";
 export { createEmo, EmoModel } from "./model.js";
@@ -11,10 +12,21 @@ export const env = {
     allowRemote: true,
     useCache: true,
 };
+let usage = null;
+function instrument(model, usageKey) {
+    const suggestions = model.suggestions.bind(model);
+    model.suggestions = (text, limit, options) => {
+        usage ??= initUsage({ key: usageKey });
+        const out = suggestions(text, limit, options);
+        usage.recordCall();
+        return out;
+    };
+    return model;
+}
 /** Loads the model from the Hugging Face Hub (cached in Cache Storage). */
 export async function load(options = {}) {
     const e = { ...env, ...options };
-    return loadModel(e, e.useCache ? webCache() : null);
+    return instrument(await loadModel(e, e.useCache ? webCache() : null), options.usageKey);
 }
 let modelPromise = null;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@desert-ant-labs/emo",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "On-device emoji suggestions from text.",
   "type": "module",
   "main": "./dist/index.node.js",
@@ -51,9 +51,15 @@
   },
   "keywords": [
     "emoji",
+    "emoji-suggestion",
+    "emoji-prediction",
+    "text-to-emoji",
+    "emoji-autocomplete",
     "on-device",
+    "offline",
     "multilingual",
-    "text-classification"
+    "typescript",
+    "keyboard"
   ],
   "license": "SEE LICENSE IN LICENSE.md",
   "repository": {
@@ -68,6 +74,9 @@
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "@desert-ant-labs/desert-ant-web": "^0.1.0"
+  },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18",
     "@types/node": "^22",