@agoric/internal 0.3.3-dev-24528f1.0 → 0.3.3-dev-3f2cb5c.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/internal",
-  "version": "0.3.3-dev-24528f1.0+24528f1",
+  "version": "0.3.3-dev-3f2cb5c.0+3f2cb5c",
   "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-24528f1.0+24528f1",
+    "@agoric/base-zone": "0.1.1-dev-3f2cb5c.0+3f2cb5c",
     "@endo/common": "^1.2.2",
     "@endo/errors": "^1.2.2",
     "@endo/far": "^1.1.2",
@@ -34,6 +34,7 @@
     "jessie.js": "^0.3.4"
   },
   "devDependencies": {
+    "@endo/exo": "^1.5.0",
     "@endo/init": "^1.1.2",
     "ava": "^5.3.0",
     "tsd": "^0.31.1"
@@ -56,7 +57,7 @@
     "access": "public"
   },
   "typeCoverage": {
-    "atLeast": 93.89
+    "atLeast": 93.78
   },
-  "gitHead": "24528f1e377f41e13e9fe47a6f04c0f4b0c33452"
+  "gitHead": "3f2cb5ca05d2514ceef73764618536263ef7a835"
 }

package/src/index.d.ts

@@ -3,6 +3,7 @@ export * from "./debug.js";
 export * from "./errors.js";
 export * from "./utils.js";
 export * from "./method-tools.js";
+export * from "./typeCheck.js";
 export * from "./typeGuards.js";
 export * from "./types.js";
 export { objectMap } from "@endo/common/object-map.js";

package/src/index.js

@@ -7,6 +7,7 @@ export * from './debug.js';
 export * from './errors.js';
 export * from './utils.js';
 export * from './method-tools.js';
+export * from './typeCheck.js';
 export * from './typeGuards.js';
 
 // eslint-disable-next-line import/export -- just types

package/src/typeCheck.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @import {MustMatch, PatternType, TypedPattern} from './types.js';
+ */
+/** @type {MustMatch} */
+export const mustMatch: MustMatch;
+export function cast<M>(specimen: unknown, patt: TypedPattern<M>): M;
+import type { MustMatch } from './types.js';
+import type { TypedPattern } from './types.js';
+//# sourceMappingURL=typeCheck.d.ts.map

package/src/typeCheck.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeCheck.d.ts","sourceRoot":"","sources":["typeCheck.js"],"names":[],"mappings":"AAGA;;GAEG;AAEH,wBAAwB;AACxB,wBADW,SAAS,CACuB;AAQpC,qBALM,CAAC,YACH,OAAO,QACP,aAAa,CAAC,CAAC,GACb,CAAC,CAQb;+BAlBsD,YAAY;kCAAZ,YAAY"}

package/src/typeCheck.js

@@ -0,0 +1,23 @@
+// @ts-check
+import { mustMatch as typelessMustMatch } from '@endo/patterns';
+
+/**
+ * @import {MustMatch, PatternType, TypedPattern} from './types.js';
+ */
+
+/** @type {MustMatch} */
+export const mustMatch = typelessMustMatch;
+
+/**
+ * @template M
+ * @param {unknown} specimen
+ * @param {TypedPattern<M>} patt
+ * @returns {M}
+ */
+export const cast = (specimen, patt) => {
+  // mustMatch throws if they don't, which means that `cast` also narrows the
+  // type but a function can't both narrow and return a type. That is by design:
+  // https://github.com/microsoft/TypeScript/issues/34636#issuecomment-545025916
+  mustMatch(specimen, patt);
+  return specimen;
+};

package/src/types.d.ts

@@ -64,3 +64,33 @@ export type Remote<Primary, Local = DataOnly<Primary>> =
 export type FarRef<Primary, Local = DataOnly<Primary>> = ERef<
   Remote<Primary, Local>
 >;
+
+/*
+ * Stop-gap until https://github.com/Agoric/agoric-sdk/issues/6160
+ * explictly specify the type that the Pattern will verify through a match.
+ *
+ * TODO move all this pattern typing stuff to @endo/patterns
+ */
+declare const validatedType: unique symbol;
+/**
+ * Tag a pattern with the static type it represents.
+ */
+export type TypedPattern<T> = Pattern & { [validatedType]?: T };
+
+export declare type PatternType<TM extends TypedPattern<any>> =
+  TM extends TypedPattern<infer T> ? T : never;
+
+// TODO make Endo's mustMatch do this
+/**
+ * Returning normally indicates success. Match failure is indicated by
+ * throwing.
+ *
+ * Note: remotables can only be matched as "remotable", not the specific kind.
+ *
+ * @see {import('@endo/patterns').mustMatch} for the implementation. This one has a type annotation to narrow if the pattern is a TypedPattern.
+ */
+export declare type MustMatch = <P extends Pattern>(
+  specimen: unknown,
+  pattern: P,
+  label?: string | number,
+) => asserts specimen is P extends TypedPattern<any> ? PatternType<P> : unknown;