@agoric/internal 0.3.3-dev-43dd3ec.0 → 0.3.3-dev-6909994.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/internal",
-  "version": "0.3.3-dev-43dd3ec.0+43dd3ec",
+  "version": "0.3.3-dev-6909994.0+6909994",
   "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-43dd3ec.0+43dd3ec",
+    "@agoric/base-zone": "0.1.1-dev-6909994.0+6909994",
     "@endo/common": "^1.2.5",
     "@endo/errors": "^1.2.5",
     "@endo/far": "^1.1.5",
@@ -59,5 +59,5 @@
   "typeCoverage": {
     "atLeast": 93.42
   },
-  "gitHead": "43dd3ec21c2f8a885af8e3c1d038437e8d2dc8e5"
+  "gitHead": "6909994fc7df88c73d6a476f4d10f56aea85bea5"
 }

package/src/index.d.ts

@@ -5,7 +5,7 @@ export * from "./utils.js";
 export * from "./method-tools.js";
 export * from "./typeCheck.js";
 export * from "./typeGuards.js";
-export * from "./types.js";
+export * from "./types-index.js";
 export { objectMap } from "@endo/common/object-map.js";
 export { objectMetaMap } from "@endo/common/object-meta-map.js";
 export { fromUniqueEntries } from "@endo/common/from-unique-entries.js";

package/src/index.js

@@ -11,7 +11,7 @@ export * from './typeCheck.js';
 export * from './typeGuards.js';
 
 // eslint-disable-next-line import/export -- just types
-export * from './types.js';
+export * from './types-index.js';
 
 export { objectMap } from '@endo/common/object-map.js';
 export { objectMetaMap } from '@endo/common/object-meta-map.js';

package/src/types-index.d.ts

@@ -0,0 +1 @@
+export * from './types.js';

package/src/types.d.ts

@@ -1,39 +1,27 @@
-/* eslint-disable max-classes-per-file */
 import type { ERef, RemotableBrand } from '@endo/eventual-send';
 import type { Primitive } from '@endo/pass-style';
+import type { Pattern } from '@endo/patterns';
 import type { Callable } from './utils.js';
-
 /**
  * A map corresponding with a total function such that `get(key)` is assumed to
  * always succeed.
  */
 export type TotalMap<K, V> = Omit<Map<K, V>, 'get'> & {
-  /** Returns the element associated with the specified key in the TotalMap. */
-  get: (key: K) => V;
+    /** Returns the element associated with the specified key in the TotalMap. */
+    get: (key: K) => V;
 };
-export type TotalMapFrom<M extends Map> =
-  M extends Map<infer K, infer V> ? TotalMap<K, V> : never;
-
+export type TotalMapFrom<M extends Map<any, any>> = M extends Map<infer K, infer V> ? TotalMap<K, V> : never;
 export declare class Callback<I extends (...args: any[]) => any> {
-  private iface: I;
-
-  public target: any;
-
-  public methodName?: PropertyKey;
-
-  public bound: unknown[];
-
-  public isSync: boolean;
+    private iface;
+    target: any;
+    methodName?: PropertyKey;
+    bound: unknown[];
+    isSync: boolean;
 }
-
-export declare class SyncCallback<
-  I extends (...args: unknown[]) => any,
-> extends Callback<I> {
-  private syncIface: I;
-
-  public isSync: true;
+export declare class SyncCallback<I extends (...args: unknown[]) => any> extends Callback<I> {
+    private syncIface;
+    isSync: true;
 }
-
 /**
 Returns a boolean for whether the given type is primitive value or primitive type.
  
@@ -50,48 +38,28 @@ IsPrimitive<Object>
 ```
  */
 export type IsPrimitive<T> = [T] extends [Primitive] ? true : false;
-
 /** Recursively extract the non-callable properties of T */
-export type DataOnly<T> =
-  IsPrimitive<T> extends true
-    ? T
-    : T extends Callable
-      ? never
-      : { [P in keyof T as T[P] extends Callable ? never : P]: DataOnly<T[P]> };
-
+export type DataOnly<T> = IsPrimitive<T> extends true ? T : T extends Callable ? never : {
+    [P in keyof T as T[P] extends Callable ? never : P]: DataOnly<T[P]>;
+};
 /**
  * A type that doesn't assume its parameter is local, but is satisfied with both
  * local and remote references. It accepts both near and marshalled references
  * that were returned from `Remotable` or `Far`.
  */
-export type Remote<Primary, Local = DataOnly<Primary>> =
-  | Primary
-  | RemotableBrand<Local, Primary>;
-
-// TODO: Add type tests for FarRef and Remote.
+export type Remote<Primary, Local = DataOnly<Primary>> = Primary | RemotableBrand<Local, Primary>;
 /**
  * Potentially remote promises or settled references.
  */
-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
- */
+export type FarRef<Primary, Local = DataOnly<Primary>> = ERef<Remote<Primary, Local>>;
 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
+export type TypedPattern<T> = Pattern & {
+    [validatedType]?: T;
+};
+export declare type PatternType<TM extends TypedPattern<any>> = TM extends TypedPattern<infer T> ? T : never;
 /**
  * Returning normally indicates success. Match failure is indicated by
  * throwing.
@@ -100,8 +68,6 @@ export declare type PatternType<TM extends TypedPattern<any>> =
  *
  * @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;
+export declare type MustMatch = <P extends Pattern>(specimen: unknown, pattern: P, label?: string | number) => asserts specimen is P extends TypedPattern<any> ? PatternType<P> : unknown;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG;IACpD,6EAA6E;IAC7E,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;CACpB,CAAC;AACF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,IAC9C,CAAC,SAAS,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC;AAE3D,MAAM,CAAC,OAAO,OAAO,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG;IAC7D,OAAO,CAAC,KAAK,CAAI;IAEV,MAAM,EAAE,GAAG,CAAC;IAEZ,UAAU,CAAC,EAAE,WAAW,CAAC;IAEzB,KAAK,EAAE,OAAO,EAAE,CAAC;IAEjB,MAAM,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,OAAO,YAAY,CAC/B,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,GAAG,CACrC,SAAQ,QAAQ,CAAC,CAAC,CAAC;IACnB,OAAO,CAAC,SAAS,CAAI;IAEd,MAAM,EAAE,IAAI,CAAC;CACrB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAEpE,2DAA2D;AAC3D,MAAM,MAAM,QAAQ,CAAC,CAAC,IACpB,WAAW,CAAC,CAAC,CAAC,SAAS,IAAI,GACvB,CAAC,GACD,CAAC,SAAS,QAAQ,GAChB,KAAK,GACL;KAAG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,KAAK,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAAC,OAAO,EAAE,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IACjD,OAAO,GACP,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAGnC;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,OAAO,EAAE,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,IAAI,CAC3D,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CACvB,CAAC;AAQF,OAAO,CAAC,MAAM,aAAa,EAAE,OAAO,MAAM,CAAC;AAC3C;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,OAAO,GAAG;IAAE,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAA;CAAE,CAAC;AAEhE,MAAM,CAAC,OAAO,MAAM,WAAW,CAAC,EAAE,SAAS,YAAY,CAAC,GAAG,CAAC,IAC1D,EAAE,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAG/C;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,MAAM,SAAS,GAAG,CAAC,CAAC,SAAS,OAAO,EAChD,QAAQ,EAAE,OAAO,EACjB,OAAO,EAAE,CAAC,EACV,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,KACpB,OAAO,CAAC,QAAQ,IAAI,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC"}

package/src/types.ts

@@ -0,0 +1,108 @@
+/* eslint-disable max-classes-per-file */
+import type { ERef, RemotableBrand } from '@endo/eventual-send';
+import type { Primitive } from '@endo/pass-style';
+import type { Pattern } from '@endo/patterns';
+import type { Callable } from './utils.js';
+
+/**
+ * A map corresponding with a total function such that `get(key)` is assumed to
+ * always succeed.
+ */
+export type TotalMap<K, V> = Omit<Map<K, V>, 'get'> & {
+  /** Returns the element associated with the specified key in the TotalMap. */
+  get: (key: K) => V;
+};
+export type TotalMapFrom<M extends Map<any, any>> =
+  M extends Map<infer K, infer V> ? TotalMap<K, V> : never;
+
+export declare class Callback<I extends (...args: any[]) => any> {
+  private iface: I;
+
+  public target: any;
+
+  public methodName?: PropertyKey;
+
+  public bound: unknown[];
+
+  public isSync: boolean;
+}
+
+export declare class SyncCallback<
+  I extends (...args: unknown[]) => any,
+> extends Callback<I> {
+  private syncIface: I;
+
+  public isSync: true;
+}
+
+/**
+Returns a boolean for whether the given type is primitive value or primitive type.
+ 
+@example
+```
+IsPrimitive<'string'>
+//=> true
+ 
+IsPrimitive<string>
+//=> true
+ 
+IsPrimitive<Object>
+//=> false
+```
+ */
+export type IsPrimitive<T> = [T] extends [Primitive] ? true : false;
+
+/** Recursively extract the non-callable properties of T */
+export type DataOnly<T> =
+  IsPrimitive<T> extends true
+    ? T
+    : T extends Callable
+      ? never
+      : { [P in keyof T as T[P] extends Callable ? never : P]: DataOnly<T[P]> };
+
+/**
+ * A type that doesn't assume its parameter is local, but is satisfied with both
+ * local and remote references. It accepts both near and marshalled references
+ * that were returned from `Remotable` or `Far`.
+ */
+export type Remote<Primary, Local = DataOnly<Primary>> =
+  | Primary
+  | RemotableBrand<Local, Primary>;
+
+// TODO: Add type tests for FarRef and Remote.
+/**
+ * Potentially remote promises or settled references.
+ */
+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;