@agoric/store 0.9.3-dev-2da8e5c.0.2da8e5c → 0.9.3-dev-3294e0c.0.3294e0c

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/store",
-  "version": "0.9.3-dev-2da8e5c.0.2da8e5c",
+  "version": "0.9.3-dev-3294e0c.0.3294e0c",
   "description": "Wrapper for JavaScript map",
   "type": "module",
   "main": "src/index.js",
@@ -62,5 +62,5 @@
   "typeCoverage": {
     "atLeast": 89.98
   },
-  "gitHead": "2da8e5ce15f4ccc3b25a87ea32954aec37eae2cb"
+  "gitHead": "3294e0c1e81f8d145c6b57624d080908b935f524"
 }

package/src/legacy/legacyWeakMap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"legacyWeakMap.d.ts","sourceRoot":"","sources":["legacyWeakMap.js"],"names":[],"mappings":"AAcO,kCALgB,CAAC,SAAV,OAAQ,EACT,CAAC,QACH,MAAM,GACJ,cAAc,CAAC,EAAE,CAAC,CAAC,CAkC/B;mCA9CgC,aAAa"}
+{"version":3,"file":"legacyWeakMap.d.ts","sourceRoot":"","sources":["legacyWeakMap.js"],"names":[],"mappings":"AAcO,kCALgB,CAAC,SAAV,OAAQ,EACT,CAAC,QACH,MAAM,GACJ,cAAc,CAAC,EAAE,CAAC,CAAC,CA4C/B;mCAxDgC,aAAa"}

package/src/legacy/legacyWeakMap.js

@@ -13,7 +13,17 @@ import { Fail, q } from '@endo/errors';
  * @returns {LegacyWeakMap<K, V>}
  */
 export const makeLegacyWeakMap = (tag = 'key') => {
-  /** @type {WeakMap<K & object, V>} */
+  /**
+   * The keys are always objects, so back onto a `WeakMap` keyed by `K & object`
+   * while operating on the public key type `K` via this bivariant view.
+   *
+   * @type {{
+   *   has(key: any): boolean,
+   *   get(key: any): V | undefined,
+   *   set(key: any, value: V): unknown,
+   *   delete(key: any): boolean,
+   * }}
+   */
   const wm = new WeakMap();
   const assertKeyDoesNotExist = key =>
     !wm.has(key) || Fail`${q(tag)} already registered: ${key}`;

package/src/stores/scalarWeakMapStore.d.ts

@@ -1,5 +1,18 @@
-export function makeWeakMapStoreMethods<K extends Key, V extends Passable>(jsmap: WeakMap<K & object, V>, assertKVOkToAdd: (k: K, v: V) => void, assertKVOkToSet: (k: K, v: V) => void, assertKeyOkToDelete?: (k: K) => void, keyName?: string): WeakMapStore<K, V>;
+export function makeWeakMapStoreMethods<K extends Key, V extends Passable>(jsmap: WeakMapStoreBacking<V>, assertKVOkToAdd: (k: K, v: V) => void, assertKVOkToSet: (k: K, v: V) => void, assertKeyOkToDelete?: (k: K) => void, keyName?: string): WeakMapStore<K, V>;
 export function makeScalarWeakMapStore<K, V>(tag?: string, { longLived, keyShape, valueShape }?: StoreOptions): RemotableObject & WeakMapStore<K, V>;
+/**
+ * A minimal view of the backing collection keyed in terms of the public key
+ * type `K`. The scalar weak map only ever stores object (remotable) keys, so it
+ * backs onto a `WeakMap` keyed by `K & object`; the non-weak scalar map store
+ * reuses these methods over a `Map<K, V>`. The bivariant `any` key lets both
+ * satisfy this view while the methods operate on `K` internally.
+ */
+export type WeakMapStoreBacking<V extends Passable> = {
+    has(key: any): boolean;
+    get(key: any): V | undefined;
+    set(key: any, value: V): unknown;
+    delete(key: any): boolean;
+};
 import type { Key } from '@endo/patterns';
 import type { Passable } from '@endo/pass-style';
 import type { WeakMapStore } from '../types.js';

package/src/stores/scalarWeakMapStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scalarWeakMapStore.d.ts","sourceRoot":"","sources":["scalarWeakMapStore.js"],"names":[],"mappings":"AAyBO,wCATY,CAAC,SAAP,GAAK,EACM,CAAC,SAAZ,QAAU,SACZ,OAAO,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,CAAC,mBACtB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,IAAI,mBACpB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,IAAI,wBACpB,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,YACd,MAAM,GACJ,aAAa,CAAC,EAAE,CAAC,CAAC,CA8D9B;AAoBM,uCALM,CAAC,EAAC,CAAC,QACL,MAAM,wCACN,YAAY,GACV,eAAe,GAAG,aAAa,CAAC,EAAE,CAAC,CAAC,CA+ChD;yBA5IqB,gBAAgB;8BACM,kBAAkB;kCACjB,aAAa;kCAAb,aAAa;qCADd,kBAAkB"}
+{"version":3,"file":"scalarWeakMapStore.d.ts","sourceRoot":"","sources":["scalarWeakMapStore.js"],"names":[],"mappings":"AAyCO,wCATY,CAAC,SAAP,GAAK,EACM,CAAC,SAAZ,QAAU,SACZ,mBAAmB,CAAC,CAAC,CAAC,mBACtB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,IAAI,mBACpB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,IAAI,wBACpB,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,YACd,MAAM,GACJ,aAAa,CAAC,EAAE,CAAC,CAAC,CA8D9B;AAoBM,uCALM,CAAC,EAAC,CAAC,QACL,MAAM,wCACN,YAAY,GACV,eAAe,GAAG,aAAa,CAAC,EAAE,CAAC,CAAC,CA+ChD;;;;;;;;gCAhJuB,CAAC,SAAZ,QAAU,IACV;IACR,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC;IACvB,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,GAAG,SAAS,CAAC;IAC7B,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC;IACjC,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC;CAC3B;yBAlBkB,gBAAgB;8BACM,kBAAkB;kCACjB,aAAa;kCAAb,aAAa;qCADd,kBAAkB"}

package/src/stores/scalarWeakMapStore.js

@@ -13,10 +13,26 @@ import {
  * @import {WeakMapStore, StoreOptions} from '../types.js';
  */
 
+/**
+ * A minimal view of the backing collection keyed in terms of the public key
+ * type `K`. The scalar weak map only ever stores object (remotable) keys, so it
+ * backs onto a `WeakMap` keyed by `K & object`; the non-weak scalar map store
+ * reuses these methods over a `Map<K, V>`. The bivariant `any` key lets both
+ * satisfy this view while the methods operate on `K` internally.
+ *
+ * @template {Passable} V
+ * @typedef {{
+ *   has(key: any): boolean,
+ *   get(key: any): V | undefined,
+ *   set(key: any, value: V): unknown,
+ *   delete(key: any): boolean,
+ * }} WeakMapStoreBacking
+ */
+
 /**
  * @template {Key} K
  * @template {Passable} V
- * @param {WeakMap<K & object, V>} jsmap
+ * @param {WeakMapStoreBacking<V>} jsmap
  * @param {(k: K, v: V) => void} assertKVOkToAdd
  * @param {(k: K, v: V) => void} assertKVOkToSet
  * @param {(k: K) => void} [assertKeyOkToDelete]

package/src/stores/scalarWeakSetStore.d.ts

@@ -1,5 +1,17 @@
-export function makeWeakSetStoreMethods<K extends Key>(jsset: WeakSet<K & object>, assertKeyOkToAdd: (k: K) => void, assertKeyOkToDelete?: (k: K) => void, keyName?: string): WeakSetStoreMethods<K>;
+export function makeWeakSetStoreMethods<K extends Key>(jsset: WeakSetStoreBacking, assertKeyOkToAdd: (k: K) => void, assertKeyOkToDelete?: (k: K) => void, keyName?: string): WeakSetStoreMethods<K>;
 export function makeScalarWeakSetStore<K>(tag?: string, { longLived, keyShape }?: StoreOptions): WeakSetStore<K>;
+/**
+ * A minimal view of the backing collection keyed in terms of the public key
+ * type `K`. The scalar weak set only ever stores object (remotable) keys, so it
+ * backs onto a `WeakSet` keyed by `K & object`; the non-weak scalar set store
+ * reuses these methods over a `Set<K>`. The bivariant `any` key lets both
+ * satisfy this view while the methods operate on `K` internally.
+ */
+export type WeakSetStoreBacking = {
+    has(key: any): boolean;
+    add(key: any): unknown;
+    delete(key: any): boolean;
+};
 import type { Key } from '@endo/patterns';
 import type { WeakSetStoreMethods } from '@agoric/store';
 import type { StoreOptions } from '@agoric/store';

package/src/stores/scalarWeakSetStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scalarWeakSetStore.d.ts","sourceRoot":"","sources":["scalarWeakSetStore.js"],"names":[],"mappings":"AAsBO,wCAPY,CAAC,SAAP,GAAK,SACP,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,oBACnB,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,wBACd,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,YACd,MAAM,GACJ,oBAAoB,CAAC,CAAC,CA8ClC;AAmBM,uCALM,CAAC,QACH,MAAM,4BACN,YAAY,GACV,aAAa,CAAC,CAAC,CAyB3B;yBAlGqB,gBAAgB;yCAC4B,eAAe;kCAAf,eAAe;kCAAf,eAAe"}
+{"version":3,"file":"scalarWeakSetStore.d.ts","sourceRoot":"","sources":["scalarWeakSetStore.js"],"names":[],"mappings":"AAoCO,wCAPY,CAAC,SAAP,GAAK,SACP,mBAAmB,oBACnB,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,wBACd,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,YACd,MAAM,GACJ,oBAAoB,CAAC,CAAC,CA8ClC;AAmBM,uCALM,CAAC,QACH,MAAM,4BACN,YAAY,GACV,aAAa,CAAC,CAAC,CAyB3B;;;;;;;;kCArGY;IACR,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC;IACvB,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC;IACvB,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC;CAC3B;yBAfkB,gBAAgB;yCAC4B,eAAe;kCAAf,eAAe;kCAAf,eAAe"}

package/src/stores/scalarWeakSetStore.js

@@ -12,9 +12,23 @@ import {
  * @import {StoreOptions, WeakSetStore, WeakSetStoreMethods} from '@agoric/store';
  */
 
+/**
+ * A minimal view of the backing collection keyed in terms of the public key
+ * type `K`. The scalar weak set only ever stores object (remotable) keys, so it
+ * backs onto a `WeakSet` keyed by `K & object`; the non-weak scalar set store
+ * reuses these methods over a `Set<K>`. The bivariant `any` key lets both
+ * satisfy this view while the methods operate on `K` internally.
+ *
+ * @typedef {{
+ *   has(key: any): boolean,
+ *   add(key: any): unknown,
+ *   delete(key: any): boolean,
+ * }} WeakSetStoreBacking
+ */
+
 /**
  * @template {Key} K
- * @param {WeakSet<K & object>} jsset
+ * @param {WeakSetStoreBacking} jsset
  * @param {(k: K) => void} assertKeyOkToAdd
  * @param {(k: K) => void} [assertKeyOkToDelete]
  * @param {string} [keyName]