@agoric/store 0.9.3-dev-727e4af.0 → 0.9.3-dev-96c9ff5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/store",
-  "version": "0.9.3-dev-727e4af.0+727e4af",
+  "version": "0.9.3-dev-96c9ff5.0+96c9ff5",
   "description": "Wrapper for JavaScript map",
   "type": "module",
   "main": "src/index.js",
@@ -30,14 +30,14 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@endo/exo": "^1.4.0",
-    "@endo/marshal": "^1.4.1",
-    "@endo/pass-style": "^1.3.1",
-    "@endo/patterns": "^1.3.1"
+    "@endo/exo": "^1.5.0",
+    "@endo/marshal": "^1.5.0",
+    "@endo/pass-style": "^1.4.0",
+    "@endo/patterns": "^1.4.0"
   },
   "devDependencies": {
-    "@endo/init": "^1.1.1",
-    "@endo/ses-ava": "^1.2.1",
+    "@endo/init": "^1.1.2",
+    "@endo/ses-ava": "^1.2.2",
     "ava": "^5.3.0"
   },
   "files": [
@@ -58,7 +58,7 @@
     "timeout": "2m"
   },
   "typeCoverage": {
-    "atLeast": 86.34
+    "atLeast": 89.45
   },
-  "gitHead": "727e4af514a8e92f400dd1671a788c5d3cbe1b8a"
+  "gitHead": "96c9ff577fe14cebeb5a38543ba7f8598ffcd0c7"
 }

package/src/stores/scalarMapStore.js

@@ -18,7 +18,7 @@ import { makeCurrentKeysKit } from './store-utils.js';
 /**
  * @import {Passable} from '@endo/pass-style');
  * @import {Key, Pattern} from '@endo/patterns');
- * @import {MapStore, StoreOptions} from '../types.js';
+ * @import {MapStore, MapStoreMethods, StoreOptions} from '../types.js';
  */
 
 const { quote: q } = assert;
@@ -31,7 +31,7 @@ const { quote: q } = assert;
  * @param {(k: K, v: V) => void} assertKVOkToSet
  * @param {(k: K) => void} [assertKeyOkToDelete]
  * @param {string} [tag]
- * @returns {MapStore<K, V>}
+ * @returns {MapStoreMethods<K, V>}
  */
 export const makeMapStoreMethods = (
   jsmap,
@@ -133,11 +133,9 @@ export const makeMapStoreMethods = (
  * or remotables. Other storeMaps will accept, for example, copyArrays and
  * copyRecords, as keys and look them up based on equality of their contents.
  *
- * @template {Key} K
- * @template {Passable} V
  * @param {string} [tag] - the column name for the key
  * @param {StoreOptions} [options]
- * @returns {MapStore<K, V>}
+ * @returns {MapStore<any, any>}
  */
 export const makeScalarMapStore = (
   tag = 'key',

package/src/stores/scalarSetStore.js

@@ -12,18 +12,18 @@ import { makeCurrentKeysKit } from './store-utils.js';
 
 /**
  * @import {Key, Pattern} from '@endo/patterns');
- * @import {SetStore, StoreOptions} from '../types.js';
+ * @import {SetStore, SetStoreMethods, StoreOptions} from '../types.js';
  */
 
 const { quote: q } = assert;
 
 /**
- * @template K
+ * @template {Key} K
  * @param {Set<K>} jsset
  * @param {(k: K) => void} assertKeyOkToAdd
  * @param {(k: K) => void} [assertKeyOkToDelete]
  * @param {string} [keyName]
- * @returns {SetStore<K>}
+ * @returns {SetStoreMethods<K>}
  */
 export const makeSetStoreMethods = (
   jsset,

package/src/stores/scalarWeakMapStore.js

@@ -6,12 +6,17 @@ import {
   isCopyMap,
 } from '@endo/patterns';
 
-/** @import {WeakMapStore, StoreOptions} from '../types.js'; */
+/**
+ * @import {Key} from '@endo/patterns';
+ * @import {Passable, RemotableObject} from '@endo/pass-style';
+ * @import {WeakMapStore, StoreOptions} from '../types.js';
+ */
 
 const { quote: q, Fail } = assert;
 
 /**
- * @template K,V
+ * @template {Key} K
+ * @template {Passable} V
  * @param {WeakMap<K & object, V>} jsmap
  * @param {(k: K, v: V) => void} assertKVOkToAdd
  * @param {(k: K, v: V) => void} assertKVOkToSet
@@ -66,6 +71,7 @@ export const makeWeakMapStoreMethods = (
     addAll: entries => {
       if (typeof entries[Symbol.iterator] !== 'function') {
         if (Object.isFrozen(entries) && isCopyMap(entries)) {
+          // @ts-expect-error XXX
           entries = getCopyMapEntries(entries);
         } else {
           Fail`provided data source is not iterable: ${entries}`;
@@ -96,7 +102,7 @@ export const makeWeakMapStoreMethods = (
  * @template K,V
  * @param {string} [tag] - tag for debugging
  * @param {StoreOptions} [options]
- * @returns {WeakMapStore<K, V>}
+ * @returns {RemotableObject & WeakMapStore<K, V>}
  */
 export const makeScalarWeakMapStore = (
   tag = 'key',

package/src/stores/scalarWeakSetStore.js

@@ -8,15 +8,18 @@ import {
 
 const { quote: q, Fail } = assert;
 
-/** @import {StoreOptions, WeakSetStore} from '@agoric/store'; */
+/**
+ * @import {Key} from '@endo/patterns';
+ * @import {StoreOptions, WeakSetStore, WeakSetStoreMethods} from '@agoric/store';
+ */
 
 /**
- * @template K
+ * @template {Key} K
  * @param {WeakSet<K & object>} jsset
  * @param {(k: K) => void} assertKeyOkToAdd
  * @param {(k: K) => void} [assertKeyOkToDelete]
  * @param {string} [keyName]
- * @returns {WeakSetStore<K>}
+ * @returns {WeakSetStoreMethods<K>}
  */
 export const makeWeakSetStoreMethods = (
   jsset,
@@ -50,6 +53,7 @@ export const makeWeakSetStoreMethods = (
     addAll: keys => {
       if (typeof keys[Symbol.iterator] !== 'function') {
         if (Object.isFrozen(keys) && isCopySet(keys)) {
+          // @ts-expect-error XXX
           keys = getCopySetKeys(keys);
         } else {
           Fail`provided data source is not iterable: ${keys}`;

package/src/stores/store-utils.js

@@ -1,14 +1,42 @@
 import { Far } from '@endo/marshal';
+import { M, matches } from '@endo/patterns';
 
 /**
  * @import {RankCompare} from '@endo/marshal';
  * @import {MapStore, WeakMapStore} from '../types.js';
+ * @import {Passable} from '@endo/pass-style';
+ * @import {Key} from '@endo/patterns';
  */
 
 const { Fail, quote: q } = assert;
 
+// TODO: Undate `@endo/patterns` to export the original, and delete the
+// reimplementation here.
 /**
- * @template K,V
+ * Should behave identically to the one in `@endo/patterns`, but reimplemented
+ * for now because `@endo/patterns` forgot to export this one. This one is
+ * simple enough that I prefer a reimplementation to a deep import.
+ *
+ * @param {unknown} s
+ * @returns {s is CopySet}
+ */
+export const isCopySet = s => matches(s, M.set());
+
+// TODO: Undate `@endo/patterns` to export the original, and delete the
+// reimplementation here.
+/**
+ * Should behave identically to the one in `@endo/patterns`, but reimplemented
+ * for now because `@endo/patterns` forgot to export this one. This one is
+ * simple enough that I prefer a reimplementation to a deep import.
+ *
+ * @param {unknown} m
+ * @returns {m is CopyMap}
+ */
+export const isCopyMap = m => matches(m, M.map());
+
+/**
+ * @template {Key} K
+ * @template {Passable} V
  * @typedef {object} CurrentKeysKit
  * @property {(k: K, v?: V) => void} assertUpdateOnAdd
  * @property {(k: K) => void} assertUpdateOnDelete
@@ -16,7 +44,8 @@ const { Fail, quote: q } = assert;
  */
 
 /**
- * @template K,V
+ * @template {Key} K
+ * @template {Passable} V
  * @param {() => Iterable<K>} getRawKeys
  * @param {(k: K) => boolean} checkHas
  * @param {RankCompare} compare
@@ -91,7 +120,8 @@ harden(makeCurrentKeysKit);
  * already is one, return that. Otherwise, call `makeValue(key)`, remember it as
  * the value for that key, and return it.
  *
- * @template K,V
+ * @template {Key} K
+ * @template {Passable} V
  * @param {WeakMapStore<K, V>} mapStore
  * @param {K} key
  * @param {(key: K) => V} makeValue
@@ -116,8 +146,8 @@ harden(provideLazy);
  * termination to happen after the make completes and before it reaches durable
  * storage.
  *
- * @template K
- * @template V
+ * @template {Key} K
+ * @template {Passable} V
  * @param {WeakMapStore<K, V>} store
  */
 export const makeAtomicProvider = store => {
@@ -167,13 +197,14 @@ export const makeAtomicProvider = store => {
 };
 harden(makeAtomicProvider);
 /**
- * @template K
- * @template V
+ * @template {Key} K
+ * @template {Passable} V
  * @typedef {ReturnType<typeof makeAtomicProvider<K, V>>} AtomicProvider<K, V>
  */
 
 /**
- * @template K, V
+ * @template {Key} K
+ * @template {Passable} V
  * @param {MapStore<K, V[]>} mapStore
  * @param {K} key
  * @param {V} item

package/src/types.js

@@ -6,7 +6,7 @@ export {};
 /**
  * Note TODO https://github.com/endojs/endo/issues/1488
  *
- * @import {Passable} from '@endo/pass-style'
+ * @import {Passable, RemotableObject} from '@endo/pass-style'
  * @import {CopySet, CopyMap, Pattern} from '@endo/patterns'
  * @import {Key} from '@endo/patterns'
  */
@@ -49,9 +49,10 @@ export {};
  * WeakStores, but with the additional query and query-update methods.
  */
 
+// TODO use Key for K
 /**
- * @template {Key & object} [K=Key]
- * @typedef {object} WeakSetStore
+ * @template K
+ * @typedef {object} WeakSetStoreMethods
  * @property {(key: K) => boolean} has Check if a key exists. The key can be any
  *   JavaScript value, though the answer will always be false for keys that
  *   cannot be found in this store.
@@ -60,12 +61,17 @@ export {};
  *   this store. For example a scalar store only allows primitives and
  *   remotables.
  * @property {(key: K) => void} delete Remove the key. Throws if not found.
- * @property {(keys: CopySet<K> | Iterable<K>) => void} addAll
+ * @property {(keys: CopySet<any> | Iterable<K>) => void} addAll
+ */
+/**
+ * @template K
+ * @typedef {RemotableObject & WeakSetStoreMethods<K>} WeakSetStore
  */
 
+// TODO use Key for K
 /**
- * @template {Key} [K=Key]
- * @typedef {object} SetStore
+ * @template K
+ * @typedef {object} SetStoreMethods
  * @property {(key: K) => boolean} has Check if a key exists. The key can be any
  *   JavaScript value, though the answer will always be false for keys that
  *   cannot be found in this store.
@@ -74,17 +80,23 @@ export {};
  *   this store. For example a scalar store only allows primitives and
  *   remotables.
  * @property {(key: K) => void} delete Remove the key. Throws if not found.
- * @property {(keys: CopySet<K> | Iterable<K>) => void} addAll
+ * @property {(keys: CopySet<any> | Iterable<K>) => void} addAll
  * @property {(keyPatt?: Pattern) => Iterable<K>} keys
  * @property {(keyPatt?: Pattern) => Iterable<K>} values
- * @property {(keyPatt?: Pattern) => CopySet<K>} snapshot
+ * @property {(keyPatt?: Pattern) => CopySet<any>} snapshot
  * @property {(keyPatt?: Pattern) => number} getSize
  * @property {(keyPatt?: Pattern) => void} clear
  */
+/**
+ * @template K
+ * @typedef {RemotableObject & SetStoreMethods<K>} SetStore
+ */
 
+// TODO use Key for K
+// TODO use Passable for V
 /**
- * @template {Key & object} [K=Key]
- * @template {Passable} [V=Passable]
+ * @template K
+ * @template V
  * @typedef {object} WeakMapStore
  * @property {(key: K) => boolean} has Check if a key exists. The key can be any
  *   JavaScript value, though the answer will always be false for keys that
@@ -96,13 +108,15 @@ export {};
  *   example a scalar store only allows primitives and remotables.
  * @property {(key: K, value: V) => void} set Set the key. Throws if not found.
  * @property {(key: K) => void} delete Remove the key. Throws if not found.
- * @property {(entries: CopyMap<K, V> | Iterable<[K, V]>) => void} addAll
+ * @property {(entries: CopyMap<any, any> | Iterable<[K, V]>) => void} addAll
  */
 
+// TODO use Key for K
+// TODO use Passable for V
 /**
- * @template {Key} [K=Key]
- * @template {Passable} [V=Passable]
- * @typedef {object} MapStore
+ * @template K
+ * @template V
+ * @typedef {object} MapStoreMethods
  * @property {(key: K) => boolean} has Check if a key exists. The key can be any
  *   JavaScript value, though the answer will always be false for keys that
  *   cannot be found in this map
@@ -113,14 +127,22 @@ export {};
  *   example a scalar store only allows primitives and remotables.
  * @property {(key: K, value: V) => void} set Set the key. Throws if not found.
  * @property {(key: K) => void} delete Remove the key. Throws if not found.
- * @property {(entries: CopyMap<K, V> | Iterable<[K, V]>) => void} addAll
+ * @property {(entries: CopyMap<any, Passable> | Iterable<[K, V]>) => void} addAll
  * @property {(keyPatt?: Pattern, valuePatt?: Pattern) => Iterable<K>} keys
  * @property {(keyPatt?: Pattern, valuePatt?: Pattern) => Iterable<V>} values
  * @property {(keyPatt?: Pattern, valuePatt?: Pattern) => Iterable<[K, V]>} entries
- * @property {(keyPatt?: Pattern, valuePatt?: Pattern) => CopyMap<K, V>} snapshot
+ * @property {(
+ *   keyPatt?: Pattern,
+ *   valuePatt?: Pattern,
+ * ) => CopyMap<any, Passable>} snapshot
  * @property {(keyPatt?: Pattern, valuePatt?: Pattern) => number} getSize
  * @property {(keyPatt?: Pattern, valuePatt?: Pattern) => void} clear
  */
+/**
+ * @template [K=any]
+ * @template [V=any]
+ * @typedef {RemotableObject & MapStoreMethods<K, V>} MapStore
+ */
 
 // ///////////////////////// Deprecated Legacy /////////////////////////////////