@xyo-network/module-model 2.52.1 → 2.53.0
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/docs.json +10904 -21812
- package/dist/types/Module.d.ts +4 -2
- package/dist/types/Module.d.ts.map +1 -1
- package/dist/types/ModuleParams.d.ts +5 -7
- package/dist/types/ModuleParams.d.ts.map +1 -1
- package/package.json +8 -8
- package/src/Module.ts +8 -2
- package/src/ModuleParams.ts +4 -18
package/dist/types/Module.d.ts
CHANGED
|
@@ -4,6 +4,7 @@ import { Promisable } from '@xyo-network/promise';
|
|
|
4
4
|
import { ModuleConfig } from './Config';
|
|
5
5
|
import { ModuleFilter } from './ModuleFilter';
|
|
6
6
|
import { AnyConfigSchema, ModuleParams } from './ModuleParams';
|
|
7
|
+
import { ModuleEventData } from './ModuleQueried';
|
|
7
8
|
import { ModuleQueryResult } from './ModuleQueryResult';
|
|
8
9
|
import { XyoQueryBoundWitness } from './Query';
|
|
9
10
|
export interface ModuleResolver {
|
|
@@ -12,7 +13,7 @@ export interface ModuleResolver {
|
|
|
12
13
|
removeResolver: (resolver: ModuleResolver) => this;
|
|
13
14
|
resolve<T extends Module = Module>(filter?: ModuleFilter): Promisable<T[]>;
|
|
14
15
|
}
|
|
15
|
-
export type
|
|
16
|
+
export type ModuleFields<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>> = {
|
|
16
17
|
address: string;
|
|
17
18
|
config: TParams['config'];
|
|
18
19
|
readonly downResolver: ModuleResolver;
|
|
@@ -22,5 +23,6 @@ export type Module<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> =
|
|
|
22
23
|
queryable: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: XyoPayload[], queryConfig?: TConf) => Promisable<boolean>;
|
|
23
24
|
start?: () => Promisable<void>;
|
|
24
25
|
readonly upResolver: ModuleResolver;
|
|
25
|
-
}
|
|
26
|
+
};
|
|
27
|
+
export type Module<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>, TEventData extends ModuleEventData = ModuleEventData> = ModuleFields<TParams> & EventFunctions<TEventData>;
|
|
26
28
|
//# sourceMappingURL=Module.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,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,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,
|
|
1
|
+
{"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,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,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,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,YAAY,CAAC,OAAO,SAAS,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,GAAG,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,IAAI;IACpI,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;IAExB,KAAK,CAAC,EAAE,MAAM,UAAU,CAAC,IAAI,CAAC,CAAA;IAI9B,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,MAAM,CAChB,OAAO,SAAS,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,GAAG,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,EACzG,UAAU,SAAS,eAAe,GAAG,eAAe,IAClD,YAAY,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC,CAAA"}
|
|
@@ -1,20 +1,18 @@
|
|
|
1
1
|
import { AccountInstance } from '@xyo-network/account-model';
|
|
2
2
|
import { AnyObject, BaseParams, WithAdditional } from '@xyo-network/core';
|
|
3
|
-
import { EventData, EventDataParams } from '@xyo-network/module-events';
|
|
4
3
|
import { WalletInstance } from '@xyo-network/wallet-model';
|
|
5
4
|
import { ModuleConfig } from './Config';
|
|
6
|
-
|
|
7
|
-
export type BasicModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TEventData extends EventData | undefined = undefined, TAdditionalParams extends AnyObject | undefined = undefined> = WithAdditional<EventDataParams<TEventData, BaseParams<{
|
|
5
|
+
export type BasicModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TAdditionalParams extends AnyObject | undefined = undefined> = WithAdditional<BaseParams<{
|
|
8
6
|
config: TConfig;
|
|
9
|
-
}
|
|
10
|
-
export type AccountModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>,
|
|
7
|
+
}>, TAdditionalParams>;
|
|
8
|
+
export type AccountModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TAdditionalParams extends AnyObject | undefined = undefined> = BasicModuleParams<TConfig, WithAdditional<{
|
|
11
9
|
account: AccountInstance;
|
|
12
10
|
}, TAdditionalParams>>;
|
|
13
|
-
export type WalletModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>,
|
|
11
|
+
export type WalletModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TAdditionalParams extends AnyObject | undefined = undefined> = BasicModuleParams<TConfig, WithAdditional<{
|
|
14
12
|
accountDerivationPath: string;
|
|
15
13
|
wallet: WalletInstance;
|
|
16
14
|
}, TAdditionalParams>>;
|
|
17
|
-
export type ModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>,
|
|
15
|
+
export type ModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>, TAdditionalParams extends AnyObject | undefined = undefined> = AccountModuleParams<TConfig, TAdditionalParams> | WalletModuleParams<TConfig, TAdditionalParams> | BasicModuleParams<TConfig, TAdditionalParams>;
|
|
18
16
|
export type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & {
|
|
19
17
|
schema: string;
|
|
20
18
|
}> = ModuleConfig<WithAdditional<Omit<TConfig, 'schema'>, {
|
|
@@ -1 +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,
|
|
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;AAEvC,MAAM,MAAM,iBAAiB,CAC3B,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,EAC7C,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IACzD,cAAc,CAChB,UAAU,CAAC;IACT,MAAM,EAAE,OAAO,CAAA;CAChB,CAAC,EACF,iBAAiB,CAClB,CAAA;AAED,MAAM,MAAM,mBAAmB,CAC7B,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,EAC7C,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IACzD,iBAAiB,CACnB,OAAO,EACP,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,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IACzD,iBAAiB,CACnB,OAAO,EACP,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,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IACzD,mBAAmB,CAAC,OAAO,EAAE,iBAAiB,CAAC,GAAG,kBAAkB,CAAC,OAAO,EAAE,iBAAiB,CAAC,GAAG,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAA;AAEpJ,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,IAAI,YAAY,CAC3G,cAAc,CACZ,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EACvB;IACE,MAAM,EAAE,MAAM,CAAA;CACf,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"}
|
package/package.json
CHANGED
|
@@ -10,13 +10,13 @@
|
|
|
10
10
|
"url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@xyo-network/account-model": "^2.
|
|
14
|
-
"@xyo-network/boundwitness-model": "^2.
|
|
15
|
-
"@xyo-network/core": "^2.
|
|
16
|
-
"@xyo-network/module-events": "^2.
|
|
17
|
-
"@xyo-network/payload-model": "^2.
|
|
18
|
-
"@xyo-network/promise": "^2.
|
|
19
|
-
"@xyo-network/wallet-model": "^2.
|
|
13
|
+
"@xyo-network/account-model": "^2.53.0",
|
|
14
|
+
"@xyo-network/boundwitness-model": "^2.53.0",
|
|
15
|
+
"@xyo-network/core": "^2.53.0",
|
|
16
|
+
"@xyo-network/module-events": "^2.53.0",
|
|
17
|
+
"@xyo-network/payload-model": "^2.53.0",
|
|
18
|
+
"@xyo-network/promise": "^2.53.0",
|
|
19
|
+
"@xyo-network/wallet-model": "^2.53.0"
|
|
20
20
|
},
|
|
21
21
|
"devDependencies": {
|
|
22
22
|
"@xylabs/ts-scripts-yarn3": "^2.16.1",
|
|
@@ -56,5 +56,5 @@
|
|
|
56
56
|
},
|
|
57
57
|
"sideEffects": false,
|
|
58
58
|
"types": "dist/types/index.d.ts",
|
|
59
|
-
"version": "2.
|
|
59
|
+
"version": "2.53.0"
|
|
60
60
|
}
|
package/src/Module.ts
CHANGED
|
@@ -5,6 +5,7 @@ import { Promisable } from '@xyo-network/promise'
|
|
|
5
5
|
import { ModuleConfig } from './Config'
|
|
6
6
|
import { ModuleFilter } from './ModuleFilter'
|
|
7
7
|
import { AnyConfigSchema, ModuleParams } from './ModuleParams'
|
|
8
|
+
import { ModuleEventData } from './ModuleQueried'
|
|
8
9
|
import { ModuleQueryResult } from './ModuleQueryResult'
|
|
9
10
|
import { XyoQueryBoundWitness } from './Query'
|
|
10
11
|
|
|
@@ -15,7 +16,7 @@ export interface ModuleResolver {
|
|
|
15
16
|
resolve<T extends Module = Module>(filter?: ModuleFilter): Promisable<T[]>
|
|
16
17
|
}
|
|
17
18
|
|
|
18
|
-
export type
|
|
19
|
+
export type ModuleFields<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>> = {
|
|
19
20
|
address: string
|
|
20
21
|
config: TParams['config']
|
|
21
22
|
|
|
@@ -41,4 +42,9 @@ export type Module<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> =
|
|
|
41
42
|
/* The resolver is a 'up' resolver. It can resolve the parent or any children of the parent*/
|
|
42
43
|
/* This is set by a NodeModule when attaching to the module */
|
|
43
44
|
readonly upResolver: ModuleResolver
|
|
44
|
-
}
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export type Module<
|
|
48
|
+
TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,
|
|
49
|
+
TEventData extends ModuleEventData = ModuleEventData,
|
|
50
|
+
> = ModuleFields<TParams> & EventFunctions<TEventData>
|
package/src/ModuleParams.ts
CHANGED
|
@@ -1,32 +1,24 @@
|
|
|
1
1
|
import { AccountInstance } from '@xyo-network/account-model'
|
|
2
2
|
import { AnyObject, BaseParams, WithAdditional } from '@xyo-network/core'
|
|
3
|
-
import { EventData, EventDataParams } from '@xyo-network/module-events'
|
|
4
3
|
import { WalletInstance } from '@xyo-network/wallet-model'
|
|
5
4
|
|
|
6
5
|
import { ModuleConfig } from './Config'
|
|
7
|
-
import { ModuleEventData } from './ModuleQueried'
|
|
8
6
|
|
|
9
7
|
export type BasicModuleParams<
|
|
10
8
|
TConfig extends AnyConfigSchema<ModuleConfig>,
|
|
11
|
-
TEventData extends EventData | undefined = undefined,
|
|
12
9
|
TAdditionalParams extends AnyObject | undefined = undefined,
|
|
13
10
|
> = WithAdditional<
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
config: TConfig
|
|
18
|
-
}>
|
|
19
|
-
>,
|
|
11
|
+
BaseParams<{
|
|
12
|
+
config: TConfig
|
|
13
|
+
}>,
|
|
20
14
|
TAdditionalParams
|
|
21
15
|
>
|
|
22
16
|
|
|
23
17
|
export type AccountModuleParams<
|
|
24
18
|
TConfig extends AnyConfigSchema<ModuleConfig>,
|
|
25
|
-
TEventData extends EventData | undefined = undefined,
|
|
26
19
|
TAdditionalParams extends AnyObject | undefined = undefined,
|
|
27
20
|
> = BasicModuleParams<
|
|
28
21
|
TConfig,
|
|
29
|
-
TEventData,
|
|
30
22
|
WithAdditional<
|
|
31
23
|
{
|
|
32
24
|
account: AccountInstance
|
|
@@ -37,11 +29,9 @@ export type AccountModuleParams<
|
|
|
37
29
|
|
|
38
30
|
export type WalletModuleParams<
|
|
39
31
|
TConfig extends AnyConfigSchema<ModuleConfig>,
|
|
40
|
-
TEventData extends EventData | undefined = undefined,
|
|
41
32
|
TAdditionalParams extends AnyObject | undefined = undefined,
|
|
42
33
|
> = BasicModuleParams<
|
|
43
34
|
TConfig,
|
|
44
|
-
TEventData,
|
|
45
35
|
WithAdditional<
|
|
46
36
|
{
|
|
47
37
|
accountDerivationPath: string
|
|
@@ -53,12 +43,8 @@ export type WalletModuleParams<
|
|
|
53
43
|
|
|
54
44
|
export type ModuleParams<
|
|
55
45
|
TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>,
|
|
56
|
-
TEventData extends ModuleEventData = ModuleEventData,
|
|
57
46
|
TAdditionalParams extends AnyObject | undefined = undefined,
|
|
58
|
-
> =
|
|
59
|
-
| AccountModuleParams<TConfig, TEventData, TAdditionalParams>
|
|
60
|
-
| WalletModuleParams<TConfig, TEventData, TAdditionalParams>
|
|
61
|
-
| BasicModuleParams<TConfig, TEventData, TAdditionalParams>
|
|
47
|
+
> = AccountModuleParams<TConfig, TAdditionalParams> | WalletModuleParams<TConfig, TAdditionalParams> | BasicModuleParams<TConfig, TAdditionalParams>
|
|
62
48
|
|
|
63
49
|
export type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & { schema: string }> = ModuleConfig<
|
|
64
50
|
WithAdditional<
|