@xyo-network/witness-model 4.1.2 → 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 -83
  2. package/package.json +10 -10
package/dist/neutral/index.d.ts CHANGED
@@ -1,83 +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 { ModuleInstance, ModuleEventArgs, ModuleEventData, ModuleConfig, AnyConfigSchema, ModuleParams, Module, ModuleQueryResult, AttachableModuleInstance, ModuleQueries } from '@xyo-network/module-model';
5
- import * as _xyo_network_payload_model from '@xyo-network/payload-model';
6
- import { Payload, WithoutPrivateStorageMeta, Query } from '@xyo-network/payload-model';
7
- import { EventData } from '@xylabs/events';
8
- import { Promisable } from '@xylabs/promise';
9
- import { AccountInstance } from '@xyo-network/account-model';
10
- import { ObjectTypeShape } from '@xylabs/typeof';
11
-
12
- type ObserveEndEventArgs<T extends ModuleInstance = ModuleInstance, TIn extends Payload = Payload, TOut extends Payload = Payload> = ModuleEventArgs<T, {
13
- errors?: Error[];
14
- inPayloads?: TIn[];
15
- outPayloads?: TOut[];
16
- }>;
17
- interface ObserveEndEventData<T extends ModuleInstance = ModuleInstance, TIn extends Payload = Payload, TOut extends Payload = Payload> extends EventData {
18
- observeEnd: ObserveEndEventArgs<T, TIn, TOut>;
19
- }
20
-
21
- type ObserveStartEventArgs<T extends ModuleInstance = ModuleInstance, TIn extends Payload = Payload> = ModuleEventArgs<T, {
22
- inPayloads?: TIn[];
23
- }>;
24
- interface ObserveStartEventData<T extends ModuleInstance = ModuleInstance, TIn extends Payload = Payload> extends EventData {
25
- observeStart: ObserveStartEventArgs<T, TIn>;
26
- }
27
-
28
- type WitnessModuleEventData<T extends ModuleInstance = ModuleInstance, TIn extends Payload = Payload, TOut extends Payload = Payload> = ObserveEndEventData<T, TIn, TOut> & ObserveStartEventData<T, TIn> & ModuleEventData<T>;
29
-
30
- declare const WitnessConfigSchema: "network.xyo.witness.config";
31
- type WitnessConfigSchema = typeof WitnessConfigSchema;
32
- type WitnessConfig<TConfig extends EmptyObject | Payload | void = void, TSchema extends string | void = void> = ModuleConfig<WithAdditional<{
33
- schema: TConfig extends Payload ? TConfig['schema'] : WitnessConfigSchema;
34
- }, TConfig>, TSchema>;
35
-
36
- interface WitnessParams<TConfig extends AnyConfigSchema<WitnessConfig> = AnyConfigSchema<WitnessConfig>> extends ModuleParams<TConfig> {
37
- }
38
-
39
- interface WitnessModule<TParams extends WitnessParams = WitnessParams, TEvents extends WitnessModuleEventData = WitnessModuleEventData> extends Module<TParams, TEvents> {
40
- }
41
-
42
- interface WitnessQueryFunctions<TIn extends Payload = Payload, TOut extends Payload = Payload> {
43
- observe: (payloads?: TIn[]) => Promisable<WithoutPrivateStorageMeta<TOut>[]>;
44
- observeQuery: (payloads?: TIn[], account?: AccountInstance) => Promisable<ModuleQueryResult<TOut>>;
45
- }
46
-
47
- interface WitnessInstance<TParams extends WitnessParams = WitnessParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEvents extends WitnessModuleEventData = WitnessModuleEventData> extends WitnessModule<TParams, TEvents>, WitnessQueryFunctions<TIn, TOut>, ModuleInstance<TParams, TEvents> {
48
- }
49
-
50
- interface AttachableWitnessInstance<TParams extends WitnessParams = WitnessParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEventData extends WitnessModuleEventData = WitnessModuleEventData> extends WitnessInstance<TParams, TIn, TOut, TEventData>, AttachableModuleInstance<TParams, TEventData> {
51
- }
52
- type AttachableWitnessInstanceTypeCheck<T extends AttachableWitnessInstance = AttachableWitnessInstance> = TypeCheck<T>;
53
- declare class IsAttachableWitnessInstanceFactory<T extends AttachableWitnessInstance = AttachableWitnessInstance> extends IsObjectFactory<T> {
54
- }
55
-
56
- declare const asAttachableWitnessInstance: _xylabs_object.AsTypeFunction<AttachableWitnessInstance<WitnessParams<_xyo_network_module_model.AnyConfigSchema<WitnessConfig>>, _xyo_network_payload_model.Payload, _xyo_network_payload_model.Payload, WitnessModuleEventData>>;
57
-
58
- declare const requiredAttachableWitnessInstanceFunctions: ObjectTypeShape;
59
- declare const isAttachableWitnessInstance: TypeCheck<AttachableWitnessInstance>;
60
-
61
- type CustomWitnessModule<TParams extends WitnessParams = WitnessParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEvents extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut>> = Module<TParams, TEvents>;
62
-
63
- type CustomWitnessInstance<TParams extends WitnessParams = WitnessParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEvents extends WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut> = WitnessModuleEventData<WitnessInstance<TParams, TIn, TOut>, TIn, TOut>> = CustomWitnessModule<TParams, TIn, TOut, TEvents> & WitnessQueryFunctions<TIn, TOut> & ModuleInstance;
64
-
65
- declare const WitnessObserveQuerySchema: "network.xyo.query.witness.observe";
66
- type WitnessObserveQuerySchema = typeof WitnessObserveQuerySchema;
67
- type WitnessObserveQuery = Query<{
68
- payloads?: string[];
69
- schema: WitnessObserveQuerySchema;
70
- }>;
71
-
72
- type WitnessQueries = WitnessObserveQuery;
73
- type WitnessModuleQueries = ModuleQueries | WitnessQueries;
74
-
75
- declare const isWitnessInstance: TypeCheck<WitnessInstance>;
76
- declare const isWitnessModule: TypeCheck<WitnessModule>;
77
- declare const asWitnessModule: _xylabs_object.AsTypeFunction<WitnessModule<WitnessParams<_xyo_network_module_model.AnyConfigSchema<WitnessConfig>>, WitnessModuleEventData>>;
78
- declare const asWitnessInstance: _xylabs_object.AsTypeFunction<WitnessInstance<WitnessParams<_xyo_network_module_model.AnyConfigSchema<WitnessConfig>>, _xyo_network_payload_model.Payload, _xyo_network_payload_model.Payload, WitnessModuleEventData>>;
79
- declare const withWitnessModule: <R>(mod: any, closure: (mod: WitnessModule<WitnessParams<_xyo_network_module_model.AnyConfigSchema<WitnessConfig>>, WitnessModuleEventData>) => R) => R | undefined;
80
- declare const withWitnessInstance: <R>(mod: any, closure: (mod: WitnessInstance<WitnessParams<_xyo_network_module_model.AnyConfigSchema<WitnessConfig>>, _xyo_network_payload_model.Payload, _xyo_network_payload_model.Payload, WitnessModuleEventData>) => R) => R | undefined;
81
-
82
- export { IsAttachableWitnessInstanceFactory, WitnessConfigSchema, WitnessObserveQuerySchema, asAttachableWitnessInstance, asWitnessInstance, asWitnessModule, isAttachableWitnessInstance, isWitnessInstance, isWitnessModule, requiredAttachableWitnessInstanceFunctions, withWitnessInstance, withWitnessModule };
83
- export type { AttachableWitnessInstance, AttachableWitnessInstanceTypeCheck, CustomWitnessInstance, CustomWitnessModule, ObserveEndEventArgs, ObserveEndEventData, ObserveStartEventArgs, ObserveStartEventData, WitnessConfig, WitnessInstance, WitnessModule, WitnessModuleEventData, WitnessModuleQueries, WitnessObserveQuery, WitnessParams, WitnessQueries, WitnessQueryFunctions };
1
+ export * from './attachable/index.ts';
2
+ export * from './Config.ts';
3
+ export * from './CustomInstance.ts';
4
+ export * from './CustomModule.ts';
5
+ export * from './EventData.ts';
6
+ export * from './EventsModels/index.ts';
7
+ export * from './Instance.ts';
8
+ export * from './Module.ts';
9
+ export * from './Params.ts';
10
+ export * from './Queries/index.ts';
11
+ export * from './QueryFunctions.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/witness-model",
3
- "version": "4.1.2",
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,17 +29,17 @@
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/object": "^4.13.15",
34
- "@xylabs/promise": "^4.13.15",
35
- "@xylabs/typeof": "^4.13.15",
36
- "@xyo-network/account-model": "^4.1.2",
37
- "@xyo-network/module-model": "^4.1.2",
38
- "@xyo-network/payload-model": "^4.1.2"
32
+ "@xylabs/events": "^4.13.16",
33
+ "@xylabs/object": "^4.13.16",
34
+ "@xylabs/promise": "^4.13.16",
35
+ "@xylabs/typeof": "^4.13.16",
36
+ "@xyo-network/account-model": "^4.1.3",
37
+ "@xyo-network/module-model": "^4.1.3",
38
+ "@xyo-network/payload-model": "^4.1.3"
39
39
  },
40
40
  "devDependencies": {
41
- "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
42
- "@xylabs/tsconfig": "^7.0.0-rc.23",
41
+ "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
42
+ "@xylabs/tsconfig": "^7.0.0-rc.27",
43
43
  "typescript": "^5.8.3"
44
44
  },
45
45
  "publishConfig": {