@agoric/swingset-liveslots 0.10.3-u18.1 → 0.10.3-u19.0

package/src/vatDataTypes.d.ts

@@ -0,0 +1,170 @@
+/**
+ * @file Types for vat-data
+ *
+ * Facet is a single object with methods.
+ * Behavior is a description when defining a kind of what facets it will have.
+ * For the non-multi defineKind, there is just one facet so it doesn't have a key.
+ */
+import type { MapStore, SetStore, StoreOptions, WeakMapStore, WeakSetStore } from '@agoric/store';
+import type { Amplify, IsInstance, ReceivePower, StateShape } from '@endo/exo';
+import type { RemotableObject } from '@endo/pass-style';
+import type { RemotableBrand } from '@endo/eventual-send';
+import type { InterfaceGuard, Pattern } from '@endo/patterns';
+import type { makeWatchedPromiseManager } from './watchedPromises.js';
+export type InterfaceGuardKit = Record<string, InterfaceGuard>;
+export type { MapStore, Pattern };
+export type Baggage = MapStore<string, any>;
+type WatchedPromisesManager = ReturnType<typeof makeWatchedPromiseManager>;
+type OmitFirstArg<F> = F extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
+type PrimaryRemotable<O> = O & RemotableObject & RemotableBrand<object, O>;
+export type KindFacet<O> = PrimaryRemotable<{
+    [K in keyof O]: OmitFirstArg<O[K]>;
+}>;
+export type KindFacets<B> = {
+    [FacetKey in keyof B]: KindFacet<B[FacetKey]>;
+};
+export type KindContext<S, F> = {
+    state: S;
+    self: KindFacet<F>;
+};
+export type MultiKindContext<S, B> = {
+    state: S;
+    facets: KindFacets<B>;
+};
+export type PlusContext<C, M extends (...args: any[]) => any> = (c: C, ...args: Parameters<M>) => ReturnType<M>;
+export type FunctionsPlusContext<C, O extends Record<string, (...args: any[]) => any>> = {
+    [K in keyof O]: PlusContext<C, O[K]>;
+};
+declare class DurableKindHandleClass {
+    private descriptionTag;
+}
+export type DurableKindHandle = DurableKindHandleClass;
+/**
+ * Grab bag of options that can be provided to `defineDurableKind` and its
+ * siblings. Not all options are meaningful in all contexts. See the
+ * doc-comments on each option.
+ */
+export type DefineKindOptions<C> = {
+    /**
+     * If provided, the `finish` function will be called after the instance is
+     * made and internally registered, but before it is returned. The finish
+     * function is to do any post-intantiation initialization that should be
+     * done before exposing the object to its clients.
+     */
+    finish?: (context: C) => void;
+    /**
+     * If provided, it describes the shape of all state records of instances
+     * of this kind.
+     */
+    stateShape?: StateShape;
+    /**
+     * If a `receiveAmplifier` function is provided to an exo class kit definition,
+     * it will be called with an `Amplify` function. If provided to the definition
+     * of a normal exo or exo class, the definition will throw, since only
+     * exo kits can be amplified.
+     * An `Amplify` function is a function that takes a facet instance of
+     * this class kit as an argument, in which case it will return the facets
+     * record, giving access to all the facet instances of the same cohort.
+     */
+    receiveAmplifier?: ReceivePower<Amplify>;
+    /**
+     * If a `receiveInstanceTester` function is provided, it will be called
+     * during the definition of the exo class or exo class kit with an
+     * `IsInstance` function. The first argument of `IsInstance`
+     * is the value to be tested. When it may be a facet instance of an
+     * exo class kit, the optional second argument, if provided, is
+     * a `facetName`. In that case, the function tests only if the first
+     * argument is an instance of that facet of the associated exo class kit.
+     */
+    receiveInstanceTester?: ReceivePower<IsInstance>;
+    /**
+     * As a kind option, intended for internal use only.
+     * Meaningful to `makeScalarBigMapStore` and its siblings. These maker
+     * fuctions will make either virtual or durable stores, depending on
+     * this flag. Defaults to off, making virtual but not durable collections.
+     *
+     * Generally, durable collections are provided with `provideDurableMapStore`
+     * and its sibling, which use this flag internally. If you do not make
+     * durable collections by other means, you can consider this as
+     * intended for internal use only.
+     */
+    durable?: boolean;
+    /**
+     * Intended for internal use only.
+     * Should the raw methods receive their `context` argument as their first
+     * argument or as their `this` binding? For `defineDurableKind` and its
+     * siblings (including `prepareSingleton`), this defaults to off, meaning that
+     * their behavior methods receive `context` as their first argument.
+     * `prepareExoClass` and its siblings (including `prepareExo`) use
+     * this flag internally to indicate that their methods receive `context`
+     * as their `this` binding.
+     */
+    thisfulMethods?: boolean;
+    /**
+     * Intended for internal use only.
+     * Only applicable if this is a class kind. A class kit kind should use
+     * `interfaceGuardKit` instead.
+     *
+     * If an `interfaceGuard` is provided, then the raw methods passed alongside
+     * it are wrapped by a function that first checks that this method's guard
+     * pattern is satisfied before calling the raw method.
+     *
+     * In `defineDurableKind` and its siblings, this defaults to `undefined`.
+     * Exo classes use this internally to protect their raw class methods
+     * using the provided interface.
+     * In absence, an exo is protected anyway, while a bare kind is
+     * not (detected by `!thisfulMethods`),
+     */
+    interfaceGuard?: InterfaceGuard;
+    /**
+     * Intended for internal use only.
+     * Only applicable if this is a class kit kind. A class kind should use
+     * `interfaceGuard` instead.
+     *
+     * If an `interfaceGuardKit` is provided, then each member of the
+     * interfaceGuardKit is used to guard the corresponding facet of the
+     * class kit.
+     *
+     * In `defineDurableKindMulti` and its siblings, this defaults to `undefined`.
+     * Exo class kits use this internally to protect their facets.
+     * In absence, an exo is protected anyway, while a bare kind is
+     * not (detected by `!thisfulMethods`),
+     */
+    interfaceGuardKit?: InterfaceGuardKit;
+};
+export type VatData = {
+    /** @deprecated Use defineVirtualExoClass instead */
+    defineKind: <P extends Array<any>, S, F>(tag: string, init: (...args: P) => S, facet: F, options?: DefineKindOptions<KindContext<S, F>>) => (...args: P) => KindFacet<F>;
+    /** @deprecated Use defineVirtualExoClassKit instead */
+    defineKindMulti: <P extends Array<any>, S, B>(tag: string, init: (...args: P) => S, behavior: B, options?: DefineKindOptions<MultiKindContext<S, B>>) => (...args: P) => KindFacets<B>;
+    makeKindHandle: (descriptionTag: string) => DurableKindHandle;
+    /** @deprecated Use defineDurableExoClass instead */
+    defineDurableKind: <P extends Array<any>, S, F>(kindHandle: DurableKindHandle, init: (...args: P) => S, facet: F, options?: DefineKindOptions<KindContext<S, F>>) => (...args: P) => KindFacet<F>;
+    /** @deprecated Use defineDurableExoClassKit instead */
+    defineDurableKindMulti: <P extends Array<any>, S, B>(kindHandle: DurableKindHandle, init: (...args: P) => S, behavior: B, options?: DefineKindOptions<MultiKindContext<S, B>>) => (...args: P) => KindFacets<B>;
+    providePromiseWatcher: WatchedPromisesManager['providePromiseWatcher'];
+    watchPromise: WatchedPromisesManager['watchPromise'];
+    makeScalarBigMapStore: <K, V>(label: string, options?: StoreOptions) => MapStore<K, V>;
+    makeScalarBigWeakMapStore: <K, V>(label: string, options?: StoreOptions) => WeakMapStore<K, V>;
+    makeScalarBigSetStore: <K>(label: string, options?: StoreOptions) => SetStore<K>;
+    makeScalarBigWeakSetStore: <K>(label: string, options?: StoreOptions) => WeakSetStore<K>;
+    canBeDurable: (specimen: unknown) => boolean;
+};
+export interface PickFacet {
+    /**
+     * When making a multi-facet kind, it's common to pick one facet to
+     * expose. E.g.,
+     *
+     *     const makeFoo = (a, b, c, d) => makeFooBase(a, b, c, d).self;
+     *
+     * This helper reduces the duplication:
+     *
+     *     const makeFoo = pickFacet(makeFooBase, 'self');
+     */
+    <M extends (...args: any[]) => any, F extends keyof ReturnType<M>>(maker: M, facetName: F): (...args: Parameters<M>) => ReturnType<M>[F];
+}
+/** @deprecated Use prepareExoClass instead */
+export type PrepareKind = <P extends Array<any>, S, F>(baggage: Baggage, tag: string, init: (...args: P) => S, facet: F, options?: DefineKindOptions<KindContext<S, F>>) => (...args: P) => KindFacet<F>;
+/** @deprecated Use prepareExoClassKit instead */
+export type PrepareKindMulti = <P extends Array<any>, S, B>(baggage: Baggage, tag: string, init: (...args: P) => S, behavior: B, options?: DefineKindOptions<MultiKindContext<S, B>>) => (...args: P) => KindFacets<B>;
+//# sourceMappingURL=vatDataTypes.d.ts.map

package/src/vatDataTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vatDataTypes.d.ts","sourceRoot":"","sources":["vatDataTypes.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,EACV,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,YAAY,EACZ,YAAY,EACb,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC/E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAItE,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAC/D,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAKlC,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE5C,KAAK,sBAAsB,GAAG,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAG3E,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,MAAM,CAAC,GAClE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GACjB,KAAK,CAAC;AAIV,KAAK,gBAAgB,CAAC,CAAC,IAAI,CAAC,GAAG,eAAe,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAE3E,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,gBAAgB,CAAC;KACzC,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACnC,CAAC,CAAC;AAEH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;KACzB,QAAQ,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI;IAAE,KAAK,EAAE,CAAC,CAAC;IAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;CAAE,CAAC;AACjE,MAAM,MAAM,gBAAgB,CAAC,CAAC,EAAE,CAAC,IAAI;IAAE,KAAK,EAAE,CAAC,CAAC;IAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;CAAE,CAAC;AAEzE,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,IAAI,CAC9D,CAAC,EAAE,CAAC,EACJ,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KACnB,UAAU,CAAC,CAAC,CAAC,CAAC;AAEnB,MAAM,MAAM,oBAAoB,CAC9B,CAAC,EACD,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,IAC/C;KACD,CAAC,IAAI,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC,CAAC;AAEF,OAAO,OAAO,sBAAsB;IAClC,OAAO,CAAC,cAAc,CAAS;CAChC;AACD,MAAM,MAAM,iBAAiB,GAAG,sBAAsB,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;IACjC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,IAAI,CAAC;IAE9B;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAEzC;;;;;;;;OAQG;IACH,qBAAqB,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;IAQjD;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;;OASG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IAEpB,oDAAoD;IACpD,UAAU,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EACrC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,EACvB,KAAK,EAAE,CAAC,EACR,OAAO,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAC3C,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAElC,uDAAuD;IACvD,eAAe,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAC1C,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,EACvB,QAAQ,EAAE,CAAC,EACX,OAAO,CAAC,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAChD,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC;IAGnC,cAAc,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,iBAAiB,CAAC;IAE9D,oDAAoD;IACpD,iBAAiB,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAC5C,UAAU,EAAE,iBAAiB,EAC7B,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,EACvB,KAAK,EAAE,CAAC,EACR,OAAO,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAC3C,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IAElC,uDAAuD;IACvD,sBAAsB,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EACjD,UAAU,EAAE,iBAAiB,EAC7B,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,EACvB,QAAQ,EAAE,CAAC,EACX,OAAO,CAAC,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAChD,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC;IAEnC,qBAAqB,EAAE,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;IACvE,YAAY,EAAE,sBAAsB,CAAC,cAAc,CAAC,CAAC;IAErD,qBAAqB,EAAE,CAAC,CAAC,EAAE,CAAC,EAC1B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,KACnB,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpB,yBAAyB,EAAE,CAAC,CAAC,EAAE,CAAC,EAC9B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,KACnB,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAExB,qBAAqB,EAAE,CAAC,CAAC,EACvB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,KACnB,QAAQ,CAAC,CAAC,CAAC,CAAC;IACjB,yBAAyB,EAAE,CAAC,CAAC,EAC3B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,KACnB,YAAY,CAAC,CAAC,CAAC,CAAC;IACrB,YAAY,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC;CAC9C,CAAC;AAIF,MAAM,WAAW,SAAS;IACxB;;;;;;;;;OASG;IACH,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,CAAC,SAAS,MAAM,UAAU,CAAC,CAAC,CAAC,EAC/D,KAAK,EAAE,CAAC,EACR,SAAS,EAAE,CAAC,GACX,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACjD;AAED,8CAA8C;AAC9C,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EACnD,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,EACvB,KAAK,EAAE,CAAC,EACR,OAAO,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAC3C,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;AAElC,iDAAiD;AACjD,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EACxD,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,EACvB,QAAQ,EAAE,CAAC,EACX,OAAO,CAAC,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAChD,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC"}

package/src/vatDataTypes.ts

@@ -0,0 +1,272 @@
+/**
+ * @file Types for vat-data
+ *
+ * Facet is a single object with methods.
+ * Behavior is a description when defining a kind of what facets it will have.
+ * For the non-multi defineKind, there is just one facet so it doesn't have a key.
+ */
+import type {
+  MapStore,
+  SetStore,
+  StoreOptions,
+  WeakMapStore,
+  WeakSetStore,
+} from '@agoric/store';
+import type { Amplify, IsInstance, ReceivePower, StateShape } from '@endo/exo';
+import type { RemotableObject } from '@endo/pass-style';
+import type { RemotableBrand } from '@endo/eventual-send';
+import type { InterfaceGuard, Pattern } from '@endo/patterns';
+import type { makeWatchedPromiseManager } from './watchedPromises.js';
+
+// TODO should be moved into @endo/patterns and eventually imported here
+// instead of this local definition.
+export type InterfaceGuardKit = Record<string, InterfaceGuard>;
+export type { MapStore, Pattern };
+
+// This needs `any` values.  If they were `unknown`, code that uses Baggage
+// would need explicit runtime checks or casts for every fetch, which is
+// onerous.
+export type Baggage = MapStore<string, any>;
+
+type WatchedPromisesManager = ReturnType<typeof makeWatchedPromiseManager>;
+
+// used to omit the 'context' parameter
+type OmitFirstArg<F> = F extends (x: any, ...args: infer P) => infer R
+  ? (...args: P) => R
+  : never;
+
+// The type of a passable local object with methods.
+// An internal helper to avoid having to repeat `O`.
+type PrimaryRemotable<O> = O & RemotableObject & RemotableBrand<object, O>;
+
+export type KindFacet<O> = PrimaryRemotable<{
+  [K in keyof O]: OmitFirstArg<O[K]>; // omit the 'context' parameter
+}>;
+
+export type KindFacets<B> = {
+  [FacetKey in keyof B]: KindFacet<B[FacetKey]>;
+};
+
+export type KindContext<S, F> = { state: S; self: KindFacet<F> };
+export type MultiKindContext<S, B> = { state: S; facets: KindFacets<B> };
+
+export type PlusContext<C, M extends (...args: any[]) => any> = (
+  c: C,
+  ...args: Parameters<M>
+) => ReturnType<M>;
+
+export type FunctionsPlusContext<
+  C,
+  O extends Record<string, (...args: any[]) => any>,
+> = {
+  [K in keyof O]: PlusContext<C, O[K]>;
+};
+
+declare class DurableKindHandleClass {
+  private descriptionTag: string;
+}
+export type DurableKindHandle = DurableKindHandleClass;
+
+/**
+ * Grab bag of options that can be provided to `defineDurableKind` and its
+ * siblings. Not all options are meaningful in all contexts. See the
+ * doc-comments on each option.
+ */
+export type DefineKindOptions<C> = {
+  /**
+   * If provided, the `finish` function will be called after the instance is
+   * made and internally registered, but before it is returned. The finish
+   * function is to do any post-intantiation initialization that should be
+   * done before exposing the object to its clients.
+   */
+  finish?: (context: C) => void;
+
+  /**
+   * If provided, it describes the shape of all state records of instances
+   * of this kind.
+   */
+  stateShape?: StateShape;
+
+  /**
+   * If a `receiveAmplifier` function is provided to an exo class kit definition,
+   * it will be called with an `Amplify` function. If provided to the definition
+   * of a normal exo or exo class, the definition will throw, since only
+   * exo kits can be amplified.
+   * An `Amplify` function is a function that takes a facet instance of
+   * this class kit as an argument, in which case it will return the facets
+   * record, giving access to all the facet instances of the same cohort.
+   */
+  receiveAmplifier?: ReceivePower<Amplify>;
+
+  /**
+   * If a `receiveInstanceTester` function is provided, it will be called
+   * during the definition of the exo class or exo class kit with an
+   * `IsInstance` function. The first argument of `IsInstance`
+   * is the value to be tested. When it may be a facet instance of an
+   * exo class kit, the optional second argument, if provided, is
+   * a `facetName`. In that case, the function tests only if the first
+   * argument is an instance of that facet of the associated exo class kit.
+   */
+  receiveInstanceTester?: ReceivePower<IsInstance>;
+
+  // TODO properties above are identical to those in FarClassOptions.
+  // These are the only options that should be exposed by
+  // vat-data's public virtual/durable exo APIs. This DefineKindOptions
+  // should explicitly be a subtype, where the methods below are only for
+  // internal use, i.e., below the exo level.
+
+  /**
+   * As a kind option, intended for internal use only.
+   * Meaningful to `makeScalarBigMapStore` and its siblings. These maker
+   * fuctions will make either virtual or durable stores, depending on
+   * this flag. Defaults to off, making virtual but not durable collections.
+   *
+   * Generally, durable collections are provided with `provideDurableMapStore`
+   * and its sibling, which use this flag internally. If you do not make
+   * durable collections by other means, you can consider this as
+   * intended for internal use only.
+   */
+  durable?: boolean;
+
+  /**
+   * Intended for internal use only.
+   * Should the raw methods receive their `context` argument as their first
+   * argument or as their `this` binding? For `defineDurableKind` and its
+   * siblings (including `prepareSingleton`), this defaults to off, meaning that
+   * their behavior methods receive `context` as their first argument.
+   * `prepareExoClass` and its siblings (including `prepareExo`) use
+   * this flag internally to indicate that their methods receive `context`
+   * as their `this` binding.
+   */
+  thisfulMethods?: boolean;
+
+  /**
+   * Intended for internal use only.
+   * Only applicable if this is a class kind. A class kit kind should use
+   * `interfaceGuardKit` instead.
+   *
+   * If an `interfaceGuard` is provided, then the raw methods passed alongside
+   * it are wrapped by a function that first checks that this method's guard
+   * pattern is satisfied before calling the raw method.
+   *
+   * In `defineDurableKind` and its siblings, this defaults to `undefined`.
+   * Exo classes use this internally to protect their raw class methods
+   * using the provided interface.
+   * In absence, an exo is protected anyway, while a bare kind is
+   * not (detected by `!thisfulMethods`),
+   */
+  interfaceGuard?: InterfaceGuard;
+
+  /**
+   * Intended for internal use only.
+   * Only applicable if this is a class kit kind. A class kind should use
+   * `interfaceGuard` instead.
+   *
+   * If an `interfaceGuardKit` is provided, then each member of the
+   * interfaceGuardKit is used to guard the corresponding facet of the
+   * class kit.
+   *
+   * In `defineDurableKindMulti` and its siblings, this defaults to `undefined`.
+   * Exo class kits use this internally to protect their facets.
+   * In absence, an exo is protected anyway, while a bare kind is
+   * not (detected by `!thisfulMethods`),
+   */
+  interfaceGuardKit?: InterfaceGuardKit;
+};
+
+export type VatData = {
+  // virtual kinds
+  /** @deprecated Use defineVirtualExoClass instead */
+  defineKind: <P extends Array<any>, S, F>(
+    tag: string,
+    init: (...args: P) => S,
+    facet: F,
+    options?: DefineKindOptions<KindContext<S, F>>,
+  ) => (...args: P) => KindFacet<F>;
+
+  /** @deprecated Use defineVirtualExoClassKit instead */
+  defineKindMulti: <P extends Array<any>, S, B>(
+    tag: string,
+    init: (...args: P) => S,
+    behavior: B,
+    options?: DefineKindOptions<MultiKindContext<S, B>>,
+  ) => (...args: P) => KindFacets<B>;
+
+  // durable kinds
+  makeKindHandle: (descriptionTag: string) => DurableKindHandle;
+
+  /** @deprecated Use defineDurableExoClass instead */
+  defineDurableKind: <P extends Array<any>, S, F>(
+    kindHandle: DurableKindHandle,
+    init: (...args: P) => S,
+    facet: F,
+    options?: DefineKindOptions<KindContext<S, F>>,
+  ) => (...args: P) => KindFacet<F>;
+
+  /** @deprecated Use defineDurableExoClassKit instead */
+  defineDurableKindMulti: <P extends Array<any>, S, B>(
+    kindHandle: DurableKindHandle,
+    init: (...args: P) => S,
+    behavior: B,
+    options?: DefineKindOptions<MultiKindContext<S, B>>,
+  ) => (...args: P) => KindFacets<B>;
+
+  providePromiseWatcher: WatchedPromisesManager['providePromiseWatcher'];
+  watchPromise: WatchedPromisesManager['watchPromise'];
+
+  makeScalarBigMapStore: <K, V>(
+    label: string,
+    options?: StoreOptions,
+  ) => MapStore<K, V>;
+  makeScalarBigWeakMapStore: <K, V>(
+    label: string,
+    options?: StoreOptions,
+  ) => WeakMapStore<K, V>;
+
+  makeScalarBigSetStore: <K>(
+    label: string,
+    options?: StoreOptions,
+  ) => SetStore<K>;
+  makeScalarBigWeakSetStore: <K>(
+    label: string,
+    options?: StoreOptions,
+  ) => WeakSetStore<K>;
+  canBeDurable: (specimen: unknown) => boolean;
+};
+
+// The JSDoc is repeated here and at the function definition so it appears
+// in IDEs where it's used, regardless of type resolution.
+export interface PickFacet {
+  /**
+   * When making a multi-facet kind, it's common to pick one facet to
+   * expose. E.g.,
+   *
+   *     const makeFoo = (a, b, c, d) => makeFooBase(a, b, c, d).self;
+   *
+   * This helper reduces the duplication:
+   *
+   *     const makeFoo = pickFacet(makeFooBase, 'self');
+   */
+  <M extends (...args: any[]) => any, F extends keyof ReturnType<M>>(
+    maker: M,
+    facetName: F,
+  ): (...args: Parameters<M>) => ReturnType<M>[F];
+}
+
+/** @deprecated Use prepareExoClass instead */
+export type PrepareKind = <P extends Array<any>, S, F>(
+  baggage: Baggage,
+  tag: string,
+  init: (...args: P) => S,
+  facet: F,
+  options?: DefineKindOptions<KindContext<S, F>>,
+) => (...args: P) => KindFacet<F>;
+
+/** @deprecated Use prepareExoClassKit instead */
+export type PrepareKindMulti = <P extends Array<any>, S, B>(
+  baggage: Baggage,
+  tag: string,
+  init: (...args: P) => S,
+  behavior: B,
+  options?: DefineKindOptions<MultiKindContext<S, B>>,
+) => (...args: P) => KindFacets<B>;

package/src/vatstore-iterators.d.ts

@@ -0,0 +1,4 @@
+export function enumerateKeysStartEnd(syscall: any, start: any, end: any, checkF: any): Generator<any, void, unknown>;
+export function enumerateKeysWithPrefix(syscall: any, prefix: any): Generator<any, void, unknown>;
+export function prefixedKeysExist(syscall: any, prefix: any): boolean;
+//# sourceMappingURL=vatstore-iterators.d.ts.map

package/src/vatstore-iterators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vatstore-iterators.d.ts","sourceRoot":"","sources":["vatstore-iterators.js"],"names":[],"mappings":"AAIA,sHAeC;AAMD,kGASC;AAGD,sEAGC"}