@agoric/vow 0.1.1-dev-01a1123.0 → 0.1.1-dev-0af876f.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agoric/vow",
3
- "version": "0.1.1-dev-01a1123.0+01a1123",
3
+ "version": "0.1.1-dev-0af876f.0+0af876f",
4
4
  "description": "Remote (shortening and disconnection-tolerant) Promise-likes",
5
5
  "type": "module",
6
6
  "main": "src/index.js",
@@ -20,8 +20,8 @@
20
20
  "lint:types": "tsc"
21
21
  },
22
22
  "dependencies": {
23
- "@agoric/base-zone": "0.1.1-dev-01a1123.0+01a1123",
24
- "@agoric/internal": "0.3.3-dev-01a1123.0+01a1123",
23
+ "@agoric/base-zone": "0.1.1-dev-0af876f.0+0af876f",
24
+ "@agoric/internal": "0.3.3-dev-0af876f.0+0af876f",
25
25
  "@endo/env-options": "^1.1.4",
26
26
  "@endo/eventual-send": "^1.2.2",
27
27
  "@endo/pass-style": "^1.4.0",
@@ -53,5 +53,5 @@
53
53
  "typeCoverage": {
54
54
  "atLeast": 89.6
55
55
  },
56
- "gitHead": "01a1123a526b11e11fa1ef80e0c532a616cd29b9"
56
+ "gitHead": "0af876fb087f76a8144730969bb88b13403d02db"
57
57
  }
package/src/tools.d.ts CHANGED
@@ -2,7 +2,7 @@ export function prepareVowTools(zone: Zone, powers?: {
2
2
  isRetryableReason?: IsRetryableReason | undefined;
3
3
  } | undefined): {
4
4
  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>;
5
- watch: <T = any, TResult1 = T, TResult2 = never, C = any>(specimenP: import("./types.js").ERef<T | import("./types.js").Vow<T>>, watcher?: import("./types.js").Watcher<T, TResult1, TResult2> | undefined, watcherContext?: C | undefined) => import("./types.js").Vow<Exclude<TResult1, void> | Exclude<TResult2, void> extends never ? TResult1 : Exclude<TResult1, void> | Exclude<TResult2, void>>;
5
+ watch: <T = any, TResult1 = T, TResult2 = never, C extends any[] = any[]>(specimenP: import("./types.js").ERef<T | import("./types.js").Vow<T>>, watcher?: import("./types.js").Watcher<T, TResult1, TResult2, C> | undefined, ...watcherArgs: C) => import("./types.js").Vow<Exclude<TResult1, void> | Exclude<TResult2, void> extends never ? TResult1 : Exclude<TResult1, void> | Exclude<TResult2, void>>;
6
6
  makeVowKit: <T>() => import("./types.js").VowKit<T>;
7
7
  allVows: (vows: unknown[]) => import("./types.js").Vow<any[]>;
8
8
  };
package/src/types.d.ts CHANGED
@@ -40,9 +40,9 @@ export type VowResolver<T = any> = {
40
40
  resolve(value?: T | PromiseVow<T>): void;
41
41
  reject(reason?: any): void;
42
42
  };
43
- export type Watcher<T = any, TResult1 = T, TResult2 = never, C = any> = {
44
- onFulfilled?: ((value: T, context?: C) => Vow<TResult1> | PromiseVow<TResult1> | TResult1) | undefined;
45
- onRejected?: ((reason: any) => Vow<TResult2> | PromiseVow<TResult2> | TResult2) | undefined;
43
+ export type Watcher<T = any, TResult1 = T, TResult2 = never, C extends any[] = any[]> = {
44
+ onFulfilled?: ((value: T, ...args: C) => Vow<TResult1> | PromiseVow<TResult1> | TResult1) | undefined;
45
+ onRejected?: ((reason: any, ...args: C) => Vow<TResult2> | PromiseVow<TResult2> | TResult2) | undefined;
46
46
  };
47
47
  import type { RemotableObject } from '@endo/pass-style';
48
48
  import type { Remote } from '@agoric/internal';
@@ -1 +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;;;;;oBAMlB,CAAC,IACD,CACZ,CAAK,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GACvC,CAAK,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAC/C,CAAK,CACF;;;;;;;kBAIU,CAAC;;;;;;;aAMD,MAAM,OAAO,CAAC,CAAC,CAAC;;uBAOhB,CAAC;WAED,eAAe,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;;gBAIlC,CAAC,UACF,WAAW,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;mBAI/B,CAAC,UACF;IACZ,GAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAChB,QAAY,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,UACR,CAAC;2BAEO,CAAC,YAAY,CAAC,KAAK,GAAG,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ;2BACjE,GAAG,KAAK,GAAG,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ;;qCAjF5C,kBAAkB;4BAC3B,kBAAkB;gCAFd,kBAAkB"}
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;;;;;oBAMlB,CAAC,IACD,CACZ,CAAK,SAAS,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GACvC,CAAK,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAC/C,CAAK,CACF;;;;;;;kBAIU,CAAC;;;;;;;aAMD,MAAM,OAAO,CAAC,CAAC,CAAC;;uBAOhB,CAAC;WAED,eAAe,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;;gBAIlC,CAAC,UACF,WAAW,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;mBAI/B,CAAC,UACF;IACZ,GAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAChB,QAAY,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;;qCAjFxD,kBAAkB;4BAC3B,kBAAkB;gCAFd,kBAAkB"}
package/src/types.js CHANGED
@@ -81,8 +81,8 @@ export {};
81
81
  * @template [T=any]
82
82
  * @template [TResult1=T]
83
83
  * @template [TResult2=never]
84
- * @template [C=any] watcher context
84
+ * @template {any[]} [C=any[]] watcher args
85
85
  * @typedef {object} Watcher
86
- * @property {(value: T, context?: C) => Vow<TResult1> | PromiseVow<TResult1> | TResult1} [onFulfilled]
87
- * @property {(reason: any) => Vow<TResult2> | PromiseVow<TResult2> | TResult2} [onRejected]
86
+ * @property {(value: T, ...args: C) => Vow<TResult1> | PromiseVow<TResult1> | TResult1} [onFulfilled]
87
+ * @property {(reason: any, ...args: C) => Vow<TResult2> | PromiseVow<TResult2> | TResult2} [onRejected]
88
88
  */
@@ -111,7 +111,7 @@ export const prepareWatchUtils = (zone, watch, makeVowKit) => {
111
111
  }
112
112
  resolver.resolve(harden(results));
113
113
  },
114
- onRejected(value, { id }) {
114
+ onRejected(value, { id, index: _index }) {
115
115
  const { idToVowState } = this.state;
116
116
  if (!idToVowState.has(id)) {
117
117
  // First rejection wins.
package/src/watch.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export function prepareWatch(zone: Zone, makeVowKit: () => VowKit<any>, isRetryableReason?: ((reason: any, lastValue: any) => any) | undefined): <T = any, TResult1 = T, TResult2 = never, C = any>(specimenP: ERef<T | Vow<T>>, watcher?: Watcher<T, TResult1, TResult2> | undefined, watcherContext?: C | undefined) => Vow<Exclude<TResult1, void> | Exclude<TResult2, void> extends never ? TResult1 : Exclude<TResult1, void> | Exclude<TResult2, void>>;
1
+ export function prepareWatch(zone: Zone, makeVowKit: () => VowKit<any>, isRetryableReason?: ((reason: any, lastValue: any) => any) | undefined): <T = any, TResult1 = T, TResult2 = never, C extends any[] = any[]>(specimenP: ERef<T | Vow<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>>;
2
2
  export type Watch = ReturnType<typeof prepareWatch>;
3
3
  import type { Zone } from '@agoric/base-zone';
4
4
  import type { VowKit } from './types.js';
@@ -1 +1 @@
1
- {"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["watch.js"],"names":[],"mappings":"AAkIO,mCAJI,IAAI,cACJ,MAAM,OAAO,GAAG,CAAC,gCACR,GAAG,aAAa,GAAG,KAAK,GAAG,iBAe/B,CAAC,QACD,QAAQ,MACR,QAAQ,UACR,CAAC,mBACJ,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,+NA0B5B;oBAIa,UAAU,CAAC,OAAO,YAAY,CAAC;0BA1KJ,mBAAmB;4BACmB,YAAY;yBAAZ,YAAY;0BAAZ,YAAY;6BAAZ,YAAY"}
1
+ {"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["watch.js"],"names":[],"mappings":"AAkIO,mCAJI,IAAI,cACJ,MAAM,OAAO,GAAG,CAAC,gCACR,GAAG,aAAa,GAAG,KAAK,GAAG,iBAe/B,CAAC,QACD,QAAQ,MACR,QAAQ,UACA,CAAC,SAAT,GAAG,EAAG,qBACT,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,2EAEhB,CAAC,yIAoBb;oBAIa,UAAU,CAAC,OAAO,YAAY,CAAC;0BAtKJ,mBAAmB;4BACmB,YAAY;yBAAZ,YAAY;0BAAZ,YAAY;6BAAZ,YAAY"}
package/src/watch.js CHANGED
@@ -38,14 +38,14 @@ const makeWatchNextStep =
38
38
  * @param {Watcher<unknown, unknown, unknown> | undefined} watcher
39
39
  * @param {keyof Required<Watcher>} wcb
40
40
  * @param {unknown} value
41
- * @param {unknown} [watcherContext]
41
+ * @param {unknown[]} [watcherArgs]
42
42
  */
43
- const settle = (resolver, watcher, wcb, value, watcherContext) => {
43
+ const settle = (resolver, watcher, wcb, value, watcherArgs = []) => {
44
44
  try {
45
45
  let chainedValue = value;
46
46
  const w = watcher && watcher[wcb];
47
47
  if (w) {
48
- chainedValue = apply(w, watcher, [value, watcherContext]);
48
+ chainedValue = apply(w, watcher, [value, ...watcherArgs]);
49
49
  } else if (wcb === 'onRejected') {
50
50
  throw value;
51
51
  }
@@ -75,22 +75,22 @@ const preparePromiseWatcher = (zone, isRetryableReason, watchNextStep) =>
75
75
  * @template [TResult2=never]
76
76
  * @param {VowResolver<TResult1 | TResult2>} resolver
77
77
  * @param {Watcher<T, TResult1, TResult2>} [watcher]
78
- * @param {unknown} [watcherContext]
78
+ * @param {unknown[]} [watcherArgs]
79
79
  */
80
- (resolver, watcher, watcherContext) => {
80
+ (resolver, watcher, watcherArgs) => {
81
81
  const state = {
82
82
  vow: /** @type {unknown} */ (undefined),
83
83
  priorRetryValue: /** @type {any} */ (undefined),
84
84
  resolver,
85
85
  watcher,
86
- watcherContext: harden(watcherContext),
86
+ watcherArgs: harden(watcherArgs),
87
87
  };
88
88
  return /** @type {Partial<typeof state>} */ (state);
89
89
  },
90
90
  {
91
91
  /** @type {Required<PromiseWatcher>['onFulfilled']} */
92
92
  onFulfilled(value) {
93
- const { watcher, watcherContext, resolver } = this.state;
93
+ const { watcher, watcherArgs, resolver } = this.state;
94
94
  if (getVowPayload(value)) {
95
95
  // We've been shortened, so reflect our state accordingly, and go again.
96
96
  this.state.vow = value;
@@ -100,11 +100,11 @@ const preparePromiseWatcher = (zone, isRetryableReason, watchNextStep) =>
100
100
  this.state.priorRetryValue = undefined;
101
101
  this.state.watcher = undefined;
102
102
  this.state.resolver = undefined;
103
- settle(resolver, watcher, 'onFulfilled', value, watcherContext);
103
+ settle(resolver, watcher, 'onFulfilled', value, watcherArgs);
104
104
  },
105
105
  /** @type {Required<PromiseWatcher>['onRejected']} */
106
106
  onRejected(reason) {
107
- const { vow, watcher, watcherContext, resolver, priorRetryValue } =
107
+ const { vow, watcher, watcherArgs, resolver, priorRetryValue } =
108
108
  this.state;
109
109
  if (vow) {
110
110
  const retryValue = isRetryableReason(reason, priorRetryValue);
@@ -118,7 +118,7 @@ const preparePromiseWatcher = (zone, isRetryableReason, watchNextStep) =>
118
118
  this.state.priorRetryValue = undefined;
119
119
  this.state.resolver = undefined;
120
120
  this.state.watcher = undefined;
121
- settle(resolver, watcher, 'onRejected', reason, watcherContext);
121
+ settle(resolver, watcher, 'onRejected', reason, watcherArgs);
122
122
  },
123
123
  },
124
124
  );
@@ -144,12 +144,12 @@ export const prepareWatch = (
144
144
  * @template [T=any]
145
145
  * @template [TResult1=T]
146
146
  * @template [TResult2=never]
147
- * @template [C=any] watcher context
147
+ * @template {any[]} [C=any[]] watcher args
148
148
  * @param {ERef<T | Vow<T>>} specimenP
149
- * @param {Watcher<T, TResult1, TResult2>} [watcher]
150
- * @param {C} [watcherContext]
149
+ * @param {Watcher<T, TResult1, TResult2, C>} [watcher]
150
+ * @param {C} watcherArgs
151
151
  */
152
- const watch = (specimenP, watcher, watcherContext) => {
152
+ const watch = (specimenP, watcher, ...watcherArgs) => {
153
153
  /** @typedef {Exclude<TResult1, void> | Exclude<TResult2, void>} Voidless */
154
154
  /** @typedef {Voidless extends never ? TResult1 : Voidless} Narrowest */
155
155
  /** @type {VowKit<Narrowest>} */
@@ -157,11 +157,7 @@ export const prepareWatch = (
157
157
 
158
158
  // Create a promise watcher to track vows, retrying upon rejection as
159
159
  // controlled by `isRetryableReason`.
160
- const promiseWatcher = makePromiseWatcher(
161
- resolver,
162
- watcher,
163
- watcherContext,
164
- );
160
+ const promiseWatcher = makePromiseWatcher(resolver, watcher, watcherArgs);
165
161
 
166
162
  // Coerce the specimen to a promise, and start the watcher cycle.
167
163
  zone.watchPromise(basicE.resolve(specimenP), promiseWatcher);