@agoric/internal 0.3.3-dev-4e588de.0 → 0.3.3-dev-d711f8f.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/internal",
-  "version": "0.3.3-dev-4e588de.0+4e588de",
+  "version": "0.3.3-dev-d711f8f.0+d711f8f",
   "description": "Externally unsupported utilities internal to agoric-sdk",
   "type": "module",
   "main": "src/index.js",
@@ -20,7 +20,7 @@
     "lint:types": "tsc"
   },
   "dependencies": {
-    "@agoric/base-zone": "0.1.1-dev-4e588de.0+4e588de",
+    "@agoric/base-zone": "0.1.1-dev-d711f8f.0+d711f8f",
     "@endo/common": "^1.2.9",
     "@endo/errors": "^1.2.9",
     "@endo/far": "^1.1.10",
@@ -34,7 +34,7 @@
     "jessie.js": "^0.3.4"
   },
   "devDependencies": {
-    "@agoric/cosmic-proto": "0.4.1-dev-4e588de.0+4e588de",
+    "@agoric/cosmic-proto": "0.4.1-dev-d711f8f.0+d711f8f",
     "@endo/exo": "^1.5.8",
     "@endo/init": "^1.1.8",
     "ava": "^5.3.0",
@@ -60,5 +60,5 @@
   "typeCoverage": {
     "atLeast": 93.04
   },
-  "gitHead": "4e588deeeee83704a5de69f3914ded0605dc1dc0"
+  "gitHead": "d711f8fd3b97a47f8c7791439df8c6b4d7baaf21"
 }

package/src/js-utils.d.ts

@@ -1,15 +1,38 @@
+/** For overriding TypeScript inferring the type of `true` as boolean. */
+export const TRUE: true;
 /**
- * @file Pure JavaScript utility functions that are compatible with but not
- *   dependent upon a hardened environment.
+ * @typedef {<O extends Record<string, unknown>>(
+ *   obj: O,
+ * ) => { [K in keyof O]: K extends string ? [K, O[K]] : never }[keyof O][]} TypedEntries
  */
+export const typedEntries: TypedEntries;
+/**
+ * @typedef {<
+ *   const Entries extends ReadonlyArray<readonly [PropertyKey, unknown]>,
+ * >(
+ *   entries: Entries,
+ * ) => { [Entry in Entries[number] as Entry[0]]: Entry[1] }} FromTypedEntries
+ */
+export const fromTypedEntries: FromTypedEntries;
+/**
+ * @typedef {<A extends unknown[], V>(
+ *   arr: A,
+ *   mapper: <K extends number>(el: A[K], idx: K, arr: A) => V,
+ * ) => V[]} TypedMap
+ */
+export const typedMap: TypedMap;
 export const logLevels: readonly ["debug", "log", "info", "warn", "error"];
 export function deepCopyJsonable<T>(value: T): T;
-export function deepMapObject(obj: object, mapper: (value: any, name: string, record: object) => any): object;
-export function objectMapMutable<O extends Record<PropertyKey, any>, V>(obj: O, mapFn: <K extends keyof O>(value: O[K], key: K) => V): { [K in keyof O]: V; };
+export function deepMapObject<O extends Record<string, unknown>, M>(obj: O, mapper: <T extends Record<string, unknown>, K extends string & keyof T>(value: T[K], name: K, record: T) => T[K] | M): O | { [K_1 in keyof O]: K_1 extends string ? O[K_1] | M : never; };
+export function defineName<F extends Function>(name: string, fn: F): F;
+export function objectMapMutable<O extends Record<string, unknown>, M>(obj: O, mapper: <K extends keyof O>(value: O[K], key: K) => M): { [K in keyof O]: K extends string ? M : never; };
 export function makeMeasureSeconds(currentTimeMillisec: () => number): <T>(fn: () => Promise<T>) => Promise<{
     result: T;
     duration: number;
 }>;
+export type TypedEntries = <O extends Record<string, unknown>>(obj: O) => { [K in keyof O]: K extends string ? [K, O[K]] : never; }[keyof O][];
+export type FromTypedEntries = <const Entries extends ReadonlyArray<readonly [PropertyKey, unknown]>>(entries: Entries) => { [Entry in Entries[number] as Entry[0]]: Entry[1]; };
+export type TypedMap = <A extends unknown[], V>(arr: A, mapper: <K extends number>(el: A[K], idx: K, arr: A) => V) => V[];
 export type LogLevel = (typeof logLevels)[keyof readonly ["debug", "log", "info", "warn", "error"] & number];
 export type LimitedConsole = Pick<Console, LogLevel>;
 //# sourceMappingURL=js-utils.d.ts.map

package/src/js-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"js-utils.d.ts","sourceRoot":"","sources":["js-utils.js"],"names":[],"mappings":"AAEA;;;GAGG;AAEH,2EAMG;AAkBI,iCAJM,CAAC,SACH,CAAC,GACC,CAAC,CAE4D;AAiDnE,mCAJI,MAAM,UACN,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,GAAG,GAC/C,MAAM,CAGuC;AASnD,iCANiC,CAAC,SAA3B,MAAM,CAAC,WAAW,EAAE,GAAG,CAAE,EAC1B,CAAC,OACH,CAAC,SACD,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,GAC3C,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,GAAE,CAKjC;AASM,wDAFI,MAAM,MAAM,IAIR,CAAC,MACH,MAAM,OAAO,CAAC,CAAC,CAAC,KACd,OAAO,CAAC;IAAE,MAAM,EAAE,CAAC,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAStD;uBAnGa,CAAC,OAAO,SAAS,EAAE,2DAAkB,MAAM,CAAC;6BAE5C,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC"}
+{"version":3,"file":"js-utils.d.ts","sourceRoot":"","sources":["js-utils.js"],"names":[],"mappings":"AASA,yEAAyE;AACzE,mBAA0C,IAAI,CAAE;AAEhD;;;;GAIG;AACH,2BAAuC,YAAY,CAAsB;AAEzE;;;;;;GAMG;AACH,+BAA2C,gBAAgB,CAEzD;AAEF;;;;;GAKG;AACH,uBAAmC,QAAQ,CAEzC;AAEF,2EAMG;AAgBI,iCAJM,CAAC,SACH,CAAC,GACC,CAAC,CAE4D;AAsEnE,8BAVgC,CAAC,SAA1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAE,EACzB,CAAC,OACH,CAAC,UACD,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,MAAM,CAAC,EACpE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EACX,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,CAAC,KACN,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GACH,CAAC,GAAG,GAAG,GAAC,IAAI,MAAM,CAAC,GAAG,GAAC,SAAS,MAAM,GAAG,CAAC,CAAC,GAAC,CAAC,GAAG,CAAC,GAAG,KAAK,GAAE,CAGO;AAgBxE,2BALiB,CAAC,SAAZ,QAAU,QACZ,MAAM,MACN,CAAC,GACC,CAAC,CAG+B;AAetC,iCANgC,CAAC,SAA1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAE,EACzB,CAAC,OACH,CAAC,UACD,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,GAC3C,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK,GAAE,CAS5D;AASM,wDAFI,MAAM,MAAM,IAIR,CAAC,MACH,MAAM,OAAO,CAAC,CAAC,CAAC,KACd,OAAO,CAAC;IAAE,MAAM,EAAE,CAAC,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAStD;2BArLY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,GAAG,EAAE,CAAC,KACH,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,GAAE,CAAC,MAAM,CAAC,CAAC,EAAE;+BAK9D,CACZ,KAAS,CAAC,OAAO,SAAS,aAAa,CAAC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,EAEpE,OAAO,EAAE,OAAO,KACb,GAAG,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAE;uBAO/C,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,CAAC,EAC/B,GAAG,EAAE,CAAC,EACN,MAAM,EAAE,CAAC,CAAC,SAAS,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,KACtD,CAAC,EAAE;uBAeG,CAAC,OAAO,SAAS,EAAE,2DAAkB,MAAM,CAAC;6BAE5C,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC"}

package/src/js-utils.js

@@ -5,6 +5,39 @@
  *   dependent upon a hardened environment.
  */
 
+const { defineProperty } = Object;
+
+/** For overriding TypeScript inferring the type of `true` as boolean. */
+export const TRUE = /** @type {const} */ (true);
+
+/**
+ * @typedef {<O extends Record<string, unknown>>(
+ *   obj: O,
+ * ) => { [K in keyof O]: K extends string ? [K, O[K]] : never }[keyof O][]} TypedEntries
+ */
+export const typedEntries = /** @type {TypedEntries} */ (Object.entries);
+
+/**
+ * @typedef {<
+ *   const Entries extends ReadonlyArray<readonly [PropertyKey, unknown]>,
+ * >(
+ *   entries: Entries,
+ * ) => { [Entry in Entries[number] as Entry[0]]: Entry[1] }} FromTypedEntries
+ */
+export const fromTypedEntries = /** @type {FromTypedEntries} */ (
+  Object.fromEntries
+);
+
+/**
+ * @typedef {<A extends unknown[], V>(
+ *   arr: A,
+ *   mapper: <K extends number>(el: A[K], idx: K, arr: A) => V,
+ * ) => V[]} TypedMap
+ */
+export const typedMap = /** @type {TypedMap} */ (
+  Function.prototype.call.bind(Array.prototype.map)
+);
+
 export const logLevels = /** @type {const} */ ([
   'debug',
   'log',
@@ -18,8 +51,6 @@ Object.freeze(logLevels);
 
 /** @typedef {Pick<Console, LogLevel>} LimitedConsole */
 
-const { entries, fromEntries } = Object;
-
 /**
  * Deep-copy a value by round-tripping it through JSON (which drops
  * function/symbol/undefined values and properties that are non-enumerable
@@ -32,11 +63,14 @@ const { entries, fromEntries } = Object;
 export const deepCopyJsonable = value => JSON.parse(JSON.stringify(value));
 
 /**
- * @param {any} value
- * @param {string | undefined} name
- * @param {object | undefined} container
- * @param {(value: any, name: string, record: object) => any} mapper
- * @returns {any}
+ * @template {Record<PropertyKey, unknown>} O
+ * @template {string & keyof O} K
+ * @template M
+ * @param {O[K]} value
+ * @param {K | undefined} name
+ * @param {O | undefined} container
+ * @param {(value: O[K], name: K, record: O) => O[K] | M} mapper
+ * @returns {O[K] | M | { [K2 in keyof O[K]]: O[K][K2] | M }}
  */
 const deepMapObjectInternal = (value, name, container, mapper) => {
   if (container && typeof name === 'string') {
@@ -51,18 +85,30 @@ const deepMapObjectInternal = (value, name, container, mapper) => {
   }
 
   let wasMapped = false;
-  const mappedEntries = Object.entries(value).map(([innerName, innerValue]) => {
+  const valueObj = /** @type {Record<string, unknown>} */ (value);
+  /**
+   * @type {<T extends typeof value, K2 extends string & keyof T>(
+   *   entry: [K2, T[K2]],
+   * ) => [K2, T[K2] | M]}
+   */
+  const mapEntry = ([innerName, innerValue]) => {
     const mappedInnerValue = deepMapObjectInternal(
       innerValue,
       innerName,
-      value,
+      valueObj,
       mapper,
     );
     wasMapped ||= mappedInnerValue !== innerValue;
-    return [innerName, mappedInnerValue];
-  });
+    return [innerName, /** @type {any} */ (mappedInnerValue)];
+  };
+  const mappedEntries = typedEntries(valueObj).map(mapEntry);
 
-  return wasMapped ? Object.fromEntries(mappedEntries) : value;
+  if (!wasMapped) {
+    return value;
+  }
+
+  const mappedObj = fromTypedEntries(mappedEntries);
+  return /** @type {any} */ (mappedObj);
 };
 
 /**
@@ -74,23 +120,56 @@ const deepMapObjectInternal = (value, name, container, mapper) => {
  * When the property value is an object, it is sent to the mapper like any other
  * value, and then recursively traversed unless replaced with a distinct value.
  *
- * @param {object} obj
- * @param {(value: any, name: string, record: object) => any} mapper
- * @returns {object}
+ * @template {Record<string, unknown>} O
+ * @template M
+ * @param {O} obj
+ * @param {<T extends Record<string, unknown>, K extends string & keyof T>(
+ *   value: T[K],
+ *   name: K,
+ *   record: T,
+ * ) => T[K] | M} mapper
+ * @returns {O | { [K in keyof O]: K extends string ? O[K] | M : never }}
  */
 export const deepMapObject = (obj, mapper) =>
-  deepMapObjectInternal(obj, undefined, undefined, mapper);
+  /** @type {any} */ (deepMapObjectInternal(obj, undefined, undefined, mapper));
 
 /**
- * @template {Record<PropertyKey, any>} O
- * @template V
+ * Explicitly set a function's name, supporting use of arrow functions for which
+ * source text doesn't include a name and no initial name is set by
+ * NamedEvaluation
+ * https://tc39.es/ecma262/multipage/syntax-directed-operations.html#sec-runtime-semantics-namedevaluation
+ *
+ * `name` is the first parameter for better readability at call sites (e.g.,
+ * `return defineName('foo', () => { ... })`).
+ *
+ * @template {Function} F
+ * @param {string} name
+ * @param {F} fn
+ * @returns {F}
+ */
+export const defineName = (name, fn) =>
+  defineProperty(fn, 'name', { value: name });
+
+/**
+ * By analogy with how `Array.prototype.map` will map the elements of an array
+ * to transformed elements of an array of the same shape, `objectMapMutable`
+ * will do likewise for the enumerable string-keyed properties of an object.
+ *
+ * Unlike endo's `objectMap`, this function returns a non-hardened object.
+ *
+ * @template {Record<string, unknown>} O
+ * @template M
  * @param {O} obj
- * @param {<K extends keyof O>(value: O[K], key: K) => V} mapFn
- * @returns {{ [K in keyof O]: V }}
+ * @param {<K extends keyof O>(value: O[K], key: K) => M} mapper
+ * @returns {{ [K in keyof O]: K extends string ? M : never }}
  */
-export const objectMapMutable = (obj, mapFn) => {
-  const newEntries = entries(obj).map(([k, v]) => [k, mapFn(v, k)]);
-  return /** @type {{ [K in keyof O]: V }} */ (fromEntries(newEntries));
+export const objectMapMutable = (obj, mapper) => {
+  const oldEntries = typedEntries(obj);
+  /** @type {<K extends keyof O>(entry: [K, O[K]]) => [K, M]} */
+  const mapEntry = ([k, v]) => [k, mapper(v, k)];
+  const newEntries = typedMap(oldEntries, mapEntry);
+  const newObj = fromTypedEntries(newEntries);
+  return /** @type {any} */ (newObj);
 };
 
 /**