@agoric/vow 0.1.1-dev-43dd3ec.0 → 0.1.1-dev-6909994.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/vow",
-  "version": "0.1.1-dev-43dd3ec.0+43dd3ec",
+  "version": "0.1.1-dev-6909994.0+6909994",
   "description": "Remote (shortening and disconnection-tolerant) Promise-likes",
   "type": "module",
   "main": "src/index.js",
@@ -19,8 +19,8 @@
     "lint:types": "tsc"
   },
   "dependencies": {
-    "@agoric/base-zone": "0.1.1-dev-43dd3ec.0+43dd3ec",
-    "@agoric/internal": "0.3.3-dev-43dd3ec.0+43dd3ec",
+    "@agoric/base-zone": "0.1.1-dev-6909994.0+6909994",
+    "@agoric/internal": "0.3.3-dev-6909994.0+6909994",
     "@endo/env-options": "^1.1.6",
     "@endo/errors": "^1.2.5",
     "@endo/eventual-send": "^1.2.5",
@@ -30,8 +30,8 @@
   },
   "devDependencies": {
     "@agoric/internal": "^0.3.2",
-    "@agoric/swingset-vat": "0.32.3-dev-43dd3ec.0+43dd3ec",
-    "@agoric/zone": "0.2.3-dev-43dd3ec.0+43dd3ec",
+    "@agoric/swingset-vat": "0.32.3-dev-6909994.0+6909994",
+    "@agoric/zone": "0.2.3-dev-6909994.0+6909994",
     "@endo/far": "^1.1.5",
     "@endo/init": "^1.1.4",
     "ava": "^5.3.0",
@@ -57,5 +57,5 @@
   "typeCoverage": {
     "atLeast": 89.96
   },
-  "gitHead": "43dd3ec21c2f8a885af8e3c1d038437e8d2dc8e5"
+  "gitHead": "6909994fc7df88c73d6a476f4d10f56aea85bea5"
 }

package/src/index.d.ts

@@ -1,7 +1,5 @@
 export * from "../vat.js";
-export * from "./types.js";
-export * from "@agoric/internal/src/types.js";
+export * from "./types-index.js";
 export { default as makeE } from "./E.js";
-export type VowTools = import("./tools.js").VowTools;
 export { VowShape, toPassableCap } from "./vow-utils.js";
 //# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":";;;;uBASa,OAAO,YAAY,EAAE,QAAQ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":""}

package/src/index.js

@@ -6,12 +6,5 @@ export * from '../vat.js';
 export { default as makeE } from './E.js';
 export { VowShape, toPassableCap } from './vow-utils.js';
 
-/**
- * @typedef {import('./tools.js').VowTools} VowTools
- */
-
 // eslint-disable-next-line import/export
-export * from './types.js';
-
-// XXX re-exporting the Remote type for back-compat
-export * from '@agoric/internal/src/types.js';
+export * from './types-index.js';

package/src/tools.d.ts

@@ -1,26 +1,7 @@
 export function prepareBasicVowTools(zone: Zone, powers?: {
     isRetryableReason?: IsRetryableReason | undefined;
-} | undefined): {
-    when: <T, TResult1 = import("./types.js").EUnwrap<T>, TResult2 = never>(specimenP: T, onFulfilled?: ((value: import("./types.js").EUnwrap<T>) => TResult1 | PromiseLike<TResult1>) | undefined, onRejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined) => Promise<TResult1 | TResult2>;
-    watch: <T = any, TResult1 = T, TResult2 = never, C extends any[] = any[]>(specimenP: EVow<T>, watcher?: import("./types.js").Watcher<T, TResult1, TResult2, C> | undefined, ...watcherArgs: C) => Vow<Exclude<TResult1, void> | Exclude<TResult2, void> extends never ? TResult1 : Exclude<TResult1, void> | Exclude<TResult2, void>>;
-    makeVowKit: <T>() => import("./types.js").VowKit<T>;
-    all: (maybeVows: unknown[]) => Vow<any[]>;
-    allVows: (maybeVows: unknown[]) => Vow<any[]>;
-    allSettled: (maybeVows: unknown[]) => Vow<({
-        status: "fulfilled";
-        value: any;
-    } | {
-        status: "rejected";
-        reason: any;
-    })[]>;
-    asVow: <T extends unknown>(fn: (...args: any[]) => Vow<Awaited<T>> | Awaited<T> | import("./types.js").PromiseVow<T>) => Vow<Awaited<T>>;
-    asPromise: AsPromiseFunction;
-    retriable: <F extends (...args: any[]) => Promise<any>>(fnZone: Zone, name: string, fn: F) => F extends (...args: infer Args) => Promise<infer R> ? (...args: Args) => Vow<R> : never;
-};
-export type VowTools = ReturnType<typeof prepareBasicVowTools>;
+} | undefined): VowTools;
 import type { Zone } from '@agoric/base-zone';
 import type { IsRetryableReason } from './types.js';
-import type { EVow } from './types.js';
-import type { Vow } from './types.js';
-import type { AsPromiseFunction } from './types.js';
+import type { VowTools } from './types.js';
 //# sourceMappingURL=tools.d.ts.map

package/src/tools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["tools.js"],"names":[],"mappings":"AAqBO,2CAJI,IAAI;;;;;;qBA4CF,OAAO,EAAE;yBAAT,OAAO,EAAE;4BAgBT,OAAO,EAAE;;;;;;;oCAFc,GACpC;;gBAnCkD,CAAC,SAApC,CAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAE,UACpC,IAAI,QACJ,MAAM,MACN,CAAC,KACC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,IAAI,CAAC,CAAC,GAAG,KAAK;EAmDrG;uBAGa,UAAU,CAAC,OAAO,oBAAoB,CAAC;0BA3F9B,mBAAmB;uCAE8B,YAAY;0BAAZ,YAAY;yBAAZ,YAAY;uCAAZ,YAAY"}
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["tools.js"],"names":[],"mappings":"AAsBO,2CALI,IAAI;;gBAGF,QAAQ,CA+EpB;0BA3FsB,mBAAmB;uCAE4B,YAAY;8BAAZ,YAAY"}

package/src/tools.js

@@ -8,7 +8,7 @@ import { makeWhen } from './when.js';
 /**
  * @import {Zone} from '@agoric/base-zone';
  * @import {Passable} from '@endo/pass-style';
- * @import {IsRetryableReason, AsPromiseFunction, EVow, Vow, ERef} from './types.js';
+ * @import {IsRetryableReason, AsPromiseFunction, Vow, VowTools} from './types.js';
  */
 
 /**
@@ -18,6 +18,7 @@ import { makeWhen } from './when.js';
  * @param {Zone} zone
  * @param {object} [powers]
  * @param {IsRetryableReason} [powers.isRetryableReason]
+ * @returns {VowTools}
  */
 export const prepareBasicVowTools = (zone, powers = {}) => {
   const { isRetryableReason = /** @type {IsRetryableReason} */ (() => false) } =
@@ -34,8 +35,10 @@ export const prepareBasicVowTools = (zone, powers = {}) => {
   const watchUtils = makeWatchUtils();
   const asVow = makeAsVow(makeVowKit);
 
+  // FIXME in https://github.com/Agoric/agoric-sdk/pull/9785
   /**
-   * TODO FIXME make this real
+   * @alpha Not yet implemented
+   *
    * Create a function that retries the given function if the underlying
    * functions rejects due to upgrade disconnection.
    *
@@ -96,5 +99,3 @@ export const prepareBasicVowTools = (zone, powers = {}) => {
   });
 };
 harden(prepareBasicVowTools);
-
-/** @typedef {ReturnType<typeof prepareBasicVowTools>} VowTools */

package/src/types-index.d.ts

@@ -0,0 +1,5 @@
+// Export all the types this package provides
+export * from './types.js';
+
+// XXX re-exporting the Remote type for back-compat
+export { Remote } from '@agoric/internal/src/types.js';

package/src/types-index.js

@@ -0,0 +1,2 @@
+// Empty JS file to correspond with its .d.ts twin
+export {};

package/src/types.d.ts

@@ -1,3 +1,6 @@
+import type { Remote } from '@agoric/internal';
+import type { Zone } from '@agoric/zone';
+import type { CopyTagged, RemotableObject } from '@endo/pass-style';
 /**
  * Return truthy if a rejection reason should result in a retry.
  */
@@ -16,7 +19,7 @@ export type EVow<T> = ERef<T | Vow<T>>;
  * Follow the chain of vow shortening to the end, returning the final value.
  * This is used within E, so we must narrow the type to its remote form.
  */
-export type EUnwrap<T> = (T extends Vow<infer U> ? EUnwrap<U> : T extends PromiseLike<infer U> ? EUnwrap<U> : T);
+export type EUnwrap<T> = T extends Vow<infer U> ? EUnwrap<U> : T extends PromiseLike<infer U> ? EUnwrap<U> : T;
 /**
  * The first version of the vow implementation
  * object.  CAVEAT: These methods must never be changed or added to, to provide
@@ -38,7 +41,7 @@ export type VowPayload<T = any> = {
 /**
  * Vows are objects that represent promises that can be stored durably.
  */
-export type Vow<T = any> = CopyTagged<"Vow", VowPayload<T>>;
+export type Vow<T = any> = CopyTagged<'Vow', VowPayload<T>>;
 export type VowKit<T = any> = {
     vow: Vow<T>;
     resolver: VowResolver<T>;
@@ -55,7 +58,50 @@ export type Watcher<T = any, TResult1 = T, TResult2 = never, C extends any[] = a
  * Converts a vow or promise to a promise, ensuring proper handling of ephemeral promises.
  */
 export type AsPromiseFunction<T = any, TResult1 = T, TResult2 = never, C extends any[] = any[]> = (specimenP: ERef<T | Vow<T>>, watcher?: Watcher<T, TResult1, TResult2, C> | undefined, watcherArgs?: C | undefined) => Promise<TResult1 | TResult2>;
-import type { RemotableObject } from '@endo/pass-style';
-import type { Remote } from '@agoric/internal';
-import type { CopyTagged } from '@endo/pass-style';
+export type VowTools = {
+    /**
+     * Vow-tolerant implementation of Promise.all that takes an iterable of vows
+     * and other {@link Passable}s and returns a single {@link Vow}. It resolves
+     * with an array of values when all of the input's promises or vows are
+     * fulfilled and rejects when any of the input's promises or vows are rejected
+     * with the first rejection reason.
+     */
+    all: (maybeVows: unknown[]) => Vow<any[]>;
+    /**
+     * Vow-tolerant
+     * implementation of Promise.allSettled that takes an iterable of vows and other
+     * {@link Passable}s and returns a single {@link Vow}. It resolves when all of
+     * the input's promises or vows are settled with an array of settled outcome
+     * objects.
+     */
+    allSettled: (maybeVows: unknown[]) => Vow<({
+        status: 'fulfilled';
+        value: any;
+    } | {
+        status: 'rejected';
+        reason: any;
+    })[]>;
+    allVows: (maybeVows: unknown[]) => Vow<any[]>;
+    /**
+     * Convert a vow or promise to a promise, ensuring proper handling of ephemeral promises.
+     */
+    asPromise: AsPromiseFunction;
+    /**
+     * Helper function that
+     * coerces the result of a function to a Vow. Helpful for scenarios like a
+     * synchronously thrown error.
+     */
+    asVow: <T extends unknown>(fn: (...args: any[]) => Vow<Awaited<T>> | Awaited<T> | PromiseVow<T>) => Vow<Awaited<T>>;
+    makeVowKit: <T>() => VowKit<T>;
+    retriable: <F extends (...args: any[]) => Promise<any>>(fnZone: Zone, name: string, fn: F) => F extends (...args: infer Args) => Promise<infer R> ? (...args: Args) => Vow<R> : never;
+    watch: <T = any, TResult1 = T, TResult2 = never, C extends any[] = any[]>(specimenP: EVow<T>, watcher?: Watcher<T, TResult1, TResult2, C> | undefined, ...watcherArgs: C) => Vow<Exclude<TResult1, void> | Exclude<TResult2, void> extends never ? TResult1 : Exclude<TResult1, void> | Exclude<TResult2, void>>;
+    /**
+     * Shorten `specimenP` until we achieve a final result.
+     *
+     * Does not survive upgrade (even if specimenP is a durable Vow).
+     *
+     * Use only if the Vow will resolve _promptly_ {@see {@link  @agoric/swingset-vat/docs/async.md}}.
+     */
+    when: <T, TResult1 = EUnwrap<T>, TResult2 = never>(specimenP: T, onFulfilled?: ((value: EUnwrap<T>) => TResult1 | PromiseLike<TResult1>) | undefined, onRejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined) => Promise<TResult1 | TResult2>;
+};
 //# sourceMappingURL=types.d.ts.map

package/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.js"],"names":[],"mappings":";;;yCAaW,GAAG,mBACH,GAAG,KAED,GAAG;;;;;uBAKH,CAAC,IACD,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;iBAKnB,CAAC,IACD,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;;;;iBAKlB,CAAC,IACD,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;;;;;oBAMhB,CAAC,IACD,CACR,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GACnC,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAC3C,CAAC,CACF;;;;;;;kBAIU,CAAC;;;;;;;aAMD,MAAM,OAAO,CAAC,CAAC,CAAC;;uBAOhB,CAAC;WAED,eAAe,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;;;;;gBAKlC,CAAC,UACF,WAAW,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;mBAI/B,CAAC,UACF;IACR,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IACZ,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CAC1B;wBAIU,CAAC,UACF;IAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;CAAE;oBAIvE,CAAC,QACD,QAAQ,MACR,QAAQ,UACA,CAAC,SAAT,GAAG,EAAG;2BAEE,CAAC,WAAW,CAAC,KAAK,GAAG,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ;2BAChE,GAAG,WAAW,CAAC,KAAK,GAAG,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ;;;;;8BAM5E,CAAC,QACD,QAAQ,MACR,QAAQ,UACA,CAAC,SAAT,GAAG,EAAG,wBAET,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,2FAGd,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;qCAtGP,kBAAkB;4BAC3B,kBAAkB;gCAFd,kBAAkB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,KAAK,GAAG,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhD,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AACzC;;GAEG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAEvC;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IACnB,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GAClB,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAC5B,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI;IAC3B;;;;;OAKG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,GAAG,IAAI;IAChC,KAAK,EAAE,eAAe,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,GAAG,GAAG,IAAI,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5D,MAAM,MAAM,MAAM,CAAC,CAAC,GAAG,GAAG,IAAI;IAC5B,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IACZ,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,GAAG,IAAI;IACjC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACzC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,OAAO,CACjB,CAAC,GAAG,GAAG,EACP,QAAQ,GAAG,CAAC,EACZ,QAAQ,GAAG,KAAK,EAChB,CAAC,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,IACrB;IACF,WAAW,CAAC,EACR,CAAC,CACC,KAAK,EAAE,CAAC,EACR,GAAG,IAAI,EAAE,CAAC,KACP,GAAG,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,GACrD,SAAS,CAAC;IACd,UAAU,CAAC,EACP,CAAC,CACC,MAAM,EAAE,GAAG,EACX,GAAG,IAAI,EAAE,CAAC,KACP,GAAG,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,GACrD,SAAS,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAC3B,CAAC,GAAG,GAAG,EACP,QAAQ,GAAG,CAAC,EACZ,QAAQ,GAAG,KAAK,EAChB,CAAC,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,IACrB,CACF,SAAS,EAAE,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,SAAS,EACvD,WAAW,CAAC,EAAE,CAAC,GAAG,SAAS,KACxB,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;AAElC,MAAM,MAAM,QAAQ,GAAG;IACrB;;;;;;OAMG;IACH,GAAG,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAC1C;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,GAAG,CACvC,CACI;QACE,MAAM,EAAE,WAAW,CAAC;QACpB,KAAK,EAAE,GAAG,CAAC;KACZ,GACD;QACE,MAAM,EAAE,UAAU,CAAC;QACnB,MAAM,EAAE,GAAG,CAAC;KACb,CACJ,EAAE,CACJ,CAAC;IACF,OAAO,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;IAC9C;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC;IAC7B;;;;OAIG;IACH,KAAK,EAAE,CAAC,CAAC,SAAS,OAAO,EACvB,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,KACjE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACrB,UAAU,EAAE,CAAC,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,EACpD,MAAM,EAAE,IAAI,EACZ,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,KACF,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GACpD,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,GACzB,KAAK,CAAC;IACV,KAAK,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,EAAE,CAAC,SAAS,GAAG,EAAE,GAAG,GAAG,EAAE,EACtE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAClB,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,SAAS,EACvD,GAAG,WAAW,EAAE,CAAC,KACd,GAAG,CACN,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,KAAK,GAC3D,QAAQ,GACR,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CACtD,CAAC;IACF;;;;;;OAMG;IACH,IAAI,EAAE,CAAC,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAG,KAAK,EAC/C,SAAS,EAAE,CAAC,EACZ,WAAW,CAAC,EACR,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GACzD,SAAS,EACb,UAAU,CAAC,EACP,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GACnD,SAAS,KACV,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;CACnC,CAAC"}

package/src/types.ts

@@ -0,0 +1,177 @@
+/* eslint-disable no-use-before-define */
+import type { Remote } from '@agoric/internal';
+import type { Zone } from '@agoric/zone';
+import type { CopyTagged, RemotableObject } from '@endo/pass-style';
+
+/**
+ * Return truthy if a rejection reason should result in a retry.
+ */
+export type IsRetryableReason = (reason: any, priorRetryValue: any) => any;
+
+/**
+ * Return type of a function that may
+ * return a promise or a vow.
+ */
+export type PromiseVow<T> = Promise<T | Vow<T>>;
+
+export type ERef<T> = T | PromiseLike<T>;
+/**
+ * Eventually a value T or Vow for it.
+ */
+export type EVow<T> = ERef<T | Vow<T>>;
+
+/**
+ * Follow the chain of vow shortening to the end, returning the final value.
+ * This is used within E, so we must narrow the type to its remote form.
+ */
+export type EUnwrap<T> =
+  T extends Vow<infer U>
+    ? EUnwrap<U>
+    : T extends PromiseLike<infer U>
+      ? EUnwrap<U>
+      : T;
+
+/**
+ * The first version of the vow implementation
+ * object.  CAVEAT: These methods must never be changed or added to, to provide
+ * forward/backward compatibility.  Create a new object and bump its version
+ * number instead.
+ */
+export type VowV0<T = any> = {
+  /**
+   * Attempt to unwrap all vows in this
+   * promise chain, returning a promise for the final value.  A rejection may
+   * indicate a temporary routing failure requiring a retry, otherwise that the
+   * decider of the terminal promise rejected it.
+   */
+  shorten: () => Promise<T>;
+};
+
+export type VowPayload<T = any> = {
+  vowV0: RemotableObject & Remote<VowV0<T>>;
+};
+
+/**
+ * Vows are objects that represent promises that can be stored durably.
+ */
+export type Vow<T = any> = CopyTagged<'Vow', VowPayload<T>>;
+
+export type VowKit<T = any> = {
+  vow: Vow<T>;
+  resolver: VowResolver<T>;
+};
+
+export type VowResolver<T = any> = {
+  resolve(value?: T | PromiseVow<T>): void;
+  reject(reason?: any): void;
+};
+
+export type Watcher<
+  T = any,
+  TResult1 = T,
+  TResult2 = never,
+  C extends any[] = any[],
+> = {
+  onFulfilled?:
+    | ((
+        value: T,
+        ...args: C
+      ) => Vow<TResult1> | PromiseVow<TResult1> | TResult1)
+    | undefined;
+  onRejected?:
+    | ((
+        reason: any,
+        ...args: C
+      ) => Vow<TResult2> | PromiseVow<TResult2> | TResult2)
+    | undefined;
+};
+
+/**
+ * Converts a vow or promise to a promise, ensuring proper handling of ephemeral promises.
+ */
+export type AsPromiseFunction<
+  T = any,
+  TResult1 = T,
+  TResult2 = never,
+  C extends any[] = any[],
+> = (
+  specimenP: ERef<T | Vow<T>>,
+  watcher?: Watcher<T, TResult1, TResult2, C> | undefined,
+  watcherArgs?: C | undefined,
+) => Promise<TResult1 | TResult2>;
+
+export type VowTools = {
+  /**
+   * Vow-tolerant implementation of Promise.all that takes an iterable of vows
+   * and other {@link Passable}s and returns a single {@link Vow}. It resolves
+   * with an array of values when all of the input's promises or vows are
+   * fulfilled and rejects when any of the input's promises or vows are rejected
+   * with the first rejection reason.
+   */
+  all: (maybeVows: unknown[]) => Vow<any[]>;
+  /**
+   * Vow-tolerant
+   * implementation of Promise.allSettled that takes an iterable of vows and other
+   * {@link Passable}s and returns a single {@link Vow}. It resolves when all of
+   * the input's promises or vows are settled with an array of settled outcome
+   * objects.
+   */
+  allSettled: (maybeVows: unknown[]) => Vow<
+    (
+      | {
+          status: 'fulfilled';
+          value: any;
+        }
+      | {
+          status: 'rejected';
+          reason: any;
+        }
+    )[]
+  >;
+  allVows: (maybeVows: unknown[]) => Vow<any[]>;
+  /**
+   * Convert a vow or promise to a promise, ensuring proper handling of ephemeral promises.
+   */
+  asPromise: AsPromiseFunction;
+  /**
+   * Helper function that
+   * coerces the result of a function to a Vow. Helpful for scenarios like a
+   * synchronously thrown error.
+   */
+  asVow: <T extends unknown>(
+    fn: (...args: any[]) => Vow<Awaited<T>> | Awaited<T> | PromiseVow<T>,
+  ) => Vow<Awaited<T>>;
+  makeVowKit: <T>() => VowKit<T>;
+  retriable: <F extends (...args: any[]) => Promise<any>>(
+    fnZone: Zone,
+    name: string,
+    fn: F,
+  ) => F extends (...args: infer Args) => Promise<infer R>
+    ? (...args: Args) => Vow<R>
+    : never;
+  watch: <T = any, TResult1 = T, TResult2 = never, C extends any[] = any[]>(
+    specimenP: EVow<T>,
+    watcher?: Watcher<T, TResult1, TResult2, C> | undefined,
+    ...watcherArgs: C
+  ) => Vow<
+    Exclude<TResult1, void> | Exclude<TResult2, void> extends never
+      ? TResult1
+      : Exclude<TResult1, void> | Exclude<TResult2, void>
+  >;
+  /**
+   * Shorten `specimenP` until we achieve a final result.
+   *
+   * Does not survive upgrade (even if specimenP is a durable Vow).
+   *
+   * Use only if the Vow will resolve _promptly_ {@see {@link  @agoric/swingset-vat/docs/async.md}}.
+   */
+  when: <T, TResult1 = EUnwrap<T>, TResult2 = never>(
+    specimenP: T,
+    onFulfilled?:
+      | ((value: EUnwrap<T>) => TResult1 | PromiseLike<TResult1>)
+      | undefined,
+    onRejected?:
+      | ((reason: any) => TResult2 | PromiseLike<TResult2>)
+      | undefined,
+  ) => Promise<TResult1 | TResult2>;
+};

package/src/watch-utils.d.ts

@@ -15,7 +15,7 @@ export function prepareWatchUtils(zone: Zone, { watch, when, makeVowKit, isRetry
         reason: any;
     })[]>;
     /** @type {AsPromiseFunction} */
-    asPromise(specimenP: any, watcher: import("./types.js").Watcher<any, any, never, any[]> | undefined, watcherArgs: any[] | undefined): Promise<any>;
+    asPromise(specimenP: any, watcher?: import("./types.js").Watcher<any, any, never, any[]> | undefined, watcherArgs?: any[] | undefined): Promise<any>;
 }>;
 import type { Zone } from '@agoric/base-zone';
 import type { Watch } from './watch.js';

package/src/types.js

@@ -1,109 +0,0 @@
-// @ts-check
-export {};
-
-/**
- * @import {CopyTagged} from '@endo/pass-style'
- * @import {RemotableObject} from '@endo/pass-style';
- * @import {Remote} from '@agoric/internal';
- * @import {prepareVowTools} from './tools.js'
- */
-
-/**
- * @callback IsRetryableReason
- * Return truthy if a rejection reason should result in a retry.
- * @param {any} reason
- * @param {any} priorRetryValue the previous value returned by this function
- * when deciding whether to retry the same logical operation
- * @returns {any} If falsy, the reason is not retryable. If truthy, the
- * priorRetryValue for the next call.
- */
-
-/**
- * @template T
- * @typedef {Promise<T | Vow<T>>} PromiseVow Return type of a function that may
- * return a promise or a vow.
- */
-
-/**
- * @template T
- * @typedef {T | PromiseLike<T>} ERef
- */
-
-/**
- * Eventually a value T or Vow for it.
- * @template T
- * @typedef {ERef<T | Vow<T>>} EVow
- */
-
-/**
- * Follow the chain of vow shortening to the end, returning the final value.
- * This is used within E, so we must narrow the type to its remote form.
- * @template T
- * @typedef {(
- *   T extends Vow<infer U> ? EUnwrap<U> :
- *   T extends PromiseLike<infer U> ? EUnwrap<U> :
- *   T
- * )} EUnwrap
- */
-
-/**
- * @template [T=any]
- * @typedef {object} VowV0 The first version of the vow implementation
- * object.  CAVEAT: These methods must never be changed or added to, to provide
- * forward/backward compatibility.  Create a new object and bump its version
- * number instead.
- *
- * @property {() => Promise<T>} shorten Attempt to unwrap all vows in this
- * promise chain, returning a promise for the final value.  A rejection may
- * indicate a temporary routing failure requiring a retry, otherwise that the
- * decider of the terminal promise rejected it.
- */
-
-/**
- * @template [T=any]
- * @typedef {object} VowPayload
- * @property {RemotableObject & Remote<VowV0<T>>} vowV0
- */
-
-/**
- * Vows are objects that represent promises that can be stored durably.
- * @template [T=any]
- * @typedef {CopyTagged<'Vow', VowPayload<T>>} Vow
- */
-
-/**
- * @template [T=any]
- * @typedef {{
- *   vow: Vow<T>,
- *   resolver: VowResolver<T>,
- * }} VowKit
- */
-
-/**
- * @template [T=any]
- * @typedef {{ resolve(value?: T | PromiseVow<T>): void, reject(reason?: any): void }} VowResolver
- */
-
-/**
- * @template [T=any]
- * @template [TResult1=T]
- * @template [TResult2=never]
- * @template {any[]} [C=any[]] watcher args
- * @typedef {object} Watcher
- * @property {(value: T, ...args: C) => Vow<TResult1> | PromiseVow<TResult1> | TResult1} [onFulfilled]
- * @property {(reason: any, ...args: C) => Vow<TResult2> | PromiseVow<TResult2> | TResult2} [onRejected]
- */
-
-/**
- * Converts a vow or promise to a promise, ensuring proper handling of ephemeral promises.
- *
- * @template [T=any]
- * @template [TResult1=T]
- * @template [TResult2=never]
- * @template {any[]} [C=any[]]
- * @callback AsPromiseFunction
- * @param {ERef<T | Vow<T>>} specimenP
- * @param {Watcher<T, TResult1, TResult2, C>} [watcher]
- * @param {C} [watcherArgs]
- * @returns {Promise<TResult1 | TResult2>}
- */