@xyo-network/module-model 2.51.8 → 2.52.0-rc.1
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.
- package/dist/cjs/Events/{EventArgs.js → Event.js} +1 -1
- package/dist/cjs/Events/Event.js.map +1 -0
- package/dist/cjs/Events/index.js +1 -4
- package/dist/cjs/Events/index.js.map +1 -1
- package/dist/cjs/{model/Module.js.map → Module.js.map} +1 -1
- package/dist/cjs/ModuleDescription.js.map +1 -0
- package/dist/cjs/ModuleEventArgs.js +3 -0
- package/dist/cjs/ModuleEventArgs.js.map +1 -0
- package/dist/cjs/{Events/EventListener.js → ModuleParams.js} +1 -1
- package/dist/cjs/ModuleParams.js.map +1 -0
- package/dist/cjs/{PartialConfig.js → ModuleQueried.js} +1 -1
- package/dist/cjs/ModuleQueried.js.map +1 -0
- package/dist/cjs/ModuleRepository.js.map +1 -0
- package/dist/cjs/index.js +6 -2
- package/dist/cjs/index.js.map +1 -1
- package/dist/docs.json +14489 -3682
- package/dist/esm/Events/Event.js +2 -0
- package/dist/esm/Events/Event.js.map +1 -0
- package/dist/esm/Events/index.js +1 -4
- package/dist/esm/Events/index.js.map +1 -1
- package/dist/esm/{model/Module.js.map → Module.js.map} +1 -1
- package/dist/esm/ModuleDescription.js.map +1 -0
- package/dist/esm/ModuleEventArgs.js +2 -0
- package/dist/esm/ModuleEventArgs.js.map +1 -0
- package/dist/esm/ModuleParams.js +2 -0
- package/dist/esm/ModuleParams.js.map +1 -0
- package/dist/esm/ModuleQueried.js +2 -0
- package/dist/esm/ModuleQueried.js.map +1 -0
- package/dist/esm/ModuleRepository.js.map +1 -0
- package/dist/esm/index.js +6 -2
- package/dist/esm/index.js.map +1 -1
- package/dist/types/Config.d.ts +5 -4
- package/dist/types/Config.d.ts.map +1 -1
- package/dist/types/Events/Event.d.ts +24 -0
- package/dist/types/Events/Event.d.ts.map +1 -0
- package/dist/types/Events/index.d.ts +1 -4
- package/dist/types/Events/index.d.ts.map +1 -1
- package/dist/types/{model/Module.d.ts → Module.d.ts} +10 -11
- package/dist/types/Module.d.ts.map +1 -0
- package/dist/types/ModuleDescription.d.ts.map +1 -0
- package/dist/types/ModuleEventArgs.d.ts +8 -0
- package/dist/types/ModuleEventArgs.d.ts.map +1 -0
- package/dist/types/ModuleParams.d.ts +28 -0
- package/dist/types/ModuleParams.d.ts.map +1 -0
- package/dist/types/ModuleQueried.d.ts +14 -0
- package/dist/types/ModuleQueried.d.ts.map +1 -0
- package/dist/types/ModuleRepository.d.ts.map +1 -0
- package/dist/types/index.d.ts +6 -2
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +8 -5
- package/src/Config.ts +23 -18
- package/src/Events/Event.ts +27 -0
- package/src/Events/index.ts +1 -4
- package/src/{model/Module.ts → Module.ts} +11 -12
- package/src/ModuleEventArgs.ts +10 -0
- package/src/ModuleParams.ts +73 -0
- package/src/ModuleQueried.ts +16 -0
- package/src/index.ts +6 -2
- package/dist/cjs/Events/EventArgs.js.map +0 -1
- package/dist/cjs/Events/EventListener.js.map +0 -1
- package/dist/cjs/Events/ModuleEventEmitter.js +0 -3
- package/dist/cjs/Events/ModuleEventEmitter.js.map +0 -1
- package/dist/cjs/Events/ModuleQueried.js +0 -5
- package/dist/cjs/Events/ModuleQueried.js.map +0 -1
- package/dist/cjs/PartialConfig.js.map +0 -1
- package/dist/cjs/model/ModuleDescription.js.map +0 -1
- package/dist/cjs/model/ModuleRepository.js.map +0 -1
- package/dist/cjs/model/index.js +0 -7
- package/dist/cjs/model/index.js.map +0 -1
- package/dist/esm/Events/EventArgs.js +0 -2
- package/dist/esm/Events/EventArgs.js.map +0 -1
- package/dist/esm/Events/EventListener.js +0 -2
- package/dist/esm/Events/EventListener.js.map +0 -1
- package/dist/esm/Events/ModuleEventEmitter.js +0 -2
- package/dist/esm/Events/ModuleEventEmitter.js.map +0 -1
- package/dist/esm/Events/ModuleQueried.js +0 -2
- package/dist/esm/Events/ModuleQueried.js.map +0 -1
- package/dist/esm/PartialConfig.js +0 -2
- package/dist/esm/PartialConfig.js.map +0 -1
- package/dist/esm/model/ModuleDescription.js.map +0 -1
- package/dist/esm/model/ModuleRepository.js.map +0 -1
- package/dist/esm/model/index.js +0 -4
- package/dist/esm/model/index.js.map +0 -1
- package/dist/types/Events/EventArgs.d.ts +0 -4
- package/dist/types/Events/EventArgs.d.ts.map +0 -1
- package/dist/types/Events/EventListener.d.ts +0 -3
- package/dist/types/Events/EventListener.d.ts.map +0 -1
- package/dist/types/Events/ModuleEventEmitter.d.ts +0 -7
- package/dist/types/Events/ModuleEventEmitter.d.ts.map +0 -1
- package/dist/types/Events/ModuleQueried.d.ts +0 -21
- package/dist/types/Events/ModuleQueried.d.ts.map +0 -1
- package/dist/types/PartialConfig.d.ts +0 -5
- package/dist/types/PartialConfig.d.ts.map +0 -1
- package/dist/types/model/Module.d.ts.map +0 -1
- package/dist/types/model/ModuleDescription.d.ts.map +0 -1
- package/dist/types/model/ModuleRepository.d.ts.map +0 -1
- package/dist/types/model/index.d.ts +0 -4
- package/dist/types/model/index.d.ts.map +0 -1
- package/src/Events/EventArgs.ts +0 -5
- package/src/Events/EventListener.ts +0 -3
- package/src/Events/ModuleEventEmitter.ts +0 -12
- package/src/Events/ModuleQueried.ts +0 -29
- package/src/PartialConfig.ts +0 -5
- package/src/model/index.ts +0 -3
- /package/dist/cjs/{model/Module.js → Module.js} +0 -0
- /package/dist/cjs/{model/ModuleDescription.js → ModuleDescription.js} +0 -0
- /package/dist/cjs/{model/ModuleRepository.js → ModuleRepository.js} +0 -0
- /package/dist/esm/{model/Module.js → Module.js} +0 -0
- /package/dist/esm/{model/ModuleDescription.js → ModuleDescription.js} +0 -0
- /package/dist/esm/{model/ModuleRepository.js → ModuleRepository.js} +0 -0
- /package/dist/types/{model/ModuleDescription.d.ts → ModuleDescription.d.ts} +0 -0
- /package/dist/types/{model/ModuleRepository.d.ts → ModuleRepository.d.ts} +0 -0
- /package/src/{model/ModuleDescription.ts → ModuleDescription.ts} +0 -0
- /package/src/{model/ModuleRepository.ts → ModuleRepository.ts} +0 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Event.js","sourceRoot":"","sources":["../../../src/Events/Event.ts"],"names":[],"mappings":""}
|
package/dist/esm/Events/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Events/index.ts"],"names":[],"mappings":"AAAA,cAAc,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Events/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Module.js","sourceRoot":"","sources":["
|
|
1
|
+
{"version":3,"file":"Module.js","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ModuleDescription.js","sourceRoot":"","sources":["../../src/ModuleDescription.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ModuleEventArgs.js","sourceRoot":"","sources":["../../src/ModuleEventArgs.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ModuleParams.js","sourceRoot":"","sources":["../../src/ModuleParams.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ModuleQueried.js","sourceRoot":"","sources":["../../src/ModuleQueried.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ModuleRepository.js","sourceRoot":"","sources":["../../src/ModuleRepository.ts"],"names":[],"mappings":""}
|
package/dist/esm/index.js
CHANGED
|
@@ -1,9 +1,13 @@
|
|
|
1
1
|
export * from './Config';
|
|
2
2
|
export * from './Events';
|
|
3
|
-
export * from './
|
|
3
|
+
export * from './Module';
|
|
4
|
+
export * from './ModuleDescription';
|
|
5
|
+
export * from './ModuleEventArgs';
|
|
4
6
|
export * from './ModuleFilter';
|
|
7
|
+
export * from './ModuleParams';
|
|
8
|
+
export * from './ModuleQueried';
|
|
5
9
|
export * from './ModuleQueryResult';
|
|
6
|
-
export * from './
|
|
10
|
+
export * from './ModuleRepository';
|
|
7
11
|
export * from './Queries';
|
|
8
12
|
export * from './Query';
|
|
9
13
|
//# sourceMappingURL=index.js.map
|
package/dist/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}
|
package/dist/types/Config.d.ts
CHANGED
|
@@ -1,18 +1,19 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { WithAdditional } from '@xyo-network/core';
|
|
2
2
|
import { XyoPayload } from '@xyo-network/payload-model';
|
|
3
3
|
export type ModuleConfigSchema = 'network.xyo.module.config';
|
|
4
4
|
export declare const ModuleConfigSchema: ModuleConfigSchema;
|
|
5
5
|
export type AddressString = string;
|
|
6
6
|
export type CosigningAddressSet = string[];
|
|
7
7
|
export type SchemaString = string;
|
|
8
|
-
export type ModuleConfigBase<
|
|
8
|
+
export type ModuleConfigBase<TConfig extends XyoPayload | undefined = undefined> = XyoPayload<WithAdditional<{
|
|
9
9
|
name?: string;
|
|
10
|
+
schema: TConfig extends XyoPayload ? TConfig['schema'] : ModuleConfigSchema;
|
|
10
11
|
security?: {
|
|
11
12
|
allowAnonymous?: boolean;
|
|
12
13
|
allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>;
|
|
13
14
|
disallowed?: Record<SchemaString, AddressString[]>;
|
|
14
15
|
};
|
|
15
16
|
storeQueries?: boolean;
|
|
16
|
-
}
|
|
17
|
-
export type ModuleConfig<TConfig extends XyoPayload =
|
|
17
|
+
}, Omit<TConfig, 'schema'>>>;
|
|
18
|
+
export type ModuleConfig<TConfig extends XyoPayload | undefined = undefined> = ModuleConfigBase<TConfig>;
|
|
18
19
|
//# sourceMappingURL=Config.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAEvD,MAAM,MAAM,kBAAkB,GAAG,2BAA2B,CAAA;AAC5D,eAAO,MAAM,kBAAkB,EAAE,kBAAgD,CAAA;AAEjF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAClC,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAA;AAC1C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,UAAU,GAAG,SAAS,GAAG,SAAS,IAAI,UAAU,CAC3F,cAAc,CACZ;IAEE,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,MAAM,EAAE,OAAO,SAAS,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAA;IAG3E,QAAQ,CAAC,EAAE;QAET,cAAc,CAAC,EAAE,OAAO,CAAA;QAGxB,OAAO,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,aAAa,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAA;QAGvE,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC,CAAA;KACnD,CAAA;IAGD,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,EACD,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CACxB,CACF,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,UAAU,GAAG,SAAS,GAAG,SAAS,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAA"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { Promisable } from '@xyo-network/promise';
|
|
2
|
+
export type EventName = PropertyKey;
|
|
3
|
+
export type EventArgs = string | number | object | undefined;
|
|
4
|
+
export type EventData = {
|
|
5
|
+
[key: EventName]: EventArgs;
|
|
6
|
+
};
|
|
7
|
+
export type EventUnsubscribeFunction = () => void;
|
|
8
|
+
export type EventAnyListener<TEventData extends EventData> = (eventName: keyof TEventData, eventData?: TEventData[keyof TEventData]) => Promisable<void>;
|
|
9
|
+
export type EventListener<TEventData extends EventData> = (eventData?: TEventData[keyof TEventData]) => Promisable<void>;
|
|
10
|
+
export type OncePromise<T> = {
|
|
11
|
+
off(): void;
|
|
12
|
+
} & Promise<T>;
|
|
13
|
+
export interface EventFunctions<TEventData extends EventData> {
|
|
14
|
+
clearListeners(eventNames: keyof TEventData | keyof TEventData[]): void;
|
|
15
|
+
emit(eventName: keyof TEventData, eventData: TEventData[keyof TEventData]): Promise<void>;
|
|
16
|
+
emitSerial(eventName: keyof TEventData, eventData: TEventData[keyof TEventData]): Promise<void>;
|
|
17
|
+
listenerCount(eventNames: keyof TEventData | keyof TEventData[]): number;
|
|
18
|
+
off(eventName: keyof TEventData | keyof TEventData[], listener: EventListener<TEventData>): void;
|
|
19
|
+
offAny(listener: EventAnyListener<TEventData> | Promise<void>): void;
|
|
20
|
+
on(eventName: keyof TEventData | keyof TEventData[], listener: EventListener<TEventData>): EventUnsubscribeFunction;
|
|
21
|
+
onAny(listener: EventAnyListener<TEventData>): EventUnsubscribeFunction;
|
|
22
|
+
once(eventName: keyof TEventData | keyof TEventData[], listener: EventListener<TEventData>): EventUnsubscribeFunction;
|
|
23
|
+
}
|
|
24
|
+
//# sourceMappingURL=Event.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Event.d.ts","sourceRoot":"","sources":["../../../src/Events/Event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,MAAM,MAAM,SAAS,GAAG,WAAW,CAAA;AACnC,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;AAC5D,MAAM,MAAM,SAAS,GAAG;IAAE,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS,CAAA;CAAE,CAAA;AACvD,MAAM,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAA;AACjD,MAAM,MAAM,gBAAgB,CAAC,UAAU,SAAS,SAAS,IAAI,CAC3D,SAAS,EAAE,MAAM,UAAU,EAC3B,SAAS,CAAC,EAAE,UAAU,CAAC,MAAM,UAAU,CAAC,KACrC,UAAU,CAAC,IAAI,CAAC,CAAA;AACrB,MAAM,MAAM,aAAa,CAAC,UAAU,SAAS,SAAS,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,MAAM,UAAU,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,CAAA;AAExH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,GAAG,IAAI,IAAI,CAAA;CACZ,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;AAEd,MAAM,WAAW,cAAc,CAAC,UAAU,SAAS,SAAS;IAC1D,cAAc,CAAC,UAAU,EAAE,MAAM,UAAU,GAAG,MAAM,UAAU,EAAE,GAAG,IAAI,CAAA;IACvE,IAAI,CAAC,SAAS,EAAE,MAAM,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,MAAM,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzF,UAAU,CAAC,SAAS,EAAE,MAAM,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,MAAM,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/F,aAAa,CAAC,UAAU,EAAE,MAAM,UAAU,GAAG,MAAM,UAAU,EAAE,GAAG,MAAM,CAAA;IACxE,GAAG,CAAC,SAAS,EAAE,MAAM,UAAU,GAAG,MAAM,UAAU,EAAE,EAAE,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;IAChG,MAAM,CAAC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACpE,EAAE,CAAC,SAAS,EAAE,MAAM,UAAU,GAAG,MAAM,UAAU,EAAE,EAAE,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,wBAAwB,CAAA;IACnH,KAAK,CAAC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,GAAG,wBAAwB,CAAA;IACvE,IAAI,CAAC,SAAS,EAAE,MAAM,UAAU,GAAG,MAAM,UAAU,EAAE,EAAE,QAAQ,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,wBAAwB,CAAA;CACtH"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Events/index.ts"],"names":[],"mappings":"AAAA,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Events/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA"}
|
|
@@ -1,26 +1,25 @@
|
|
|
1
1
|
import { XyoPayload } from '@xyo-network/payload-model';
|
|
2
2
|
import { Promisable } from '@xyo-network/promise';
|
|
3
|
-
import { ModuleConfig } from '
|
|
4
|
-
import {
|
|
5
|
-
import { ModuleFilter } from '
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
3
|
+
import { ModuleConfig } from './Config';
|
|
4
|
+
import { EventFunctions } from './Events';
|
|
5
|
+
import { ModuleFilter } from './ModuleFilter';
|
|
6
|
+
import { AnyConfigSchema, ModuleParams } from './ModuleParams';
|
|
7
|
+
import { ModuleQueryResult } from './ModuleQueryResult';
|
|
8
|
+
import { XyoQueryBoundWitness } from './Query';
|
|
8
9
|
export interface ModuleResolver {
|
|
9
10
|
addResolver: (resolver: ModuleResolver) => this;
|
|
10
11
|
isModuleResolver: boolean;
|
|
11
12
|
removeResolver: (resolver: ModuleResolver) => this;
|
|
12
13
|
resolve<T extends Module = Module>(filter?: ModuleFilter): Promisable<T[]>;
|
|
13
14
|
}
|
|
14
|
-
export type
|
|
15
|
-
on: TModuleEventEmitter extends ModuleEventEmitter ? ModuleQueriedEventEmitter['on'] | TModuleEventEmitter['on'] : ModuleQueriedEventEmitter['on'];
|
|
16
|
-
} & Module<TConfig>;
|
|
17
|
-
export type Module<TConfig extends ModuleConfig = ModuleConfig> = {
|
|
15
|
+
export type Module<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>> = {
|
|
18
16
|
address: string;
|
|
19
|
-
config:
|
|
17
|
+
config: TParams['config'];
|
|
20
18
|
readonly downResolver: ModuleResolver;
|
|
19
|
+
params: TParams;
|
|
21
20
|
queries: string[];
|
|
22
21
|
query: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: XyoPayload[], queryConfig?: TConf) => Promisable<ModuleQueryResult>;
|
|
23
22
|
queryable: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: XyoPayload[], queryConfig?: TConf) => Promisable<boolean>;
|
|
24
23
|
readonly upResolver: ModuleResolver;
|
|
25
|
-
}
|
|
24
|
+
} & EventFunctions<TParams['eventData']>;
|
|
26
25
|
//# sourceMappingURL=Module.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAE9C,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAC/C,gBAAgB,EAAE,OAAO,CAAA;IACzB,cAAc,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAClD,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAAA;CAC3E;AAED,MAAM,MAAM,MAAM,CAAC,OAAO,SAAS,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,GAAG,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,IAAI;IAC9H,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IAGzB,QAAQ,CAAC,YAAY,EAAE,cAAc,CAAA;IAErC,MAAM,EAAE,OAAO,CAAA;IAEf,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,EAAE,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EACtG,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,UAAU,EAAE,EACvB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAClC,SAAS,EAAE,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EAC1G,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,UAAU,EAAE,EACvB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,OAAO,CAAC,CAAA;IAIxB,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAA;CACpC,GAAG,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ModuleDescription.d.ts","sourceRoot":"","sources":["../../src/ModuleDescription.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { EventArgs } from './Events';
|
|
2
|
+
import { Module } from './Module';
|
|
3
|
+
export type ModuleEventArgs<TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs ? {
|
|
4
|
+
module: Module;
|
|
5
|
+
} & TArgs : {
|
|
6
|
+
module: Module;
|
|
7
|
+
};
|
|
8
|
+
//# sourceMappingURL=ModuleEventArgs.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ModuleEventArgs.d.ts","sourceRoot":"","sources":["../../src/ModuleEventArgs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IAAI,KAAK,SAAS,SAAS,GAClG;IACE,MAAM,EAAE,MAAM,CAAA;CACf,GAAG,KAAK,GACT;IACE,MAAM,EAAE,MAAM,CAAA;CACf,CAAA"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { AccountInstance } from '@xyo-network/account-model';
|
|
2
|
+
import { AnyObject, BaseParams, WithAdditional } from '@xyo-network/core';
|
|
3
|
+
import { WalletInstance } from '@xyo-network/wallet-model';
|
|
4
|
+
import { ModuleConfig } from './Config';
|
|
5
|
+
import { EventData } from './Events';
|
|
6
|
+
export type EventDataParams<TEventData extends EventData | undefined = undefined, TParams extends BaseParams = BaseParams> = TParams & {
|
|
7
|
+
eventData?: TEventData extends EventData ? TEventData | any : any;
|
|
8
|
+
};
|
|
9
|
+
export type BasicModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TEventData extends EventData | undefined = undefined, TAdditionalParams extends AnyObject | undefined = undefined> = WithAdditional<EventDataParams<TEventData, BaseParams<{
|
|
10
|
+
config: TConfig;
|
|
11
|
+
}>>, TAdditionalParams>;
|
|
12
|
+
export type AccountModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TEventData extends EventData | undefined = undefined, TAdditionalParams extends AnyObject | undefined = undefined> = BasicModuleParams<TConfig, TEventData, WithAdditional<{
|
|
13
|
+
account: AccountInstance;
|
|
14
|
+
}, TAdditionalParams>>;
|
|
15
|
+
export type WalletModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TEventData extends EventData | undefined = undefined, TAdditionalParams extends AnyObject | undefined = undefined> = BasicModuleParams<TConfig, TEventData, WithAdditional<{
|
|
16
|
+
accountDerivationPath: string;
|
|
17
|
+
wallet: WalletInstance;
|
|
18
|
+
}, TAdditionalParams>>;
|
|
19
|
+
export type ModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>, TEventData extends EventData | undefined = undefined, TAdditionalParams extends AnyObject | undefined = undefined> = AccountModuleParams<TConfig, TEventData, TAdditionalParams> | WalletModuleParams<TConfig, TEventData, TAdditionalParams> | BasicModuleParams<TConfig, TEventData, TAdditionalParams>;
|
|
20
|
+
export type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & {
|
|
21
|
+
schema: string;
|
|
22
|
+
}> = ModuleConfig<Omit<TConfig, 'schema'> & {
|
|
23
|
+
schema: string;
|
|
24
|
+
}>;
|
|
25
|
+
export type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {
|
|
26
|
+
schema?: TConfig['schema'];
|
|
27
|
+
};
|
|
28
|
+
//# sourceMappingURL=ModuleParams.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ModuleParams.d.ts","sourceRoot":"","sources":["../../src/ModuleParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE1D,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAEpC,MAAM,MAAM,eAAe,CAAC,UAAU,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EAAE,OAAO,SAAS,UAAU,GAAG,UAAU,IAAI,OAAO,GAAG;IAErI,SAAS,CAAC,EAAE,UAAU,SAAS,SAAS,GAAG,UAAU,GAAG,GAAG,GAAG,GAAG,CAAA;CAClE,CAAA;AAED,MAAM,MAAM,iBAAiB,CAC3B,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,EAC7C,UAAU,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EACpD,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IACzD,cAAc,CAChB,eAAe,CACb,UAAU,EACV,UAAU,CAAC;IACT,MAAM,EAAE,OAAO,CAAA;CAChB,CAAC,CACH,EACD,iBAAiB,CAClB,CAAA;AAED,MAAM,MAAM,mBAAmB,CAC7B,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,EAC7C,UAAU,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EACpD,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IACzD,iBAAiB,CACnB,OAAO,EACP,UAAU,EACV,cAAc,CACZ;IACE,OAAO,EAAE,eAAe,CAAA;CACzB,EACD,iBAAiB,CAClB,CACF,CAAA;AAED,MAAM,MAAM,kBAAkB,CAC5B,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,EAC7C,UAAU,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EACpD,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IACzD,iBAAiB,CACnB,OAAO,EACP,UAAU,EACV,cAAc,CACZ;IACE,qBAAqB,EAAE,MAAM,CAAA;IAC7B,MAAM,EAAE,cAAc,CAAA;CACvB,EACD,iBAAiB,CAClB,CACF,CAAA;AAED,MAAM,MAAM,YAAY,CACtB,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,EAC7E,UAAU,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EACpD,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IAEzD,mBAAmB,CAAC,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,GAC3D,kBAAkB,CAAC,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,GAC1D,iBAAiB,CAAC,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAA;AAE7D,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,IAAI,YAAY,CAC3G,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;IACxB,MAAM,EAAE,MAAM,CAAA;CACf,CACF,CAAA;AAED,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;CAAE,CAAA"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { XyoBoundWitness } from '@xyo-network/boundwitness-model';
|
|
2
|
+
import { XyoPayload } from '@xyo-network/payload-model';
|
|
3
|
+
import { EventData } from './Events';
|
|
4
|
+
import { ModuleEventArgs } from './ModuleEventArgs';
|
|
5
|
+
import { XyoQueryBoundWitness } from './Query';
|
|
6
|
+
export type ModuleQueriedEventArgs = ModuleEventArgs<{
|
|
7
|
+
payloads?: XyoPayload[];
|
|
8
|
+
query: XyoQueryBoundWitness;
|
|
9
|
+
result: [XyoBoundWitness, XyoPayload[]];
|
|
10
|
+
}>;
|
|
11
|
+
export interface ModuleEventData extends EventData {
|
|
12
|
+
moduleQueried: ModuleQueriedEventArgs;
|
|
13
|
+
}
|
|
14
|
+
//# sourceMappingURL=ModuleQueried.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ModuleQueried.d.ts","sourceRoot":"","sources":["../../src/ModuleQueried.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAEvD,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAE9C,MAAM,MAAM,sBAAsB,GAAG,eAAe,CAAC;IACnD,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAA;IACvB,KAAK,EAAE,oBAAoB,CAAA;IAC3B,MAAM,EAAE,CAAC,eAAe,EAAE,UAAU,EAAE,CAAC,CAAA;CACxC,CAAC,CAAA;AAEF,MAAM,WAAW,eAAgB,SAAQ,SAAS;IAChD,aAAa,EAAE,sBAAsB,CAAA;CACtC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ModuleRepository.d.ts","sourceRoot":"","sources":["../../src/ModuleRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAEjD,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAC3B,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IAEpC,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;CACzC"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,9 +1,13 @@
|
|
|
1
1
|
export * from './Config';
|
|
2
2
|
export * from './Events';
|
|
3
|
-
export * from './
|
|
3
|
+
export * from './Module';
|
|
4
|
+
export * from './ModuleDescription';
|
|
5
|
+
export * from './ModuleEventArgs';
|
|
4
6
|
export * from './ModuleFilter';
|
|
7
|
+
export * from './ModuleParams';
|
|
8
|
+
export * from './ModuleQueried';
|
|
5
9
|
export * from './ModuleQueryResult';
|
|
6
|
-
export * from './
|
|
10
|
+
export * from './ModuleRepository';
|
|
7
11
|
export * from './Queries';
|
|
8
12
|
export * from './Query';
|
|
9
13
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}
|
package/package.json
CHANGED
|
@@ -10,10 +10,12 @@
|
|
|
10
10
|
"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@xyo-network/
|
|
14
|
-
"@xyo-network/
|
|
15
|
-
"@xyo-network/
|
|
16
|
-
"@xyo-network/
|
|
13
|
+
"@xyo-network/account-model": "^2.52.0-rc.1",
|
|
14
|
+
"@xyo-network/boundwitness-model": "^2.52.0-rc.1",
|
|
15
|
+
"@xyo-network/core": "^2.52.0-rc.1",
|
|
16
|
+
"@xyo-network/payload-model": "^2.52.0-rc.1",
|
|
17
|
+
"@xyo-network/promise": "^2.52.0-rc.1",
|
|
18
|
+
"@xyo-network/wallet-model": "^2.52.0-rc.1"
|
|
17
19
|
},
|
|
18
20
|
"devDependencies": {
|
|
19
21
|
"@xylabs/ts-scripts-yarn3": "^2.16.1",
|
|
@@ -53,5 +55,6 @@
|
|
|
53
55
|
},
|
|
54
56
|
"sideEffects": false,
|
|
55
57
|
"types": "dist/types/index.d.ts",
|
|
56
|
-
"version": "2.
|
|
58
|
+
"version": "2.52.0-rc.1",
|
|
59
|
+
"stableVersion": "2.51.9"
|
|
57
60
|
}
|
package/src/Config.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { WithAdditional } from '@xyo-network/core'
|
|
2
2
|
import { XyoPayload } from '@xyo-network/payload-model'
|
|
3
3
|
|
|
4
4
|
export type ModuleConfigSchema = 'network.xyo.module.config'
|
|
@@ -8,26 +8,31 @@ export type AddressString = string
|
|
|
8
8
|
export type CosigningAddressSet = string[]
|
|
9
9
|
export type SchemaString = string
|
|
10
10
|
|
|
11
|
-
export type ModuleConfigBase<
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
11
|
+
export type ModuleConfigBase<TConfig extends XyoPayload | undefined = undefined> = XyoPayload<
|
|
12
|
+
WithAdditional<
|
|
13
|
+
{
|
|
14
|
+
//friendly name of module (not collision resistent)
|
|
15
|
+
name?: string
|
|
15
16
|
|
|
16
|
-
|
|
17
|
-
security?: {
|
|
18
|
-
//will process queries that have unsigned boundwitness in tuples
|
|
19
|
-
allowAnonymous?: boolean
|
|
17
|
+
schema: TConfig extends XyoPayload ? TConfig['schema'] : ModuleConfigSchema
|
|
20
18
|
|
|
21
|
-
//if
|
|
22
|
-
|
|
19
|
+
//if both allowed and disallowed is specified, then disallowed takes priority
|
|
20
|
+
security?: {
|
|
21
|
+
//will process queries that have unsigned boundwitness in tuples
|
|
22
|
+
allowAnonymous?: boolean
|
|
23
23
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
}
|
|
24
|
+
//if schema in record, then only these address sets can access query
|
|
25
|
+
allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>
|
|
27
26
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
27
|
+
//if schema in record, then anyone except these addresses can access query
|
|
28
|
+
disallowed?: Record<SchemaString, AddressString[]>
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
//store the queries made to the module in an archivist if possible
|
|
32
|
+
storeQueries?: boolean
|
|
33
|
+
},
|
|
34
|
+
Omit<TConfig, 'schema'>
|
|
35
|
+
>
|
|
31
36
|
>
|
|
32
37
|
|
|
33
|
-
export type ModuleConfig<TConfig extends XyoPayload =
|
|
38
|
+
export type ModuleConfig<TConfig extends XyoPayload | undefined = undefined> = ModuleConfigBase<TConfig>
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { Promisable } from '@xyo-network/promise'
|
|
2
|
+
|
|
3
|
+
export type EventName = PropertyKey
|
|
4
|
+
export type EventArgs = string | number | object | undefined
|
|
5
|
+
export type EventData = { [key: EventName]: EventArgs }
|
|
6
|
+
export type EventUnsubscribeFunction = () => void
|
|
7
|
+
export type EventAnyListener<TEventData extends EventData> = (
|
|
8
|
+
eventName: keyof TEventData,
|
|
9
|
+
eventData?: TEventData[keyof TEventData],
|
|
10
|
+
) => Promisable<void>
|
|
11
|
+
export type EventListener<TEventData extends EventData> = (eventData?: TEventData[keyof TEventData]) => Promisable<void>
|
|
12
|
+
|
|
13
|
+
export type OncePromise<T> = {
|
|
14
|
+
off(): void
|
|
15
|
+
} & Promise<T>
|
|
16
|
+
|
|
17
|
+
export interface EventFunctions<TEventData extends EventData> {
|
|
18
|
+
clearListeners(eventNames: keyof TEventData | keyof TEventData[]): void
|
|
19
|
+
emit(eventName: keyof TEventData, eventData: TEventData[keyof TEventData]): Promise<void>
|
|
20
|
+
emitSerial(eventName: keyof TEventData, eventData: TEventData[keyof TEventData]): Promise<void>
|
|
21
|
+
listenerCount(eventNames: keyof TEventData | keyof TEventData[]): number
|
|
22
|
+
off(eventName: keyof TEventData | keyof TEventData[], listener: EventListener<TEventData>): void
|
|
23
|
+
offAny(listener: EventAnyListener<TEventData> | Promise<void>): void
|
|
24
|
+
on(eventName: keyof TEventData | keyof TEventData[], listener: EventListener<TEventData>): EventUnsubscribeFunction
|
|
25
|
+
onAny(listener: EventAnyListener<TEventData>): EventUnsubscribeFunction
|
|
26
|
+
once(eventName: keyof TEventData | keyof TEventData[], listener: EventListener<TEventData>): EventUnsubscribeFunction
|
|
27
|
+
}
|
package/src/Events/index.ts
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import { XyoPayload } from '@xyo-network/payload-model'
|
|
2
2
|
import { Promisable } from '@xyo-network/promise'
|
|
3
3
|
|
|
4
|
-
import { ModuleConfig } from '
|
|
5
|
-
import {
|
|
6
|
-
import { ModuleFilter } from '
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
4
|
+
import { ModuleConfig } from './Config'
|
|
5
|
+
import { EventFunctions } from './Events'
|
|
6
|
+
import { ModuleFilter } from './ModuleFilter'
|
|
7
|
+
import { AnyConfigSchema, ModuleParams } from './ModuleParams'
|
|
8
|
+
import { ModuleQueryResult } from './ModuleQueryResult'
|
|
9
|
+
import { XyoQueryBoundWitness } from './Query'
|
|
9
10
|
|
|
10
11
|
export interface ModuleResolver {
|
|
11
12
|
addResolver: (resolver: ModuleResolver) => this
|
|
@@ -14,17 +15,15 @@ export interface ModuleResolver {
|
|
|
14
15
|
resolve<T extends Module = Module>(filter?: ModuleFilter): Promisable<T[]>
|
|
15
16
|
}
|
|
16
17
|
|
|
17
|
-
export type
|
|
18
|
-
on: TModuleEventEmitter extends ModuleEventEmitter ? ModuleQueriedEventEmitter['on'] | TModuleEventEmitter['on'] : ModuleQueriedEventEmitter['on']
|
|
19
|
-
} & Module<TConfig>
|
|
20
|
-
|
|
21
|
-
export type Module<TConfig extends ModuleConfig = ModuleConfig> = {
|
|
18
|
+
export type Module<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>> = {
|
|
22
19
|
address: string
|
|
23
|
-
config:
|
|
20
|
+
config: TParams['config']
|
|
24
21
|
|
|
25
22
|
/* The resolver is a 'down' resolver. It can resolve the module or any children (if it is a node for example), that are in the module*/
|
|
26
23
|
readonly downResolver: ModuleResolver
|
|
27
24
|
|
|
25
|
+
params: TParams
|
|
26
|
+
|
|
28
27
|
queries: string[]
|
|
29
28
|
query: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(
|
|
30
29
|
query: T,
|
|
@@ -40,4 +39,4 @@ export type Module<TConfig extends ModuleConfig = ModuleConfig> = {
|
|
|
40
39
|
/* The resolver is a 'up' resolver. It can resolve the parent or any children of the parent*/
|
|
41
40
|
/* This is set by a NodeModule when attaching to the module */
|
|
42
41
|
readonly upResolver: ModuleResolver
|
|
43
|
-
}
|
|
42
|
+
} & EventFunctions<TParams['eventData']>
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { AccountInstance } from '@xyo-network/account-model'
|
|
2
|
+
import { AnyObject, BaseParams, WithAdditional } from '@xyo-network/core'
|
|
3
|
+
import { WalletInstance } from '@xyo-network/wallet-model'
|
|
4
|
+
|
|
5
|
+
import { ModuleConfig } from './Config'
|
|
6
|
+
import { EventData } from './Events'
|
|
7
|
+
|
|
8
|
+
export type EventDataParams<TEventData extends EventData | undefined = undefined, TParams extends BaseParams = BaseParams> = TParams & {
|
|
9
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
10
|
+
eventData?: TEventData extends EventData ? TEventData | any : any
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export type BasicModuleParams<
|
|
14
|
+
TConfig extends AnyConfigSchema<ModuleConfig>,
|
|
15
|
+
TEventData extends EventData | undefined = undefined,
|
|
16
|
+
TAdditionalParams extends AnyObject | undefined = undefined,
|
|
17
|
+
> = WithAdditional<
|
|
18
|
+
EventDataParams<
|
|
19
|
+
TEventData,
|
|
20
|
+
BaseParams<{
|
|
21
|
+
config: TConfig
|
|
22
|
+
}>
|
|
23
|
+
>,
|
|
24
|
+
TAdditionalParams
|
|
25
|
+
>
|
|
26
|
+
|
|
27
|
+
export type AccountModuleParams<
|
|
28
|
+
TConfig extends AnyConfigSchema<ModuleConfig>,
|
|
29
|
+
TEventData extends EventData | undefined = undefined,
|
|
30
|
+
TAdditionalParams extends AnyObject | undefined = undefined,
|
|
31
|
+
> = BasicModuleParams<
|
|
32
|
+
TConfig,
|
|
33
|
+
TEventData,
|
|
34
|
+
WithAdditional<
|
|
35
|
+
{
|
|
36
|
+
account: AccountInstance
|
|
37
|
+
},
|
|
38
|
+
TAdditionalParams
|
|
39
|
+
>
|
|
40
|
+
>
|
|
41
|
+
|
|
42
|
+
export type WalletModuleParams<
|
|
43
|
+
TConfig extends AnyConfigSchema<ModuleConfig>,
|
|
44
|
+
TEventData extends EventData | undefined = undefined,
|
|
45
|
+
TAdditionalParams extends AnyObject | undefined = undefined,
|
|
46
|
+
> = BasicModuleParams<
|
|
47
|
+
TConfig,
|
|
48
|
+
TEventData,
|
|
49
|
+
WithAdditional<
|
|
50
|
+
{
|
|
51
|
+
accountDerivationPath: string
|
|
52
|
+
wallet: WalletInstance
|
|
53
|
+
},
|
|
54
|
+
TAdditionalParams
|
|
55
|
+
>
|
|
56
|
+
>
|
|
57
|
+
|
|
58
|
+
export type ModuleParams<
|
|
59
|
+
TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>,
|
|
60
|
+
TEventData extends EventData | undefined = undefined,
|
|
61
|
+
TAdditionalParams extends AnyObject | undefined = undefined,
|
|
62
|
+
> =
|
|
63
|
+
| AccountModuleParams<TConfig, TEventData, TAdditionalParams>
|
|
64
|
+
| WalletModuleParams<TConfig, TEventData, TAdditionalParams>
|
|
65
|
+
| BasicModuleParams<TConfig, TEventData, TAdditionalParams>
|
|
66
|
+
|
|
67
|
+
export type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & { schema: string }> = ModuleConfig<
|
|
68
|
+
Omit<TConfig, 'schema'> & {
|
|
69
|
+
schema: string
|
|
70
|
+
}
|
|
71
|
+
>
|
|
72
|
+
|
|
73
|
+
export type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & { schema?: TConfig['schema'] }
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { XyoBoundWitness } from '@xyo-network/boundwitness-model'
|
|
2
|
+
import { XyoPayload } from '@xyo-network/payload-model'
|
|
3
|
+
|
|
4
|
+
import { EventData } from './Events'
|
|
5
|
+
import { ModuleEventArgs } from './ModuleEventArgs'
|
|
6
|
+
import { XyoQueryBoundWitness } from './Query'
|
|
7
|
+
|
|
8
|
+
export type ModuleQueriedEventArgs = ModuleEventArgs<{
|
|
9
|
+
payloads?: XyoPayload[]
|
|
10
|
+
query: XyoQueryBoundWitness
|
|
11
|
+
result: [XyoBoundWitness, XyoPayload[]]
|
|
12
|
+
}>
|
|
13
|
+
|
|
14
|
+
export interface ModuleEventData extends EventData {
|
|
15
|
+
moduleQueried: ModuleQueriedEventArgs
|
|
16
|
+
}
|
package/src/index.ts
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
export * from './Config'
|
|
2
2
|
export * from './Events'
|
|
3
|
-
export * from './
|
|
3
|
+
export * from './Module'
|
|
4
|
+
export * from './ModuleDescription'
|
|
5
|
+
export * from './ModuleEventArgs'
|
|
4
6
|
export * from './ModuleFilter'
|
|
7
|
+
export * from './ModuleParams'
|
|
8
|
+
export * from './ModuleQueried'
|
|
5
9
|
export * from './ModuleQueryResult'
|
|
6
|
-
export * from './
|
|
10
|
+
export * from './ModuleRepository'
|
|
7
11
|
export * from './Queries'
|
|
8
12
|
export * from './Query'
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"EventArgs.js","sourceRoot":"","sources":["../../../src/Events/EventArgs.ts"],"names":[],"mappings":""}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"EventListener.js","sourceRoot":"","sources":["../../../src/Events/EventListener.ts"],"names":[],"mappings":""}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ModuleEventEmitter.js","sourceRoot":"","sources":["../../../src/Events/ModuleEventEmitter.ts"],"names":[],"mappings":""}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ModuleQueried.js","sourceRoot":"","sources":["../../../src/Events/ModuleQueried.ts"],"names":[],"mappings":";;;AAUa,QAAA,kBAAkB,GAAuB,eAAe,CAAA"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"PartialConfig.js","sourceRoot":"","sources":["../../src/PartialConfig.ts"],"names":[],"mappings":""}
|