@xyo-network/module-abstract 2.73.3 → 2.74.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.
Files changed (46) hide show
  1. package/dist/AbstractModule.d.mts +84 -0
  2. package/dist/AbstractModule.d.mts.map +1 -0
  3. package/dist/AbstractModule.d.ts +84 -0
  4. package/dist/AbstractModule.d.ts.map +1 -0
  5. package/dist/AbstractModuleInstance.d.mts +14 -0
  6. package/dist/AbstractModuleInstance.d.mts.map +1 -0
  7. package/dist/AbstractModuleInstance.d.ts +14 -0
  8. package/dist/AbstractModuleInstance.d.ts.map +1 -0
  9. package/dist/BaseEmitter.d.mts +17 -0
  10. package/dist/BaseEmitter.d.mts.map +1 -0
  11. package/dist/BaseEmitter.d.ts +17 -0
  12. package/dist/BaseEmitter.d.ts.map +1 -0
  13. package/dist/Error.d.mts +15 -0
  14. package/dist/Error.d.mts.map +1 -0
  15. package/dist/Error.d.ts +15 -0
  16. package/dist/Error.d.ts.map +1 -0
  17. package/dist/QueryValidator/ModuleConfigQueryValidator.d.mts +15 -0
  18. package/dist/QueryValidator/ModuleConfigQueryValidator.d.mts.map +1 -0
  19. package/dist/QueryValidator/ModuleConfigQueryValidator.d.ts +15 -0
  20. package/dist/QueryValidator/ModuleConfigQueryValidator.d.ts.map +1 -0
  21. package/dist/QueryValidator/QueryValidator.d.mts +8 -0
  22. package/dist/QueryValidator/QueryValidator.d.mts.map +1 -0
  23. package/dist/QueryValidator/QueryValidator.d.ts +8 -0
  24. package/dist/QueryValidator/QueryValidator.d.ts.map +1 -0
  25. package/dist/QueryValidator/SupportedQueryValidator.d.mts +22 -0
  26. package/dist/QueryValidator/SupportedQueryValidator.d.mts.map +1 -0
  27. package/dist/QueryValidator/SupportedQueryValidator.d.ts +22 -0
  28. package/dist/QueryValidator/SupportedQueryValidator.d.ts.map +1 -0
  29. package/dist/QueryValidator/index.d.mts +4 -0
  30. package/dist/QueryValidator/index.d.mts.map +1 -0
  31. package/dist/QueryValidator/index.d.ts +4 -0
  32. package/dist/QueryValidator/index.d.ts.map +1 -0
  33. package/dist/index.d.mts +6 -163
  34. package/dist/index.d.mts.map +1 -0
  35. package/dist/index.d.ts +6 -163
  36. package/dist/index.d.ts.map +1 -0
  37. package/dist/index.js +7 -7
  38. package/dist/index.js.map +1 -1
  39. package/dist/index.mjs +7 -7
  40. package/dist/index.mjs.map +1 -1
  41. package/package.json +25 -33
  42. package/src/AbstractModule.ts +13 -17
  43. package/src/AbstractModuleInstance.ts +2 -13
  44. package/types.d.ts +3 -0
  45. package/dist/docs.json +0 -41338
  46. package/tsup.config.ts +0 -16
package/dist/index.d.mts CHANGED
@@ -1,163 +1,6 @@
1
- import { AccountInstance } from '@xyo-network/account-model';
2
- import { ArchivistInstance } from '@xyo-network/archivist-model';
3
- import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
4
- import * as _xyo_network_boundwitness_model from '@xyo-network/boundwitness-model';
5
- import { BoundWitness } from '@xyo-network/boundwitness-model';
6
- import { ModuleManifestPayload } from '@xyo-network/manifest-model';
7
- import { AnyConfigSchema, ModuleConfig, SchemaString, AddressString, Module, ModuleParams, ModuleEventData, ModuleQueryBase, ModuleInstance, CreatableModule, CreatableModuleFactory, ModuleQueryResult, ModuleFilter, ModuleFilterOptions, ModuleDescriptionPayload, AddressPreviousHashPayload, ModuleQueryHandlerResult } from '@xyo-network/module-model';
8
- import { CompositeModuleResolver } from '@xyo-network/module-resolver';
9
- import * as _xyo_network_payload_model from '@xyo-network/payload-model';
10
- import { Payload, Query, ModuleError } from '@xyo-network/payload-model';
11
- import { Promisable, PromiseEx } from '@xyo-network/promise';
12
- import { WalletInstance } from '@xyo-network/wallet-model';
13
- import { BaseParams, Base } from '@xyo-network/core';
14
- import { EventData, EventFunctions, EventListener, EventAnyListener } from '@xyo-network/module-events';
15
- import { PayloadBuilder } from '@xyo-network/payload-builder';
16
-
17
- declare class BaseEmitter<TParams extends BaseParams = BaseParams, TEventData extends EventData = EventData> extends Base<TParams> implements EventFunctions<TEventData> {
18
- eventData: TEventData;
19
- private events;
20
- constructor(params: TParams);
21
- clearListeners(eventNames: keyof TEventData | (keyof TEventData)[]): void;
22
- emit<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
23
- emitSerial<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
24
- listenerCount(eventNames: keyof TEventData | (keyof TEventData)[]): number;
25
- off<TEventName extends keyof TEventData>(eventNames: TEventName | TEventName[], listener: EventListener<TEventData[TEventName]>): void;
26
- offAny(listener: EventAnyListener): void;
27
- on<TEventName extends keyof TEventData>(eventNames: TEventName | TEventName[], listener: EventListener<TEventData[TEventName]>): () => void;
28
- onAny(listener: EventAnyListener): () => void;
29
- once<TEventName extends keyof TEventData>(eventName: TEventName, listener: EventListener<TEventData[TEventName]>): () => void;
30
- }
31
-
32
- type Queryable<T extends QueryBoundWitness = QueryBoundWitness> = (query: T, payloads?: Payload[]) => Promisable<boolean>;
33
- interface QueryValidator<T extends QueryBoundWitness = QueryBoundWitness> {
34
- queryable: Queryable<T>;
35
- }
36
-
37
- type SortedPipedAddressesString = string;
38
- declare class ModuleConfigQueryValidator<TConfig extends AnyConfigSchema<ModuleConfig>> implements QueryValidator {
39
- protected allowed: Record<SchemaString, SortedPipedAddressesString[]>;
40
- protected disallowed: Record<SchemaString, AddressString[]>;
41
- protected readonly hasAllowedRules: boolean;
42
- protected readonly hasDisallowedRules: boolean;
43
- protected readonly hasRules: boolean;
44
- constructor(config?: TConfig);
45
- queryable: Queryable;
46
- protected queryAllowed: (schema: SchemaString, addresses: string[]) => boolean;
47
- protected queryDisallowed: (schema: SchemaString, addresses: string[]) => boolean;
48
- }
49
-
50
- declare const isQuerySupportedByModule: <T extends _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_boundwitness_model.BoundWitnessFields & {
51
- query: string;
52
- resultSet?: string | undefined;
53
- schema: "network.xyo.boundwitness";
54
- } & {
55
- schema: "network.xyo.boundwitness";
56
- } = _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_boundwitness_model.BoundWitnessFields & {
57
- query: string;
58
- resultSet?: string | undefined;
59
- schema: "network.xyo.boundwitness";
60
- } & {
61
- schema: "network.xyo.boundwitness";
62
- }>(mod: Module, query: T, payloads?: Payload[]) => Promise<boolean>;
63
- declare class SupportedQueryValidator implements QueryValidator {
64
- protected readonly mod: Module;
65
- constructor(mod: Module);
66
- queryable: Queryable;
67
- }
68
-
69
- declare abstract class AbstractModule<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<ModuleConfig>, TEventData extends ModuleEventData = ModuleEventData> extends BaseEmitter<TParams, TEventData> implements Module<TParams, TEventData> {
70
- static configSchemas: string[];
71
- static enableLazyLoad: boolean;
72
- protected static privateConstructorKey: string;
73
- readonly downResolver: Omit<CompositeModuleResolver, 'resolve'>;
74
- readonly upResolver: Omit<CompositeModuleResolver, 'resolve>'>;
75
- protected _account: AccountInstance | undefined;
76
- protected readonly _baseModuleQueryAccountPaths: Record<ModuleQueryBase['schema'], string>;
77
- protected readonly _queryAccounts: Record<ModuleQueryBase['schema'], AccountInstance | undefined>;
78
- protected _startPromise: Promisable<boolean> | undefined;
79
- protected _started: Promisable<boolean> | undefined;
80
- protected readonly moduleConfigQueryValidator: Queryable;
81
- protected readonly supportedQueryValidator: Queryable;
82
- private _busyCount;
83
- constructor(privateConstructorKey: string, params: TParams, account: AccountInstance);
84
- static get configSchema(): string;
85
- get account(): AccountInstance;
86
- get address(): string;
87
- get allowAnonymous(): boolean;
88
- get config(): TParams['config'];
89
- get ephemeralQueryAccountEnabled(): boolean;
90
- get queries(): string[];
91
- get queryAccountPaths(): Readonly<Record<Query['schema'], string | undefined>>;
92
- get queryAccounts(): Readonly<Record<Query['schema'], AccountInstance | undefined>>;
93
- get timestamp(): boolean;
94
- protected abstract get _queryAccountPaths(): Record<Query['schema'], string>;
95
- static _getRootFunction(funcName: string): any;
96
- static _noOverride(functionName: string): void;
97
- static create<TModule extends ModuleInstance>(this: CreatableModule<TModule>, params?: Omit<TModule['params'], 'config'> & {
98
- config?: TModule['params']['config'];
99
- }): Promise<TModule>;
100
- static determineAccount({ account, accountDerivationPath, wallet, }: {
101
- account?: AccountInstance | 'random';
102
- accountDerivationPath?: string;
103
- wallet?: WalletInstance;
104
- }): Promise<AccountInstance>;
105
- static factory<TModule extends ModuleInstance>(this: CreatableModule<TModule>, params?: Omit<TModule['params'], 'config'> & {
106
- config?: TModule['params']['config'];
107
- }): CreatableModuleFactory<TModule>;
108
- _getRootFunction(funcName: string): any;
109
- _noOverride(functionName: string): void;
110
- busy<R>(closure: () => Promise<R>): Promise<R>;
111
- emit<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
112
- previousHash(): Promisable<string | undefined>;
113
- query<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryResult>;
114
- queryable<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): boolean;
115
- resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter, options?: ModuleFilterOptions<T>): Promise<T[]>;
116
- resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddress: string, options?: ModuleFilterOptions<T>): Promise<T | undefined>;
117
- start(_timeout?: number): Promisable<boolean>;
118
- started(notStartedAction?: 'error' | 'throw' | 'warn' | 'log' | 'none', tryStart?: boolean): Promise<boolean>;
119
- stop(_timeout?: number): Promise<boolean>;
120
- protected bindHashes(hashes: string[], schema: SchemaString[], account?: AccountInstance): PromiseEx<unknown, AccountInstance>;
121
- protected bindHashesInternal(hashes: string[], schema: SchemaString[], account?: AccountInstance): Promise<BoundWitness>;
122
- protected bindQuery<T extends Query>(query: T, payloads?: Payload[], account?: AccountInstance): PromiseEx<[QueryBoundWitness, Payload[], Payload[]], AccountInstance>;
123
- protected bindQueryInternal<T extends Query>(query: T, payloads?: Payload[], account?: AccountInstance): Promise<[QueryBoundWitness, Payload[], Payload[]]>;
124
- protected bindQueryResult<T extends Query>(query: T, payloads: Payload[], additionalWitnesses?: AccountInstance[], errors?: ModuleError[]): Promise<ModuleQueryResult>;
125
- protected commitArchivist: () => Promise<ArchivistInstance | undefined>;
126
- protected describeHandler(): Promise<ModuleDescriptionPayload>;
127
- protected discoverHandler(): Promisable<Payload[]>;
128
- protected initializeQueryAccounts(): Promise<void>;
129
- protected manifestHandler(_ignoreAddresses?: string[]): Promisable<ModuleManifestPayload>;
130
- protected moduleAddressHandler(): Promisable<AddressPreviousHashPayload[]>;
131
- protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
132
- protected readArchivist: () => Promise<ArchivistInstance | undefined>;
133
- protected startHandler(): Promise<boolean>;
134
- protected stopHandler(_timeout?: number): Promisable<boolean>;
135
- protected subscribeHandler(): void;
136
- protected validateConfig(config?: unknown, parents?: string[]): boolean;
137
- protected writeArchivist: () => Promise<ArchivistInstance | undefined>;
138
- private getArchivist;
139
- }
140
-
141
- declare abstract class AbstractModuleInstance<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<ModuleConfig>, TEventData extends ModuleEventData = ModuleEventData> extends AbstractModule<TParams, TEventData> implements Module<TParams, TEventData> {
142
- constructor(privateConstructorKey: string, params: TParams, account: AccountInstance);
143
- describe(): Promise<ModuleDescriptionPayload>;
144
- discover(): Promise<Payload[]>;
145
- manifest(ignoreAddresses?: string[]): Promise<ModuleManifestPayload>;
146
- moduleAddress(): Promise<AddressPreviousHashPayload[]>;
147
- subscribe(_queryAccount?: AccountInstance): void;
148
- }
149
-
150
- declare class ModuleErrorBuilder extends PayloadBuilder {
151
- _message?: string;
152
- _name?: string;
153
- _query?: string;
154
- _sources?: string[];
155
- constructor();
156
- build(): ModuleError;
157
- message(message: string): this;
158
- name(name: string): this;
159
- query(query: string): this;
160
- sources(sources: string[]): this;
161
- }
162
-
163
- export { AbstractModule, AbstractModuleInstance, BaseEmitter, ModuleConfigQueryValidator, ModuleErrorBuilder, QueryValidator, Queryable, SortedPipedAddressesString, SupportedQueryValidator, isQuerySupportedByModule };
1
+ export * from './AbstractModule';
2
+ export * from './AbstractModuleInstance';
3
+ export * from './BaseEmitter';
4
+ export * from './Error';
5
+ export * from './QueryValidator';
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,0BAA0B,CAAA;AACxC,cAAc,eAAe,CAAA;AAC7B,cAAc,SAAS,CAAA;AACvB,cAAc,kBAAkB,CAAA"}
package/dist/index.d.ts CHANGED
@@ -1,163 +1,6 @@
1
- import { AccountInstance } from '@xyo-network/account-model';
2
- import { ArchivistInstance } from '@xyo-network/archivist-model';
3
- import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
4
- import * as _xyo_network_boundwitness_model from '@xyo-network/boundwitness-model';
5
- import { BoundWitness } from '@xyo-network/boundwitness-model';
6
- import { ModuleManifestPayload } from '@xyo-network/manifest-model';
7
- import { AnyConfigSchema, ModuleConfig, SchemaString, AddressString, Module, ModuleParams, ModuleEventData, ModuleQueryBase, ModuleInstance, CreatableModule, CreatableModuleFactory, ModuleQueryResult, ModuleFilter, ModuleFilterOptions, ModuleDescriptionPayload, AddressPreviousHashPayload, ModuleQueryHandlerResult } from '@xyo-network/module-model';
8
- import { CompositeModuleResolver } from '@xyo-network/module-resolver';
9
- import * as _xyo_network_payload_model from '@xyo-network/payload-model';
10
- import { Payload, Query, ModuleError } from '@xyo-network/payload-model';
11
- import { Promisable, PromiseEx } from '@xyo-network/promise';
12
- import { WalletInstance } from '@xyo-network/wallet-model';
13
- import { BaseParams, Base } from '@xyo-network/core';
14
- import { EventData, EventFunctions, EventListener, EventAnyListener } from '@xyo-network/module-events';
15
- import { PayloadBuilder } from '@xyo-network/payload-builder';
16
-
17
- declare class BaseEmitter<TParams extends BaseParams = BaseParams, TEventData extends EventData = EventData> extends Base<TParams> implements EventFunctions<TEventData> {
18
- eventData: TEventData;
19
- private events;
20
- constructor(params: TParams);
21
- clearListeners(eventNames: keyof TEventData | (keyof TEventData)[]): void;
22
- emit<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
23
- emitSerial<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
24
- listenerCount(eventNames: keyof TEventData | (keyof TEventData)[]): number;
25
- off<TEventName extends keyof TEventData>(eventNames: TEventName | TEventName[], listener: EventListener<TEventData[TEventName]>): void;
26
- offAny(listener: EventAnyListener): void;
27
- on<TEventName extends keyof TEventData>(eventNames: TEventName | TEventName[], listener: EventListener<TEventData[TEventName]>): () => void;
28
- onAny(listener: EventAnyListener): () => void;
29
- once<TEventName extends keyof TEventData>(eventName: TEventName, listener: EventListener<TEventData[TEventName]>): () => void;
30
- }
31
-
32
- type Queryable<T extends QueryBoundWitness = QueryBoundWitness> = (query: T, payloads?: Payload[]) => Promisable<boolean>;
33
- interface QueryValidator<T extends QueryBoundWitness = QueryBoundWitness> {
34
- queryable: Queryable<T>;
35
- }
36
-
37
- type SortedPipedAddressesString = string;
38
- declare class ModuleConfigQueryValidator<TConfig extends AnyConfigSchema<ModuleConfig>> implements QueryValidator {
39
- protected allowed: Record<SchemaString, SortedPipedAddressesString[]>;
40
- protected disallowed: Record<SchemaString, AddressString[]>;
41
- protected readonly hasAllowedRules: boolean;
42
- protected readonly hasDisallowedRules: boolean;
43
- protected readonly hasRules: boolean;
44
- constructor(config?: TConfig);
45
- queryable: Queryable;
46
- protected queryAllowed: (schema: SchemaString, addresses: string[]) => boolean;
47
- protected queryDisallowed: (schema: SchemaString, addresses: string[]) => boolean;
48
- }
49
-
50
- declare const isQuerySupportedByModule: <T extends _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_boundwitness_model.BoundWitnessFields & {
51
- query: string;
52
- resultSet?: string | undefined;
53
- schema: "network.xyo.boundwitness";
54
- } & {
55
- schema: "network.xyo.boundwitness";
56
- } = _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_boundwitness_model.BoundWitnessFields & {
57
- query: string;
58
- resultSet?: string | undefined;
59
- schema: "network.xyo.boundwitness";
60
- } & {
61
- schema: "network.xyo.boundwitness";
62
- }>(mod: Module, query: T, payloads?: Payload[]) => Promise<boolean>;
63
- declare class SupportedQueryValidator implements QueryValidator {
64
- protected readonly mod: Module;
65
- constructor(mod: Module);
66
- queryable: Queryable;
67
- }
68
-
69
- declare abstract class AbstractModule<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<ModuleConfig>, TEventData extends ModuleEventData = ModuleEventData> extends BaseEmitter<TParams, TEventData> implements Module<TParams, TEventData> {
70
- static configSchemas: string[];
71
- static enableLazyLoad: boolean;
72
- protected static privateConstructorKey: string;
73
- readonly downResolver: Omit<CompositeModuleResolver, 'resolve'>;
74
- readonly upResolver: Omit<CompositeModuleResolver, 'resolve>'>;
75
- protected _account: AccountInstance | undefined;
76
- protected readonly _baseModuleQueryAccountPaths: Record<ModuleQueryBase['schema'], string>;
77
- protected readonly _queryAccounts: Record<ModuleQueryBase['schema'], AccountInstance | undefined>;
78
- protected _startPromise: Promisable<boolean> | undefined;
79
- protected _started: Promisable<boolean> | undefined;
80
- protected readonly moduleConfigQueryValidator: Queryable;
81
- protected readonly supportedQueryValidator: Queryable;
82
- private _busyCount;
83
- constructor(privateConstructorKey: string, params: TParams, account: AccountInstance);
84
- static get configSchema(): string;
85
- get account(): AccountInstance;
86
- get address(): string;
87
- get allowAnonymous(): boolean;
88
- get config(): TParams['config'];
89
- get ephemeralQueryAccountEnabled(): boolean;
90
- get queries(): string[];
91
- get queryAccountPaths(): Readonly<Record<Query['schema'], string | undefined>>;
92
- get queryAccounts(): Readonly<Record<Query['schema'], AccountInstance | undefined>>;
93
- get timestamp(): boolean;
94
- protected abstract get _queryAccountPaths(): Record<Query['schema'], string>;
95
- static _getRootFunction(funcName: string): any;
96
- static _noOverride(functionName: string): void;
97
- static create<TModule extends ModuleInstance>(this: CreatableModule<TModule>, params?: Omit<TModule['params'], 'config'> & {
98
- config?: TModule['params']['config'];
99
- }): Promise<TModule>;
100
- static determineAccount({ account, accountDerivationPath, wallet, }: {
101
- account?: AccountInstance | 'random';
102
- accountDerivationPath?: string;
103
- wallet?: WalletInstance;
104
- }): Promise<AccountInstance>;
105
- static factory<TModule extends ModuleInstance>(this: CreatableModule<TModule>, params?: Omit<TModule['params'], 'config'> & {
106
- config?: TModule['params']['config'];
107
- }): CreatableModuleFactory<TModule>;
108
- _getRootFunction(funcName: string): any;
109
- _noOverride(functionName: string): void;
110
- busy<R>(closure: () => Promise<R>): Promise<R>;
111
- emit<TEventName extends keyof TEventData = keyof TEventData, TEventArgs extends TEventData[TEventName] = TEventData[TEventName]>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
112
- previousHash(): Promisable<string | undefined>;
113
- query<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryResult>;
114
- queryable<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): boolean;
115
- resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter, options?: ModuleFilterOptions<T>): Promise<T[]>;
116
- resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddress: string, options?: ModuleFilterOptions<T>): Promise<T | undefined>;
117
- start(_timeout?: number): Promisable<boolean>;
118
- started(notStartedAction?: 'error' | 'throw' | 'warn' | 'log' | 'none', tryStart?: boolean): Promise<boolean>;
119
- stop(_timeout?: number): Promise<boolean>;
120
- protected bindHashes(hashes: string[], schema: SchemaString[], account?: AccountInstance): PromiseEx<unknown, AccountInstance>;
121
- protected bindHashesInternal(hashes: string[], schema: SchemaString[], account?: AccountInstance): Promise<BoundWitness>;
122
- protected bindQuery<T extends Query>(query: T, payloads?: Payload[], account?: AccountInstance): PromiseEx<[QueryBoundWitness, Payload[], Payload[]], AccountInstance>;
123
- protected bindQueryInternal<T extends Query>(query: T, payloads?: Payload[], account?: AccountInstance): Promise<[QueryBoundWitness, Payload[], Payload[]]>;
124
- protected bindQueryResult<T extends Query>(query: T, payloads: Payload[], additionalWitnesses?: AccountInstance[], errors?: ModuleError[]): Promise<ModuleQueryResult>;
125
- protected commitArchivist: () => Promise<ArchivistInstance | undefined>;
126
- protected describeHandler(): Promise<ModuleDescriptionPayload>;
127
- protected discoverHandler(): Promisable<Payload[]>;
128
- protected initializeQueryAccounts(): Promise<void>;
129
- protected manifestHandler(_ignoreAddresses?: string[]): Promisable<ModuleManifestPayload>;
130
- protected moduleAddressHandler(): Promisable<AddressPreviousHashPayload[]>;
131
- protected queryHandler<T extends QueryBoundWitness = QueryBoundWitness, TConfig extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConfig): Promise<ModuleQueryHandlerResult>;
132
- protected readArchivist: () => Promise<ArchivistInstance | undefined>;
133
- protected startHandler(): Promise<boolean>;
134
- protected stopHandler(_timeout?: number): Promisable<boolean>;
135
- protected subscribeHandler(): void;
136
- protected validateConfig(config?: unknown, parents?: string[]): boolean;
137
- protected writeArchivist: () => Promise<ArchivistInstance | undefined>;
138
- private getArchivist;
139
- }
140
-
141
- declare abstract class AbstractModuleInstance<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<ModuleConfig>, TEventData extends ModuleEventData = ModuleEventData> extends AbstractModule<TParams, TEventData> implements Module<TParams, TEventData> {
142
- constructor(privateConstructorKey: string, params: TParams, account: AccountInstance);
143
- describe(): Promise<ModuleDescriptionPayload>;
144
- discover(): Promise<Payload[]>;
145
- manifest(ignoreAddresses?: string[]): Promise<ModuleManifestPayload>;
146
- moduleAddress(): Promise<AddressPreviousHashPayload[]>;
147
- subscribe(_queryAccount?: AccountInstance): void;
148
- }
149
-
150
- declare class ModuleErrorBuilder extends PayloadBuilder {
151
- _message?: string;
152
- _name?: string;
153
- _query?: string;
154
- _sources?: string[];
155
- constructor();
156
- build(): ModuleError;
157
- message(message: string): this;
158
- name(name: string): this;
159
- query(query: string): this;
160
- sources(sources: string[]): this;
161
- }
162
-
163
- export { AbstractModule, AbstractModuleInstance, BaseEmitter, ModuleConfigQueryValidator, ModuleErrorBuilder, QueryValidator, Queryable, SortedPipedAddressesString, SupportedQueryValidator, isQuerySupportedByModule };
1
+ export * from './AbstractModule';
2
+ export * from './AbstractModuleInstance';
3
+ export * from './BaseEmitter';
4
+ export * from './Error';
5
+ export * from './QueryValidator';
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,0BAA0B,CAAA;AACxC,cAAc,eAAe,CAAA;AAC7B,cAAc,SAAS,CAAA;AACvB,cAAc,kBAAkB,CAAA"}
package/dist/index.js CHANGED
@@ -606,6 +606,13 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
606
606
  ...queries
607
607
  ]);
608
608
  }
609
+ async getArchivist(kind) {
610
+ if (!this.config.archivist)
611
+ return void 0;
612
+ const filter = typeof this.config.archivist === "string" || this.config.archivist instanceof String ? this.config.archivist : this.config?.archivist?.[kind];
613
+ const resolved = await this.upResolver.resolve(filter);
614
+ return (0, import_archivist_model.asArchivistInstance)(resolved);
615
+ }
609
616
  async initializeQueryAccounts() {
610
617
  const paths = Object.values(this.queryAccountPaths).filter(import_exists.exists);
611
618
  const distinctPaths = new Set(paths);
@@ -753,13 +760,6 @@ var AbstractModule = class _AbstractModule extends BaseEmitter {
753
760
  }, true);
754
761
  }
755
762
  writeArchivist = () => this.getArchivist("write");
756
- async getArchivist(kind) {
757
- if (!this.config.archivist)
758
- return void 0;
759
- const filter = typeof this.config.archivist === "string" || this.config.archivist instanceof String ? this.config.archivist : this.config?.archivist?.[kind];
760
- const resolved = await this.upResolver.resolve(filter);
761
- return (0, import_archivist_model.asArchivistInstance)(resolved);
762
- }
763
763
  };
764
764
 
765
765
  // src/AbstractModuleInstance.ts