@xyo-network/bridge-model 2.72.8 → 2.73.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 (57) hide show
  1. package/dist/index.d.mts +266 -0
  2. package/dist/index.d.ts +266 -0
  3. package/dist/index.js +76 -0
  4. package/dist/index.js.map +1 -0
  5. package/dist/index.mjs +40 -0
  6. package/dist/index.mjs.map +1 -0
  7. package/package.json +35 -22
  8. package/tsup.config.ts +16 -0
  9. package/dist/cjs/Bridge.js +0 -3
  10. package/dist/cjs/Bridge.js.map +0 -1
  11. package/dist/cjs/Config.js +0 -5
  12. package/dist/cjs/Config.js.map +0 -1
  13. package/dist/cjs/Queries/Connect.js +0 -5
  14. package/dist/cjs/Queries/Connect.js.map +0 -1
  15. package/dist/cjs/Queries/Connected.js +0 -5
  16. package/dist/cjs/Queries/Connected.js.map +0 -1
  17. package/dist/cjs/Queries/Disconnect.js +0 -5
  18. package/dist/cjs/Queries/Disconnect.js.map +0 -1
  19. package/dist/cjs/Queries/index.js +0 -7
  20. package/dist/cjs/Queries/index.js.map +0 -1
  21. package/dist/cjs/index.js +0 -8
  22. package/dist/cjs/index.js.map +0 -1
  23. package/dist/cjs/typeChecks.js +0 -16
  24. package/dist/cjs/typeChecks.js.map +0 -1
  25. package/dist/docs.json +0 -35405
  26. package/dist/esm/Bridge.js +0 -2
  27. package/dist/esm/Bridge.js.map +0 -1
  28. package/dist/esm/Config.js +0 -2
  29. package/dist/esm/Config.js.map +0 -1
  30. package/dist/esm/Queries/Connect.js +0 -2
  31. package/dist/esm/Queries/Connect.js.map +0 -1
  32. package/dist/esm/Queries/Connected.js +0 -2
  33. package/dist/esm/Queries/Connected.js.map +0 -1
  34. package/dist/esm/Queries/Disconnect.js +0 -2
  35. package/dist/esm/Queries/Disconnect.js.map +0 -1
  36. package/dist/esm/Queries/index.js +0 -4
  37. package/dist/esm/Queries/index.js.map +0 -1
  38. package/dist/esm/index.js +0 -5
  39. package/dist/esm/index.js.map +0 -1
  40. package/dist/esm/typeChecks.js +0 -13
  41. package/dist/esm/typeChecks.js.map +0 -1
  42. package/dist/types/Bridge.d.ts +0 -25
  43. package/dist/types/Bridge.d.ts.map +0 -1
  44. package/dist/types/Config.d.ts +0 -14
  45. package/dist/types/Config.d.ts.map +0 -1
  46. package/dist/types/Queries/Connect.d.ts +0 -8
  47. package/dist/types/Queries/Connect.d.ts.map +0 -1
  48. package/dist/types/Queries/Connected.d.ts +0 -7
  49. package/dist/types/Queries/Connected.d.ts.map +0 -1
  50. package/dist/types/Queries/Disconnect.d.ts +0 -8
  51. package/dist/types/Queries/Disconnect.d.ts.map +0 -1
  52. package/dist/types/Queries/index.d.ts +0 -12
  53. package/dist/types/Queries/index.d.ts.map +0 -1
  54. package/dist/types/index.d.ts +0 -5
  55. package/dist/types/index.d.ts.map +0 -1
  56. package/dist/types/typeChecks.d.ts +0 -198
  57. package/dist/types/typeChecks.d.ts.map +0 -1
@@ -0,0 +1,266 @@
1
+ import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
2
+ import * as _xyo_network_module_model from '@xyo-network/module-model';
3
+ import { AnyConfigSchema, ModuleParams, ModuleEventData, ModuleInstance, ModuleConfig as ModuleConfig$1, ModuleResolver, ModuleQueryResult, ModuleFilter, ModuleFilterOptions, ModuleQueryBase, ModuleQuery } from '@xyo-network/module-model';
4
+ import * as _xyo_network_payload_model from '@xyo-network/payload-model';
5
+ import { Payload, Query } from '@xyo-network/payload-model';
6
+ import { Promisable } from '@xyo-network/promise';
7
+ import * as _xyo_network_core from '@xyo-network/core';
8
+ import { WithAdditional } from '@xyo-network/core';
9
+ import { ModuleConfig } from '@xyo-network/module';
10
+ import * as _xyo_network_wallet_model from '@xyo-network/wallet-model';
11
+ import * as _xyo_network_account_model from '@xyo-network/account-model';
12
+ import * as _xyo_network_object_identity from '@xyo-network/object-identity';
13
+
14
+ type BridgeConfigSchema = 'network.xyo.bridge.config';
15
+ declare const BridgeConfigSchema: BridgeConfigSchema;
16
+ interface CacheConfig {
17
+ max?: number;
18
+ ttl?: number;
19
+ }
20
+ type BridgeConfig<TConfig extends Payload | undefined = undefined> = ModuleConfig<WithAdditional<{
21
+ discoverCache?: CacheConfig | true;
22
+ schema: TConfig extends Payload ? TConfig['schema'] : BridgeConfigSchema;
23
+ }, TConfig>>;
24
+
25
+ interface Bridge {
26
+ connect: () => Promisable<boolean>;
27
+ connected: boolean;
28
+ disconnect: () => Promisable<boolean>;
29
+ }
30
+ type BridgeParams<TConfig extends AnyConfigSchema<BridgeConfig> = AnyConfigSchema<BridgeConfig>> = ModuleParams<TConfig>;
31
+ interface BridgeModule<TParams extends BridgeParams = BridgeParams, TEventData extends ModuleEventData = ModuleEventData> extends ModuleInstance<TParams, TEventData> {
32
+ getRootAddress(): Promisable<string>;
33
+ targetConfig(address: string): ModuleConfig$1;
34
+ targetDiscover(address?: string): Promisable<Payload[]>;
35
+ targetDownResolver(address?: string): ModuleResolver | undefined;
36
+ targetQueries(address: string): string[];
37
+ targetQuery(address: string, query: Query, payloads?: Payload[]): Promisable<ModuleQueryResult>;
38
+ targetQueryable(address: string, query: QueryBoundWitness, payloads?: Payload[], queryConfig?: ModuleConfig$1): Promisable<boolean>;
39
+ targetResolve(address: string, filter?: ModuleFilter, options?: ModuleFilterOptions): Promisable<ModuleInstance[]>;
40
+ targetResolve(address: string, nameOrAddress: string, options?: ModuleFilterOptions): Promisable<ModuleInstance | undefined>;
41
+ targetResolve(address: string, nameOrAddressOrFilter?: ModuleFilter | string, options?: ModuleFilterOptions): Promisable<ModuleInstance | ModuleInstance[] | undefined>;
42
+ }
43
+ type BridgeInstance<TParams extends BridgeParams = BridgeParams, TEventData extends ModuleEventData = ModuleEventData> = BridgeModule<TParams, TEventData> & Bridge;
44
+
45
+ type BridgeConnectQuerySchema = 'network.xyo.query.bridge.connect';
46
+ declare const BridgeConnectQuerySchema: BridgeConnectQuerySchema;
47
+ type BridgeConnectQuery = Query<{
48
+ schema: BridgeConnectQuerySchema;
49
+ uri?: string;
50
+ }>;
51
+
52
+ type BridgeConnectedQuerySchema = 'network.xyo.query.bridge.connected';
53
+ declare const BridgeConnectedQuerySchema: BridgeConnectedQuerySchema;
54
+ type BridgeConnectedQuery = Query<{
55
+ schema: BridgeConnectedQuerySchema;
56
+ }>;
57
+
58
+ type BridgeDisconnectQuerySchema = 'network.xyo.query.bridge.disconnect';
59
+ declare const BridgeDisconnectQuerySchema: BridgeDisconnectQuerySchema;
60
+ type BridgeDisconnectQuery = Query<{
61
+ schema: BridgeDisconnectQuerySchema;
62
+ uri?: string;
63
+ }>;
64
+
65
+ type BridgeQueryBase = BridgeConnectQuery | BridgeDisconnectQuery | BridgeConnectedQuery;
66
+ type BridgeModuleQueries = ModuleQueryBase | BridgeQueryBase;
67
+ type BridgeQuery<T extends Query | void = void> = ModuleQuery<T extends Query ? BridgeQueryBase | T : BridgeQueryBase>;
68
+
69
+ declare const isBridgeInstance: _xyo_network_object_identity.ObjectTypeCheck<BridgeInstance>;
70
+ declare const isBridgeModule: _xyo_network_module_model.ModuleTypeCheck<BridgeModule<_xyo_network_core.BaseParamsFields & {
71
+ account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
72
+ config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
73
+ accountDerivationPath?: string | undefined;
74
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
75
+ readonly name?: string | undefined;
76
+ readonly paging?: Record<string, {
77
+ size?: number | undefined;
78
+ }> | undefined;
79
+ readonly schema: string;
80
+ readonly security?: {
81
+ readonly allowAnonymous?: boolean | undefined;
82
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
83
+ readonly disallowed?: Record<string, string[]> | undefined;
84
+ } | undefined;
85
+ readonly sign?: boolean | undefined;
86
+ readonly storeQueries?: boolean | undefined;
87
+ readonly timestamp?: boolean | undefined;
88
+ } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
89
+ accountDerivationPath?: string | undefined;
90
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
91
+ readonly name?: string | undefined;
92
+ readonly paging?: Record<string, {
93
+ size?: number | undefined;
94
+ }> | undefined;
95
+ readonly schema: "network.xyo.bridge.config";
96
+ readonly security?: {
97
+ readonly allowAnonymous?: boolean | undefined;
98
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
99
+ readonly disallowed?: Record<string, string[]> | undefined;
100
+ } | undefined;
101
+ readonly sign?: boolean | undefined;
102
+ readonly storeQueries?: boolean | undefined;
103
+ readonly timestamp?: boolean | undefined;
104
+ } & Omit<{
105
+ discoverCache?: true | CacheConfig | undefined;
106
+ schema: "network.xyo.bridge.config";
107
+ }, "schema"> & {
108
+ schema: "network.xyo.bridge.config";
109
+ }, "schema"> & {
110
+ schema: string;
111
+ }, "schema"> & {
112
+ schema: string;
113
+ };
114
+ ephemeralQueryAccountEnabled?: boolean | undefined;
115
+ wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
116
+ }, _xyo_network_module_model.ModuleEventData<object>>>;
117
+ declare const asBridgeModule: {
118
+ (obj: any, config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): BridgeModule<_xyo_network_core.BaseParamsFields & {
119
+ account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
120
+ config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
121
+ accountDerivationPath?: string | undefined;
122
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
123
+ readonly name?: string | undefined;
124
+ readonly paging?: Record<string, {
125
+ size?: number | undefined;
126
+ }> | undefined;
127
+ readonly schema: string;
128
+ readonly security?: {
129
+ readonly allowAnonymous?: boolean | undefined;
130
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
131
+ readonly disallowed?: Record<string, string[]> | undefined;
132
+ } | undefined;
133
+ readonly sign?: boolean | undefined;
134
+ readonly storeQueries?: boolean | undefined;
135
+ readonly timestamp?: boolean | undefined;
136
+ } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
137
+ accountDerivationPath?: string | undefined;
138
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
139
+ readonly name?: string | undefined;
140
+ readonly paging?: Record<string, {
141
+ size?: number | undefined;
142
+ }> | undefined;
143
+ readonly schema: "network.xyo.bridge.config";
144
+ readonly security?: {
145
+ readonly allowAnonymous?: boolean | undefined;
146
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
147
+ readonly disallowed?: Record<string, string[]> | undefined;
148
+ } | undefined;
149
+ readonly sign?: boolean | undefined;
150
+ readonly storeQueries?: boolean | undefined;
151
+ readonly timestamp?: boolean | undefined;
152
+ } & Omit<{
153
+ discoverCache?: true | CacheConfig | undefined;
154
+ schema: "network.xyo.bridge.config";
155
+ }, "schema"> & {
156
+ schema: "network.xyo.bridge.config";
157
+ }, "schema"> & {
158
+ schema: string;
159
+ }, "schema"> & {
160
+ schema: string;
161
+ };
162
+ ephemeralQueryAccountEnabled?: boolean | undefined;
163
+ wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
164
+ }, _xyo_network_module_model.ModuleEventData<object>> | undefined;
165
+ (obj: any, assert: string | (() => string), config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): BridgeModule<_xyo_network_core.BaseParamsFields & {
166
+ account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
167
+ config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
168
+ accountDerivationPath?: string | undefined;
169
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
170
+ readonly name?: string | undefined;
171
+ readonly paging?: Record<string, {
172
+ size?: number | undefined;
173
+ }> | undefined;
174
+ readonly schema: string;
175
+ readonly security?: {
176
+ readonly allowAnonymous?: boolean | undefined;
177
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
178
+ readonly disallowed?: Record<string, string[]> | undefined;
179
+ } | undefined;
180
+ readonly sign?: boolean | undefined;
181
+ readonly storeQueries?: boolean | undefined;
182
+ readonly timestamp?: boolean | undefined;
183
+ } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
184
+ accountDerivationPath?: string | undefined;
185
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
186
+ readonly name?: string | undefined;
187
+ readonly paging?: Record<string, {
188
+ size?: number | undefined;
189
+ }> | undefined;
190
+ readonly schema: "network.xyo.bridge.config";
191
+ readonly security?: {
192
+ readonly allowAnonymous?: boolean | undefined;
193
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
194
+ readonly disallowed?: Record<string, string[]> | undefined;
195
+ } | undefined;
196
+ readonly sign?: boolean | undefined;
197
+ readonly storeQueries?: boolean | undefined;
198
+ readonly timestamp?: boolean | undefined;
199
+ } & Omit<{
200
+ discoverCache?: true | CacheConfig | undefined;
201
+ schema: "network.xyo.bridge.config";
202
+ }, "schema"> & {
203
+ schema: "network.xyo.bridge.config";
204
+ }, "schema"> & {
205
+ schema: string;
206
+ }, "schema"> & {
207
+ schema: string;
208
+ };
209
+ ephemeralQueryAccountEnabled?: boolean | undefined;
210
+ wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
211
+ }, _xyo_network_module_model.ModuleEventData<object>>;
212
+ };
213
+ declare const asBridgeInstance: {
214
+ (obj: any, config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): BridgeInstance | undefined;
215
+ (obj: any, assert: string | (() => string), config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): BridgeInstance;
216
+ };
217
+ declare const withBridgeModule: <R>(module: any, closure: (module: BridgeModule<_xyo_network_core.BaseParamsFields & {
218
+ account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
219
+ config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
220
+ accountDerivationPath?: string | undefined;
221
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
222
+ readonly name?: string | undefined;
223
+ readonly paging?: Record<string, {
224
+ size?: number | undefined;
225
+ }> | undefined;
226
+ readonly schema: string;
227
+ readonly security?: {
228
+ readonly allowAnonymous?: boolean | undefined;
229
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
230
+ readonly disallowed?: Record<string, string[]> | undefined;
231
+ } | undefined;
232
+ readonly sign?: boolean | undefined;
233
+ readonly storeQueries?: boolean | undefined;
234
+ readonly timestamp?: boolean | undefined;
235
+ } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
236
+ accountDerivationPath?: string | undefined;
237
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
238
+ readonly name?: string | undefined;
239
+ readonly paging?: Record<string, {
240
+ size?: number | undefined;
241
+ }> | undefined;
242
+ readonly schema: "network.xyo.bridge.config";
243
+ readonly security?: {
244
+ readonly allowAnonymous?: boolean | undefined;
245
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
246
+ readonly disallowed?: Record<string, string[]> | undefined;
247
+ } | undefined;
248
+ readonly sign?: boolean | undefined;
249
+ readonly storeQueries?: boolean | undefined;
250
+ readonly timestamp?: boolean | undefined;
251
+ } & Omit<{
252
+ discoverCache?: true | CacheConfig | undefined;
253
+ schema: "network.xyo.bridge.config";
254
+ }, "schema"> & {
255
+ schema: "network.xyo.bridge.config";
256
+ }, "schema"> & {
257
+ schema: string;
258
+ }, "schema"> & {
259
+ schema: string;
260
+ };
261
+ ephemeralQueryAccountEnabled?: boolean | undefined;
262
+ wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
263
+ }, _xyo_network_module_model.ModuleEventData<object>>) => R) => R | undefined;
264
+ declare const withBridgeInstance: <R>(module: any, closure: (module: BridgeInstance) => R) => R | undefined;
265
+
266
+ export { Bridge, BridgeConfig, BridgeConfigSchema, BridgeConnectQuery, BridgeConnectQuerySchema, BridgeConnectedQuery, BridgeConnectedQuerySchema, BridgeDisconnectQuery, BridgeDisconnectQuerySchema, BridgeInstance, BridgeModule, BridgeModuleQueries, BridgeParams, BridgeQuery, BridgeQueryBase, CacheConfig, asBridgeInstance, asBridgeModule, isBridgeInstance, isBridgeModule, withBridgeInstance, withBridgeModule };
@@ -0,0 +1,266 @@
1
+ import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
2
+ import * as _xyo_network_module_model from '@xyo-network/module-model';
3
+ import { AnyConfigSchema, ModuleParams, ModuleEventData, ModuleInstance, ModuleConfig as ModuleConfig$1, ModuleResolver, ModuleQueryResult, ModuleFilter, ModuleFilterOptions, ModuleQueryBase, ModuleQuery } from '@xyo-network/module-model';
4
+ import * as _xyo_network_payload_model from '@xyo-network/payload-model';
5
+ import { Payload, Query } from '@xyo-network/payload-model';
6
+ import { Promisable } from '@xyo-network/promise';
7
+ import * as _xyo_network_core from '@xyo-network/core';
8
+ import { WithAdditional } from '@xyo-network/core';
9
+ import { ModuleConfig } from '@xyo-network/module';
10
+ import * as _xyo_network_wallet_model from '@xyo-network/wallet-model';
11
+ import * as _xyo_network_account_model from '@xyo-network/account-model';
12
+ import * as _xyo_network_object_identity from '@xyo-network/object-identity';
13
+
14
+ type BridgeConfigSchema = 'network.xyo.bridge.config';
15
+ declare const BridgeConfigSchema: BridgeConfigSchema;
16
+ interface CacheConfig {
17
+ max?: number;
18
+ ttl?: number;
19
+ }
20
+ type BridgeConfig<TConfig extends Payload | undefined = undefined> = ModuleConfig<WithAdditional<{
21
+ discoverCache?: CacheConfig | true;
22
+ schema: TConfig extends Payload ? TConfig['schema'] : BridgeConfigSchema;
23
+ }, TConfig>>;
24
+
25
+ interface Bridge {
26
+ connect: () => Promisable<boolean>;
27
+ connected: boolean;
28
+ disconnect: () => Promisable<boolean>;
29
+ }
30
+ type BridgeParams<TConfig extends AnyConfigSchema<BridgeConfig> = AnyConfigSchema<BridgeConfig>> = ModuleParams<TConfig>;
31
+ interface BridgeModule<TParams extends BridgeParams = BridgeParams, TEventData extends ModuleEventData = ModuleEventData> extends ModuleInstance<TParams, TEventData> {
32
+ getRootAddress(): Promisable<string>;
33
+ targetConfig(address: string): ModuleConfig$1;
34
+ targetDiscover(address?: string): Promisable<Payload[]>;
35
+ targetDownResolver(address?: string): ModuleResolver | undefined;
36
+ targetQueries(address: string): string[];
37
+ targetQuery(address: string, query: Query, payloads?: Payload[]): Promisable<ModuleQueryResult>;
38
+ targetQueryable(address: string, query: QueryBoundWitness, payloads?: Payload[], queryConfig?: ModuleConfig$1): Promisable<boolean>;
39
+ targetResolve(address: string, filter?: ModuleFilter, options?: ModuleFilterOptions): Promisable<ModuleInstance[]>;
40
+ targetResolve(address: string, nameOrAddress: string, options?: ModuleFilterOptions): Promisable<ModuleInstance | undefined>;
41
+ targetResolve(address: string, nameOrAddressOrFilter?: ModuleFilter | string, options?: ModuleFilterOptions): Promisable<ModuleInstance | ModuleInstance[] | undefined>;
42
+ }
43
+ type BridgeInstance<TParams extends BridgeParams = BridgeParams, TEventData extends ModuleEventData = ModuleEventData> = BridgeModule<TParams, TEventData> & Bridge;
44
+
45
+ type BridgeConnectQuerySchema = 'network.xyo.query.bridge.connect';
46
+ declare const BridgeConnectQuerySchema: BridgeConnectQuerySchema;
47
+ type BridgeConnectQuery = Query<{
48
+ schema: BridgeConnectQuerySchema;
49
+ uri?: string;
50
+ }>;
51
+
52
+ type BridgeConnectedQuerySchema = 'network.xyo.query.bridge.connected';
53
+ declare const BridgeConnectedQuerySchema: BridgeConnectedQuerySchema;
54
+ type BridgeConnectedQuery = Query<{
55
+ schema: BridgeConnectedQuerySchema;
56
+ }>;
57
+
58
+ type BridgeDisconnectQuerySchema = 'network.xyo.query.bridge.disconnect';
59
+ declare const BridgeDisconnectQuerySchema: BridgeDisconnectQuerySchema;
60
+ type BridgeDisconnectQuery = Query<{
61
+ schema: BridgeDisconnectQuerySchema;
62
+ uri?: string;
63
+ }>;
64
+
65
+ type BridgeQueryBase = BridgeConnectQuery | BridgeDisconnectQuery | BridgeConnectedQuery;
66
+ type BridgeModuleQueries = ModuleQueryBase | BridgeQueryBase;
67
+ type BridgeQuery<T extends Query | void = void> = ModuleQuery<T extends Query ? BridgeQueryBase | T : BridgeQueryBase>;
68
+
69
+ declare const isBridgeInstance: _xyo_network_object_identity.ObjectTypeCheck<BridgeInstance>;
70
+ declare const isBridgeModule: _xyo_network_module_model.ModuleTypeCheck<BridgeModule<_xyo_network_core.BaseParamsFields & {
71
+ account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
72
+ config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
73
+ accountDerivationPath?: string | undefined;
74
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
75
+ readonly name?: string | undefined;
76
+ readonly paging?: Record<string, {
77
+ size?: number | undefined;
78
+ }> | undefined;
79
+ readonly schema: string;
80
+ readonly security?: {
81
+ readonly allowAnonymous?: boolean | undefined;
82
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
83
+ readonly disallowed?: Record<string, string[]> | undefined;
84
+ } | undefined;
85
+ readonly sign?: boolean | undefined;
86
+ readonly storeQueries?: boolean | undefined;
87
+ readonly timestamp?: boolean | undefined;
88
+ } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
89
+ accountDerivationPath?: string | undefined;
90
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
91
+ readonly name?: string | undefined;
92
+ readonly paging?: Record<string, {
93
+ size?: number | undefined;
94
+ }> | undefined;
95
+ readonly schema: "network.xyo.bridge.config";
96
+ readonly security?: {
97
+ readonly allowAnonymous?: boolean | undefined;
98
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
99
+ readonly disallowed?: Record<string, string[]> | undefined;
100
+ } | undefined;
101
+ readonly sign?: boolean | undefined;
102
+ readonly storeQueries?: boolean | undefined;
103
+ readonly timestamp?: boolean | undefined;
104
+ } & Omit<{
105
+ discoverCache?: true | CacheConfig | undefined;
106
+ schema: "network.xyo.bridge.config";
107
+ }, "schema"> & {
108
+ schema: "network.xyo.bridge.config";
109
+ }, "schema"> & {
110
+ schema: string;
111
+ }, "schema"> & {
112
+ schema: string;
113
+ };
114
+ ephemeralQueryAccountEnabled?: boolean | undefined;
115
+ wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
116
+ }, _xyo_network_module_model.ModuleEventData<object>>>;
117
+ declare const asBridgeModule: {
118
+ (obj: any, config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): BridgeModule<_xyo_network_core.BaseParamsFields & {
119
+ account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
120
+ config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
121
+ accountDerivationPath?: string | undefined;
122
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
123
+ readonly name?: string | undefined;
124
+ readonly paging?: Record<string, {
125
+ size?: number | undefined;
126
+ }> | undefined;
127
+ readonly schema: string;
128
+ readonly security?: {
129
+ readonly allowAnonymous?: boolean | undefined;
130
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
131
+ readonly disallowed?: Record<string, string[]> | undefined;
132
+ } | undefined;
133
+ readonly sign?: boolean | undefined;
134
+ readonly storeQueries?: boolean | undefined;
135
+ readonly timestamp?: boolean | undefined;
136
+ } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
137
+ accountDerivationPath?: string | undefined;
138
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
139
+ readonly name?: string | undefined;
140
+ readonly paging?: Record<string, {
141
+ size?: number | undefined;
142
+ }> | undefined;
143
+ readonly schema: "network.xyo.bridge.config";
144
+ readonly security?: {
145
+ readonly allowAnonymous?: boolean | undefined;
146
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
147
+ readonly disallowed?: Record<string, string[]> | undefined;
148
+ } | undefined;
149
+ readonly sign?: boolean | undefined;
150
+ readonly storeQueries?: boolean | undefined;
151
+ readonly timestamp?: boolean | undefined;
152
+ } & Omit<{
153
+ discoverCache?: true | CacheConfig | undefined;
154
+ schema: "network.xyo.bridge.config";
155
+ }, "schema"> & {
156
+ schema: "network.xyo.bridge.config";
157
+ }, "schema"> & {
158
+ schema: string;
159
+ }, "schema"> & {
160
+ schema: string;
161
+ };
162
+ ephemeralQueryAccountEnabled?: boolean | undefined;
163
+ wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
164
+ }, _xyo_network_module_model.ModuleEventData<object>> | undefined;
165
+ (obj: any, assert: string | (() => string), config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): BridgeModule<_xyo_network_core.BaseParamsFields & {
166
+ account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
167
+ config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
168
+ accountDerivationPath?: string | undefined;
169
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
170
+ readonly name?: string | undefined;
171
+ readonly paging?: Record<string, {
172
+ size?: number | undefined;
173
+ }> | undefined;
174
+ readonly schema: string;
175
+ readonly security?: {
176
+ readonly allowAnonymous?: boolean | undefined;
177
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
178
+ readonly disallowed?: Record<string, string[]> | undefined;
179
+ } | undefined;
180
+ readonly sign?: boolean | undefined;
181
+ readonly storeQueries?: boolean | undefined;
182
+ readonly timestamp?: boolean | undefined;
183
+ } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
184
+ accountDerivationPath?: string | undefined;
185
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
186
+ readonly name?: string | undefined;
187
+ readonly paging?: Record<string, {
188
+ size?: number | undefined;
189
+ }> | undefined;
190
+ readonly schema: "network.xyo.bridge.config";
191
+ readonly security?: {
192
+ readonly allowAnonymous?: boolean | undefined;
193
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
194
+ readonly disallowed?: Record<string, string[]> | undefined;
195
+ } | undefined;
196
+ readonly sign?: boolean | undefined;
197
+ readonly storeQueries?: boolean | undefined;
198
+ readonly timestamp?: boolean | undefined;
199
+ } & Omit<{
200
+ discoverCache?: true | CacheConfig | undefined;
201
+ schema: "network.xyo.bridge.config";
202
+ }, "schema"> & {
203
+ schema: "network.xyo.bridge.config";
204
+ }, "schema"> & {
205
+ schema: string;
206
+ }, "schema"> & {
207
+ schema: string;
208
+ };
209
+ ephemeralQueryAccountEnabled?: boolean | undefined;
210
+ wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
211
+ }, _xyo_network_module_model.ModuleEventData<object>>;
212
+ };
213
+ declare const asBridgeInstance: {
214
+ (obj: any, config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): BridgeInstance | undefined;
215
+ (obj: any, assert: string | (() => string), config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): BridgeInstance;
216
+ };
217
+ declare const withBridgeModule: <R>(module: any, closure: (module: BridgeModule<_xyo_network_core.BaseParamsFields & {
218
+ account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
219
+ config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
220
+ accountDerivationPath?: string | undefined;
221
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
222
+ readonly name?: string | undefined;
223
+ readonly paging?: Record<string, {
224
+ size?: number | undefined;
225
+ }> | undefined;
226
+ readonly schema: string;
227
+ readonly security?: {
228
+ readonly allowAnonymous?: boolean | undefined;
229
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
230
+ readonly disallowed?: Record<string, string[]> | undefined;
231
+ } | undefined;
232
+ readonly sign?: boolean | undefined;
233
+ readonly storeQueries?: boolean | undefined;
234
+ readonly timestamp?: boolean | undefined;
235
+ } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
236
+ accountDerivationPath?: string | undefined;
237
+ readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
238
+ readonly name?: string | undefined;
239
+ readonly paging?: Record<string, {
240
+ size?: number | undefined;
241
+ }> | undefined;
242
+ readonly schema: "network.xyo.bridge.config";
243
+ readonly security?: {
244
+ readonly allowAnonymous?: boolean | undefined;
245
+ readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
246
+ readonly disallowed?: Record<string, string[]> | undefined;
247
+ } | undefined;
248
+ readonly sign?: boolean | undefined;
249
+ readonly storeQueries?: boolean | undefined;
250
+ readonly timestamp?: boolean | undefined;
251
+ } & Omit<{
252
+ discoverCache?: true | CacheConfig | undefined;
253
+ schema: "network.xyo.bridge.config";
254
+ }, "schema"> & {
255
+ schema: "network.xyo.bridge.config";
256
+ }, "schema"> & {
257
+ schema: string;
258
+ }, "schema"> & {
259
+ schema: string;
260
+ };
261
+ ephemeralQueryAccountEnabled?: boolean | undefined;
262
+ wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
263
+ }, _xyo_network_module_model.ModuleEventData<object>>) => R) => R | undefined;
264
+ declare const withBridgeInstance: <R>(module: any, closure: (module: BridgeInstance) => R) => R | undefined;
265
+
266
+ export { Bridge, BridgeConfig, BridgeConfigSchema, BridgeConnectQuery, BridgeConnectQuerySchema, BridgeConnectedQuery, BridgeConnectedQuerySchema, BridgeDisconnectQuery, BridgeDisconnectQuerySchema, BridgeInstance, BridgeModule, BridgeModuleQueries, BridgeParams, BridgeQuery, BridgeQueryBase, CacheConfig, asBridgeInstance, asBridgeModule, isBridgeInstance, isBridgeModule, withBridgeInstance, withBridgeModule };
package/dist/index.js ADDED
@@ -0,0 +1,76 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __export = (target, all) => {
7
+ for (var name in all)
8
+ __defProp(target, name, { get: all[name], enumerable: true });
9
+ };
10
+ var __copyProps = (to, from, except, desc) => {
11
+ if (from && typeof from === "object" || typeof from === "function") {
12
+ for (let key of __getOwnPropNames(from))
13
+ if (!__hasOwnProp.call(to, key) && key !== except)
14
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
+ }
16
+ return to;
17
+ };
18
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
+
20
+ // src/index.ts
21
+ var src_exports = {};
22
+ __export(src_exports, {
23
+ BridgeConfigSchema: () => BridgeConfigSchema,
24
+ BridgeConnectQuerySchema: () => BridgeConnectQuerySchema,
25
+ BridgeConnectedQuerySchema: () => BridgeConnectedQuerySchema,
26
+ BridgeDisconnectQuerySchema: () => BridgeDisconnectQuerySchema,
27
+ asBridgeInstance: () => asBridgeInstance,
28
+ asBridgeModule: () => asBridgeModule,
29
+ isBridgeInstance: () => isBridgeInstance,
30
+ isBridgeModule: () => isBridgeModule,
31
+ withBridgeInstance: () => withBridgeInstance,
32
+ withBridgeModule: () => withBridgeModule
33
+ });
34
+ module.exports = __toCommonJS(src_exports);
35
+
36
+ // src/Config.ts
37
+ var BridgeConfigSchema = "network.xyo.bridge.config";
38
+
39
+ // src/Queries/Connect.ts
40
+ var BridgeConnectQuerySchema = "network.xyo.query.bridge.connect";
41
+
42
+ // src/Queries/Connected.ts
43
+ var BridgeConnectedQuerySchema = "network.xyo.query.bridge.connected";
44
+
45
+ // src/Queries/Disconnect.ts
46
+ var BridgeDisconnectQuerySchema = "network.xyo.query.bridge.disconnect";
47
+
48
+ // src/typeChecks.ts
49
+ var import_module_model = require("@xyo-network/module-model");
50
+ var import_object_identity = require("@xyo-network/object-identity");
51
+ var isBridgeInstance = new import_module_model.IsInstanceFactory().create(
52
+ {
53
+ connect: "function",
54
+ disconnect: "function"
55
+ },
56
+ [import_module_model.isModuleInstance]
57
+ );
58
+ var isBridgeModule = new import_module_model.IsModuleFactory().create([BridgeConnectQuerySchema, BridgeDisconnectQuerySchema]);
59
+ var asBridgeModule = import_object_identity.AsObjectFactory.create(isBridgeModule);
60
+ var asBridgeInstance = import_object_identity.AsObjectFactory.create(isBridgeInstance);
61
+ var withBridgeModule = import_module_model.WithFactory.create(isBridgeModule);
62
+ var withBridgeInstance = import_module_model.WithFactory.create(isBridgeInstance);
63
+ // Annotate the CommonJS export names for ESM import in node:
64
+ 0 && (module.exports = {
65
+ BridgeConfigSchema,
66
+ BridgeConnectQuerySchema,
67
+ BridgeConnectedQuerySchema,
68
+ BridgeDisconnectQuerySchema,
69
+ asBridgeInstance,
70
+ asBridgeModule,
71
+ isBridgeInstance,
72
+ isBridgeModule,
73
+ withBridgeInstance,
74
+ withBridgeModule
75
+ });
76
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts","../src/Config.ts","../src/Queries/Connect.ts","../src/Queries/Connected.ts","../src/Queries/Disconnect.ts","../src/typeChecks.ts"],"sourcesContent":["export * from './Bridge'\nexport * from './Config'\nexport * from './Queries'\nexport * from './typeChecks'\n","import { WithAdditional } from '@xyo-network/core'\nimport { ModuleConfig } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\n\nexport type BridgeConfigSchema = 'network.xyo.bridge.config'\nexport const BridgeConfigSchema: BridgeConfigSchema = 'network.xyo.bridge.config'\n\nexport interface CacheConfig {\n max?: number\n ttl?: number\n}\n\nexport type BridgeConfig<TConfig extends Payload | undefined = undefined> = ModuleConfig<\n WithAdditional<\n {\n discoverCache?: CacheConfig | true\n schema: TConfig extends Payload ? TConfig['schema'] : BridgeConfigSchema\n },\n TConfig\n >\n>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type BridgeConnectQuerySchema = 'network.xyo.query.bridge.connect'\nexport const BridgeConnectQuerySchema: BridgeConnectQuerySchema = 'network.xyo.query.bridge.connect'\n\nexport type BridgeConnectQuery = Query<{\n schema: BridgeConnectQuerySchema\n uri?: string\n}>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type BridgeConnectedQuerySchema = 'network.xyo.query.bridge.connected'\nexport const BridgeConnectedQuerySchema: BridgeConnectedQuerySchema = 'network.xyo.query.bridge.connected'\n\nexport type BridgeConnectedQuery = Query<{\n schema: BridgeConnectedQuerySchema\n}>\n","import { Query } from '@xyo-network/payload-model'\n\nexport type BridgeDisconnectQuerySchema = 'network.xyo.query.bridge.disconnect'\nexport const BridgeDisconnectQuerySchema: BridgeDisconnectQuerySchema = 'network.xyo.query.bridge.disconnect'\n\nexport type BridgeDisconnectQuery = Query<{\n schema: BridgeDisconnectQuerySchema\n uri?: string\n}>\n","import { IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory } from '@xyo-network/module-model'\nimport { AsObjectFactory } from '@xyo-network/object-identity'\n\nimport { BridgeInstance, BridgeModule } from './Bridge'\nimport { BridgeConnectQuerySchema, BridgeDisconnectQuerySchema } from './Queries'\n\nexport const isBridgeInstance = new IsInstanceFactory<BridgeInstance>().create(\n {\n connect: 'function',\n disconnect: 'function',\n },\n [isModuleInstance],\n)\nexport const isBridgeModule = new IsModuleFactory<BridgeModule>().create([BridgeConnectQuerySchema, BridgeDisconnectQuerySchema])\n\nexport const asBridgeModule = AsObjectFactory.create(isBridgeModule)\nexport const asBridgeInstance = AsObjectFactory.create(isBridgeInstance)\nexport const withBridgeModule = WithFactory.create(isBridgeModule)\nexport const withBridgeInstance = WithFactory.create(isBridgeInstance)\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACKO,IAAM,qBAAyC;;;ACF/C,IAAM,2BAAqD;;;ACA3D,IAAM,6BAAyD;;;ACA/D,IAAM,8BAA2D;;;ACHxE,0BAAkF;AAClF,6BAAgC;AAKzB,IAAM,mBAAmB,IAAI,sCAAkC,EAAE;AAAA,EACtE;AAAA,IACE,SAAS;AAAA,IACT,YAAY;AAAA,EACd;AAAA,EACA,CAAC,oCAAgB;AACnB;AACO,IAAM,iBAAiB,IAAI,oCAA8B,EAAE,OAAO,CAAC,0BAA0B,2BAA2B,CAAC;AAEzH,IAAM,iBAAiB,uCAAgB,OAAO,cAAc;AAC5D,IAAM,mBAAmB,uCAAgB,OAAO,gBAAgB;AAChE,IAAM,mBAAmB,gCAAY,OAAO,cAAc;AAC1D,IAAM,qBAAqB,gCAAY,OAAO,gBAAgB;","names":[]}
package/dist/index.mjs ADDED
@@ -0,0 +1,40 @@
1
+ // src/Config.ts
2
+ var BridgeConfigSchema = "network.xyo.bridge.config";
3
+
4
+ // src/Queries/Connect.ts
5
+ var BridgeConnectQuerySchema = "network.xyo.query.bridge.connect";
6
+
7
+ // src/Queries/Connected.ts
8
+ var BridgeConnectedQuerySchema = "network.xyo.query.bridge.connected";
9
+
10
+ // src/Queries/Disconnect.ts
11
+ var BridgeDisconnectQuerySchema = "network.xyo.query.bridge.disconnect";
12
+
13
+ // src/typeChecks.ts
14
+ import { IsInstanceFactory, IsModuleFactory, isModuleInstance, WithFactory } from "@xyo-network/module-model";
15
+ import { AsObjectFactory } from "@xyo-network/object-identity";
16
+ var isBridgeInstance = new IsInstanceFactory().create(
17
+ {
18
+ connect: "function",
19
+ disconnect: "function"
20
+ },
21
+ [isModuleInstance]
22
+ );
23
+ var isBridgeModule = new IsModuleFactory().create([BridgeConnectQuerySchema, BridgeDisconnectQuerySchema]);
24
+ var asBridgeModule = AsObjectFactory.create(isBridgeModule);
25
+ var asBridgeInstance = AsObjectFactory.create(isBridgeInstance);
26
+ var withBridgeModule = WithFactory.create(isBridgeModule);
27
+ var withBridgeInstance = WithFactory.create(isBridgeInstance);
28
+ export {
29
+ BridgeConfigSchema,
30
+ BridgeConnectQuerySchema,
31
+ BridgeConnectedQuerySchema,
32
+ BridgeDisconnectQuerySchema,
33
+ asBridgeInstance,
34
+ asBridgeModule,
35
+ isBridgeInstance,
36
+ isBridgeModule,
37
+ withBridgeInstance,
38
+ withBridgeModule
39
+ };
40
+ //# sourceMappingURL=index.mjs.map