wontopos 2.2.39 → 2.2.40

package/README.md

@@ -209,7 +209,7 @@ data to fix it.
 ## Changelog
 
 The three clients release in lockstep — same version, same surface, same day. Patch
-releases are additive. Five inside 2.2 were not, deliberately and each with its
+releases are additive. Six inside 2.2 were not, deliberately and each with its
 reason; the changelog lists them.
 
 See [CHANGELOG.md](https://github.com/wontopos/wontopos-node/blob/main/CHANGELOG.md).

package/dist/cjs/wontopos.d.cts

@@ -74,10 +74,11 @@ export declare class PaymentRequiredError extends WosError {
 /** 403 — the key/model isn't allowed to do this. */
 export declare class PermissionDeniedError extends WosError {
 }
-/** 404 — the store or resource doesn't exist (create the store first). */
+/** 404 — the store or resource doesn't exist. */
 export declare class NotFoundError extends WosError {
 }
-/** 409 — a concurrent write to the same store. Retry. */
+/** 409 — another write to this store was in flight (nothing was stored; retry), or the
+ *  store id collides with an existing store's (permanent). */
 export declare class ConflictError extends WosError {
 }
 /** 429 — too many requests. Back off and retry (the client already retries these). */
@@ -159,6 +160,8 @@ export interface StatusResult {
 /**
  * An image attached to a memory, passed to `add`/`store` via `opts.image`.
  *
+ * Both edges must be 700px or more; a smaller image is refused (400).
+ *
  * What the service keeps is NOT your original. An image whose long edge is over
  * 1568px is downscaled to 1568 before anything else happens, and that smaller
  * picture is what gets stored, and handed back by `getImage`. Nothing on our side
@@ -291,8 +294,8 @@ export interface LineageResult {
 export interface SpeakerPage {
     speaker?: string;
     memories: Memory[];
-    /** How many underlying records a delete would actually remove, beyond what was returned. */
     chunks?: number;
+    /** The count to show before anyone confirms a delete of this speaker's memories. */
     points_to_delete?: number;
     returned?: number;
     has_more?: boolean;
@@ -307,20 +310,17 @@ export interface UpdateResult {
     status?: string;
     [key: string]: unknown;
 }
-/** `searchFull` → everything one search answered with, not just the merged memories.
- *
- *  `search` returns the memories and nothing else, which is the right answer for
- *  almost every call. Two options make it the wrong one: `max_images` asks for
- *  photos, which arrive in their own field, and `verify` is reported on by
- *  `verify_used`. Merging away both means paying for a
- *  search you shaped and never seeing what came of it. */
+/** `searchFull` → everything one search answered with. `search` returns every memory
+ *  as one array; this keeps the fields apart and adds `verify_used`, the report on
+ *  the `verify` option. */
 export interface SearchResult {
     /** What others said, and general memories. */
     memories: Memory[];
     /** The assistant's own words (speaker "me"); `[]` on a model that does not keep
      *  them apart. */
     self_memories: Memory[];
-    /** Image memories, when `max_images` asked for any; `[]` otherwise. */
+    /** Image memories the answer carried (one by default on an image-capable model,
+     *  up to `max_images`); `[]` when there were none. */
     images: Memory[];
     /** Re-ask passes actually performed. Present only when `verify` was sent; lower
      *  than you asked for means the store had nothing further to add. */
@@ -434,18 +434,21 @@ export interface EngramCatalog {
 }
 /** `createStore` / `deleteStore` → `{ user_id, status }`. */
 export interface StoreOpResult {
-    /** The store id the API actually used — NOT necessarily the one you sent.
-     *  Ids are normalized (see the `note`), so compare this against your input. */
+    /** The store id. `createStore` answers with the id as you sent it. */
     user_id?: string;
+    /** The normalized form the store is filed under, when it differs from `user_id`. */
+    canonical_id?: string;
     status?: string;
-    /** Present when the API changed your id, explaining how. Read it: two of your
-     *  end users can land in one store if their ids differ only by punctuation. */
+    /** Present when the API filed your id under a normalized form, explaining how. */
     note?: string;
     [key: string]: unknown;
 }
 export interface StoreInfo {
+    /** The id the store was created with — pass it back as `userId`. */
     user_id: string;
     created_at: string;
+    /** The normalized form the store is filed under, when it differs from `user_id`. */
+    canonical_id?: string;
     [key: string]: unknown;
 }
 /** `addSpeaker` / `removeSpeaker` → `{ user_id, speaker, status }`. */
@@ -535,11 +538,15 @@ export interface SearchOptions {
      * than answering with no images.
      */
     max_images?: number;
+    /** Delivery form, "memoir" or "archive" (Scroll 1.2+): how each memory's time is
+     *  rendered. The service refuses an unknown one (400). */
+    form?: string;
+    /** Your UTC offset in hours, for rendering times in `form`. */
+    tz?: number;
     /**
      * Fields the service accepts that this version does not know about, merged into the
-     * request as written. Every other key is refused, so a typo cannot reach the wire —
-     * `verfy: 3` used to be sent, dropped by the service, and answered normally, leaving
-     * a caller billed for one pass believing they had bought three.
+     * request as written. Every other key is refused, so a typo cannot reach the wire.
+     * The store, the query and the count always win over a copy in here.
      */
     extra?: Record<string, unknown>;
 }
@@ -708,18 +715,18 @@ export declare class Client {
      *  a call that passes no count is unaffected. Before 2.2.35 the count was sent on
      *  unchecked.
      *
-     *  `limit` bounds `memories`, not the returned array. On a model that keeps the
-     *  assistant's own words separate (Scroll 1.2+) those come back as well, so the
-     *  array can hold more than `limit`. They were retrieved and billed either way;
-     *  dropping them would only hide what you already paid for. Size a prompt window
-     *  on the array you get back, not on `limit`. `searchSelf()` hands the two back
-     *  apart. */
+     *  `limit` bounds `memories`, not the returned array. The assistant's own words
+     *  (Scroll 1.2+) and image memories (Tablet 2+, one unless `max_images` says
+     *  otherwise) come back in it as well, so it can hold more than `limit`. They are
+     *  billed either way. Size a prompt window on the array you get back, not on
+     *  `limit`. `searchFull()` hands the fields back apart. */
     search(query: string, userId?: string, limit?: number, opts?: SearchOptions): Promise<Memory[]>;
     /** Search a self-memory model (Scroll 1.2+): both fields from ONE call. Returns
      * `{ memories, self_memories }` — `memories` is what others said and general
      * memories, `self_memories` is the assistant's OWN words (stored with speaker
      * "me"), kept apart so whoever reads them never confuses who said what. On a model
-     * that does not keep them apart, `self_memories` is `[]`. `userId` may be omitted. */
+     * that does not keep them apart, `self_memories` is `[]`. Image memories are not
+     * included; `search` and `searchFull` carry them. `userId` may be omitted. */
     searchSelf(query: string, userId?: string, limit?: number, opts?: SearchOptions): Promise<SelfSearchResult>;
     /**
      * Search, and keep every field the answer came with.
@@ -729,7 +736,7 @@ export declare class Client {
      *
      *     const r = await mem.searchFull("the day we moved", "alice", 10,
      *                                    { max_images: 3, verify: 2 });
-     *     r.images.length;   // the photos, which `search` drops
+     *     r.images.length;   // the photos, apart from the text memories
      *     r.verify_used;     // how many re-ask passes actually ran (you are billed per pass)
      *
      * Both options need Tablet 2 or newer and are refused (403) on an older engine
@@ -943,9 +950,8 @@ export declare class Client {
      * assistant's own words, otherwise a person's name. Same cursor paging as
      * `listImages`.
      *
-     * `chunks` / `points_to_delete` report how many internal records a delete would
-     * actually remove — usually more than `returned`, and worth showing to whoever is
-     * about to confirm one.
+     * `points_to_delete` is the count to show before anyone confirms a delete of this
+     * speaker's memories.
      */
     bySpeaker(speaker: string, userId?: string, opts?: {
         limit?: number;
@@ -975,7 +981,8 @@ export declare class Client {
      * return 404. Idempotent. Every account starts with a `default` store.
      * Returns `{ user_id, status }` (`status` is `"created"` or `"exists"`). */
     createStore(userId?: string): Promise<StoreOpResult>;
-    /** List your stores: `[{ user_id, created_at }, ...]` (`default` first). */
+    /** List your stores: `[{ user_id, created_at, canonical_id? }, ...]` (`default`
+     *  first). Each `user_id` is the id the store was created with. */
     listStores(): Promise<StoreInfo[]>;
     /** Delete a store and ALL its memories. Returns `{ user_id, status }`. */
     deleteStore(userId: string): Promise<StoreOpResult>;

package/dist/cjs/wontopos.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WME = exports.Client = exports.ServerError = exports.RateLimitError = exports.ConflictError = exports.NotFoundError = exports.PermissionDeniedError = exports.PaymentRequiredError = exports.AuthenticationError = exports.BadRequestError = exports.APIConnectionError = exports.WosError = exports.CONTEXT_LIMIT_MAX = exports.CONTEXT_LIMIT_MIN = exports.SEARCH_LIMIT_MAX = exports.SEARCH_LIMIT_MIN = void 0;
 exports._resetStoreIdWarnings = _resetStoreIdWarnings;
 exports._resetFilterWarnings = _resetFilterWarnings;
-const VERSION = "2.2.39";
+const VERSION = "2.2.40";
 const RUNTIME = (() => {
     const p = globalThis?.process;
     return p?.version ? ` (node/${p.version}; ${p.platform}-${p.arch})` : "";
@@ -40,8 +40,9 @@ const warnedStoreIds = new Set();
 function warnIfStoreIdCollapses(id) {
     if (!id || warnedStoreIds.has(id))
         return;
+    const valid = STORE_ID_FORMAT.test(id);
     const normalized = normalizeStoreId(id);
-    if (normalized === id)
+    if (valid && normalized === id)
         return;
     warnedStoreIds.add(id);
     while (warnedStoreIds.size > WARNED_STORE_IDS_MAX) {
@@ -50,10 +51,27 @@ function warnIfStoreIdCollapses(id) {
             break;
         warnedStoreIds.delete(oldest);
     }
-    console.warn(`wontopos: store id ${JSON.stringify(id)} is stored as ${JSON.stringify(normalized)} ` +
-        `(lowercased, and anything outside [a-z0-9_] becomes "_"). Ids that differ only by case or ` +
-        `punctuation share ONE store and therefore one set of memories — if these ids come from your ` +
-        `end users, normalize them yourself first so two people can never collide.`);
+    if (!valid) {
+        console.warn(`wontopos: store id ${JSON.stringify(id)} is not a valid store id: use 1-64 ASCII letters, ` +
+            `digits, ".", "_" and "-", starting with a letter or digit. Creating it is refused (400).`);
+        return;
+    }
+    console.warn(`wontopos: store id ${JSON.stringify(id)} normalizes to ${JSON.stringify(normalized)}. ` +
+        `Ids that differ only by case name this same store; one that differs only by punctuation ` +
+        `cannot be created beside it (409) and is not found when used (404). If these ids come from ` +
+        `your end users, normalize them yourself first so two people never compete for one name.`);
+}
+const STORE_ID_FORMAT = /^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$/;
+const NOT_METADATA = new Set(["userid", "storeid", "idempotencykey"]);
+function checkMetadataKeys(metadata) {
+    if (metadata == null || typeof metadata !== "object")
+        return;
+    for (const k of Object.keys(metadata)) {
+        if (NOT_METADATA.has(k.toLowerCase().replace(/[\s_.-]/g, ""))) {
+            throw new Error(`${JSON.stringify(k)} is not a metadata field: pass the store as userId and an ` +
+                `idempotency key as opts.idempotencyKey. Nothing was sent.`);
+        }
+    }
 }
 function _resetStoreIdWarnings() {
     warnedStoreIds.clear();
@@ -141,13 +159,24 @@ function parseRateLimit(h) {
 const asList = (x) => (Array.isArray(x) ? x : []);
 const asObj = (x) => (x != null && typeof x === "object" && !Array.isArray(x) ? x : {});
 const asRecords = (x) => asList(x).filter((m) => m != null && typeof m === "object" && !Array.isArray(m));
+const memoryFromGet = (r) => {
+    const o = asObj(r);
+    if (o.memory != null && typeof o.memory === "object" && !Array.isArray(o.memory))
+        return o.memory;
+    return typeof o.id === "string" ? o : {};
+};
 function mergeResults(r) {
-    const main = asRecords(r?.memories);
-    const mine = asRecords(r?.self_memories);
-    if (mine.length === 0)
-        return main;
-    const seen = new Set(main.map((m) => m.id).filter((id) => typeof id === "string"));
-    return main.concat(mine.filter((m) => !(typeof m.id === "string" && seen.has(m.id))));
+    const out = asRecords(r?.memories);
+    const seen = new Set(out.map((m) => m.id).filter((id) => typeof id === "string"));
+    for (const m of [...asRecords(r?.self_memories), ...asRecords(r?.images)]) {
+        if (typeof m.id === "string") {
+            if (seen.has(m.id))
+                continue;
+            seen.add(m.id);
+        }
+        out.push(m);
+    }
+    return out;
 }
 function withForm(body, form, tz) {
     if (form !== undefined)
@@ -219,7 +248,7 @@ const KNOWN_FILTER_KEYS = new Set([
 ]);
 const warnedFilterKeys = new Set();
 const KNOWN_SEARCH_KEYS = new Set([
-    "cache_control", "speaker", "filters", "verify", "max_images", "extra",
+    "cache_control", "speaker", "filters", "verify", "max_images", "form", "tz", "extra",
 ]);
 const RESERVED_SEARCH_KEYS = new Set(["user_id", "query", "max_results"]);
 const KNOWN_RECALL_KEYS = new Set(["form", "tz", "limit", "context_limit"]);
@@ -408,6 +437,7 @@ class Client {
         return this.clone({ maxRetries });
     }
     async add(content, userId, metadata = {}, opts = {}) {
+        checkMetadataKeys(metadata);
         const body = { user_id: this.uid(userId), content, metadata };
         if (opts.image !== undefined)
             body.image = normalizeImage(opts.image);
@@ -491,7 +521,7 @@ class Client {
         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.trim() }).then((r) => asObj(r.memory));
+        return this.post("/api/v1/memory/get", { user_id: this.uid(userId), memory_id: memoryId.trim() }).then(memoryFromGet);
     }
     async listMemories(userId, opts = {}) {
         const body = { user_id: this.uid(userId), limit: opts.limit ?? 100 };

package/dist/wontopos.d.ts

@@ -74,10 +74,11 @@ export declare class PaymentRequiredError extends WosError {
 /** 403 — the key/model isn't allowed to do this. */
 export declare class PermissionDeniedError extends WosError {
 }
-/** 404 — the store or resource doesn't exist (create the store first). */
+/** 404 — the store or resource doesn't exist. */
 export declare class NotFoundError extends WosError {
 }
-/** 409 — a concurrent write to the same store. Retry. */
+/** 409 — another write to this store was in flight (nothing was stored; retry), or the
+ *  store id collides with an existing store's (permanent). */
 export declare class ConflictError extends WosError {
 }
 /** 429 — too many requests. Back off and retry (the client already retries these). */
@@ -159,6 +160,8 @@ export interface StatusResult {
 /**
  * An image attached to a memory, passed to `add`/`store` via `opts.image`.
  *
+ * Both edges must be 700px or more; a smaller image is refused (400).
+ *
  * What the service keeps is NOT your original. An image whose long edge is over
  * 1568px is downscaled to 1568 before anything else happens, and that smaller
  * picture is what gets stored, and handed back by `getImage`. Nothing on our side
@@ -291,8 +294,8 @@ export interface LineageResult {
 export interface SpeakerPage {
     speaker?: string;
     memories: Memory[];
-    /** How many underlying records a delete would actually remove, beyond what was returned. */
     chunks?: number;
+    /** The count to show before anyone confirms a delete of this speaker's memories. */
     points_to_delete?: number;
     returned?: number;
     has_more?: boolean;
@@ -307,20 +310,17 @@ export interface UpdateResult {
     status?: string;
     [key: string]: unknown;
 }
-/** `searchFull` → everything one search answered with, not just the merged memories.
- *
- *  `search` returns the memories and nothing else, which is the right answer for
- *  almost every call. Two options make it the wrong one: `max_images` asks for
- *  photos, which arrive in their own field, and `verify` is reported on by
- *  `verify_used`. Merging away both means paying for a
- *  search you shaped and never seeing what came of it. */
+/** `searchFull` → everything one search answered with. `search` returns every memory
+ *  as one array; this keeps the fields apart and adds `verify_used`, the report on
+ *  the `verify` option. */
 export interface SearchResult {
     /** What others said, and general memories. */
     memories: Memory[];
     /** The assistant's own words (speaker "me"); `[]` on a model that does not keep
      *  them apart. */
     self_memories: Memory[];
-    /** Image memories, when `max_images` asked for any; `[]` otherwise. */
+    /** Image memories the answer carried (one by default on an image-capable model,
+     *  up to `max_images`); `[]` when there were none. */
     images: Memory[];
     /** Re-ask passes actually performed. Present only when `verify` was sent; lower
      *  than you asked for means the store had nothing further to add. */
@@ -434,18 +434,21 @@ export interface EngramCatalog {
 }
 /** `createStore` / `deleteStore` → `{ user_id, status }`. */
 export interface StoreOpResult {
-    /** The store id the API actually used — NOT necessarily the one you sent.
-     *  Ids are normalized (see the `note`), so compare this against your input. */
+    /** The store id. `createStore` answers with the id as you sent it. */
     user_id?: string;
+    /** The normalized form the store is filed under, when it differs from `user_id`. */
+    canonical_id?: string;
     status?: string;
-    /** Present when the API changed your id, explaining how. Read it: two of your
-     *  end users can land in one store if their ids differ only by punctuation. */
+    /** Present when the API filed your id under a normalized form, explaining how. */
     note?: string;
     [key: string]: unknown;
 }
 export interface StoreInfo {
+    /** The id the store was created with — pass it back as `userId`. */
     user_id: string;
     created_at: string;
+    /** The normalized form the store is filed under, when it differs from `user_id`. */
+    canonical_id?: string;
     [key: string]: unknown;
 }
 /** `addSpeaker` / `removeSpeaker` → `{ user_id, speaker, status }`. */
@@ -535,11 +538,15 @@ export interface SearchOptions {
      * than answering with no images.
      */
     max_images?: number;
+    /** Delivery form, "memoir" or "archive" (Scroll 1.2+): how each memory's time is
+     *  rendered. The service refuses an unknown one (400). */
+    form?: string;
+    /** Your UTC offset in hours, for rendering times in `form`. */
+    tz?: number;
     /**
      * Fields the service accepts that this version does not know about, merged into the
-     * request as written. Every other key is refused, so a typo cannot reach the wire —
-     * `verfy: 3` used to be sent, dropped by the service, and answered normally, leaving
-     * a caller billed for one pass believing they had bought three.
+     * request as written. Every other key is refused, so a typo cannot reach the wire.
+     * The store, the query and the count always win over a copy in here.
      */
     extra?: Record<string, unknown>;
 }
@@ -708,18 +715,18 @@ export declare class Client {
      *  a call that passes no count is unaffected. Before 2.2.35 the count was sent on
      *  unchecked.
      *
-     *  `limit` bounds `memories`, not the returned array. On a model that keeps the
-     *  assistant's own words separate (Scroll 1.2+) those come back as well, so the
-     *  array can hold more than `limit`. They were retrieved and billed either way;
-     *  dropping them would only hide what you already paid for. Size a prompt window
-     *  on the array you get back, not on `limit`. `searchSelf()` hands the two back
-     *  apart. */
+     *  `limit` bounds `memories`, not the returned array. The assistant's own words
+     *  (Scroll 1.2+) and image memories (Tablet 2+, one unless `max_images` says
+     *  otherwise) come back in it as well, so it can hold more than `limit`. They are
+     *  billed either way. Size a prompt window on the array you get back, not on
+     *  `limit`. `searchFull()` hands the fields back apart. */
     search(query: string, userId?: string, limit?: number, opts?: SearchOptions): Promise<Memory[]>;
     /** Search a self-memory model (Scroll 1.2+): both fields from ONE call. Returns
      * `{ memories, self_memories }` — `memories` is what others said and general
      * memories, `self_memories` is the assistant's OWN words (stored with speaker
      * "me"), kept apart so whoever reads them never confuses who said what. On a model
-     * that does not keep them apart, `self_memories` is `[]`. `userId` may be omitted. */
+     * that does not keep them apart, `self_memories` is `[]`. Image memories are not
+     * included; `search` and `searchFull` carry them. `userId` may be omitted. */
     searchSelf(query: string, userId?: string, limit?: number, opts?: SearchOptions): Promise<SelfSearchResult>;
     /**
      * Search, and keep every field the answer came with.
@@ -729,7 +736,7 @@ export declare class Client {
      *
      *     const r = await mem.searchFull("the day we moved", "alice", 10,
      *                                    { max_images: 3, verify: 2 });
-     *     r.images.length;   // the photos, which `search` drops
+     *     r.images.length;   // the photos, apart from the text memories
      *     r.verify_used;     // how many re-ask passes actually ran (you are billed per pass)
      *
      * Both options need Tablet 2 or newer and are refused (403) on an older engine
@@ -943,9 +950,8 @@ export declare class Client {
      * assistant's own words, otherwise a person's name. Same cursor paging as
      * `listImages`.
      *
-     * `chunks` / `points_to_delete` report how many internal records a delete would
-     * actually remove — usually more than `returned`, and worth showing to whoever is
-     * about to confirm one.
+     * `points_to_delete` is the count to show before anyone confirms a delete of this
+     * speaker's memories.
      */
     bySpeaker(speaker: string, userId?: string, opts?: {
         limit?: number;
@@ -975,7 +981,8 @@ export declare class Client {
      * return 404. Idempotent. Every account starts with a `default` store.
      * Returns `{ user_id, status }` (`status` is `"created"` or `"exists"`). */
     createStore(userId?: string): Promise<StoreOpResult>;
-    /** List your stores: `[{ user_id, created_at }, ...]` (`default` first). */
+    /** List your stores: `[{ user_id, created_at, canonical_id? }, ...]` (`default`
+     *  first). Each `user_id` is the id the store was created with. */
     listStores(): Promise<StoreInfo[]>;
     /** Delete a store and ALL its memories. Returns `{ user_id, status }`. */
     deleteStore(userId: string): Promise<StoreOpResult>;

package/dist/wontopos.js

@@ -1,4 +1,4 @@
-const VERSION = "2.2.39";
+const VERSION = "2.2.40";
 const RUNTIME = (() => {
     const p = globalThis?.process;
     return p?.version ? ` (node/${p.version}; ${p.platform}-${p.arch})` : "";
@@ -35,8 +35,9 @@ const warnedStoreIds = new Set();
 function warnIfStoreIdCollapses(id) {
     if (!id || warnedStoreIds.has(id))
         return;
+    const valid = STORE_ID_FORMAT.test(id);
     const normalized = normalizeStoreId(id);
-    if (normalized === id)
+    if (valid && normalized === id)
         return;
     warnedStoreIds.add(id);
     while (warnedStoreIds.size > WARNED_STORE_IDS_MAX) {
@@ -45,10 +46,27 @@ function warnIfStoreIdCollapses(id) {
             break;
         warnedStoreIds.delete(oldest);
     }
-    console.warn(`wontopos: store id ${JSON.stringify(id)} is stored as ${JSON.stringify(normalized)} ` +
-        `(lowercased, and anything outside [a-z0-9_] becomes "_"). Ids that differ only by case or ` +
-        `punctuation share ONE store and therefore one set of memories — if these ids come from your ` +
-        `end users, normalize them yourself first so two people can never collide.`);
+    if (!valid) {
+        console.warn(`wontopos: store id ${JSON.stringify(id)} is not a valid store id: use 1-64 ASCII letters, ` +
+            `digits, ".", "_" and "-", starting with a letter or digit. Creating it is refused (400).`);
+        return;
+    }
+    console.warn(`wontopos: store id ${JSON.stringify(id)} normalizes to ${JSON.stringify(normalized)}. ` +
+        `Ids that differ only by case name this same store; one that differs only by punctuation ` +
+        `cannot be created beside it (409) and is not found when used (404). If these ids come from ` +
+        `your end users, normalize them yourself first so two people never compete for one name.`);
+}
+const STORE_ID_FORMAT = /^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$/;
+const NOT_METADATA = new Set(["userid", "storeid", "idempotencykey"]);
+function checkMetadataKeys(metadata) {
+    if (metadata == null || typeof metadata !== "object")
+        return;
+    for (const k of Object.keys(metadata)) {
+        if (NOT_METADATA.has(k.toLowerCase().replace(/[\s_.-]/g, ""))) {
+            throw new Error(`${JSON.stringify(k)} is not a metadata field: pass the store as userId and an ` +
+                `idempotency key as opts.idempotencyKey. Nothing was sent.`);
+        }
+    }
 }
 export function _resetStoreIdWarnings() {
     warnedStoreIds.clear();
@@ -136,13 +154,24 @@ function parseRateLimit(h) {
 const asList = (x) => (Array.isArray(x) ? x : []);
 const asObj = (x) => (x != null && typeof x === "object" && !Array.isArray(x) ? x : {});
 const asRecords = (x) => asList(x).filter((m) => m != null && typeof m === "object" && !Array.isArray(m));
+const memoryFromGet = (r) => {
+    const o = asObj(r);
+    if (o.memory != null && typeof o.memory === "object" && !Array.isArray(o.memory))
+        return o.memory;
+    return typeof o.id === "string" ? o : {};
+};
 function mergeResults(r) {
-    const main = asRecords(r?.memories);
-    const mine = asRecords(r?.self_memories);
-    if (mine.length === 0)
-        return main;
-    const seen = new Set(main.map((m) => m.id).filter((id) => typeof id === "string"));
-    return main.concat(mine.filter((m) => !(typeof m.id === "string" && seen.has(m.id))));
+    const out = asRecords(r?.memories);
+    const seen = new Set(out.map((m) => m.id).filter((id) => typeof id === "string"));
+    for (const m of [...asRecords(r?.self_memories), ...asRecords(r?.images)]) {
+        if (typeof m.id === "string") {
+            if (seen.has(m.id))
+                continue;
+            seen.add(m.id);
+        }
+        out.push(m);
+    }
+    return out;
 }
 function withForm(body, form, tz) {
     if (form !== undefined)
@@ -204,7 +233,7 @@ const KNOWN_FILTER_KEYS = new Set([
 ]);
 const warnedFilterKeys = new Set();
 const KNOWN_SEARCH_KEYS = new Set([
-    "cache_control", "speaker", "filters", "verify", "max_images", "extra",
+    "cache_control", "speaker", "filters", "verify", "max_images", "form", "tz", "extra",
 ]);
 const RESERVED_SEARCH_KEYS = new Set(["user_id", "query", "max_results"]);
 const KNOWN_RECALL_KEYS = new Set(["form", "tz", "limit", "context_limit"]);
@@ -393,6 +422,7 @@ export class Client {
         return this.clone({ maxRetries });
     }
     async add(content, userId, metadata = {}, opts = {}) {
+        checkMetadataKeys(metadata);
         const body = { user_id: this.uid(userId), content, metadata };
         if (opts.image !== undefined)
             body.image = normalizeImage(opts.image);
@@ -476,7 +506,7 @@ export class Client {
         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.trim() }).then((r) => asObj(r.memory));
+        return this.post("/api/v1/memory/get", { user_id: this.uid(userId), memory_id: memoryId.trim() }).then(memoryFromGet);
     }
     async listMemories(userId, opts = {}) {
         const body = { user_id: this.uid(userId), limit: opts.limit ?? 100 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wontopos",
-  "version": "2.2.39",
+  "version": "2.2.40",
   "description": "Wontopos \u2014 long-term memory for AI agents. Identical recall in every language, ~100\u00d7 lower LLM bill.",
   "keywords": [
     "memory",