@xyo-network/diviner-model 4.1.1 → 4.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/neutral/index.d.ts +13 -108
  2. package/package.json +11 -11
package/dist/neutral/index.d.ts CHANGED
@@ -1,108 +1,13 @@
1
- import * as _xylabs_object from '@xylabs/object';
2
- import { EmptyObject, WithAdditional, TypeCheck, IsObjectFactory } from '@xylabs/object';
3
- import * as _xyo_network_module_model from '@xyo-network/module-model';
4
- import { Module, ModuleEventArgs, ModuleInstance, ModuleEventData, ModuleQueryResult, ModuleConfig, ModuleIdentifier, AnyConfigSchema, ModuleParams, AttachableModuleInstance, ModuleQueries } from '@xyo-network/module-model';
5
- import * as _xyo_network_payload_model from '@xyo-network/payload-model';
6
- import { Payload, WithoutPrivateStorageMeta, Schema, WithSchema, Query } from '@xyo-network/payload-model';
7
- import { EventData } from '@xylabs/events';
8
- import { RetryConfig } from '@xylabs/retry';
9
- import { AccountInstance } from '@xyo-network/account-model';
10
- import { ObjectTypeShape } from '@xylabs/typeof';
11
- import { Hash } from '@xylabs/hex';
12
-
13
- type DivineEndEventArgs<T extends Module = Module, TIn extends Payload = Payload, TOut extends Payload = Payload> = ModuleEventArgs<T, {
14
- errors: Error[];
15
- inPayloads: TIn[];
16
- outPayloads: TOut[];
17
- }>;
18
- interface DivineEndEventData<T extends Module = Module, TIn extends Payload = Payload, TOut extends Payload = Payload> extends EventData {
19
- divineEnd: DivineEndEventArgs<T, TIn, TOut>;
20
- }
21
-
22
- type DivineStartEventArgs<T extends Module = Module, TIn extends Payload = Payload> = ModuleEventArgs<T, {
23
- inPayloads: TIn[];
24
- }>;
25
- interface DivineStartEventData<T extends Module = Module, TIn extends Payload = Payload> extends EventData {
26
- divineStart: DivineStartEventArgs<T, TIn>;
27
- }
28
-
29
- type DivinerModuleEventData<TInstance extends ModuleInstance = ModuleInstance, TIn extends Payload = Payload, TOut extends Payload = Payload> = DivineEndEventData<TInstance, TIn, TOut> & DivineStartEventData<TInstance, TIn> & ModuleEventData<TInstance>;
30
-
31
- type DivinerDivineResult<T extends Payload> = WithoutPrivateStorageMeta<T>;
32
- interface DivinerQueryFunctions<TIn extends Payload = Payload, TOut extends Payload = Payload> {
33
- divine: (payloads?: TIn[], retry?: RetryConfig) => Promise<DivinerDivineResult<TOut>[]>;
34
- divineQuery: (payloads?: TIn[], account?: AccountInstance, retry?: RetryConfig) => Promise<ModuleQueryResult<TOut>>;
35
- }
36
-
37
- declare const DivinerConfigSchema: "network.xyo.diviner.config";
38
- type DivinerConfigSchema = typeof DivinerConfigSchema;
39
- interface ModuleEventSubscription {
40
- sourceEvent: string;
41
- sourceModule: ModuleIdentifier;
42
- targetModuleFunction?: string;
43
- }
44
- type DivinerConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends Schema | void = void> = ModuleConfig<WithAdditional<{
45
- eventSubscriptions?: ModuleEventSubscription[];
46
- schema: TConfig extends Payload ? TConfig['schema'] : DivinerConfigSchema;
47
- }, TConfig>, TSchema>;
48
-
49
- interface DivinerParams<TConfig extends AnyConfigSchema<DivinerConfig> = AnyConfigSchema<DivinerConfig>> extends ModuleParams<TConfig> {
50
- }
51
-
52
- interface DivinerModule<TParams extends DivinerParams = DivinerParams, TEvents extends DivinerModuleEventData = DivinerModuleEventData> extends Module<TParams, TEvents> {
53
- }
54
-
55
- interface DivinerInstance<TParams extends DivinerParams = DivinerParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEvents extends DivinerModuleEventData = DivinerModuleEventData> extends DivinerModule<TParams, TEvents>, DivinerQueryFunctions<TIn, TOut>, ModuleInstance<TParams, TEvents> {
56
- }
57
-
58
- interface AttachableDivinerInstance<TParams extends DivinerParams = DivinerParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEventData extends DivinerModuleEventData = DivinerModuleEventData> extends DivinerInstance<TParams, TIn, TOut, TEventData>, AttachableModuleInstance<TParams, TEventData> {
59
- }
60
- type AttachableDivinerInstanceTypeCheck<T extends AttachableDivinerInstance = AttachableDivinerInstance> = TypeCheck<T>;
61
- declare class IsAttachableDivinerInstanceFactory<T extends AttachableDivinerInstance = AttachableDivinerInstance> extends IsObjectFactory<T> {
62
- }
63
-
64
- declare const asAttachableDivinerInstance: _xylabs_object.AsTypeFunction<AttachableDivinerInstance<DivinerParams<_xyo_network_module_model.AnyConfigSchema<DivinerConfig>>, _xyo_network_payload_model.Payload, _xyo_network_payload_model.Payload, DivinerModuleEventData>>;
65
-
66
- declare const requiredAttachableDivinerInstanceFunctions: ObjectTypeShape;
67
- declare const isAttachableDivinerInstance: TypeCheck<AttachableDivinerInstance>;
68
-
69
- type DivinedPayload<T extends void | EmptyObject | WithSchema = void, S extends Schema | void = void> = Payload<WithAdditional<{
70
- sources: Hash[];
71
- }, T>, S>;
72
-
73
- type DivinerDivineQuerySchema = 'network.xyo.query.diviner.divine';
74
- declare const DivinerDivineQuerySchema: DivinerDivineQuerySchema;
75
- type DivinerDivineQuery = Query<{
76
- schema: DivinerDivineQuerySchema;
77
- }>;
78
-
79
- type DivinerQueries = DivinerDivineQuery;
80
- type DivinerModuleQueries = ModuleQueries | DivinerQueries;
81
-
82
- /**
83
- * Configuration for searchable storage of local state
84
- */
85
- interface SearchableStorage {
86
- /**
87
- * Name/Address of the archivist where intermediate communications are stored
88
- */
89
- archivist: ModuleIdentifier;
90
- /**
91
- * Name/Address of the diviner where intermediate communications are filtered
92
- */
93
- boundWitnessDiviner?: ModuleIdentifier;
94
- /**
95
- * Name/Address of the diviner where intermediate communications are filtered
96
- */
97
- payloadDiviner?: ModuleIdentifier;
98
- }
99
-
100
- declare const isDivinerInstance: TypeCheck<DivinerInstance>;
101
- declare const isDivinerModule: TypeCheck<DivinerModule>;
102
- declare const asDivinerModule: _xylabs_object.AsTypeFunction<DivinerModule<DivinerParams<_xyo_network_module_model.AnyConfigSchema<DivinerConfig>>, DivinerModuleEventData>>;
103
- declare const asDivinerInstance: _xylabs_object.AsTypeFunction<DivinerInstance<DivinerParams<_xyo_network_module_model.AnyConfigSchema<DivinerConfig>>, _xyo_network_payload_model.Payload, _xyo_network_payload_model.Payload, DivinerModuleEventData>>;
104
- declare const withDivinerModule: <R>(mod: any, closure: (mod: DivinerModule<DivinerParams<_xyo_network_module_model.AnyConfigSchema<DivinerConfig>>, DivinerModuleEventData>) => R) => R | undefined;
105
- declare const withDivinerInstance: <R>(mod: any, closure: (mod: DivinerInstance<DivinerParams<_xyo_network_module_model.AnyConfigSchema<DivinerConfig>>, _xyo_network_payload_model.Payload, _xyo_network_payload_model.Payload, DivinerModuleEventData>) => R) => R | undefined;
106
-
107
- export { DivinerConfigSchema, DivinerDivineQuerySchema, IsAttachableDivinerInstanceFactory, asAttachableDivinerInstance, asDivinerInstance, asDivinerModule, isAttachableDivinerInstance, isDivinerInstance, isDivinerModule, requiredAttachableDivinerInstanceFunctions, withDivinerInstance, withDivinerModule };
108
- export type { AttachableDivinerInstance, AttachableDivinerInstanceTypeCheck, DivineEndEventArgs, DivineEndEventData, DivineStartEventArgs, DivineStartEventData, DivinedPayload, DivinerConfig, DivinerDivineQuery, DivinerDivineResult, DivinerInstance, DivinerModule, DivinerModuleEventData, DivinerModuleQueries, DivinerParams, DivinerQueries, DivinerQueryFunctions, ModuleEventSubscription, SearchableStorage };
1
+ export * from './attachable/index.ts';
2
+ export * from './Config.ts';
3
+ export * from './DivinerQueryFunctions.ts';
4
+ export * from './EventData.ts';
5
+ export * from './EventsModels/index.ts';
6
+ export * from './Instance.ts';
7
+ export * from './Module.ts';
8
+ export * from './Params.ts';
9
+ export * from './Payload.ts';
10
+ export * from './Queries/index.ts';
11
+ export * from './SearchableStorage.ts';
12
+ export * from './typeChecks.ts';
13
+ //# sourceMappingURL=index.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/diviner-model",
3
- "version": "4.1.1",
3
+ "version": "4.1.3",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,18 +29,18 @@
29
29
  "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/events": "^4.13.15",
33
- "@xylabs/hex": "^4.13.15",
34
- "@xylabs/object": "^4.13.15",
35
- "@xylabs/retry": "^4.13.15",
36
- "@xylabs/typeof": "^4.13.15",
37
- "@xyo-network/account-model": "^4.1.1",
38
- "@xyo-network/module-model": "^4.1.1",
39
- "@xyo-network/payload-model": "^4.1.1"
32
+ "@xylabs/events": "^4.13.16",
33
+ "@xylabs/hex": "^4.13.16",
34
+ "@xylabs/object": "^4.13.16",
35
+ "@xylabs/retry": "^4.13.16",
36
+ "@xylabs/typeof": "^4.13.16",
37
+ "@xyo-network/account-model": "^4.1.3",
38
+ "@xyo-network/module-model": "^4.1.3",
39
+ "@xyo-network/payload-model": "^4.1.3"
40
40
  },
41
41
  "devDependencies": {
42
- "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
43
- "@xylabs/tsconfig": "^7.0.0-rc.23",
42
+ "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
43
+ "@xylabs/tsconfig": "^7.0.0-rc.27",
44
44
  "typescript": "^5.8.3"
45
45
  },
46
46
  "publishConfig": {