@xyo-network/diviner-stateful 2.99.2 → 2.99.4

package/dist/neutral/Config.d.cts

@@ -0,0 +1,22 @@
+import { DivinerConfig } from '@xyo-network/diviner-model';
+import { ModuleIdentifier } from '@xyo-network/module-model';
+/**
+ * The schema for a Stateful Diviner config
+ */
+export declare const StatefulDivinerConfigSchema: "network.xyo.diviner.stateful.config";
+/**
+ * The schema for a Stateful Diviner config
+ */
+export type StatefulDivinerConfigSchema = typeof StatefulDivinerConfigSchema;
+/**
+ * The config for a Stateful Diviner
+ */
+export type StatefulDivinerConfig = DivinerConfig<{
+    schema: StatefulDivinerConfigSchema;
+    stateStore: {
+        archivist: ModuleIdentifier;
+        boundWitnessDiviner: ModuleIdentifier;
+        payloadDiviner: ModuleIdentifier;
+    };
+}>;
+//# sourceMappingURL=Config.d.ts.map

package/dist/neutral/Config.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAI5D;;GAEG;AACH,eAAO,MAAM,2BAA2B,uCAA6C,CAAA;AACrF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAA;AAE5E;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAAC;IAChD,MAAM,EAAE,2BAA2B,CAAA;IACnC,UAAU,EAAE;QACV,SAAS,EAAE,gBAAgB,CAAA;QAC3B,mBAAmB,EAAE,gBAAgB,CAAA;QACrC,cAAc,EAAE,gBAAgB,CAAA;KACjC,CAAA;CACF,CAAC,CAAA"}

package/dist/neutral/Config.d.mts

@@ -0,0 +1,22 @@
+import { DivinerConfig } from '@xyo-network/diviner-model';
+import { ModuleIdentifier } from '@xyo-network/module-model';
+/**
+ * The schema for a Stateful Diviner config
+ */
+export declare const StatefulDivinerConfigSchema: "network.xyo.diviner.stateful.config";
+/**
+ * The schema for a Stateful Diviner config
+ */
+export type StatefulDivinerConfigSchema = typeof StatefulDivinerConfigSchema;
+/**
+ * The config for a Stateful Diviner
+ */
+export type StatefulDivinerConfig = DivinerConfig<{
+    schema: StatefulDivinerConfigSchema;
+    stateStore: {
+        archivist: ModuleIdentifier;
+        boundWitnessDiviner: ModuleIdentifier;
+        payloadDiviner: ModuleIdentifier;
+    };
+}>;
+//# sourceMappingURL=Config.d.ts.map

package/dist/neutral/Config.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAI5D;;GAEG;AACH,eAAO,MAAM,2BAA2B,uCAA6C,CAAA;AACrF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAA;AAE5E;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAAC;IAChD,MAAM,EAAE,2BAA2B,CAAA;IACnC,UAAU,EAAE;QACV,SAAS,EAAE,gBAAgB,CAAA;QAC3B,mBAAmB,EAAE,gBAAgB,CAAA;QACrC,cAAc,EAAE,gBAAgB,CAAA;KACjC,CAAA;CACF,CAAC,CAAA"}

package/dist/neutral/Config.d.ts

@@ -0,0 +1,22 @@
+import { DivinerConfig } from '@xyo-network/diviner-model';
+import { ModuleIdentifier } from '@xyo-network/module-model';
+/**
+ * The schema for a Stateful Diviner config
+ */
+export declare const StatefulDivinerConfigSchema: "network.xyo.diviner.stateful.config";
+/**
+ * The schema for a Stateful Diviner config
+ */
+export type StatefulDivinerConfigSchema = typeof StatefulDivinerConfigSchema;
+/**
+ * The config for a Stateful Diviner
+ */
+export type StatefulDivinerConfig = DivinerConfig<{
+    schema: StatefulDivinerConfigSchema;
+    stateStore: {
+        archivist: ModuleIdentifier;
+        boundWitnessDiviner: ModuleIdentifier;
+        payloadDiviner: ModuleIdentifier;
+    };
+}>;
+//# sourceMappingURL=Config.d.ts.map

package/dist/neutral/Config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAI5D;;GAEG;AACH,eAAO,MAAM,2BAA2B,uCAA6C,CAAA;AACrF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAA;AAE5E;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,aAAa,CAAC;IAChD,MAAM,EAAE,2BAA2B,CAAA;IACnC,UAAU,EAAE;QACV,SAAS,EAAE,gBAAgB,CAAA;QAC3B,mBAAmB,EAAE,gBAAgB,CAAA;QACrC,cAAc,EAAE,gBAAgB,CAAA;KACjC,CAAA;CACF,CAAC,CAAA"}

package/dist/neutral/Diviner.d.cts

@@ -0,0 +1,100 @@
+import { ArchivistWrapper } from '@xyo-network/archivist-wrapper';
+import { AbstractDiviner } from '@xyo-network/diviner-abstract';
+import { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model';
+import { DivinerWrapper } from '@xyo-network/diviner-wrapper';
+import { ModuleState, StateDictionary } from '@xyo-network/module-model';
+import { Payload, Schema, WithMeta } from '@xyo-network/payload-model';
+import { StatefulDivinerParams } from './Params';
+/**
+ * A Diviner that maintains state
+ */
+export declare abstract class StatefulDiviner<TParams extends StatefulDivinerParams = StatefulDivinerParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut>, TState extends StateDictionary = StateDictionary> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    /**
+     * The last state
+     */
+    protected _lastState?: WithMeta<ModuleState<TState>>;
+    /**
+     * Commit the internal state of the Diviner process. This is similar
+     * to a transaction completion in a database and should only be called
+     * when results have been successfully persisted to the appropriate
+     * external stores.
+     * @param nextState The state to commit
+     */
+    protected commitState(nextState: WithMeta<ModuleState<TState>>): Promise<void>;
+    /**
+     * Retrieves the archivist for the specified store
+     * @param store The store to retrieve the archivist for
+     * @returns The archivist for the specified store
+     */
+    protected getArchivistForStateStore(): Promise<ArchivistWrapper<import("@xyo-network/archivist-model").ArchivistModule<import("@xylabs/object").BaseParamsFields & {
+        account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+        addToResolvers?: boolean | undefined;
+        allowNameResolution?: boolean | undefined;
+        config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
+            parents?: import("@xyo-network/archivist-model").ArchivistParents | undefined;
+            requireAllParents?: boolean | undefined;
+            schema: "network.xyo.archivist.config";
+            storeParentReads?: boolean | undefined;
+        }, "schema"> & {
+            schema: "network.xyo.archivist.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[] | undefined;
+    }, import("@xyo-network/archivist-model").ArchivistModuleEventData>>>;
+    /**
+     * Retrieves the BoundWitness Diviner for the specified store
+     * @param store The store to retrieve the BoundWitness Diviner for
+     * @returns The BoundWitness Diviner for the specified store
+     */
+    protected getBoundWitnessDivinerForStateStore(): Promise<DivinerWrapper<import("@xyo-network/diviner-model").DivinerModule<import("@xylabs/object").BaseParamsFields & {
+        account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+        addToResolvers?: boolean | undefined;
+        allowNameResolution?: boolean | undefined;
+        config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[] | undefined;
+    }, DivinerModuleEventData>, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields>>;
+    /**
+     * Retrieves the Payload Diviner for the specified store
+     * @param store The store to retrieve the Payload Diviner for
+     * @returns The Payload Diviner for the specified store
+     */
+    protected getPayloadDivinerForStateStore(): Promise<DivinerWrapper<import("@xyo-network/diviner-model").DivinerModule<import("@xylabs/object").BaseParamsFields & {
+        account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+        addToResolvers?: boolean | undefined;
+        allowNameResolution?: boolean | undefined;
+        config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[] | undefined;
+    }, DivinerModuleEventData>, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields>>;
+    /**
+     * Retrieves the last state of the Diviner process. Used to recover state after
+     * preemptions, reboots, etc.
+     */
+    protected retrieveState(): Promise<WithMeta<ModuleState<TState>> | undefined>;
+}
+//# sourceMappingURL=Diviner.d.ts.map

package/dist/neutral/Diviner.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Diviner.d.ts","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AAGjE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAE/D,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,EAAiB,WAAW,EAAqB,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAE1G,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAGtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAIhD;;GAEG;AACH,8BAAsB,eAAe,CACnC,OAAO,SAAS,qBAAqB,GAAG,qBAAqB,EAC7D,GAAG,SAAS,OAAO,GAAG,OAAO,EAC7B,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,EACD,MAAM,SAAS,eAAe,GAAG,eAAe,CAChD,SAAQ,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACvD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAwD;IACxG,gBAAyB,mBAAmB,EAAE,MAAM,CAA8B;IAElF;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;IAEpD;;;;;;OAMG;cACa,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IASpE;;;;OAIG;cACa,yBAAyB;;;;;;;;;;;;;;;;;IAMzC;;;;OAIG;cACa,mCAAmC;;;;;;;;;;;;;;;;;;IAMnD;;;;OAIG;cACa,8BAA8B;;;;;;;;;;;;;;;;;;IAM9C;;;OAGG;cACa,aAAa,IAAI,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;CAwCpF"}

package/dist/neutral/Diviner.d.mts

@@ -0,0 +1,100 @@
+import { ArchivistWrapper } from '@xyo-network/archivist-wrapper';
+import { AbstractDiviner } from '@xyo-network/diviner-abstract';
+import { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model';
+import { DivinerWrapper } from '@xyo-network/diviner-wrapper';
+import { ModuleState, StateDictionary } from '@xyo-network/module-model';
+import { Payload, Schema, WithMeta } from '@xyo-network/payload-model';
+import { StatefulDivinerParams } from './Params';
+/**
+ * A Diviner that maintains state
+ */
+export declare abstract class StatefulDiviner<TParams extends StatefulDivinerParams = StatefulDivinerParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut>, TState extends StateDictionary = StateDictionary> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    /**
+     * The last state
+     */
+    protected _lastState?: WithMeta<ModuleState<TState>>;
+    /**
+     * Commit the internal state of the Diviner process. This is similar
+     * to a transaction completion in a database and should only be called
+     * when results have been successfully persisted to the appropriate
+     * external stores.
+     * @param nextState The state to commit
+     */
+    protected commitState(nextState: WithMeta<ModuleState<TState>>): Promise<void>;
+    /**
+     * Retrieves the archivist for the specified store
+     * @param store The store to retrieve the archivist for
+     * @returns The archivist for the specified store
+     */
+    protected getArchivistForStateStore(): Promise<ArchivistWrapper<import("@xyo-network/archivist-model").ArchivistModule<import("@xylabs/object").BaseParamsFields & {
+        account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+        addToResolvers?: boolean | undefined;
+        allowNameResolution?: boolean | undefined;
+        config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
+            parents?: import("@xyo-network/archivist-model").ArchivistParents | undefined;
+            requireAllParents?: boolean | undefined;
+            schema: "network.xyo.archivist.config";
+            storeParentReads?: boolean | undefined;
+        }, "schema"> & {
+            schema: "network.xyo.archivist.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[] | undefined;
+    }, import("@xyo-network/archivist-model").ArchivistModuleEventData>>>;
+    /**
+     * Retrieves the BoundWitness Diviner for the specified store
+     * @param store The store to retrieve the BoundWitness Diviner for
+     * @returns The BoundWitness Diviner for the specified store
+     */
+    protected getBoundWitnessDivinerForStateStore(): Promise<DivinerWrapper<import("@xyo-network/diviner-model").DivinerModule<import("@xylabs/object").BaseParamsFields & {
+        account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+        addToResolvers?: boolean | undefined;
+        allowNameResolution?: boolean | undefined;
+        config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[] | undefined;
+    }, DivinerModuleEventData>, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields>>;
+    /**
+     * Retrieves the Payload Diviner for the specified store
+     * @param store The store to retrieve the Payload Diviner for
+     * @returns The Payload Diviner for the specified store
+     */
+    protected getPayloadDivinerForStateStore(): Promise<DivinerWrapper<import("@xyo-network/diviner-model").DivinerModule<import("@xylabs/object").BaseParamsFields & {
+        account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+        addToResolvers?: boolean | undefined;
+        allowNameResolution?: boolean | undefined;
+        config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[] | undefined;
+    }, DivinerModuleEventData>, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields>>;
+    /**
+     * Retrieves the last state of the Diviner process. Used to recover state after
+     * preemptions, reboots, etc.
+     */
+    protected retrieveState(): Promise<WithMeta<ModuleState<TState>> | undefined>;
+}
+//# sourceMappingURL=Diviner.d.ts.map

package/dist/neutral/Diviner.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Diviner.d.ts","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AAGjE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAE/D,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,EAAiB,WAAW,EAAqB,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAE1G,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAGtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAIhD;;GAEG;AACH,8BAAsB,eAAe,CACnC,OAAO,SAAS,qBAAqB,GAAG,qBAAqB,EAC7D,GAAG,SAAS,OAAO,GAAG,OAAO,EAC7B,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,EACD,MAAM,SAAS,eAAe,GAAG,eAAe,CAChD,SAAQ,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACvD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAwD;IACxG,gBAAyB,mBAAmB,EAAE,MAAM,CAA8B;IAElF;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;IAEpD;;;;;;OAMG;cACa,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IASpE;;;;OAIG;cACa,yBAAyB;;;;;;;;;;;;;;;;;IAMzC;;;;OAIG;cACa,mCAAmC;;;;;;;;;;;;;;;;;;IAMnD;;;;OAIG;cACa,8BAA8B;;;;;;;;;;;;;;;;;;IAM9C;;;OAGG;cACa,aAAa,IAAI,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;CAwCpF"}

package/dist/neutral/Diviner.d.ts

@@ -0,0 +1,100 @@
+import { ArchivistWrapper } from '@xyo-network/archivist-wrapper';
+import { AbstractDiviner } from '@xyo-network/diviner-abstract';
+import { DivinerInstance, DivinerModuleEventData } from '@xyo-network/diviner-model';
+import { DivinerWrapper } from '@xyo-network/diviner-wrapper';
+import { ModuleState, StateDictionary } from '@xyo-network/module-model';
+import { Payload, Schema, WithMeta } from '@xyo-network/payload-model';
+import { StatefulDivinerParams } from './Params';
+/**
+ * A Diviner that maintains state
+ */
+export declare abstract class StatefulDiviner<TParams extends StatefulDivinerParams = StatefulDivinerParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut>, TState extends StateDictionary = StateDictionary> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    /**
+     * The last state
+     */
+    protected _lastState?: WithMeta<ModuleState<TState>>;
+    /**
+     * Commit the internal state of the Diviner process. This is similar
+     * to a transaction completion in a database and should only be called
+     * when results have been successfully persisted to the appropriate
+     * external stores.
+     * @param nextState The state to commit
+     */
+    protected commitState(nextState: WithMeta<ModuleState<TState>>): Promise<void>;
+    /**
+     * Retrieves the archivist for the specified store
+     * @param store The store to retrieve the archivist for
+     * @returns The archivist for the specified store
+     */
+    protected getArchivistForStateStore(): Promise<ArchivistWrapper<import("@xyo-network/archivist-model").ArchivistModule<import("@xylabs/object").BaseParamsFields & {
+        account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+        addToResolvers?: boolean | undefined;
+        allowNameResolution?: boolean | undefined;
+        config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
+            parents?: import("@xyo-network/archivist-model").ArchivistParents | undefined;
+            requireAllParents?: boolean | undefined;
+            schema: "network.xyo.archivist.config";
+            storeParentReads?: boolean | undefined;
+        }, "schema"> & {
+            schema: "network.xyo.archivist.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[] | undefined;
+    }, import("@xyo-network/archivist-model").ArchivistModuleEventData>>>;
+    /**
+     * Retrieves the BoundWitness Diviner for the specified store
+     * @param store The store to retrieve the BoundWitness Diviner for
+     * @returns The BoundWitness Diviner for the specified store
+     */
+    protected getBoundWitnessDivinerForStateStore(): Promise<DivinerWrapper<import("@xyo-network/diviner-model").DivinerModule<import("@xylabs/object").BaseParamsFields & {
+        account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+        addToResolvers?: boolean | undefined;
+        allowNameResolution?: boolean | undefined;
+        config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[] | undefined;
+    }, DivinerModuleEventData>, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields>>;
+    /**
+     * Retrieves the Payload Diviner for the specified store
+     * @param store The store to retrieve the Payload Diviner for
+     * @returns The Payload Diviner for the specified store
+     */
+    protected getPayloadDivinerForStateStore(): Promise<DivinerWrapper<import("@xyo-network/diviner-model").DivinerModule<import("@xylabs/object").BaseParamsFields & {
+        account?: import("@xyo-network/account-model").AccountInstance | "random" | undefined;
+        addToResolvers?: boolean | undefined;
+        allowNameResolution?: boolean | undefined;
+        config: import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & Omit<import("@xyo-network/module-model").ArchivingModuleConfig & import("@xyo-network/module-model").ModuleConfigFields & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: "network.xyo.diviner.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean | undefined;
+        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[] | undefined;
+    }, DivinerModuleEventData>, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields, {
+        schema: string;
+    } & import("@xyo-network/payload-model").PayloadFields>>;
+    /**
+     * Retrieves the last state of the Diviner process. Used to recover state after
+     * preemptions, reboots, etc.
+     */
+    protected retrieveState(): Promise<WithMeta<ModuleState<TState>> | undefined>;
+}
+//# sourceMappingURL=Diviner.d.ts.map

package/dist/neutral/Diviner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Diviner.d.ts","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AAGjE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAE/D,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,EAAiB,WAAW,EAAqB,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAE1G,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAGtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAIhD;;GAEG;AACH,8BAAsB,eAAe,CACnC,OAAO,SAAS,qBAAqB,GAAG,qBAAqB,EAC7D,GAAG,SAAS,OAAO,GAAG,OAAO,EAC7B,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,EACD,MAAM,SAAS,eAAe,GAAG,eAAe,CAChD,SAAQ,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACvD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAwD;IACxG,gBAAyB,mBAAmB,EAAE,MAAM,CAA8B;IAElF;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;IAEpD;;;;;;OAMG;cACa,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IASpE;;;;OAIG;cACa,yBAAyB;;;;;;;;;;;;;;;;;IAMzC;;;;OAIG;cACa,mCAAmC;;;;;;;;;;;;;;;;;;IAMnD;;;;OAIG;cACa,8BAA8B;;;;;;;;;;;;;;;;;;IAM9C;;;OAGG;cACa,aAAa,IAAI,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;CAwCpF"}