@xyo-network/module-model 2.57.4 → 2.57.6
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/Queries/ModuleAccount/Payload.js +6 -0
- package/dist/cjs/Queries/ModuleAccount/Payload.js.map +1 -0
- package/dist/cjs/Queries/ModuleAccount/Query.js +5 -0
- package/dist/cjs/Queries/ModuleAccount/Query.js.map +1 -0
- package/dist/cjs/Queries/ModuleAccount/index.js +6 -0
- package/dist/cjs/Queries/ModuleAccount/index.js.map +1 -0
- package/dist/cjs/Queries/index.js +1 -1
- package/dist/cjs/Queries/index.js.map +1 -1
- package/dist/docs.json +17259 -4878
- package/dist/esm/Queries/ModuleAccount/Payload.js +3 -0
- package/dist/esm/Queries/ModuleAccount/Payload.js.map +1 -0
- package/dist/esm/Queries/ModuleAccount/Query.js +2 -0
- package/dist/esm/Queries/ModuleAccount/Query.js.map +1 -0
- package/dist/esm/Queries/ModuleAccount/index.js +3 -0
- package/dist/esm/Queries/ModuleAccount/index.js.map +1 -0
- package/dist/esm/Queries/index.js +1 -1
- package/dist/esm/Queries/index.js.map +1 -1
- package/dist/types/Config.d.ts +46 -8
- package/dist/types/Config.d.ts.map +1 -1
- package/dist/types/Module.d.ts +10 -0
- package/dist/types/Module.d.ts.map +1 -1
- package/dist/types/Queries/ModuleAccount/Payload.d.ts +9 -0
- package/dist/types/Queries/ModuleAccount/Payload.d.ts.map +1 -0
- package/dist/types/Queries/ModuleAccount/Query.d.ts +7 -0
- package/dist/types/Queries/ModuleAccount/Query.d.ts.map +1 -0
- package/dist/types/Queries/ModuleAccount/index.d.ts +3 -0
- package/dist/types/Queries/ModuleAccount/index.d.ts.map +1 -0
- package/dist/types/Queries/index.d.ts +3 -3
- package/dist/types/Queries/index.d.ts.map +1 -1
- package/docs/assets/highlight.css +22 -0
- package/docs/assets/main.js +58 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1367 -0
- package/docs/functions/creatableModule-1.html +126 -0
- package/docs/functions/isQueryBoundWitness.html +105 -0
- package/docs/index.html +107 -0
- package/docs/interfaces/AddressModuleFilter.html +120 -0
- package/docs/interfaces/CreatableModule.html +201 -0
- package/docs/interfaces/IndividualArchivistConfig.html +134 -0
- package/docs/interfaces/ModuleDescription.html +141 -0
- package/docs/interfaces/ModuleEventData.html +122 -0
- package/docs/interfaces/ModuleRepository.html +271 -0
- package/docs/interfaces/ModuleResolver.html +216 -0
- package/docs/interfaces/ModuleSubscribeFilter.html +123 -0
- package/docs/interfaces/NameModuleFilter.html +120 -0
- package/docs/interfaces/QueryFields.html +153 -0
- package/docs/interfaces/QueryModuleFilter.html +120 -0
- package/docs/modules.html +161 -0
- package/docs/types/AccountModuleParams.html +103 -0
- package/docs/types/AddressPreviousHashPayload.html +96 -0
- package/docs/types/AddressPreviousHashSchema.html +97 -0
- package/docs/types/AddressString.html +96 -0
- package/docs/types/AllModuleFilter.html +96 -0
- package/docs/types/AnyConfigSchema.html +101 -0
- package/docs/types/AnyModuleConfig.html +96 -0
- package/docs/types/AnyModuleFilter.html +96 -0
- package/docs/types/ArchivistModuleConfig.html +96 -0
- package/docs/types/BasicModuleParams.html +103 -0
- package/docs/types/CosigningAddressSet.html +96 -0
- package/docs/types/CreatableModuleFactory.html +101 -0
- package/docs/types/Module.html +103 -0
- package/docs/types/ModuleAccountQuery.html +96 -0
- package/docs/types/ModuleAccountQuerySchema.html +97 -0
- package/docs/types/ModuleConfig.html +101 -0
- package/docs/types/ModuleConfigBase.html +101 -0
- package/docs/types/ModuleConfigSchema.html +97 -0
- package/docs/types/ModuleDiscoverQuery.html +96 -0
- package/docs/types/ModuleDiscoverQuerySchema.html +97 -0
- package/docs/types/ModuleEventArgs.html +103 -0
- package/docs/types/ModuleFields.html +172 -0
- package/docs/types/ModuleFilter.html +96 -0
- package/docs/types/ModuleParams.html +103 -0
- package/docs/types/ModuleQueriedEventArgs.html +96 -0
- package/docs/types/ModuleQuery.html +101 -0
- package/docs/types/ModuleQueryBase.html +96 -0
- package/docs/types/ModuleQueryResult.html +101 -0
- package/docs/types/ModuleSubscribeQuery.html +96 -0
- package/docs/types/ModuleSubscribeQuerySchema.html +97 -0
- package/docs/types/NameOrAddress.html +96 -0
- package/docs/types/OptionalConfigSchema.html +101 -0
- package/docs/types/Query.html +101 -0
- package/docs/types/QueryBoundWitness.html +96 -0
- package/docs/types/QueryBoundWitnessSchema.html +97 -0
- package/docs/types/SchemaString.html +96 -0
- package/docs/types/WalletModuleParams.html +103 -0
- package/docs/variables/AddressPreviousHashSchema-1.html +97 -0
- package/docs/variables/ModuleAccountQuerySchema-1.html +97 -0
- package/docs/variables/ModuleConfigSchema-1.html +97 -0
- package/docs/variables/ModuleDiscoverQuerySchema-1.html +97 -0
- package/docs/variables/ModuleSubscribeQuerySchema-1.html +97 -0
- package/docs/variables/QueryBoundWitnessSchema-1.html +97 -0
- package/package.json +11 -10
- package/src/Config.ts +50 -15
- package/src/Module.ts +10 -0
- package/src/Queries/ModuleAccount/Payload.ts +11 -0
- package/src/Queries/ModuleAccount/Query.ts +8 -0
- package/src/Queries/ModuleAccount/index.ts +2 -0
- package/src/Queries/index.ts +3 -3
- package/dist/cjs/Queries/PreviousHash.js +0 -5
- package/dist/cjs/Queries/PreviousHash.js.map +0 -1
- package/dist/esm/Queries/PreviousHash.js +0 -2
- package/dist/esm/Queries/PreviousHash.js.map +0 -1
- package/dist/types/Queries/PreviousHash.d.ts +0 -7
- package/dist/types/Queries/PreviousHash.d.ts.map +0 -1
- package/src/Queries/PreviousHash.ts +0 -8
package/src/Module.ts
CHANGED
|
@@ -13,7 +13,17 @@ export interface ModuleResolver {
|
|
|
13
13
|
addResolver: (resolver: ModuleResolver) => this
|
|
14
14
|
isModuleResolver: boolean
|
|
15
15
|
removeResolver: (resolver: ModuleResolver) => this
|
|
16
|
+
/**
|
|
17
|
+
* Resolves all modules matching the supplied filter. If no filter
|
|
18
|
+
* is supplied, all modules are returned
|
|
19
|
+
* @param filter Filter criteria for the desired modules
|
|
20
|
+
*/
|
|
16
21
|
resolve<T extends Module = Module>(filter?: ModuleFilter): Promisable<T[]>
|
|
22
|
+
/**
|
|
23
|
+
* Resolves a single module, or undefined if no modules matched the filter.
|
|
24
|
+
* @param filter The desired Module's Address or Name
|
|
25
|
+
*/
|
|
26
|
+
resolveOne<T extends Module = Module>(filter: string): Promisable<T | undefined>
|
|
17
27
|
}
|
|
18
28
|
|
|
19
29
|
export type ModuleEventArgs<TModule extends Module = Module, TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { AddressSchema } from '@xyo-network/address-payload-plugin'
|
|
2
|
+
import { Payload } from '@xyo-network/payload-model'
|
|
3
|
+
|
|
4
|
+
export const AddressPreviousHashSchema = `${AddressSchema}.hash.previous`
|
|
5
|
+
export type AddressPreviousHashSchema = typeof AddressPreviousHashSchema
|
|
6
|
+
|
|
7
|
+
export type AddressPreviousHashPayload = Payload<{
|
|
8
|
+
address: string
|
|
9
|
+
previousHash?: string
|
|
10
|
+
schema: AddressPreviousHashSchema
|
|
11
|
+
}>
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { Query } from '../../Query'
|
|
2
|
+
|
|
3
|
+
export type ModuleAccountQuerySchema = 'network.xyo.query.module.account'
|
|
4
|
+
export const ModuleAccountQuerySchema: ModuleAccountQuerySchema = 'network.xyo.query.module.account'
|
|
5
|
+
|
|
6
|
+
export type ModuleAccountQuery = Query<{
|
|
7
|
+
schema: ModuleAccountQuerySchema
|
|
8
|
+
}>
|
package/src/Queries/index.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { Query } from '../Query'
|
|
2
2
|
import { ModuleDiscoverQuery } from './Discover'
|
|
3
|
-
import {
|
|
3
|
+
import { ModuleAccountQuery } from './ModuleAccount'
|
|
4
4
|
import { ModuleSubscribeQuery } from './Subscribe'
|
|
5
5
|
|
|
6
6
|
export * from './Discover'
|
|
7
|
-
export * from './
|
|
7
|
+
export * from './ModuleAccount'
|
|
8
8
|
export * from './Subscribe'
|
|
9
9
|
|
|
10
|
-
export type ModuleQueryBase = ModuleDiscoverQuery |
|
|
10
|
+
export type ModuleQueryBase = ModuleDiscoverQuery | ModuleAccountQuery | ModuleSubscribeQuery
|
|
11
11
|
|
|
12
12
|
export type ModuleQuery<T extends Query | void = void> = T extends Query ? ModuleQueryBase | T : ModuleQueryBase
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"PreviousHash.js","sourceRoot":"","sources":["../../../src/Queries/PreviousHash.ts"],"names":[],"mappings":";;;AAGa,QAAA,6BAA6B,GAAkC,gDAAgD,CAAA"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"PreviousHash.js","sourceRoot":"","sources":["../../../src/Queries/PreviousHash.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,6BAA6B,GAAkC,gDAAgD,CAAA"}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { Query } from '../Query';
|
|
2
|
-
export type ModulePreviousHashQuerySchema = 'network.xyo.query.module.account.hash.previous';
|
|
3
|
-
export declare const ModulePreviousHashQuerySchema: ModulePreviousHashQuerySchema;
|
|
4
|
-
export type ModulePreviousHashQuery = Query<{
|
|
5
|
-
schema: ModulePreviousHashQuerySchema;
|
|
6
|
-
}>;
|
|
7
|
-
//# sourceMappingURL=PreviousHash.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"PreviousHash.d.ts","sourceRoot":"","sources":["../../../src/Queries/PreviousHash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAEhC,MAAM,MAAM,6BAA6B,GAAG,gDAAgD,CAAA;AAC5F,eAAO,MAAM,6BAA6B,EAAE,6BAAgF,CAAA;AAE5H,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC;IAC1C,MAAM,EAAE,6BAA6B,CAAA;CACtC,CAAC,CAAA"}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { Query } from '../Query'
|
|
2
|
-
|
|
3
|
-
export type ModulePreviousHashQuerySchema = 'network.xyo.query.module.account.hash.previous'
|
|
4
|
-
export const ModulePreviousHashQuerySchema: ModulePreviousHashQuerySchema = 'network.xyo.query.module.account.hash.previous'
|
|
5
|
-
|
|
6
|
-
export type ModulePreviousHashQuery = Query<{
|
|
7
|
-
schema: ModulePreviousHashQuerySchema
|
|
8
|
-
}>
|