@agoric/vow 0.1.1-dev-303a9f2.0 → 0.1.1-dev-b953651.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/vow",
-  "version": "0.1.1-dev-303a9f2.0+303a9f2",
+  "version": "0.1.1-dev-b953651.0+b953651",
   "description": "Remote (shortening and disconnection-tolerant) Promise-likes",
   "type": "module",
   "main": "src/index.js",
@@ -20,8 +20,8 @@
     "lint:types": "tsc"
   },
   "dependencies": {
-    "@agoric/base-zone": "0.1.1-dev-303a9f2.0+303a9f2",
-    "@agoric/internal": "0.3.3-dev-303a9f2.0+303a9f2",
+    "@agoric/base-zone": "0.1.1-dev-b953651.0+b953651",
+    "@agoric/internal": "0.3.3-dev-b953651.0+b953651",
     "@endo/env-options": "^1.1.4",
     "@endo/eventual-send": "^1.2.2",
     "@endo/pass-style": "^1.4.0",
@@ -54,5 +54,5 @@
   "typeCoverage": {
     "atLeast": 89.34
   },
-  "gitHead": "303a9f20404106fe9c09befbd728ed7a20ccf7e0"
+  "gitHead": "b95365108e7b1db73148bd742d46cae30890683b"
 }

package/src/index.d.ts

@@ -1,5 +1,5 @@
 export * from "./tools.js";
 export * from "./types.js";
 export { default as makeE } from "./E.js";
-export { VowShape } from "./vow-utils.js";
+export { VowShape, toPassableCap } from "./vow-utils.js";
 //# sourceMappingURL=index.d.ts.map

package/src/index.js

@@ -1,7 +1,7 @@
 // @ts-check
 export * from './tools.js';
 export { default as makeE } from './E.js';
-export { VowShape } from './vow-utils.js';
+export { VowShape, toPassableCap } from './vow-utils.js';
 
 // eslint-disable-next-line import/export
 export * from './types.js';

package/src/vow-utils.d.ts

@@ -1,7 +1,10 @@
 export { basicE };
 export const VowShape: import("@endo/patterns").Matcher;
-export function isVow(specimen: any): boolean;
+export function isVow(specimen: unknown): specimen is Vow;
 export function getVowPayload<T>(specimen: any): VowPayload<T> | undefined;
+export function toPassableCap(k: PassableCap | Vow): PassableCap;
 import { E as basicE } from '@endo/eventual-send';
-import type { VowPayload } from './types';
+import type { Vow } from './types.js';
+import type { VowPayload } from './types.js';
+import type { PassableCap } from '@endo/pass-style';
 //# sourceMappingURL=vow-utils.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"vow-utils.d.ts","sourceRoot":"","sources":["vow-utils.js"],"names":[],"mappings":";AASA,wDAKE;AAEK,8CAC8C;AAc9C,8BAFiB,CAAC,YADd,GAAG,6BAUb;4BArC2B,qBAAqB;gCAId,SAAS"}
+{"version":3,"file":"vow-utils.d.ts","sourceRoot":"","sources":["vow-utils.js"],"names":[],"mappings":";AAYA,wDAKE;AAMK,gCAHI,OAAO,mBAImC;AAc9C,8BAFiB,CAAC,YADd,GAAG,6BAUb;AAoBM,iEAQN;4BAxE2B,qBAAqB;yBAMf,YAAY;gCAAZ,YAAY;iCADhB,kBAAkB"}

package/src/vow-utils.js

@@ -3,7 +3,10 @@ import { E as basicE } from '@endo/eventual-send';
 import { isPassable } from '@endo/pass-style';
 import { M, matches } from '@endo/patterns';
 
-/** @import {VowPayload, Vow} from './types' */
+/**
+ * @import {PassableCap} from '@endo/pass-style'
+ * @import {VowPayload, Vow} from './types.js'
+ */
 
 export { basicE };
 
@@ -14,6 +17,10 @@ export const VowShape = M.tagged(
   }),
 );
 
+/**
+ * @param {unknown} specimen
+ * @returns {specimen is Vow}
+ */
 export const isVow = specimen =>
   isPassable(specimen) && matches(specimen, VowShape);
 harden(isVow);
@@ -38,3 +45,31 @@ export const getVowPayload = specimen => {
   return vow.payload;
 };
 harden(getVowPayload);
+
+/**
+ * For when you have a Vow or a `PassableCap` (`RemotableObject` or
+ * passable `Promise`) and you need `PassableCap`,
+ * typically to serve as a key in a `Map`, `WeakMap`, `Store`, or `WeakStore`.
+ *
+ * Relies on, and encapsulates, the current "V0" representation of a vow
+ * as containing a unique remotable shortener.
+ *
+ * Note: if `k` is not a `Vow`, `toPassableCap` does no enforcement that `k`
+ * is already a `PassableCap`. Rather, it just acts as an identity function
+ * returning `k` without further checking. The types only describe the
+ * intended use. (If warranted, we may later add such enforcement, so please
+ * do not rely on either the presence or absence of such enforcement.)
+ *
+ * @param {PassableCap | Vow} k
+ * @returns {PassableCap}
+ */
+export const toPassableCap = k => {
+  const payload = getVowPayload(k);
+  if (payload === undefined) {
+    return /** @type {PassableCap} */ (k);
+  }
+  const { vowV0 } = payload;
+  // vowMap.set(vowV0, h);
+  return vowV0;
+};
+harden(toPassableCap);