@agoric/cache 0.3.3-other-dev-8f8782b.0 → 0.3.3-other-dev-fbe72e7.0.fbe72e7

package/CHANGELOG.md

@@ -3,14 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-### [0.3.3-u11.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.3.2...@agoric/cache@0.3.3-u11.0) (2023-08-24)
-
-**Note:** Version bump only for package @agoric/cache
-
-
-
-
-
 ### [0.3.2](https://github.com/Agoric/agoric-sdk/compare/@agoric/cache@0.3.1...@agoric/cache@0.3.2) (2023-06-02)
 
 **Note:** Version bump only for package @agoric/cache

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/cache",
-  "version": "0.3.3-other-dev-8f8782b.0+8f8782b",
+  "version": "0.3.3-other-dev-fbe72e7.0.fbe72e7",
   "description": "Agoric's simple cache interface",
   "type": "module",
   "main": "src/main.js",
@@ -8,40 +8,46 @@
   "scripts": {
     "build": "exit 0",
     "test": "ava",
-    "test:c8": "c8 $C8_OPTIONS ava --config=ava-nesm.config.js",
+    "test:c8": "c8 --all ${C8_OPTIONS:-} ava",
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
-    "lint": "run-s --continue-on-error lint:*",
-    "lint:types": "tsc -p jsconfig.json",
-    "lint:eslint": "eslint --ext .js,.ts ."
+    "lint": "yarn run -T run-s --continue-on-error 'lint:*'",
+    "lint:types": "yarn run -T tsc",
+    "lint:eslint": "yarn run -T eslint ."
   },
   "keywords": [],
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/internal": "0.3.3-other-dev-8f8782b.0+8f8782b",
-    "@agoric/notifier": "0.6.3-other-dev-8f8782b.0+8f8782b",
-    "@agoric/store": "0.9.3-other-dev-8f8782b.0+8f8782b",
-    "@agoric/vat-data": "0.5.3-other-dev-8f8782b.0+8f8782b",
-    "@endo/far": "0.2.18",
-    "@endo/marshal": "0.8.5"
+    "@agoric/internal": "0.3.3-other-dev-fbe72e7.0.fbe72e7",
+    "@agoric/notifier": "0.6.3-other-dev-fbe72e7.0.fbe72e7",
+    "@agoric/store": "0.9.3-other-dev-fbe72e7.0.fbe72e7",
+    "@agoric/vat-data": "0.5.3-other-dev-fbe72e7.0.fbe72e7",
+    "@endo/far": "^1.1.14",
+    "@endo/marshal": "^1.8.0"
   },
   "devDependencies": {
-    "@agoric/zoe": "0.26.3-other-dev-8f8782b.0+8f8782b",
-    "ava": "^5.2.0",
-    "c8": "^7.13.0"
+    "@agoric/zoe": "0.26.3-other-dev-fbe72e7.0.fbe72e7",
+    "ava": "^5.3.0",
+    "c8": "^10.1.3"
   },
   "publishConfig": {
     "access": "public"
   },
   "engines": {
-    "node": ">=14.15.0"
+    "node": "^20.9 || ^22.11"
   },
   "ava": {
     "files": [
-      "test/**/test-*.js"
+      "test/**/*.test.*"
+    ],
+    "require": [
+      "@endo/init/debug.js"
     ],
     "timeout": "20m"
   },
-  "gitHead": "8f8782bc52393e9d4fc82523ecf31cab429b11b3"
+  "typeCoverage": {
+    "atLeast": 94.13
+  },
+  "gitHead": "fbe72e72107f9997f788674e668c660d92ec4492"
 }

package/src/cache.js

@@ -4,22 +4,27 @@ import { E, Far } from '@endo/far';
 
 import { makeScalarStoreCoordinator } from './store.js';
 
+/**
+ * @import {Passable, RemotableObject} from '@endo/pass-style';
+ * @import {Key, Pattern} from '@endo/patterns';
+ */
+
 /**
  * @typedef {{ [x: PropertyKey]: any } | string | symbol | bigint | null |
- * undefined | number | ((oldValue: any) => ERef<unknown>)} Update a `newValue`
+ * undefined | number | ((oldValue: any) => ERef<Passable>)} Update a `newValue`
  * to update to.  If a function, then it should take an oldValue and return a
  * `newValue` or promise for `newValue`
  */
 
 /**
- * @param {ERef<import('./types').Coordinator>} [coordinator]
+ * @param {ERef<import('./types.js').Coordinator>} [coordinator]
  */
 export const makeCache = (coordinator = makeScalarStoreCoordinator()) => {
   /**
    * The ground state for a cache key value is `undefined`.  It is impossible to
    * distinguish a set value of `undefined` from an unset key
    *
-   * @param {unknown} key the cache key (any key type acceptable to the cache)
+   * @param {Passable} key the cache key (any key type acceptable to the cache)
    * @param {[] | [Update] | [Update, Pattern]} optUpdateGuardPattern an optional
    */
   const cache = (key, ...optUpdateGuardPattern) => {

package/src/main.js

@@ -1,4 +1,5 @@
 // @jessie-check
+/// <reference types="@agoric/internal/exported" />
 
 // eslint-disable-next-line import/export
 export * from './types.js';

package/src/state.js

@@ -30,7 +30,7 @@ export const makeState = (value, priorState = GROUND_STATE) =>
 /**
  * Wrap a state store to have a default value using the GROUND_STATE
  *
- * @param {MapStore<string, import('./state').State>} stateStore
+ * @param {MapStore<string, import('./state.js').State>} stateStore
  */
 export const withGroundState = stateStore => ({
   ...stateStore,

package/src/store.js

@@ -5,10 +5,13 @@ import { makeScalarBigMapStore } from '@agoric/vat-data';
 import { untilTrue } from '@agoric/internal';
 import { withGroundState, makeState } from './state.js';
 
-import './types.js';
+/**
+ * @import {Passable, RemotableObject} from '@endo/pass-style';
+ * @import {Key, Pattern} from '@endo/patterns';
+ */
 
 /**
- * @param {(obj: unknown) => unknown} [sanitize]
+ * @param {(obj: Passable) => Passable} [sanitize]
  * @returns {(key: Passable) => Promise<string>}
  */
 const makeKeyToString = (sanitize = obj => obj) => {
@@ -37,16 +40,16 @@ const makeKeyToString = (sanitize = obj => obj) => {
 
 /**
  * @param {string} keyStr
- * @param {(oldValue: unknown) => unknown} txn
+ * @param {(oldValue: Passable) => Passable} txn
  * @param {Pattern} guardPattern
- * @param {(obj: unknown) => unknown} sanitize Process keys and values with
+ * @param {(obj: Passable) => Passable} sanitize Process keys and values with
  * this function before storing them
  * @param {{
- * get(key: string): import('./state').State;
- * set(key: string, value: import('./state').State): void;
- * init(key: string, value: import('./state').State): void;
+ * get(key: string): import('./state.js').State;
+ * set(key: string, value: import('./state.js').State): void;
+ * init(key: string, value: import('./state.js').State): void;
  * }} stateStore
- * @returns {Promise<unknown>} the value of the updated state
+ * @returns {Promise<Passable>} the value of the updated state
  */
 const applyCacheTransaction = async (
   keyStr,
@@ -58,8 +61,8 @@ const applyCacheTransaction = async (
   /**
    * Retrieve a potential updated state from the transaction.
    *
-   * @param {import('./state').State} basisState
-   * @returns {Promise<import('./state').State | null>} the updated state, or null if no longer applicable
+   * @param {import('./state.js').State} basisState
+   * @returns {Promise<import('./state.js').State | null>} the updated state, or null if no longer applicable
    */
   const getUpdatedState = async basisState => {
     const { value } = basisState;
@@ -108,11 +111,12 @@ const applyCacheTransaction = async (
 };
 
 /**
- * @param {MapStore<string, import('./state').State>} stateStore
+ * @param {MapStore<string, import('./state.js').State>} stateStore
  * @param {ERef<Marshaller>} marshaller
  * @returns {Promise<string>}
  */
 const stringifyStateStore = async (stateStore, marshaller) => {
+  /** @type {Passable} */
   const obj = {};
   for (const [key, value] of stateStore.entries()) {
     obj[key] = E(marshaller).toCapData(value);
@@ -126,8 +130,8 @@ const stringifyStateStore = async (stateStore, marshaller) => {
  * Make a cache coordinator backed by a MapStore.  This coordinator doesn't
  * currently enforce any cache eviction, but that would be a useful feature.
  *
- * @param {MapStore<string, import('./state').State>} [stateStore]
- * @param {(obj: unknown) => unknown} [sanitize] Process keys and values with
+ * @param {MapStore<string, import('./state.js').State>} [stateStore]
+ * @param {(obj: Passable) => Passable} [sanitize] Process keys and values with
  * this function before storing them. Defaults to deeplyFulfilled.
  */
 export const makeScalarStoreCoordinator = (
@@ -138,7 +142,7 @@ export const makeScalarStoreCoordinator = (
 
   const defaultStateStore = withGroundState(stateStore);
 
-  /** @type {import('./types').Coordinator} */
+  /** @type {import('./types.js').Coordinator} */
   const coord = Far('store cache coordinator', {
     getRecentValue: async key => {
       const keyStr = await serializePassable(key);
@@ -171,7 +175,7 @@ export const makeScalarStoreCoordinator = (
 /**
  * Don't write any marshalled value that's older than what's already pushed
  *
- * @param {MapStore<string, import('./state').State>} stateStore
+ * @param {MapStore<string, import('./state.js').State>} stateStore
  * @param {ERef<Marshaller>} marshaller
  * @param {ERef<StorageNode>} storageNode
  * @returns {<T>(storedValue: T) => Promise<T>}
@@ -218,7 +222,7 @@ export const makeChainStorageCoordinator = (storageNode, marshaller) => {
     storageNode,
   );
 
-  /** @type {import('./types').Coordinator} */
+  /** @type {import('./types.js').Coordinator} */
   const coord = Far('store cache coordinator', {
     getRecentValue: async key => {
       const keyStr = await serializePassable(key);

package/src/types.js

@@ -1,13 +1,17 @@
 // @jessie-check
 
+/// <reference types="@agoric/store/exported.js" />
+
 // XXX package factoring debt
-import '@agoric/notifier/exported.js';
-import '@agoric/store/exported.js';
 
 // Ensure this is a module.
 export {};
 
-/** @template T @typedef {import('@endo/far').ERef<T>} ERef */
+/**
+ * @import { ERef } from '@endo/far'
+ * @import {Passable} from '@endo/pass-style'
+ * @import {Key, Pattern} from '@endo/patterns';
+ */
 
 /**
  * @typedef {object} Updater

package/test/{test-storage.js → storage.test.js}

@@ -1,7 +1,5 @@
 // Must be first to set up globals
-// import { test } from '@agoric/zoe/tools/prepare-test-env-ava.js';
-// eslint-disable-next-line import/no-extraneous-dependencies -- XXX
-import '@agoric/swingset-vat/tools/prepare-test-env.js';
+import '@agoric/zoe/tools/prepare-test-env.js';
 
 import test from 'ava';
 import { makeChainStorageRoot } from '@agoric/internal/src/lib-chainStorage.js';
@@ -29,13 +27,16 @@ harden(makeSimpleMarshaller);
 
 const setup = () => {
   const storageNodeState = {};
-  const chainStorage = makeChainStorageRoot(message => {
-    assert(message.method === 'set');
-    assert(message.args.length === 1);
-    const [[path, value]] = message.args;
-    assert(path === 'cache');
-    storageNodeState.cache = value;
-  }, 'cache');
+  const chainStorage = makeChainStorageRoot(
+    Far('ToStorage', message => {
+      assert(message.method === 'set');
+      assert(message.args.length === 1);
+      const [[path, value]] = message.args;
+      assert(path === 'cache');
+      storageNodeState.cache = value;
+    }),
+    'cache',
+  );
   const cache = makeCache(
     makeChainStorageCoordinator(chainStorage, makeSimpleMarshaller()),
   );

package/{jsconfig.json → tsconfig.json}

@@ -1,6 +1,7 @@
 // This file can contain .js-specific Typescript compiler config.
 {
   "extends": "../../tsconfig.json",
+  "compilerOptions": {},
   "include": [
     "*.js",
     "public/**/*.js",