@xyo-network/sentinel-model 2.111.2 → 3.0.0

package/dist/neutral/index.d.ts

@@ -1,14 +1,478 @@
-export * from './Automation.ts';
-export * from './Config.ts';
-export * from './EventData.ts';
-export * from './EventsModels/index.ts';
-export * from './Instance.ts';
-export * from './Job.ts';
-export * from './Module.ts';
-export * from './Params.ts';
-export * from './Queries/index.ts';
-export * from './ResolvedTask.ts';
-export * from './Sentinel.ts';
-export * from './Task.ts';
-export * from './typeChecks.ts';
-//# sourceMappingURL=index.d.ts.map
+import * as _xyo_network_payload_model from '@xyo-network/payload-model';
+import { Payload, Query } from '@xyo-network/payload-model';
+import * as _xylabs_object from '@xylabs/object';
+import { WithAdditional, EmptyObject } from '@xylabs/object';
+import * as _xyo_network_module_model from '@xyo-network/module-model';
+import { ModuleIdentifier, ModuleConfig, Module, ModuleEventArgs, ModuleEventData, AnyConfigSchema, ModuleParams, ModuleQueryResult, ModuleInstance, ModuleQueries } from '@xyo-network/module-model';
+import { Address } from '@xylabs/hex';
+import { EventData } from '@xyo-network/module-events';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+import * as _xylabs_promise from '@xylabs/promise';
+import { Promisable } from '@xylabs/promise';
+import * as _xyo_network_account_model from '@xyo-network/account-model';
+import { AccountInstance } from '@xyo-network/account-model';
+import { ArchivistInstance } from '@xyo-network/archivist-model';
+import { DivinerInstance } from '@xyo-network/diviner-model';
+import { WitnessInstance } from '@xyo-network/witness-model';
+
+type SentinelAutomationSchema = 'network.xyo.automation';
+declare const SentinelAutomationSchema: SentinelAutomationSchema;
+type SentinelIntervalAutomationSchema = 'network.xyo.automation.interval';
+declare const SentinelIntervalAutomationSchema: SentinelIntervalAutomationSchema;
+type SentinelEventAutomationSchema = 'network.xyo.automation.event';
+declare const SentinelEventAutomationSchema: SentinelEventAutomationSchema;
+type SentinelBaseAutomationPayload<T extends Payload> = Payload<{
+    type?: 'interval' | 'event';
+} & T>;
+type SentinelIntervalAutomationPayload = SentinelBaseAutomationPayload<{
+    end?: number;
+    frequency?: number;
+    frequencyUnits?: 'second' | 'minute' | 'hour' | 'day';
+    remaining?: number;
+    schema: SentinelIntervalAutomationSchema;
+    start: number;
+    type: 'interval';
+}>;
+declare const isSentinelIntervalAutomation: (x?: unknown | null) => x is _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+    type?: "interval" | "event";
+} & {
+    end?: number;
+    frequency?: number;
+    frequencyUnits?: "second" | "minute" | "hour" | "day";
+    remaining?: number;
+    schema: SentinelIntervalAutomationSchema;
+    start: number;
+    type: "interval";
+};
+type SentinelEventAutomationPayload = SentinelBaseAutomationPayload<{
+    schema: SentinelEventAutomationSchema;
+    type: 'event';
+}>;
+type SentinelAutomationPayload = Payload<SentinelIntervalAutomationPayload | SentinelEventAutomationPayload, SentinelAutomationSchema | SentinelIntervalAutomationSchema | SentinelEventAutomationSchema>;
+
+interface ModuleTask<TEndpoints extends string = string> {
+    endPoint?: TEndpoints;
+    input?: boolean | ModuleIdentifier | ModuleIdentifier[];
+    mod: ModuleIdentifier;
+    required?: boolean;
+}
+type ArchivistTask = ModuleTask<'all' | 'clear' | 'commit' | 'delete' | 'get' | 'insert'>;
+type DivinerTask = ModuleTask<'divine'>;
+type WitnessTask = ModuleTask<'observe'>;
+type Task = WitnessTask | DivinerTask | ArchivistTask | ModuleTask;
+
+declare const SentinelConfigSchema: "network.xyo.sentinel.config";
+type SentinelConfigSchema = typeof SentinelConfigSchema;
+type SentinelConfig<TConfig extends Payload | void = void, TSchema extends string | void = void> = ModuleConfig<WithAdditional<{
+    automations?: SentinelAutomationPayload[];
+    schema: TConfig extends Payload ? TConfig['schema'] : SentinelConfigSchema;
+    synchronous?: boolean;
+    tasks: Task[];
+    throwErrors?: boolean;
+}, TConfig>, TSchema>;
+
+type JobEndEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    finalResult?: Record<Address, Payload[]>;
+    inPayloads?: Payload[];
+}>;
+interface JobEndEventData<T extends Module = Module> extends EventData {
+    jobEnd: JobEndEventArgs<T>;
+}
+
+type JobStartEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    inPayloads?: Payload[];
+}>;
+interface JobStartEventData<T extends Module = Module> extends EventData {
+    jobStart: JobStartEventArgs<T>;
+}
+
+type ReportEndEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    boundwitness?: BoundWitness;
+    inPayloads?: Payload[];
+    outPayloads?: Payload[];
+}>;
+interface ReportEndEventData<T extends Module = Module> extends EventData {
+    reportEnd: ReportEndEventArgs<T>;
+}
+
+type ReportStartEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    inPayloads?: Payload[];
+}>;
+interface ReportStartEventData<T extends Module = Module> extends EventData {
+    reportStart: ReportStartEventArgs<T>;
+}
+
+type TaskEndEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    address: Address;
+    inPayloads?: Payload[];
+    name?: string;
+    outPayloads?: Payload[];
+}>;
+interface TaskEndEventData<T extends Module = Module> extends EventData {
+    taskEnd: TaskEndEventArgs<T>;
+}
+
+type TaskStartEventArgs<T extends Module = Module> = ModuleEventArgs<T, {
+    address: Address;
+    inPayloads?: Payload[];
+    name?: string;
+}>;
+interface TaskStartEventData<T extends Module = Module> extends EventData {
+    taskStart: TaskStartEventArgs<T>;
+}
+
+interface SentinelModuleEventData<T extends Module = Module> extends TaskEndEventData<T>, TaskStartEventData<T>, JobEndEventData<T>, JobStartEventData<T>, ReportEndEventData<T>, ReportStartEventData<T>, ModuleEventData<T> {
+}
+
+type SentinelParams<TConfig extends AnyConfigSchema<SentinelConfig> = AnyConfigSchema<SentinelConfig>, TAdditionalParams extends EmptyObject | void = void> = ModuleParams<TConfig, TAdditionalParams>;
+
+interface SentinelModule<TParams extends SentinelParams = SentinelParams, TEventData extends SentinelModuleEventData = SentinelModuleEventData> extends Module<TParams, TEventData> {
+}
+interface CustomSentinelModule<TParams extends SentinelParams = SentinelParams, TEvents extends SentinelModuleEventData<SentinelModule<TParams>> = SentinelModuleEventData<SentinelModule<TParams>>> extends Module<TParams, TEvents> {
+}
+
+interface Sentinel<TIn extends Payload = Payload, TOut extends Payload = Payload> {
+    report: (payloads?: TIn[]) => Promisable<TOut[]>;
+    reportQuery: (payloads?: TIn[], account?: AccountInstance) => Promisable<ModuleQueryResult<TOut>>;
+}
+
+interface SentinelInstance<TParams extends SentinelParams = SentinelParams, TEventData extends SentinelModuleEventData = SentinelModuleEventData> extends SentinelModule<TParams, TEventData>, Sentinel, ModuleInstance<TParams, TEventData> {
+}
+interface CustomSentinelInstance<TParams extends SentinelParams = SentinelParams, TEvents extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>> extends CustomSentinelModule<TParams, TEvents>, Sentinel, SentinelInstance<TParams, TEvents> {
+}
+
+type ResolvedModuleTask<TTask extends ModuleTask = ModuleTask, TInstance extends ModuleInstance = ModuleInstance> = Omit<TTask, 'mod'> & {
+    mod: TInstance;
+};
+type ResolvedArchivistTask = ResolvedModuleTask<ArchivistTask, ArchivistInstance>;
+type ResolvedDivinerTask = ResolvedModuleTask<DivinerTask, DivinerInstance>;
+type ResolvedWitnessTask = ResolvedModuleTask<WitnessTask, WitnessInstance>;
+type ResolvedTask = ResolvedArchivistTask | ResolvedDivinerTask | ResolvedWitnessTask | ResolvedModuleTask;
+
+interface SentinelJob {
+    tasks: ResolvedTask[][];
+}
+
+type SentinelReportQuerySchema = 'network.xyo.query.sentinel.report';
+declare const SentinelReportQuerySchema: SentinelReportQuerySchema;
+type SentinelReportQuery = Query<{
+    schema: SentinelReportQuerySchema;
+}>;
+
+type SentinelQueries = SentinelReportQuery;
+type SentinelModuleQueries = ModuleQueries | SentinelQueries;
+
+declare const isSentinelInstance: _xylabs_object.TypeCheck<SentinelInstance<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+        automations?: SentinelAutomationPayload[];
+        schema: "network.xyo.sentinel.config";
+        synchronous?: boolean;
+        tasks: Task[];
+        throwErrors?: boolean;
+    }, "schema"> & {
+        schema: "network.xyo.sentinel.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+        schema: "network.xyo.module.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, _xyo_network_module_model.ModuleEventData<object>>>>>;
+declare const isSentinelModule: _xyo_network_module_model.ModuleTypeCheck<SentinelModule<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+        automations?: SentinelAutomationPayload[];
+        schema: "network.xyo.sentinel.config";
+        synchronous?: boolean;
+        tasks: Task[];
+        throwErrors?: boolean;
+    }, "schema"> & {
+        schema: "network.xyo.sentinel.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+        schema: "network.xyo.module.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, _xyo_network_module_model.ModuleEventData<object>>>>>;
+declare const asSentinelModule: {
+    <TType extends SentinelModule<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>>>>>(value: _xylabs_promise.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
+    <TType extends SentinelModule<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>>>>>(value: _xylabs_promise.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<SentinelModule<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>>>>>, config?: _xylabs_object.TypeCheckConfig): TType;
+};
+declare const asSentinelInstance: {
+    <TType extends SentinelInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>>>>>(value: _xylabs_promise.AnyNonPromise, config?: _xylabs_object.TypeCheckConfig): TType | undefined;
+    <TType extends SentinelInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>>>>>(value: _xylabs_promise.AnyNonPromise, assert: _xylabs_object.StringOrAlertFunction<SentinelInstance<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+            automations?: SentinelAutomationPayload[];
+            schema: "network.xyo.sentinel.config";
+            synchronous?: boolean;
+            tasks: Task[];
+            throwErrors?: boolean;
+        }, "schema"> & {
+            schema: "network.xyo.sentinel.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+        account?: _xyo_network_account_model.AccountInstance | "random";
+        addToResolvers?: boolean;
+        additionalSigners?: _xyo_network_account_model.AccountInstance[];
+        allowNameResolution?: boolean;
+        config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+            schema: "network.xyo.module.config";
+        }, "schema"> & {
+            schema: string;
+        };
+        ephemeralQueryAccountEnabled?: boolean;
+        moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+    }, _xyo_network_module_model.ModuleEventData<object>>>>>, config?: _xylabs_object.TypeCheckConfig): TType;
+};
+declare const withSentinelModule: <R>(mod: any, closure: (mod: SentinelModule<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+        automations?: SentinelAutomationPayload[];
+        schema: "network.xyo.sentinel.config";
+        synchronous?: boolean;
+        tasks: Task[];
+        throwErrors?: boolean;
+    }, "schema"> & {
+        schema: "network.xyo.sentinel.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+        schema: "network.xyo.module.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, _xyo_network_module_model.ModuleEventData<object>>>>) => R) => R | undefined;
+declare const withSentinelInstance: <R>(mod: any, closure: (mod: SentinelInstance<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & {
+        automations?: SentinelAutomationPayload[];
+        schema: "network.xyo.sentinel.config";
+        synchronous?: boolean;
+        tasks: Task[];
+        throwErrors?: boolean;
+    }, "schema"> & {
+        schema: "network.xyo.sentinel.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, SentinelModuleEventData<_xyo_network_module_model.Module<_xylabs_object.BaseParamsFields & {
+    account?: _xyo_network_account_model.AccountInstance | "random";
+    addToResolvers?: boolean;
+    additionalSigners?: _xyo_network_account_model.AccountInstance[];
+    allowNameResolution?: boolean;
+    config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & Omit<_xyo_network_module_model.ArchivingModuleConfig & _xyo_network_module_model.ModuleConfigFields & _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
+        schema: "network.xyo.module.config";
+    }, "schema"> & {
+        schema: string;
+    };
+    ephemeralQueryAccountEnabled?: boolean;
+    moduleIdentifierTransformers?: _xyo_network_module_model.ModuleIdentifierTransformer[];
+}, _xyo_network_module_model.ModuleEventData<object>>>>) => R) => R | undefined;
+
+export { type ArchivistTask, type CustomSentinelInstance, type CustomSentinelModule, type DivinerTask, type JobEndEventArgs, type JobEndEventData, type JobStartEventArgs, type JobStartEventData, type ModuleTask, type ReportEndEventArgs, type ReportEndEventData, type ReportStartEventArgs, type ReportStartEventData, type ResolvedArchivistTask, type ResolvedDivinerTask, type ResolvedModuleTask, type ResolvedTask, type ResolvedWitnessTask, type Sentinel, type SentinelAutomationPayload, SentinelAutomationSchema, type SentinelBaseAutomationPayload, type SentinelConfig, SentinelConfigSchema, type SentinelEventAutomationPayload, SentinelEventAutomationSchema, type SentinelInstance, type SentinelIntervalAutomationPayload, SentinelIntervalAutomationSchema, type SentinelJob, type SentinelModule, type SentinelModuleEventData, type SentinelModuleQueries, type SentinelParams, type SentinelQueries, type SentinelReportQuery, SentinelReportQuerySchema, type Task, type TaskEndEventArgs, type TaskEndEventData, type TaskStartEventArgs, type TaskStartEventData, type WitnessTask, asSentinelInstance, asSentinelModule, isSentinelInstance, isSentinelIntervalAutomation, isSentinelModule, withSentinelInstance, withSentinelModule };

package/package.json

@@ -10,52 +10,33 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xylabs/hex": "^3.6.8",
-    "@xylabs/object": "^3.6.8",
-    "@xylabs/promise": "^3.6.8",
-    "@xyo-network/account-model": "^2.111.2",
-    "@xyo-network/archivist-model": "^2.111.2",
-    "@xyo-network/boundwitness-model": "^2.111.2",
-    "@xyo-network/diviner-model": "^2.111.2",
-    "@xyo-network/module-events": "^2.111.2",
-    "@xyo-network/module-model": "^2.111.2",
-    "@xyo-network/payload-model": "^2.111.2",
-    "@xyo-network/witness-model": "^2.111.2"
+    "@xylabs/hex": "^3.6.12",
+    "@xylabs/object": "^3.6.12",
+    "@xylabs/promise": "^3.6.12",
+    "@xyo-network/account-model": "^3.0.0",
+    "@xyo-network/archivist-model": "^3.0.0",
+    "@xyo-network/boundwitness-model": "^3.0.0",
+    "@xyo-network/diviner-model": "^3.0.0",
+    "@xyo-network/module-events": "^3.0.0",
+    "@xyo-network/module-model": "^3.0.0",
+    "@xyo-network/payload-model": "^3.0.0",
+    "@xyo-network/witness-model": "^3.0.0"
   },
   "description": "Primary SDK for using XYO Protocol 2.0",
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^3.15.13",
-    "@xylabs/tsconfig": "^3.15.13",
+    "@xylabs/ts-scripts-yarn3": "next",
+    "@xylabs/tsconfig": "next",
     "typescript": "^5.5.4"
   },
-  "types": "dist/node/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "exports": {
     ".": {
-      "browser": {
-        "require": {
-          "types": "./dist/browser/index.d.cts",
-          "default": "./dist/browser/index.cjs"
-        },
-        "import": {
-          "types": "./dist/browser/index.d.mts",
-          "default": "./dist/browser/index.mjs"
-        }
-      },
-      "node": {
-        "require": {
-          "types": "./dist/node/index.d.cts",
-          "default": "./dist/node/index.cjs"
-        },
-        "import": {
-          "types": "./dist/node/index.d.mts",
-          "default": "./dist/node/index.mjs"
-        }
-      }
+      "types": "./dist/neutral/index.d.ts",
+      "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "main": "dist/node/index.cjs",
-  "module": "dist/node/index.mjs",
+  "module": "dist/neutral/index.mjs",
   "homepage": "https://xyo.network",
   "license": "LGPL-3.0-only",
   "publishConfig": {
@@ -66,6 +47,6 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
   },
   "sideEffects": false,
-  "version": "2.111.2",
+  "version": "3.0.0",
   "type": "module"
 }

package/src/Module.ts

@@ -3,11 +3,9 @@ import { Module } from '@xyo-network/module-model'
 import { SentinelModuleEventData } from './EventData.ts'
 import { SentinelParams } from './Params.ts'
 
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface SentinelModule<TParams extends SentinelParams = SentinelParams, TEventData extends SentinelModuleEventData = SentinelModuleEventData>
   extends Module<TParams, TEventData> {}
 
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface CustomSentinelModule<
   TParams extends SentinelParams = SentinelParams,
   TEvents extends SentinelModuleEventData<SentinelModule<TParams>> = SentinelModuleEventData<SentinelModule<TParams>>,

package/xy.config.ts

@@ -0,0 +1,12 @@
+import { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
+const config: XyTsupConfig = {
+  compile: {
+    browser: {},
+    neutral: {
+      src: true,
+    },
+    node: {},
+  },
+}
+
+export default config

package/dist/browser/Automation.d.cts

@@ -1,36 +0,0 @@
-import { Payload } from '@xyo-network/payload-model';
-export type SentinelAutomationSchema = 'network.xyo.automation';
-export declare const SentinelAutomationSchema: SentinelAutomationSchema;
-export type SentinelIntervalAutomationSchema = 'network.xyo.automation.interval';
-export declare const SentinelIntervalAutomationSchema: SentinelIntervalAutomationSchema;
-export type SentinelEventAutomationSchema = 'network.xyo.automation.event';
-export declare const SentinelEventAutomationSchema: SentinelEventAutomationSchema;
-export type SentinelBaseAutomationPayload<T extends Payload> = Payload<{
-    type?: 'interval' | 'event';
-} & T>;
-export type SentinelIntervalAutomationPayload = SentinelBaseAutomationPayload<{
-    end?: number;
-    frequency?: number;
-    frequencyUnits?: 'second' | 'minute' | 'hour' | 'day';
-    remaining?: number;
-    schema: SentinelIntervalAutomationSchema;
-    start: number;
-    type: 'interval';
-}>;
-export declare const isSentinelIntervalAutomation: (x?: unknown | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & {
-    type?: "interval" | "event";
-} & {
-    end?: number;
-    frequency?: number;
-    frequencyUnits?: "second" | "minute" | "hour" | "day";
-    remaining?: number;
-    schema: SentinelIntervalAutomationSchema;
-    start: number;
-    type: "interval";
-};
-export type SentinelEventAutomationPayload = SentinelBaseAutomationPayload<{
-    schema: SentinelEventAutomationSchema;
-    type: 'event';
-}>;
-export type SentinelAutomationPayload = Payload<SentinelIntervalAutomationPayload | SentinelEventAutomationPayload, SentinelAutomationSchema | SentinelIntervalAutomationSchema | SentinelEventAutomationSchema>;
-//# sourceMappingURL=Automation.d.ts.map

package/dist/browser/Automation.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Automation.d.ts","sourceRoot":"","sources":["../../src/Automation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAE3E,MAAM,MAAM,wBAAwB,GAAG,wBAAwB,CAAA;AAC/D,eAAO,MAAM,wBAAwB,EAAE,wBAAmD,CAAA;AAE1F,MAAM,MAAM,gCAAgC,GAAG,iCAAiC,CAAA;AAChF,eAAO,MAAM,gCAAgC,EAAE,gCAAoE,CAAA;AAEnH,MAAM,MAAM,6BAA6B,GAAG,8BAA8B,CAAA;AAC1E,eAAO,MAAM,6BAA6B,EAAE,6BAA8D,CAAA;AAE1G,MAAM,MAAM,6BAA6B,CAAC,CAAC,SAAS,OAAO,IAAI,OAAO,CACpE;IACE,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAA;CAC5B,GAAG,CAAC,CACN,CAAA;AAGD,MAAM,MAAM,iCAAiC,GAAG,6BAA6B,CAAC;IAE5E,GAAG,CAAC,EAAE,MAAM,CAAA;IAGZ,SAAS,CAAC,EAAE,MAAM,CAAA;IAGlB,cAAc,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAA;IAGrD,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,MAAM,EAAE,gCAAgC,CAAA;IAGxC,KAAK,EAAE,MAAM,CAAA;IAGb,IAAI,EAAE,UAAU,CAAA;CACjB,CAAC,CAAA;AAEF,eAAO,MAAM,4BAA4B;WA3B9B,UAAU,GAAG,OAAO;;UAOvB,MAAM;gBAGA,MAAM;qBAGD,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK;gBAGzC,MAAM;YAEV,gCAAgC;WAGjC,MAAM;UAGP,UAAU;CAGoH,CAAA;AAGtI,MAAM,MAAM,8BAA8B,GAAG,6BAA6B,CAAC;IACzE,MAAM,EAAE,6BAA6B,CAAA;IACrC,IAAI,EAAE,OAAO,CAAA;CACd,CAAC,CAAA;AAGF,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAC7C,iCAAiC,GAAG,8BAA8B,EAClE,wBAAwB,GAAG,gCAAgC,GAAG,6BAA6B,CAC5F,CAAA"}