@xyo-network/module-model 2.64.10 → 2.65.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/dist/cjs/CreatableModuleDictionary.js +3 -0
  2. package/dist/cjs/CreatableModuleDictionary.js.map +1 -0
  3. package/dist/cjs/{Query/Payload.js → Events/ModuleBusy.js} +1 -1
  4. package/dist/cjs/Events/ModuleBusy.js.map +1 -0
  5. package/dist/cjs/Events/ModuleQueried.js +3 -0
  6. package/dist/cjs/Events/ModuleQueried.js.map +1 -0
  7. package/dist/cjs/Events/index.js +6 -0
  8. package/dist/cjs/Events/index.js.map +1 -0
  9. package/dist/cjs/ModuleFactory.js +30 -0
  10. package/dist/cjs/ModuleFactory.js.map +1 -0
  11. package/dist/cjs/Queries/index.js.map +1 -1
  12. package/dist/cjs/index.js +4 -2
  13. package/dist/cjs/index.js.map +1 -1
  14. package/dist/cjs/lib/duplicateModules.js +17 -0
  15. package/dist/cjs/lib/duplicateModules.js.map +1 -0
  16. package/dist/cjs/lib/index.js +6 -0
  17. package/dist/cjs/lib/index.js.map +1 -0
  18. package/dist/cjs/lib/serializable.js +38 -0
  19. package/dist/cjs/lib/serializable.js.map +1 -0
  20. package/dist/docs.json +24820 -12010
  21. package/dist/esm/CreatableModuleDictionary.js +2 -0
  22. package/dist/esm/CreatableModuleDictionary.js.map +1 -0
  23. package/dist/esm/Events/ModuleBusy.js +2 -0
  24. package/dist/esm/Events/ModuleBusy.js.map +1 -0
  25. package/dist/esm/Events/ModuleQueried.js +2 -0
  26. package/dist/esm/Events/ModuleQueried.js.map +1 -0
  27. package/dist/esm/Events/index.js +3 -0
  28. package/dist/esm/Events/index.js.map +1 -0
  29. package/dist/esm/ModuleFactory.js +28 -0
  30. package/dist/esm/ModuleFactory.js.map +1 -0
  31. package/dist/esm/Queries/index.js.map +1 -1
  32. package/dist/esm/index.js +4 -2
  33. package/dist/esm/index.js.map +1 -1
  34. package/dist/esm/lib/duplicateModules.js +13 -0
  35. package/dist/esm/lib/duplicateModules.js.map +1 -0
  36. package/dist/esm/lib/index.js +3 -0
  37. package/dist/esm/lib/index.js.map +1 -0
  38. package/dist/esm/lib/serializable.js +32 -0
  39. package/dist/esm/lib/serializable.js.map +1 -0
  40. package/dist/types/CreatableModule.d.ts +7 -7
  41. package/dist/types/CreatableModule.d.ts.map +1 -1
  42. package/dist/types/CreatableModuleDictionary.d.ts +5 -0
  43. package/dist/types/CreatableModuleDictionary.d.ts.map +1 -0
  44. package/dist/types/Events/ModuleBusy.d.ts +9 -0
  45. package/dist/types/Events/ModuleBusy.d.ts.map +1 -0
  46. package/dist/types/Events/ModuleQueried.d.ts +14 -0
  47. package/dist/types/Events/ModuleQueried.d.ts.map +1 -0
  48. package/dist/types/Events/index.d.ts +3 -0
  49. package/dist/types/Events/index.d.ts.map +1 -0
  50. package/dist/types/Module.d.ts +11 -22
  51. package/dist/types/Module.d.ts.map +1 -1
  52. package/dist/types/ModuleFactory.d.ts +15 -0
  53. package/dist/types/ModuleFactory.d.ts.map +1 -0
  54. package/dist/types/ModuleQueryResult.d.ts +1 -1
  55. package/dist/types/ModuleQueryResult.d.ts.map +1 -1
  56. package/dist/types/Queries/Describe/Query.d.ts +1 -1
  57. package/dist/types/Queries/Describe/Query.d.ts.map +1 -1
  58. package/dist/types/Queries/Discover.d.ts +1 -1
  59. package/dist/types/Queries/Discover.d.ts.map +1 -1
  60. package/dist/types/Queries/Manifest.d.ts +1 -1
  61. package/dist/types/Queries/Manifest.d.ts.map +1 -1
  62. package/dist/types/Queries/ModuleAddress/Query.d.ts +1 -1
  63. package/dist/types/Queries/ModuleAddress/Query.d.ts.map +1 -1
  64. package/dist/types/Queries/Subscribe.d.ts +1 -1
  65. package/dist/types/Queries/Subscribe.d.ts.map +1 -1
  66. package/dist/types/Queries/index.d.ts +1 -1
  67. package/dist/types/Queries/index.d.ts.map +1 -1
  68. package/dist/types/index.d.ts +4 -2
  69. package/dist/types/index.d.ts.map +1 -1
  70. package/dist/types/lib/duplicateModules.d.ts +12 -0
  71. package/dist/types/lib/duplicateModules.d.ts.map +1 -0
  72. package/dist/types/lib/index.d.ts +3 -0
  73. package/dist/types/lib/index.d.ts.map +1 -0
  74. package/dist/types/lib/serializable.d.ts +3 -0
  75. package/dist/types/lib/serializable.d.ts.map +1 -0
  76. package/package.json +14 -12
  77. package/src/CreatableModule.ts +7 -7
  78. package/src/CreatableModuleDictionary.ts +5 -0
  79. package/src/Events/ModuleBusy.ts +9 -0
  80. package/src/Events/ModuleQueried.ts +19 -0
  81. package/src/Events/index.ts +2 -0
  82. package/src/Module.ts +12 -27
  83. package/src/ModuleFactory.ts +40 -0
  84. package/src/ModuleQueryResult.ts +1 -1
  85. package/src/Queries/Describe/Query.ts +1 -1
  86. package/src/Queries/Discover.ts +1 -1
  87. package/src/Queries/Manifest.ts +1 -1
  88. package/src/Queries/ModuleAddress/Query.ts +1 -1
  89. package/src/Queries/Subscribe.ts +1 -1
  90. package/src/Queries/index.ts +2 -1
  91. package/src/index.ts +4 -2
  92. package/src/lib/duplicateModules.ts +14 -0
  93. package/src/lib/index.ts +2 -0
  94. package/src/lib/serializable.ts +41 -0
  95. package/dist/cjs/Error.js +0 -5
  96. package/dist/cjs/Error.js.map +0 -1
  97. package/dist/cjs/Query/Payload.js.map +0 -1
  98. package/dist/cjs/Query/QueryBoundWitness.js +0 -8
  99. package/dist/cjs/Query/QueryBoundWitness.js.map +0 -1
  100. package/dist/cjs/Query/index.js +0 -6
  101. package/dist/cjs/Query/index.js.map +0 -1
  102. package/dist/esm/Error.js +0 -2
  103. package/dist/esm/Error.js.map +0 -1
  104. package/dist/esm/Query/Payload.js +0 -2
  105. package/dist/esm/Query/Payload.js.map +0 -1
  106. package/dist/esm/Query/QueryBoundWitness.js +0 -4
  107. package/dist/esm/Query/QueryBoundWitness.js.map +0 -1
  108. package/dist/esm/Query/index.js +0 -3
  109. package/dist/esm/Query/index.js.map +0 -1
  110. package/dist/types/Error.d.ts +0 -11
  111. package/dist/types/Error.d.ts.map +0 -1
  112. package/dist/types/Query/Payload.d.ts +0 -13
  113. package/dist/types/Query/Payload.d.ts.map +0 -1
  114. package/dist/types/Query/QueryBoundWitness.d.ts +0 -17
  115. package/dist/types/Query/QueryBoundWitness.d.ts.map +0 -1
  116. package/dist/types/Query/index.d.ts +0 -3
  117. package/dist/types/Query/index.d.ts.map +0 -1
  118. package/src/Error.ts +0 -12
  119. package/src/Query/Payload.ts +0 -17
  120. package/src/Query/QueryBoundWitness.ts +0 -13
  121. package/src/Query/index.ts +0 -2
@@ -0,0 +1,5 @@
1
+ import { CreatableModuleFactory } from './CreatableModule'
2
+
3
+ export interface CreatableModuleDictionary {
4
+ [key: string]: CreatableModuleFactory
5
+ }
@@ -0,0 +1,9 @@
1
+ import { EventData } from '@xyo-network/module-events'
2
+
3
+ import { IndirectModule, ModuleEventArgs } from '../Module'
4
+
5
+ export type ModuleBusyEventArgs<TModule extends IndirectModule = IndirectModule> = ModuleEventArgs<TModule, { busy: boolean }>
6
+
7
+ export interface ModuleBusyEventData extends EventData {
8
+ moduleBusy: ModuleBusyEventArgs
9
+ }
@@ -0,0 +1,19 @@
1
+ import { QueryBoundWitness } from '@xyo-network/boundwitness-builder'
2
+ import { EventData } from '@xyo-network/module-events'
3
+ import { Payload } from '@xyo-network/payload-model'
4
+
5
+ import { IndirectModule, ModuleEventArgs } from '../Module'
6
+ import { ModuleQueryResult } from '../ModuleQueryResult'
7
+
8
+ export type ModuleQueriedEventArgs = ModuleEventArgs<
9
+ IndirectModule,
10
+ {
11
+ payloads?: Payload[]
12
+ query: QueryBoundWitness
13
+ result: ModuleQueryResult
14
+ }
15
+ >
16
+
17
+ export interface ModuleQueriedEventData extends EventData {
18
+ moduleQueried: ModuleQueriedEventArgs
19
+ }
@@ -0,0 +1,2 @@
1
+ export * from './ModuleBusy'
2
+ export * from './ModuleQueried'
package/src/Module.ts CHANGED
@@ -1,32 +1,28 @@
1
1
  import { AccountInstance } from '@xyo-network/account-model'
2
+ import { QueryBoundWitness } from '@xyo-network/boundwitness-builder'
2
3
  import { ModuleManifestPayload } from '@xyo-network/manifest-model'
3
- import { EventArgs, EventData, EventFunctions } from '@xyo-network/module-events'
4
+ import { EventArgs, EventFunctions } from '@xyo-network/module-events'
4
5
  import { Payload } from '@xyo-network/payload-model'
5
6
  import { Promisable } from '@xyo-network/promise'
6
7
 
7
8
  import { AnyConfigSchema, ModuleConfig } from './Config'
9
+ import { ModuleBusyEventData, ModuleQueriedEventData } from './Events'
8
10
  import { ModuleDescription } from './ModuleDescription'
9
11
  import { ModuleFilter } from './ModuleFilter'
10
12
  import { ModuleParams } from './ModuleParams'
11
13
  import { ModuleQueryResult } from './ModuleQueryResult'
12
14
  import { AddressPreviousHashPayload } from './Queries'
13
- import { QueryBoundWitness } from './Query'
14
15
 
15
- export interface ModuleResolver {
16
+ export interface ResolveFunctions {
17
+ resolve<TModule extends Module = Module>(filter?: ModuleFilter): Promisable<TModule[]>
18
+ resolve<TModule extends Module = Module>(nameOrAddress: string): Promisable<TModule | undefined>
19
+ resolve<TModule extends Module = Module>(nameOrAddressOrFilter?: ModuleFilter | string): Promisable<TModule | TModule[] | undefined>
20
+ }
21
+
22
+ export interface ModuleResolver extends ResolveFunctions {
16
23
  addResolver: (resolver: ModuleResolver) => this
17
24
  isModuleResolver: boolean
18
25
  removeResolver: (resolver: ModuleResolver) => this
19
- /**
20
- * Resolves all modules matching the supplied filter. If no filter
21
- * is supplied, all modules are returned
22
- * @param filter Filter criteria for the desired modules
23
- */
24
- resolve<T extends IndirectModule = IndirectModule>(filter?: ModuleFilter): Promisable<T[]>
25
- /**
26
- * Resolves a single module, or undefined if no modules matched the filter.
27
- * @param filter The desired Module's Address or Name
28
- */
29
- resolveOne<T extends IndirectModule = IndirectModule>(filter: string): Promisable<T | undefined>
30
26
  }
31
27
 
32
28
  export type ModuleEventArgs<
@@ -40,18 +36,7 @@ export type ModuleEventArgs<
40
36
  module: TModule
41
37
  }
42
38
 
43
- export type ModuleQueriedEventArgs = ModuleEventArgs<
44
- IndirectModule,
45
- {
46
- payloads?: Payload[]
47
- query: QueryBoundWitness
48
- result: ModuleQueryResult
49
- }
50
- >
51
-
52
- export interface ModuleEventData extends EventData {
53
- moduleQueried: ModuleQueriedEventArgs
54
- }
39
+ export interface ModuleEventData extends ModuleQueriedEventData, ModuleBusyEventData {}
55
40
 
56
41
  export type ModuleQueryFunctions = {
57
42
  addressPreviousHash: () => Promisable<AddressPreviousHashPayload>
@@ -100,7 +85,7 @@ export type IndirectModule<
100
85
  export type DirectModule<
101
86
  TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,
102
87
  TEventData extends ModuleEventData = ModuleEventData,
103
- > = IndirectModule<TParams, TEventData> & ModuleQueryFunctions
88
+ > = IndirectModule<TParams, TEventData> & ModuleQueryFunctions & ResolveFunctions
104
89
 
105
90
  export type ModuleInstance<
106
91
  TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,
@@ -0,0 +1,40 @@
1
+ import { Logger } from '@xyo-network/core'
2
+ import merge from 'lodash/merge'
3
+
4
+ import { CreatableModule, CreatableModuleFactory } from './CreatableModule'
5
+ import { IndirectModule } from './Module'
6
+
7
+ export class ModuleFactory<TModule extends IndirectModule> implements CreatableModuleFactory<TModule> {
8
+ configSchemas: CreatableModuleFactory<TModule>['configSchemas']
9
+
10
+ creatableModule: CreatableModule<TModule>
11
+
12
+ defaultLogger?: Logger | undefined
13
+
14
+ defaultParams?: TModule['params']
15
+
16
+ constructor(creatableModule: CreatableModule<TModule>, params?: TModule['params']) {
17
+ this.creatableModule = creatableModule
18
+ this.defaultParams = params
19
+ this.configSchemas = creatableModule.configSchemas
20
+ }
21
+
22
+ get configSchema(): string {
23
+ return this.configSchemas[0]
24
+ }
25
+
26
+ static withParams<T extends IndirectModule>(creatableModule: CreatableModule<T>, params?: T['params']) {
27
+ return new ModuleFactory(creatableModule, params)
28
+ }
29
+
30
+ create<T extends IndirectModule>(this: CreatableModuleFactory<T>, params?: TModule['params'] | undefined): Promise<T> {
31
+ const factory = this as ModuleFactory<T>
32
+ const schema = factory.creatableModule.configSchema
33
+ const mergedParams: TModule['params'] = merge(factory.defaultParams ?? {}, params, { config: { schema } })
34
+ return factory.creatableModule.create<T>(mergedParams)
35
+ }
36
+
37
+ factory<T extends IndirectModule>(this: CreatableModule<T>, _params?: T['params'] | undefined): CreatableModuleFactory<T> {
38
+ throw new Error('Method not implemented.')
39
+ }
40
+ }
@@ -1,4 +1,4 @@
1
1
  import { BoundWitness } from '@xyo-network/boundwitness-model'
2
2
  import { Payload } from '@xyo-network/payload-model'
3
3
 
4
- export type ModuleQueryResult<T extends Payload = Payload> = [BoundWitness, T[], Payload[]]
4
+ export type ModuleQueryResult<E extends Payload[] = Payload[]> = [BoundWitness, Payload[], E]
@@ -1,4 +1,4 @@
1
- import { Query } from '../../Query'
1
+ import { Query } from '@xyo-network/payload-model'
2
2
 
3
3
  export type ModuleDescribeQuerySchema = 'network.xyo.query.module.describe'
4
4
  export const ModuleDescribeQuerySchema: ModuleDescribeQuerySchema = 'network.xyo.query.module.describe'
@@ -1,4 +1,4 @@
1
- import { Query } from '../Query'
1
+ import { Query } from '@xyo-network/payload-model'
2
2
 
3
3
  export type ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'
4
4
  export const ModuleDiscoverQuerySchema: ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover'
@@ -1,4 +1,4 @@
1
- import { Query } from '../Query'
1
+ import { Query } from '@xyo-network/payload-model'
2
2
 
3
3
  export type ModuleManifestQuerySchema = 'network.xyo.query.module.manifest'
4
4
  export const ModuleManifestQuerySchema: ModuleManifestQuerySchema = 'network.xyo.query.module.manifest'
@@ -1,4 +1,4 @@
1
- import { Query } from '../../Query'
1
+ import { Query } from '@xyo-network/payload-model'
2
2
 
3
3
  export type ModuleAddressQuerySchema = 'network.xyo.query.module.address'
4
4
  export const ModuleAddressQuerySchema: ModuleAddressQuerySchema = 'network.xyo.query.module.address'
@@ -1,4 +1,4 @@
1
- import { Query } from '../Query'
1
+ import { Query } from '@xyo-network/payload-model'
2
2
 
3
3
  export type ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'
4
4
  export const ModuleSubscribeQuerySchema: ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe'
@@ -1,4 +1,5 @@
1
- import { Query } from '../Query'
1
+ import { Query } from '@xyo-network/payload-model'
2
+
2
3
  import { ModuleDescribeQuery } from './Describe'
3
4
  import { ModuleDiscoverQuery } from './Discover'
4
5
  import { ModuleAddressQuery } from './ModuleAddress'
package/src/index.ts CHANGED
@@ -1,14 +1,16 @@
1
1
  export * from './asModule'
2
2
  export * from './Config'
3
3
  export * from './CreatableModule'
4
- export * from './Error'
4
+ export * from './CreatableModuleDictionary'
5
+ export * from './Events'
5
6
  export * from './isModule'
7
+ export * from './lib'
6
8
  export * from './Module'
7
9
  export * from './ModuleDescription'
10
+ export * from './ModuleFactory'
8
11
  export * from './ModuleFilter'
9
12
  export * from './ModuleParams'
10
13
  export * from './ModuleQueryResult'
11
14
  export * from './ModuleRepository'
12
15
  export * from './Queries'
13
- export * from './Query'
14
16
  export * from './withModule'
@@ -0,0 +1,14 @@
1
+ import { IndirectModule } from '../Module'
2
+
3
+ /**
4
+ * Used to filter duplicates from an array of modules
5
+ * @example: modulesArray.filter(duplicateModules)
6
+ * @param value Current Module
7
+ * @param index Current Module's index
8
+ * @param array Module Array
9
+ * @returns True if the Module's address is the first occurrence of
10
+ * that address in the array, false otherwise
11
+ */
12
+ export const duplicateModules = (value: IndirectModule, index: number, array: IndirectModule[]): value is IndirectModule => {
13
+ return array.findIndex((v) => v.address === value.address) === index
14
+ }
@@ -0,0 +1,2 @@
1
+ export * from './duplicateModules'
2
+ export * from './serializable'
@@ -0,0 +1,41 @@
1
+ // Inspired by https://stackoverflow.com/a/49079549/2803259
2
+
3
+ import every from 'lodash/every'
4
+ import isArray from 'lodash/isArray'
5
+ import isBoolean from 'lodash/isBoolean'
6
+ import isNull from 'lodash/isNull'
7
+ import isNumber from 'lodash/isNumber'
8
+ import isPlainObject from 'lodash/isPlainObject'
9
+ import isString from 'lodash/isString'
10
+ import isUndefined from 'lodash/isUndefined'
11
+ import overSome from 'lodash/overSome'
12
+
13
+ const JSONPrimitiveChecks = [isUndefined, isNull, isBoolean, isNumber, isString]
14
+ const JSONComplexChecks = [isPlainObject, isArray]
15
+
16
+ export const serializable = (field: unknown, depth?: number): boolean | null => {
17
+ let depthExceeded = false
18
+ const decrementDepth = () => (depth ? depth-- : undefined)
19
+
20
+ const recursiveSerializable = (field: unknown) => {
21
+ if (depth !== undefined && depth < 1) {
22
+ depthExceeded = true
23
+ return false
24
+ }
25
+
26
+ // decrement during every recursion
27
+ decrementDepth()
28
+
29
+ const nestedSerializable = (field: unknown): boolean => overSome(JSONComplexChecks)(field) && every(field as object, recursiveSerializable)
30
+
31
+ return overSome([...JSONPrimitiveChecks, nestedSerializable])(field)
32
+ }
33
+
34
+ const valid = recursiveSerializable(field)
35
+
36
+ return depthExceeded ? null : valid
37
+ }
38
+
39
+ export const serializableField = (field: unknown) => {
40
+ return overSome([...JSONPrimitiveChecks, ...JSONComplexChecks])(field)
41
+ }
package/dist/cjs/Error.js DELETED
@@ -1,5 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ModuleErrorSchema = void 0;
4
- exports.ModuleErrorSchema = 'network.xyo.error.module';
5
- //# sourceMappingURL=Error.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Error.js","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":";;;AAGa,QAAA,iBAAiB,GAAsB,0BAA0B,CAAA"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"Payload.js","sourceRoot":"","sources":["../../../src/Query/Payload.ts"],"names":[],"mappings":""}
@@ -1,8 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.isQueryBoundWitness = exports.QueryBoundWitnessSchema = void 0;
4
- const boundwitness_model_1 = require("@xyo-network/boundwitness-model");
5
- exports.QueryBoundWitnessSchema = boundwitness_model_1.BoundWitnessSchema;
6
- const isQueryBoundWitness = (x) => (0, boundwitness_model_1.isBoundWitness)(x) && (x === null || x === void 0 ? void 0 : x.query) !== undefined;
7
- exports.isQueryBoundWitness = isQueryBoundWitness;
8
- //# sourceMappingURL=QueryBoundWitness.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"QueryBoundWitness.js","sourceRoot":"","sources":["../../../src/Query/QueryBoundWitness.ts"],"names":[],"mappings":";;;AAAA,wEAAkG;AAIrF,QAAA,uBAAuB,GAA4B,uCAAkB,CAAA;AAQ3E,MAAM,mBAAmB,GAAG,CAAC,CAAkB,EAA0B,EAAE,CAAC,IAAA,mCAAc,EAAC,CAAC,CAAC,IAAI,CAAC,CAAuB,aAAvB,CAAC,uBAAD,CAAC,CAAwB,KAAK,MAAK,SAAS,CAAA;AAAxI,QAAA,mBAAmB,uBAAqH"}
@@ -1,6 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const tslib_1 = require("tslib");
4
- tslib_1.__exportStar(require("./Payload"), exports);
5
- tslib_1.__exportStar(require("./QueryBoundWitness"), exports);
6
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Query/index.ts"],"names":[],"mappings":";;;AAAA,oDAAyB;AACzB,8DAAmC"}
package/dist/esm/Error.js DELETED
@@ -1,2 +0,0 @@
1
- export const ModuleErrorSchema = 'network.xyo.error.module';
2
- //# sourceMappingURL=Error.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Error.js","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,iBAAiB,GAAsB,0BAA0B,CAAA"}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=Payload.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Payload.js","sourceRoot":"","sources":["../../../src/Query/Payload.ts"],"names":[],"mappings":""}
@@ -1,4 +0,0 @@
1
- import { BoundWitnessSchema, isBoundWitness } from '@xyo-network/boundwitness-model';
2
- export const QueryBoundWitnessSchema = BoundWitnessSchema;
3
- export const isQueryBoundWitness = (x) => isBoundWitness(x) && x?.query !== undefined;
4
- //# sourceMappingURL=QueryBoundWitness.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"QueryBoundWitness.js","sourceRoot":"","sources":["../../../src/Query/QueryBoundWitness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,kBAAkB,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAIlG,MAAM,CAAC,MAAM,uBAAuB,GAA4B,kBAAkB,CAAA;AAQlF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAkB,EAA0B,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,IAAK,CAAuB,EAAE,KAAK,KAAK,SAAS,CAAA"}
@@ -1,3 +0,0 @@
1
- export * from './Payload';
2
- export * from './QueryBoundWitness';
3
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Query/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,qBAAqB,CAAA"}
@@ -1,11 +0,0 @@
1
- import { Payload } from '@xyo-network/payload-model';
2
- export type ModuleErrorSchema = 'network.xyo.error.module';
3
- export declare const ModuleErrorSchema: ModuleErrorSchema;
4
- export type ModuleError = Payload<{
5
- message?: string;
6
- name?: string;
7
- query?: string;
8
- schema: ModuleErrorSchema;
9
- sources?: string[];
10
- }>;
11
- //# sourceMappingURL=Error.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,MAAM,MAAM,iBAAiB,GAAG,0BAA0B,CAAA;AAC1D,eAAO,MAAM,iBAAiB,EAAE,iBAA8C,CAAA;AAE9E,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,iBAAiB,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB,CAAC,CAAA"}
@@ -1,13 +0,0 @@
1
- import { Payload } from '@xyo-network/payload-model';
2
- export interface QueryFields {
3
- /** @field The addresses of the intended handlers */
4
- address?: string | [string];
5
- /** @field The maximum XYO that can be spent executing the query */
6
- budget?: number;
7
- /** @field The frequency on which this query can be rerun */
8
- maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
9
- /** @field The starting point for the bidding on the query */
10
- minBid?: number;
11
- }
12
- export type Query<T extends Payload | void = void> = T extends Payload ? Payload<T & QueryFields> : Payload<QueryFields>;
13
- //# sourceMappingURL=Payload.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../src/Query/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,MAAM,WAAW,WAAW;IAC1B,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,CAAC,CAAA;IAE3B,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;IAExF,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,OAAO,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,SAAS,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,WAAW,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA"}
@@ -1,17 +0,0 @@
1
- import { BoundWitness, BoundWitnessSchema } from '@xyo-network/boundwitness-model';
2
- import { Payload } from '@xyo-network/payload-model';
3
- export type QueryBoundWitnessSchema = BoundWitnessSchema;
4
- export declare const QueryBoundWitnessSchema: QueryBoundWitnessSchema;
5
- export type QueryBoundWitness = BoundWitness<{
6
- query: string;
7
- resultSet?: string;
8
- schema: BoundWitnessSchema;
9
- }>;
10
- export declare const isQueryBoundWitness: (x?: Payload | null) => x is import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/boundwitness-model").BoundWitnessFields & {
11
- query: string;
12
- resultSet?: string | undefined;
13
- schema: BoundWitnessSchema;
14
- } & {
15
- schema: "network.xyo.boundwitness";
16
- };
17
- //# sourceMappingURL=QueryBoundWitness.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"QueryBoundWitness.d.ts","sourceRoot":"","sources":["../../../src/Query/QueryBoundWitness.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAkB,MAAM,iCAAiC,CAAA;AAClG,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,MAAM,MAAM,uBAAuB,GAAG,kBAAkB,CAAA;AACxD,eAAO,MAAM,uBAAuB,EAAE,uBAA4C,CAAA;AAElF,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,kBAAkB,CAAA;CAC3B,CAAC,CAAA;AAEF,eAAO,MAAM,mBAAmB,OAAQ,OAAO,GAAG,IAAI;WAL7C,MAAM;;YAEL,kBAAkB;;;CAGyH,CAAA"}
@@ -1,3 +0,0 @@
1
- export * from './Payload';
2
- export * from './QueryBoundWitness';
3
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Query/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,qBAAqB,CAAA"}
package/src/Error.ts DELETED
@@ -1,12 +0,0 @@
1
- import { Payload } from '@xyo-network/payload-model'
2
-
3
- export type ModuleErrorSchema = 'network.xyo.error.module'
4
- export const ModuleErrorSchema: ModuleErrorSchema = 'network.xyo.error.module'
5
-
6
- export type ModuleError = Payload<{
7
- message?: string
8
- name?: string
9
- query?: string
10
- schema: ModuleErrorSchema
11
- sources?: string[]
12
- }>
@@ -1,17 +0,0 @@
1
- import { Payload } from '@xyo-network/payload-model'
2
-
3
- export interface QueryFields {
4
- /** @field The addresses of the intended handlers */
5
- address?: string | [string]
6
-
7
- /** @field The maximum XYO that can be spent executing the query */
8
- budget?: number
9
-
10
- /** @field The frequency on which this query can be rerun */
11
- maxFrequency?: 'once' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'
12
-
13
- /** @field The starting point for the bidding on the query */
14
- minBid?: number
15
- }
16
-
17
- export type Query<T extends Payload | void = void> = T extends Payload ? Payload<T & QueryFields> : Payload<QueryFields>
@@ -1,13 +0,0 @@
1
- import { BoundWitness, BoundWitnessSchema, isBoundWitness } from '@xyo-network/boundwitness-model'
2
- import { Payload } from '@xyo-network/payload-model'
3
-
4
- export type QueryBoundWitnessSchema = BoundWitnessSchema
5
- export const QueryBoundWitnessSchema: QueryBoundWitnessSchema = BoundWitnessSchema
6
-
7
- export type QueryBoundWitness = BoundWitness<{
8
- query: string
9
- resultSet?: string
10
- schema: BoundWitnessSchema
11
- }>
12
-
13
- export const isQueryBoundWitness = (x?: Payload | null): x is QueryBoundWitness => isBoundWitness(x) && (x as QueryBoundWitness)?.query !== undefined
@@ -1,2 +0,0 @@
1
- export * from './Payload'
2
- export * from './QueryBoundWitness'