wontopos 2.2.37 → 2.2.39

package/dist/wontopos.js

@@ -1,4 +1,4 @@
-const VERSION = "2.2.37";
+const VERSION = "2.2.39";
 const RUNTIME = (() => {
     const p = globalThis?.process;
     return p?.version ? ` (node/${p.version}; ${p.platform}-${p.arch})` : "";
@@ -13,7 +13,7 @@ function logDebug(msg) {
 const DEFAULT_BASE_URL = "https://api.wontopos.com";
 const DEFAULT_MODEL = "tablet-2";
 const RETRY_ALWAYS = new Set([429]);
-const RETRY_IF_IDEMPOTENT = new Set([502, 503]);
+const RETRY_IF_IDEMPOTENT = new Set([408, 502, 503, 504]);
 const IDEMPOTENT_METHODS = new Set(["GET", "HEAD", "PUT", "DELETE", "OPTIONS"]);
 const LOOPBACK_HOSTS = new Set(["localhost", "127.0.0.1", "::1", "0.0.0.0"]);
 const MAX_RESPONSE_BYTES = 64 * 1024 * 1024;
@@ -24,6 +24,12 @@ function normalizeStoreId(id) {
     return id.toLowerCase().replace(/[^a-z0-9_]/g, "_");
 }
 const WARNED_STORE_IDS_MAX = 1024;
+function assertUsableStoreId(userId) {
+    if (userId !== undefined && (typeof userId !== "string" || !userId.trim())) {
+        throw new Error(`userId must be a non-blank string; got ${JSON.stringify(userId)}. Omit it to use the client's ` +
+            "default store, or pass a real store id — anything else would silently write into the default store.");
+    }
+}
 const WARNED_FILTER_KEYS_MAX = 1024;
 const warnedStoreIds = new Set();
 function warnIfStoreIdCollapses(id) {
@@ -197,6 +203,47 @@ const KNOWN_FILTER_KEYS = new Set([
     "min_importance",
 ]);
 const warnedFilterKeys = new Set();
+const KNOWN_SEARCH_KEYS = new Set([
+    "cache_control", "speaker", "filters", "verify", "max_images", "extra",
+]);
+const RESERVED_SEARCH_KEYS = new Set(["user_id", "query", "max_results"]);
+const KNOWN_RECALL_KEYS = new Set(["form", "tz", "limit", "context_limit"]);
+const KNOWN_ENGRAM_KEYS = new Set(["form", "tz"]);
+function checkSearchOpts(opts) {
+    checkOpts(opts, KNOWN_SEARCH_KEYS, "search");
+}
+function checkOpts(opts, known, what) {
+    for (const k of Object.keys(opts)) {
+        if (RESERVED_SEARCH_KEYS.has(k))
+            throw new Error(`${JSON.stringify(k)} is set by the call, not by options — pass it as an argument. ` +
+                `An app forwarding untrusted input as options cannot steer the store, the query ` +
+                `or the count, and this says so rather than dropping it silently.`);
+        if (known.has(k))
+            continue;
+        const near = [...known].find((n) => n !== "extra" && editWithin(k, n, 2));
+        throw new Error(`unknown ${what} option ${JSON.stringify(k)}` +
+            (near ? ` — did you mean ${JSON.stringify(near)}?` : "") +
+            `. It would have had no effect, and the call would have looked like it worked.` +
+            (known.has("extra")
+                ? ` Pass it under \`extra\` if the service accepts it and this client does not know it yet.`
+                : ""));
+    }
+}
+function editWithin(a, b, max) {
+    if (Math.abs(a.length - b.length) > max)
+        return false;
+    const prev = Array.from({ length: b.length + 1 }, (_, j) => j);
+    for (let i = 1; i <= a.length; i++) {
+        let diag = prev[0];
+        prev[0] = i;
+        for (let j = 1; j <= b.length; j++) {
+            const tmp = prev[j];
+            prev[j] = Math.min(prev[j] + 1, prev[j - 1] + 1, diag + (a[i - 1] === b[j - 1] ? 0 : 1));
+            diag = tmp;
+        }
+    }
+    return prev[b.length] <= max;
+}
 function warnOnUnknownFilters(filters) {
     if (!filters || typeof filters !== "object" || Array.isArray(filters))
         return;
@@ -242,6 +289,11 @@ export class Client {
             throw new Error("apiKey contains whitespace - check for a stray newline or paste error");
         if (/[\x00-\x1f\x7f]/.test(key))
             throw new Error("apiKey contains a control character - check for a stray byte or paste error");
+        if (/[^\x00-\x7f]/.test(key)) {
+            const bad = key.match(/[^\x00-\x7f]/)?.[0];
+            throw new Error(`apiKey contains a non-ASCII character (${JSON.stringify(bad)}) - rich text turns '-' into an ` +
+                "en dash; copy the key from a plain-text field");
+        }
         this.apiKey = key;
         this.base = (opts.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
         const tm = opts.timeoutMs;
@@ -250,7 +302,8 @@ export class Client {
         if (this.model && !MODEL_RE.test(this.model)) {
             throw new Error(`invalid model name: ${JSON.stringify(this.model)} (letters, digits, '.', '_', '-' only)`);
         }
-        this.defaultUser = opts.userId || DEFAULT_USER;
+        assertUsableStoreId(opts.userId);
+        this.defaultUser = opts.userId ?? DEFAULT_USER;
         const mr = opts.maxRetries ?? opts.retries;
         this.maxRetries = typeof mr === "number" && Number.isFinite(mr) ? Math.max(0, Math.floor(mr)) : 2;
         const dl = opts.deadlineMs;
@@ -298,11 +351,8 @@ export class Client {
         return `Client(${this.base}, model=${this.model}, userId=${this.defaultUser}, apiKey=${maskKey(this.apiKey)})`;
     }
     uid(userId) {
-        if (userId !== undefined && (typeof userId !== "string" || !userId.trim())) {
-            throw new Error(`userId must be a non-blank string; got ${JSON.stringify(userId)}. Omit it to use the client's ` +
-                "default store, or pass a real store id — anything else would silently write into the default store.");
-        }
-        const id = userId || this.defaultUser;
+        assertUsableStoreId(userId);
+        const id = userId ?? this.defaultUser;
         warnIfStoreIdCollapses(id);
         return id;
     }
@@ -324,6 +374,10 @@ export class Client {
         return this.clone({ model });
     }
     withUser(userId) {
+        if (userId === undefined) {
+            throw new Error("withUser() needs a store id. It was called with undefined — usually a lookup that " +
+                "found nothing. Use the client's own default instead of calling withUser at all.");
+        }
         return this.clone({ userId });
     }
     withSignal(signal) {
@@ -338,43 +392,49 @@ export class Client {
     withRetries(maxRetries) {
         return this.clone({ maxRetries });
     }
-    add(content, userId, metadata = {}, opts = {}) {
+    async add(content, userId, metadata = {}, opts = {}) {
         const body = { user_id: this.uid(userId), content, metadata };
         if (opts.image !== undefined)
             body.image = normalizeImage(opts.image);
         return this.post("/api/v1/memory/store", body, opts.idempotencyKey);
     }
-    store(content, userId, metadata = {}, opts = {}) {
+    async store(content, userId, metadata = {}, opts = {}) {
         return this.add(content, userId, metadata, opts);
     }
-    addTurn(userMsg, assistantMsg, userId, opts = {}) {
+    async addTurn(userMsg, assistantMsg, userId, opts = {}) {
         return this.post("/api/v1/memory/store-turn", { user_id: this.uid(userId), user_msg: userMsg, assistant_msg: assistantMsg }, opts.idempotencyKey);
     }
-    addBulk(content, userId, category = "general", timestamp, opts = {}) {
+    async addBulk(content, userId, category = "general", timestamp, opts = {}) {
         const body = { user_id: this.uid(userId), content, category };
         if (timestamp)
             body.timestamp = timestamp;
         return this.post("/api/v1/memory/bulk-store", body, opts.idempotencyKey);
     }
-    update(oldMemoryId, newContent, userId, opts = {}) {
+    async update(oldMemoryId, newContent, userId, opts = {}) {
         return this.post("/api/v1/memory/supersede", { user_id: this.uid(userId), old_memory_id: oldMemoryId, new_content: newContent }, opts.idempotencyKey);
     }
     async search(query, userId, limit = 10, opts = {}) {
+        checkSearchOpts(opts);
         warnOnUnknownFilters(opts.filters);
         checkCount(limit, "limit");
-        const r = await this.post("/api/v1/memory/search", { ...opts, user_id: this.uid(userId), query, max_results: limit });
+        const { extra, ...known } = opts;
+        const r = await this.post("/api/v1/memory/search", { ...extra, ...known, user_id: this.uid(userId), query, max_results: limit });
         return mergeResults(r);
     }
     async searchSelf(query, userId, limit = 10, opts = {}) {
+        checkSearchOpts(opts);
         warnOnUnknownFilters(opts.filters);
         checkCount(limit, "limit");
-        const r = await this.post("/api/v1/memory/search", { ...opts, user_id: this.uid(userId), query, max_results: limit });
+        const { extra, ...known } = opts;
+        const r = await this.post("/api/v1/memory/search", { ...extra, ...known, user_id: this.uid(userId), query, max_results: limit });
         return { memories: asRecords(r.memories), self_memories: asRecords(r.self_memories) };
     }
     async searchFull(query, userId, limit = 10, opts = {}) {
+        checkSearchOpts(opts);
         warnOnUnknownFilters(opts.filters);
         checkCount(limit, "limit");
-        const r = await this.post("/api/v1/memory/search", { ...opts, user_id: this.uid(userId), query, max_results: limit });
+        const { extra, ...known } = opts;
+        const r = await this.post("/api/v1/memory/search", { ...extra, ...known, user_id: this.uid(userId), query, max_results: limit });
         return {
             ...r,
             memories: asRecords(r.memories),
@@ -383,6 +443,7 @@ export class Client {
         };
     }
     async recall(query, userId, opts = {}) {
+        checkOpts(opts, KNOWN_RECALL_KEYS, "recall");
         const body = { user_id: this.uid(userId), query };
         if (opts.limit !== undefined) {
             checkCount(opts.limit, "limit");
@@ -394,14 +455,15 @@ export class Client {
         }
         return this.post("/api/v1/memory/recall", withForm(body, opts.form, opts.tz));
     }
-    engram(name, query, userId, opts = {}) {
+    async engram(name, query, userId, opts = {}) {
+        checkOpts(opts, KNOWN_ENGRAM_KEYS, "engram");
         return this.post("/api/v1/engram/run", withForm({ name, user_id: this.uid(userId), query }, opts.form, opts.tz));
     }
     async history(userId) {
         const r = await this.post("/api/v1/memory/history", { user_id: this.uid(userId) });
         return asRecords(r.turns);
     }
-    stats(userId) {
+    async stats(userId) {
         return this.post("/api/v1/memory/stats", { user_id: this.uid(userId) });
     }
     async usage(days = 7) {
@@ -410,13 +472,13 @@ export class Client {
         }
         return this.request("GET", `/api/v1/won/usage?days=${days}`);
     }
-    get(userId, memoryId) {
-        if (!memoryId || typeof memoryId !== "string") {
+    async get(userId, memoryId) {
+        if (typeof memoryId !== "string" || !memoryId.trim()) {
             throw new Error("memoryId is required — the id that add/store or listMemories returned.");
         }
-        return this.post("/api/v1/memory/get", { user_id: this.uid(userId), memory_id: memoryId }).then((r) => asObj(r.memory));
+        return this.post("/api/v1/memory/get", { user_id: this.uid(userId), memory_id: memoryId.trim() }).then((r) => asObj(r.memory));
     }
-    listMemories(userId, opts = {}) {
+    async listMemories(userId, opts = {}) {
         const body = { user_id: this.uid(userId), limit: opts.limit ?? 100 };
         if (opts.cursor)
             body.cursor = opts.cursor;
@@ -444,22 +506,28 @@ export class Client {
             out.push(m);
         return out;
     }
-    getImage(userId, memoryId) {
-        if (!memoryId || typeof memoryId !== "string") {
+    async exportImages(userId, opts = {}) {
+        const out = [];
+        for await (const m of this.iterImages(userId, opts))
+            out.push(m);
+        return out;
+    }
+    async getImage(userId, memoryId) {
+        if (typeof memoryId !== "string" || !memoryId.trim()) {
             throw new Error("memoryId is required — the id that add/store or listImages returned.");
         }
-        return this.requestBytes("/api/v1/memory/image", { user_id: this.uid(userId), memory_id: memoryId });
+        return this.requestBytes("/api/v1/memory/image", { user_id: this.uid(userId), memory_id: memoryId.trim() });
     }
-    forgetImage(userId, memoryId, opts = {}) {
-        if (!memoryId || typeof memoryId !== "string") {
+    async forgetImage(userId, memoryId, opts = {}) {
+        if (typeof memoryId !== "string" || !memoryId.trim()) {
             throw new Error("memoryId is required — the id of the memory whose image you want removed.");
         }
-        const body = { user_id: this.uid(userId), memory_id: memoryId };
+        const body = { user_id: this.uid(userId), memory_id: memoryId.trim() };
         if (opts.preview)
             body.preview = true;
         return this.request("DELETE", "/api/v1/memory/image", body);
     }
-    listImages(userId, opts = {}) {
+    async listImages(userId, opts = {}) {
         const body = { user_id: this.uid(userId) };
         if (opts.limit !== undefined)
             body.limit = opts.limit;
@@ -489,7 +557,7 @@ export class Client {
         throw new Error(`stopped after ${MAX_PAGES} pages — the store did not end. This is a truncated ` +
             `answer, not the whole store.`);
     }
-    revisions(userId, opts = {}) {
+    async revisions(userId, opts = {}) {
         const body = {};
         if (opts.include !== undefined)
             body.include = opts.include;
@@ -502,13 +570,13 @@ export class Client {
         body.user_id = this.uid(userId);
         return this.post("/api/v1/won/revisions", body);
     }
-    lineage(userId, memoryId) {
-        if (!memoryId || typeof memoryId !== "string") {
+    async lineage(userId, memoryId) {
+        if (typeof memoryId !== "string" || !memoryId.trim()) {
             throw new Error("memoryId is required — the memory whose history you want.");
         }
-        return this.post("/api/v1/memory/lineage", { user_id: this.uid(userId), memory_id: memoryId });
+        return this.post("/api/v1/memory/lineage", { user_id: this.uid(userId), memory_id: memoryId.trim() });
     }
-    bySpeaker(speaker, userId, opts = {}) {
+    async bySpeaker(speaker, userId, opts = {}) {
         if (!speaker || typeof speaker !== "string" || speaker.trim() === "") {
             throw new Error('speaker is required — "me" for the assistant, or a person\'s name.');
         }
@@ -532,41 +600,42 @@ export class Client {
     async listEngrams() {
         const data = await this.request("GET", "/api/v1/engram");
         return {
+            ...data,
             engrams: asRecords(data.engrams),
             forms: asRecords(data.forms),
             note: typeof data.note === "string" ? data.note : undefined,
         };
     }
-    createStore(userId) {
+    async createStore(userId) {
         return this.post("/api/v1/memory/collection", { user_id: this.uid(userId) });
     }
     async listStores() {
         const r = await this.request("GET", "/api/v1/memory/collections");
         return asRecords(r.collections);
     }
-    deleteStore(userId) {
+    async deleteStore(userId) {
         if (typeof userId !== "string" || !userId.trim())
             throw new Error("userId is required (a non-blank string) — deleteStore never falls back to the default store.");
         warnIfStoreIdCollapses(userId);
         return this.request("DELETE", "/api/v1/memory/collection", { user_id: userId });
     }
-    addSpeaker(speaker, userId) {
+    async addSpeaker(speaker, userId) {
         return this.post("/api/v1/memory/speakers", { user_id: this.uid(userId), speaker });
     }
     async listSpeakers(userId) {
         const r = await this.request("GET", `/api/v1/memory/speakers?user_id=${encodeURIComponent(this.uid(userId))}`);
         return { ...r, speakers: asRecords(r?.speakers) };
     }
-    removeSpeaker(speaker, userId) {
+    async removeSpeaker(speaker, userId) {
         return this.request("DELETE", "/api/v1/memory/speakers", { user_id: this.uid(userId), speaker });
     }
-    delete(userId, memoryId) {
+    async delete(userId, memoryId) {
         if (typeof memoryId !== "string" || !memoryId.trim()) {
             throw new Error("memoryId is required (non-blank). To delete every memory in a store, call deleteAll(userId) explicitly.");
         }
         return this.post("/api/v1/memory/forget", { user_id: this.uid(userId), memory_id: memoryId.trim() });
     }
-    deleteAll(userId) {
+    async deleteAll(userId) {
         if (typeof userId !== "string" || !userId.trim())
             throw new Error("userId is required (a non-blank string) for deleteAll — anything else would wipe the default store.");
         warnIfStoreIdCollapses(userId);
@@ -701,7 +770,9 @@ export class Client {
                     if (e?.name === "AbortError" || att.signal.aborted) {
                         throw new APIConnectionError(0, this.abortMessage(att.why()));
                     }
-                    throw e;
+                    if (e instanceof WosError)
+                        throw e;
+                    throw new APIConnectionError(0, `network error: ${e?.message ?? e}`);
                 }
                 if (buf.byteLength === 0) {
                     throw new WosError(res.status, "empty image body — the service returned no bytes");
@@ -774,6 +845,14 @@ export class Client {
         const attempts = this.maxRetries + 1;
         const logPath = path.split("?")[0];
         const deadlineAt = this.deadlineAt();
+        let payload;
+        try {
+            payload = body === undefined ? undefined : JSON.stringify(body);
+        }
+        catch (e) {
+            throw new Error(`request body could not be serialized: ${e instanceof Error ? e.message : String(e)}. ` +
+                "Pass plain JSON values — an ORM entity, a BigInt or a circular reference cannot be sent.");
+        }
         for (let attempt = 0; attempt < attempts; attempt++) {
             const start = Date.now();
             const att = this.beginAttempt(deadlineAt);
@@ -782,7 +861,7 @@ export class Client {
                 res = await this.fetchImpl(`${this.base}${path}`, {
                     method,
                     headers: extraHeaders ? { ...this.headers, ...extraHeaders } : this.headers,
-                    body: body === undefined ? undefined : JSON.stringify(body),
+                    body: payload,
                     signal: att.signal,
                     redirect: "manual",
                 });
@@ -826,7 +905,14 @@ export class Client {
                 }
                 if (e instanceof WosError)
                     throw e;
-                throw new APIConnectionError(0, `network error: ${e?.message ?? e}`);
+                if (!(IDEMPOTENT_METHODS.has(method.toUpperCase()) && attempt + 1 < attempts)) {
+                    throw new APIConnectionError(0, `network error: ${e?.message ?? e}`);
+                }
+                att.clear();
+                const delay = this.backoffMs(attempt);
+                logDebug(`${method} ${logPath} — body dropped mid-stream, retrying in ${delay}ms (attempt ${attempt + 1}/${attempts})`);
+                await this.backoffSleep(delay, deadlineAt);
+                continue;
             }
             finally {
                 att.clear();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "wontopos",
-  "version": "2.2.37",
-  "description": "Wontopos — long-term memory for AI agents. Identical recall in every language, ~100× lower LLM bill.",
+  "version": "2.2.39",
+  "description": "Wontopos \u2014 long-term memory for AI agents. Identical recall in every language, ~100\u00d7 lower LLM bill.",
   "keywords": [
     "memory",
     "ai",
@@ -20,11 +20,17 @@
   "types": "./dist/wontopos.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/wontopos.d.ts",
-      "import": "./dist/wontopos.js",
-      "require": "./dist/cjs/wontopos.js",
+      "import": {
+        "types": "./dist/wontopos.d.ts",
+        "default": "./dist/wontopos.js"
+      },
+      "require": {
+        "types": "./dist/cjs/wontopos.d.cts",
+        "default": "./dist/cjs/wontopos.js"
+      },
       "default": "./dist/wontopos.js"
-    }
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist",
@@ -35,7 +41,7 @@
     "node": ">=18"
   },
   "scripts": {
-    "build": "tsc && tsc -p tsconfig.types.json && tsc -p tsconfig.cjs.json && node -e \"require('fs').writeFileSync('dist/cjs/package.json','{\\\"type\\\":\\\"commonjs\\\"}\\n')\"",
+    "build": "tsc && tsc -p tsconfig.types.json && tsc -p tsconfig.cjs.json && node -e \"const fs=require('fs');fs.writeFileSync('dist/cjs/package.json','{\\\"type\\\":\\\"commonjs\\\"}\\n');fs.copyFileSync('dist/wontopos.d.ts','dist/cjs/wontopos.d.cts')\"",
     "test": "npm run build && node --test tests/client.test.mjs tests/cjs.test.cjs",
     "prepublishOnly": "npm run build && node scripts/pre-publish.mjs"
   },
@@ -44,5 +50,9 @@
   },
   "bugs": {
     "url": "https://wontopos.com/contact?topic=bug"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wontopos/wontopos-node.git"
   }
 }