@xyo-network/module-model 2.64.6 → 2.64.8

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 (69) hide show
  1. package/dist/cjs/Queries/{ModuleAccount → ModuleAddress}/Payload.js.map +1 -1
  2. package/dist/cjs/Queries/ModuleAddress/Query.js +5 -0
  3. package/dist/cjs/Queries/ModuleAddress/Query.js.map +1 -0
  4. package/dist/cjs/Queries/ModuleAddress/index.js.map +1 -0
  5. package/dist/cjs/Queries/index.js +1 -1
  6. package/dist/cjs/asModule.js +28 -0
  7. package/dist/cjs/asModule.js.map +1 -0
  8. package/dist/cjs/index.js +1 -0
  9. package/dist/cjs/index.js.map +1 -1
  10. package/dist/cjs/isModule.js +46 -9
  11. package/dist/cjs/isModule.js.map +1 -1
  12. package/dist/cjs/withModule.js +4 -3
  13. package/dist/cjs/withModule.js.map +1 -1
  14. package/dist/docs.json +5751 -2708
  15. package/dist/esm/Queries/{ModuleAccount → ModuleAddress}/Payload.js.map +1 -1
  16. package/dist/esm/Queries/ModuleAddress/Query.js +2 -0
  17. package/dist/esm/Queries/ModuleAddress/Query.js.map +1 -0
  18. package/dist/esm/Queries/ModuleAddress/index.js.map +1 -0
  19. package/dist/esm/Queries/index.js +1 -1
  20. package/dist/esm/asModule.js +25 -0
  21. package/dist/esm/asModule.js.map +1 -0
  22. package/dist/esm/index.js +1 -0
  23. package/dist/esm/index.js.map +1 -1
  24. package/dist/esm/isModule.js +41 -8
  25. package/dist/esm/isModule.js.map +1 -1
  26. package/dist/esm/withModule.js +4 -3
  27. package/dist/esm/withModule.js.map +1 -1
  28. package/dist/types/Module.d.ts +15 -7
  29. package/dist/types/Module.d.ts.map +1 -1
  30. package/dist/types/Queries/{ModuleAccount → ModuleAddress}/Payload.d.ts.map +1 -1
  31. package/dist/types/Queries/ModuleAddress/Query.d.ts +7 -0
  32. package/dist/types/Queries/{ModuleAccount → ModuleAddress}/Query.d.ts.map +1 -1
  33. package/dist/types/Queries/ModuleAddress/index.d.ts.map +1 -0
  34. package/dist/types/Queries/index.d.ts +3 -3
  35. package/dist/types/Query/QueryBoundWitness.d.ts +2 -0
  36. package/dist/types/Query/QueryBoundWitness.d.ts.map +1 -1
  37. package/dist/types/asModule.d.ts +16 -0
  38. package/dist/types/asModule.d.ts.map +1 -0
  39. package/dist/types/index.d.ts +1 -0
  40. package/dist/types/index.d.ts.map +1 -1
  41. package/dist/types/isModule.d.ts +12 -4
  42. package/dist/types/isModule.d.ts.map +1 -1
  43. package/dist/types/withModule.d.ts +5 -5
  44. package/dist/types/withModule.d.ts.map +1 -1
  45. package/package.json +11 -10
  46. package/src/Module.ts +25 -8
  47. package/src/Queries/ModuleAddress/Query.ts +8 -0
  48. package/src/Queries/index.ts +3 -3
  49. package/src/asModule.ts +39 -0
  50. package/src/index.ts +1 -0
  51. package/src/isModule.ts +59 -14
  52. package/src/withModule.ts +7 -7
  53. package/dist/cjs/Queries/ModuleAccount/Query.js +0 -5
  54. package/dist/cjs/Queries/ModuleAccount/Query.js.map +0 -1
  55. package/dist/cjs/Queries/ModuleAccount/index.js.map +0 -1
  56. package/dist/esm/Queries/ModuleAccount/Query.js +0 -2
  57. package/dist/esm/Queries/ModuleAccount/Query.js.map +0 -1
  58. package/dist/esm/Queries/ModuleAccount/index.js.map +0 -1
  59. package/dist/types/Queries/ModuleAccount/Query.d.ts +0 -7
  60. package/dist/types/Queries/ModuleAccount/index.d.ts.map +0 -1
  61. package/src/Queries/ModuleAccount/Query.ts +0 -8
  62. /package/dist/cjs/Queries/{ModuleAccount → ModuleAddress}/Payload.js +0 -0
  63. /package/dist/cjs/Queries/{ModuleAccount → ModuleAddress}/index.js +0 -0
  64. /package/dist/esm/Queries/{ModuleAccount → ModuleAddress}/Payload.js +0 -0
  65. /package/dist/esm/Queries/{ModuleAccount → ModuleAddress}/index.js +0 -0
  66. /package/dist/types/Queries/{ModuleAccount → ModuleAddress}/Payload.d.ts +0 -0
  67. /package/dist/types/Queries/{ModuleAccount → ModuleAddress}/index.d.ts +0 -0
  68. /package/src/Queries/{ModuleAccount → ModuleAddress}/Payload.ts +0 -0
  69. /package/src/Queries/{ModuleAccount → ModuleAddress}/index.ts +0 -0
@@ -1 +1 @@
1
- {"version":3,"file":"Payload.js","sourceRoot":"","sources":["../../../../src/Queries/ModuleAccount/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAA;AAGnE,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,aAAa,gBAAgB,CAAA"}
1
+ {"version":3,"file":"Payload.js","sourceRoot":"","sources":["../../../../src/Queries/ModuleAddress/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAA;AAGnE,MAAM,CAAC,MAAM,yBAAyB,GAAG,GAAG,aAAa,gBAAgB,CAAA"}
@@ -0,0 +1,2 @@
1
+ export const ModuleAddressQuerySchema = 'network.xyo.query.module.address';
2
+ //# sourceMappingURL=Query.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Query.js","sourceRoot":"","sources":["../../../../src/Queries/ModuleAddress/Query.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,wBAAwB,GAA6B,kCAAkC,CAAA"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/Queries/ModuleAddress/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}
@@ -1,4 +1,4 @@
1
1
  export * from './Discover';
2
- export * from './ModuleAccount';
2
+ export * from './ModuleAddress';
3
3
  export * from './Subscribe';
4
4
  //# sourceMappingURL=index.js.map
@@ -0,0 +1,25 @@
1
+ import { assertEx } from '@xylabs/assert';
2
+ import { isModule, isModuleInstance } from './isModule';
3
+ export const AsFactory = {
4
+ create: (typeCheck) => {
5
+ function func(
6
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
7
+ module, assert) {
8
+ const result = typeCheck(module) ? module : undefined;
9
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
10
+ const noUndefined = (assert) => {
11
+ return !!assert;
12
+ };
13
+ if (noUndefined(assert)) {
14
+ return assertEx(result, typeof assert === 'function' ? assert() : assert);
15
+ }
16
+ else {
17
+ return result;
18
+ }
19
+ }
20
+ return func;
21
+ },
22
+ };
23
+ export const asModule = AsFactory.create(isModule);
24
+ export const asModuleInstance = AsFactory.create(isModuleInstance);
25
+ //# sourceMappingURL=asModule.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"asModule.js","sourceRoot":"","sources":["../../src/asModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAqB,QAAQ,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAE1E,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,MAAM,EAAE,CAAyB,SAAqC,EAAE,EAAE;QAUxE,SAAS,IAAI;QACX,8DAA8D;QAC9D,MAAW,EACX,MAAgC;YAEhC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;YAErD,8DAA8D;YAC9D,MAAM,WAAW,GAAG,CAAC,MAAW,EAAqB,EAAE;gBACrD,OAAO,CAAC,CAAC,MAAM,CAAA;YACjB,CAAC,CAAA;YAED,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE;gBACvB,OAAO,QAAQ,CAAC,MAAM,EAAE,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;aAC1E;iBAAM;gBACL,OAAO,MAAM,CAAA;aACd;QACH,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;AAClD,MAAM,CAAC,MAAM,gBAAgB,GAAG,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA"}
package/dist/esm/index.js CHANGED
@@ -1,3 +1,4 @@
1
+ export * from './asModule';
1
2
  export * from './Config';
2
3
  export * from './CreatableModule';
3
4
  export * from './Error';
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA"}
@@ -1,14 +1,47 @@
1
+ export const isType = (value, expectedType) => {
2
+ if (expectedType === 'array') {
3
+ return Array.isArray(value);
4
+ }
5
+ else if (expectedType === 'payload') {
6
+ return typeof value === 'object' && typeof value.schema === 'string';
7
+ }
8
+ else {
9
+ return typeof value === expectedType;
10
+ }
11
+ };
12
+ export const IsInstanceFactory = {
13
+ create: (shape, additionalCheck) => {
14
+ return (module = {}) => {
15
+ return ((additionalCheck?.(module) ?? true) &&
16
+ (Object.entries(shape ?? {}).reduce((prev, [key, type]) => prev && isType(module[key], type), true) ?? true));
17
+ };
18
+ },
19
+ };
1
20
  export const IsModuleFactory = {
2
- create: (baseCheck, expectedFunctions,
3
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
4
- additionalCheck) => {
5
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
6
- return (module) => {
7
- return ((baseCheck?.(module) || true) &&
21
+ create: (expectedQueries, additionalCheck) => {
22
+ return (module = {}) => {
23
+ return (isModuleInstance(module) &&
8
24
  (additionalCheck?.(module) ?? true) &&
9
- (expectedFunctions?.reduce((prev, value) => prev && typeof module[value] === 'function', true) ?? true));
25
+ (expectedQueries?.reduce((prev, query) => prev && module.queries.includes(query), true) ?? true));
10
26
  };
11
27
  },
12
28
  };
13
- export const isModule = IsModuleFactory.create(undefined, ['query'], (module) => typeof module.config === 'object');
29
+ export const isModuleInstance = IsInstanceFactory.create({
30
+ account: 'object',
31
+ address: 'string',
32
+ config: 'object',
33
+ discover: 'function',
34
+ downResolver: 'object',
35
+ manifest: 'function',
36
+ params: 'object',
37
+ queries: 'array',
38
+ query: 'function',
39
+ queryable: 'function',
40
+ upResolver: 'object',
41
+ });
42
+ export const isModule = (module = {}, expectedQueries, additionalCheck) => {
43
+ return (isModuleInstance(module) &&
44
+ (additionalCheck?.(module) ?? true) &&
45
+ (expectedQueries?.reduce((prev, query) => prev && module.queries.includes(query), true) ?? true));
46
+ };
14
47
  //# sourceMappingURL=isModule.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"isModule.js","sourceRoot":"","sources":["../../src/isModule.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM,EAAE,CACN,SAA2B,EAC3B,iBAA4B;IAC5B,8DAA8D;IAC9D,eAA0C,EACtB,EAAE;QACtB,8DAA8D;QAC9D,OAAO,CAAC,MAAW,EAAe,EAAE;YAClC,OAAO,CACL,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC;gBAC7B,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC;gBACnC,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,UAAU,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,CACxG,CAAA;QACH,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAA4B,eAAe,CAAC,MAAM,CAAS,SAAS,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAA"}
1
+ {"version":3,"file":"isModule.js","sourceRoot":"","sources":["../../src/isModule.ts"],"names":[],"mappings":"AAWA,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAU,EAAE,YAAuB,EAAE,EAAE;IAC5D,IAAI,YAAY,KAAK,OAAO,EAAE;QAC5B,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;KAC5B;SAAM,IAAI,YAAY,KAAK,SAAS,EAAE;QACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAA;KACrE;SAAM;QACL,OAAO,OAAO,KAAK,KAAK,YAAY,CAAA;KACrC;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,MAAM,EAAE,CAA4B,KAAyB,EAAE,eAA0C,EAAwB,EAAE;QACjI,OAAO,CAAC,SAAc,EAAE,EAAe,EAAE;YACvC,OAAO,CACL,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC;gBACnC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,CAC7G,CAAA;QACH,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM,EAAE,CAA4C,eAA0B,EAAE,eAA0C,EAAsB,EAAE;QAChJ,OAAO,CAAC,SAAc,EAAE,EAAe,EAAE;YACvC,OAAO,CACL,gBAAgB,CAAC,MAAM,CAAC;gBACxB,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC;gBACnC,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,CACjG,CAAA;QACH,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAsC,iBAAiB,CAAC,MAAM,CAAiB;IAC1G,OAAO,EAAE,QAAQ;IACjB,OAAO,EAAE,QAAQ;IACjB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;IACpB,YAAY,EAAE,QAAQ;IACtB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,UAAU;IACjB,SAAS,EAAE,UAAU;IACrB,UAAU,EAAE,QAAQ;CACrB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,SAAc,EAAE,EAChB,eAA0B,EAC1B,eAA0C,EAC7B,EAAE;IACf,OAAO,CACL,gBAAgB,CAAC,MAAM,CAAC;QACxB,CAAC,eAAe,EAAE,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC;QACnC,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,CACjG,CAAA;AACH,CAAC,CAAA"}
@@ -1,5 +1,5 @@
1
- import { isModule } from './isModule';
2
- export const WithModuleFactory = {
1
+ import { isModule, isModuleInstance } from './isModule';
2
+ export const WithFactory = {
3
3
  create: (typeCheck) => {
4
4
  return (
5
5
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -10,5 +10,6 @@ export const WithModuleFactory = {
10
10
  };
11
11
  },
12
12
  };
13
- export const withModule = WithModuleFactory.create(isModule);
13
+ export const withModule = WithFactory.create(isModule);
14
+ export const withModuleInstance = WithFactory.create(isModuleInstance);
14
15
  //# sourceMappingURL=withModule.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"withModule.js","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmB,MAAM,YAAY,CAAA;AAGtD,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,MAAM,EAAE,CAA4B,SAA6B,EAAE,EAAE;QACnE,OAAO;QACL,8DAA8D;QAC9D,MAAW;QACX,8DAA8D;QAC9D,OAA2B,EACZ,EAAE;YACjB,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACxD,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA"}
1
+ {"version":3,"file":"withModule.js","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,QAAQ,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAE1E,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,MAAM,EAAE,CAAmB,SAA+B,EAAE,EAAE;QAC5D,OAAO;QACL,8DAA8D;QAC9D,MAAW;QACX,8DAA8D;QAC9D,OAAyB,EACV,EAAE;YACjB,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACxD,CAAC,CAAA;IACH,CAAC;CACF,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;AACtD,MAAM,CAAC,MAAM,kBAAkB,GAAG,WAAW,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA"}
@@ -4,9 +4,11 @@ import { EventArgs, EventData, EventFunctions } from '@xyo-network/module-events
4
4
  import { Payload } from '@xyo-network/payload-model';
5
5
  import { Promisable } from '@xyo-network/promise';
6
6
  import { AnyConfigSchema, ModuleConfig } from './Config';
7
+ import { ModuleDescription } from './ModuleDescription';
7
8
  import { ModuleFilter } from './ModuleFilter';
8
9
  import { ModuleParams } from './ModuleParams';
9
10
  import { ModuleQueryResult } from './ModuleQueryResult';
11
+ import { AddressPreviousHashPayload } from './Queries';
10
12
  import { QueryBoundWitness } from './Query';
11
13
  export interface ModuleResolver {
12
14
  addResolver: (resolver: ModuleResolver) => this;
@@ -17,19 +19,19 @@ export interface ModuleResolver {
17
19
  * is supplied, all modules are returned
18
20
  * @param filter Filter criteria for the desired modules
19
21
  */
20
- resolve<T extends Module = Module>(filter?: ModuleFilter): Promisable<T[]>;
22
+ resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter): Promisable<T[]>;
21
23
  /**
22
24
  * Resolves a single module, or undefined if no modules matched the filter.
23
25
  * @param filter The desired Module's Address or Name
24
26
  */
25
- resolveOne<T extends Module = Module>(filter: string): Promisable<T | undefined>;
27
+ resolveOne<T extends ModuleInstance = ModuleInstance>(filter: string): Promisable<T | undefined>;
26
28
  }
27
- export type ModuleEventArgs<TModule extends Module = Module, TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs ? {
29
+ export type ModuleEventArgs<TModule extends ModuleInstance = ModuleInstance, TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs ? {
28
30
  module: TModule;
29
31
  } & TArgs : {
30
32
  module: TModule;
31
33
  };
32
- export type ModuleQueriedEventArgs = ModuleEventArgs<Module, {
34
+ export type ModuleQueriedEventArgs = ModuleEventArgs<ModuleInstance, {
33
35
  payloads?: Payload[];
34
36
  query: QueryBoundWitness;
35
37
  result: ModuleQueryResult;
@@ -37,19 +39,25 @@ export type ModuleQueriedEventArgs = ModuleEventArgs<Module, {
37
39
  export interface ModuleEventData extends EventData {
38
40
  moduleQueried: ModuleQueriedEventArgs;
39
41
  }
42
+ export type ModuleQueryFunctions = {
43
+ addressPreviousHash: () => Promisable<AddressPreviousHashPayload>;
44
+ discover: () => Promisable<Payload[]>;
45
+ manifest: () => Promisable<ModuleManifest>;
46
+ };
40
47
  export type ModuleFields<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>> = {
41
- account?: AccountInstance;
42
48
  address: string;
43
49
  config: TParams['config'];
50
+ describe: () => Promise<ModuleDescription>;
44
51
  readonly downResolver: ModuleResolver;
45
52
  loadAccount?: () => Promisable<AccountInstance>;
46
- manifest: () => Promisable<ModuleManifest>;
47
53
  params: TParams;
54
+ previousHash: () => Promisable<string | undefined>;
48
55
  queries: string[];
49
56
  query: <T extends QueryBoundWitness = QueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConf) => Promisable<ModuleQueryResult>;
50
57
  queryable: <T extends QueryBoundWitness = QueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConf) => Promisable<boolean>;
51
58
  start?: () => Promisable<void>;
52
59
  readonly upResolver: ModuleResolver;
53
60
  };
54
- export type Module<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>, TEventData extends ModuleEventData = ModuleEventData> = ModuleFields<TParams> & EventFunctions<TEventData>;
61
+ export type Module<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>, TEventData extends ModuleEventData = ModuleEventData> = ModuleFields<TParams> & EventFunctions<TEventData> & ModuleQueryFunctions;
62
+ export type ModuleInstance<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>, TEventData extends ModuleEventData = ModuleEventData> = Module<TParams, TEventData>;
55
63
  //# sourceMappingURL=Module.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AACjF,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAE3C,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAC/C,gBAAgB,EAAE,OAAO,CAAA;IACzB,cAAc,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAClD;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAAA;IAC1E;;;OAGG;IACH,UAAU,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;CACjF;AAED,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,EAAE,KAAK,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IAAI,KAAK,SAAS,SAAS,GACnI;IACE,MAAM,EAAE,OAAO,CAAA;CAChB,GAAG,KAAK,GACT;IACE,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAEL,MAAM,MAAM,sBAAsB,GAAG,eAAe,CAClD,MAAM,EACN;IACE,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,EAAE,iBAAiB,CAAA;IACxB,MAAM,EAAE,iBAAiB,CAAA;CAC1B,CACF,CAAA;AAED,MAAM,WAAW,eAAgB,SAAQ,SAAS;IAChD,aAAa,EAAE,sBAAsB,CAAA;CACtC;AAED,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,GAAG,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,IAAI;IACpI,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IAGzB,QAAQ,CAAC,YAAY,EAAE,cAAc,CAAA;IAErC,WAAW,CAAC,EAAE,MAAM,UAAU,CAAC,eAAe,CAAC,CAAA;IAE/C,QAAQ,EAAE,MAAM,UAAU,CAAC,cAAc,CAAC,CAAA;IAE1C,MAAM,EAAE,OAAO,CAAA;IAEf,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,EAAE,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EAChG,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,OAAO,EAAE,EACpB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAClC,SAAS,EAAE,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EACpG,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,OAAO,EAAE,EACpB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,OAAO,CAAC,CAAA;IAExB,KAAK,CAAC,EAAE,MAAM,UAAU,CAAC,IAAI,CAAC,CAAA;IAI9B,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,MAAM,CAChB,OAAO,SAAS,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,GAAG,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,EACzG,UAAU,SAAS,eAAe,GAAG,eAAe,IAClD,YAAY,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC,CAAA"}
1
+ {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AACjF,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAA;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAE3C,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAC/C,gBAAgB,EAAE,OAAO,CAAA;IACzB,cAAc,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAClD;;;;OAIG;IACH,OAAO,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAAA;IAC1F;;;OAGG;IACH,UAAU,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;CACjG;AAED,MAAM,MAAM,eAAe,CACzB,OAAO,SAAS,cAAc,GAAG,cAAc,EAC/C,KAAK,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IAC7C,KAAK,SAAS,SAAS,GACvB;IACE,MAAM,EAAE,OAAO,CAAA;CAChB,GAAG,KAAK,GACT;IACE,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAEL,MAAM,MAAM,sBAAsB,GAAG,eAAe,CAClD,cAAc,EACd;IACE,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,EAAE,iBAAiB,CAAA;IACxB,MAAM,EAAE,iBAAiB,CAAA;CAC1B,CACF,CAAA;AAED,MAAM,WAAW,eAAgB,SAAQ,SAAS;IAChD,aAAa,EAAE,sBAAsB,CAAA;CACtC;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,mBAAmB,EAAE,MAAM,UAAU,CAAC,0BAA0B,CAAC,CAAA;IACjE,QAAQ,EAAE,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;IACrC,QAAQ,EAAE,MAAM,UAAU,CAAC,cAAc,CAAC,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,GAAG,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,IAAI;IACpI,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IAEzB,QAAQ,EAAE,MAAM,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAG1C,QAAQ,CAAC,YAAY,EAAE,cAAc,CAAA;IAErC,WAAW,CAAC,EAAE,MAAM,UAAU,CAAC,eAAe,CAAC,CAAA;IAE/C,MAAM,EAAE,OAAO,CAAA;IAEf,YAAY,EAAE,MAAM,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;IAElD,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,EAAE,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EAChG,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,OAAO,EAAE,EACpB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAClC,SAAS,EAAE,CAAC,CAAC,SAAS,iBAAiB,GAAG,iBAAiB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EACpG,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,OAAO,EAAE,EACpB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,OAAO,CAAC,CAAA;IAExB,KAAK,CAAC,EAAE,MAAM,UAAU,CAAC,IAAI,CAAC,CAAA;IAI9B,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,MAAM,CAChB,OAAO,SAAS,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,GAAG,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,EACzG,UAAU,SAAS,eAAe,GAAG,eAAe,IAClD,YAAY,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,oBAAoB,CAAA;AAE7E,MAAM,MAAM,cAAc,CACxB,OAAO,SAAS,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,GAAG,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,EACzG,UAAU,SAAS,eAAe,GAAG,eAAe,IAClD,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../src/Queries/ModuleAccount/Payload.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,eAAO,MAAM,yBAAyB,QAAmC,CAAA;AACzE,MAAM,MAAM,yBAAyB,GAAG,OAAO,yBAAyB,CAAA;AAExE,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,yBAAyB,CAAA;CAClC,CAAC,CAAA"}
1
+ {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../../../src/Queries/ModuleAddress/Payload.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEpD,eAAO,MAAM,yBAAyB,QAAmC,CAAA;AACzE,MAAM,MAAM,yBAAyB,GAAG,OAAO,yBAAyB,CAAA;AAExE,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC;IAC/C,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,yBAAyB,CAAA;CAClC,CAAC,CAAA"}
@@ -0,0 +1,7 @@
1
+ import { Query } from '../../Query';
2
+ export type ModuleAddressQuerySchema = 'network.xyo.query.module.address';
3
+ export declare const ModuleAddressQuerySchema: ModuleAddressQuerySchema;
4
+ export type ModuleAddressQuery = Query<{
5
+ schema: ModuleAddressQuerySchema;
6
+ }>;
7
+ //# sourceMappingURL=Query.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../../../src/Queries/ModuleAccount/Query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAEnC,MAAM,MAAM,wBAAwB,GAAG,kCAAkC,CAAA;AACzE,eAAO,MAAM,wBAAwB,EAAE,wBAA6D,CAAA;AAEpG,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC;IACrC,MAAM,EAAE,wBAAwB,CAAA;CACjC,CAAC,CAAA"}
1
+ {"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../../../src/Queries/ModuleAddress/Query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAEnC,MAAM,MAAM,wBAAwB,GAAG,kCAAkC,CAAA;AACzE,eAAO,MAAM,wBAAwB,EAAE,wBAA6D,CAAA;AAEpG,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC;IACrC,MAAM,EAAE,wBAAwB,CAAA;CACjC,CAAC,CAAA"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Queries/ModuleAddress/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}
@@ -1,10 +1,10 @@
1
1
  import { Query } from '../Query';
2
2
  import { ModuleDiscoverQuery } from './Discover';
3
- import { ModuleAccountQuery } from './ModuleAccount';
3
+ import { ModuleAddressQuery } from './ModuleAddress';
4
4
  import { ModuleSubscribeQuery } from './Subscribe';
5
5
  export * from './Discover';
6
- export * from './ModuleAccount';
6
+ export * from './ModuleAddress';
7
7
  export * from './Subscribe';
8
- export type ModuleQueryBase = ModuleDiscoverQuery | ModuleAccountQuery | ModuleSubscribeQuery;
8
+ export type ModuleQueryBase = ModuleDiscoverQuery | ModuleAddressQuery | ModuleSubscribeQuery;
9
9
  export type ModuleQuery<T extends Query | void = void> = T extends Query ? ModuleQueryBase | T : ModuleQueryBase;
10
10
  //# sourceMappingURL=index.d.ts.map
@@ -11,5 +11,7 @@ export declare const isQueryBoundWitness: (x?: Payload | null) => x is import("@
11
11
  query: string;
12
12
  resultSet?: string | undefined;
13
13
  schema: BoundWitnessSchema;
14
+ } & {
15
+ schema: "network.xyo.boundwitness";
14
16
  };
15
17
  //# sourceMappingURL=QueryBoundWitness.d.ts.map
@@ -1 +1 @@
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
+ {"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"}
@@ -0,0 +1,16 @@
1
+ import { InstanceTypeCheck } from './isModule';
2
+ export declare const AsFactory: {
3
+ create: <TModule extends object>(typeCheck: InstanceTypeCheck<TModule>) => {
4
+ (module: any): TModule | undefined;
5
+ (module: any, assert: string | (() => string)): TModule;
6
+ };
7
+ };
8
+ export declare const asModule: {
9
+ (module: any): import("./Module").Module | undefined;
10
+ (module: any, assert: string | (() => string)): import("./Module").Module;
11
+ };
12
+ export declare const asModuleInstance: {
13
+ (module: any): import("./Module").ModuleInstance | undefined;
14
+ (module: any, assert: string | (() => string)): import("./Module").ModuleInstance;
15
+ };
16
+ //# sourceMappingURL=asModule.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"asModule.d.ts","sourceRoot":"","sources":["../../src/asModule.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAA8B,MAAM,YAAY,CAAA;AAE1E,eAAO,MAAM,SAAS;;iBAIR,GAAG;iBAIH,GAAG,UACH,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC;;CAsBpC,CAAA;AAED,eAAO,MAAM,QAAQ;aA7BP,GAAG;aAIH,GAAG,0BACa,MAAM;CAwBc,CAAA;AAClD,eAAO,MAAM,gBAAgB;aA9Bf,GAAG;aAIH,GAAG,0BACa,MAAM;CAyB8B,CAAA"}
@@ -1,3 +1,4 @@
1
+ export * from './asModule';
1
2
  export * from './Config';
2
3
  export * from './CreatableModule';
3
4
  export * from './Error';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA"}
@@ -1,7 +1,15 @@
1
- import { Module } from './Module';
2
- export type ModuleTypeCheck<T extends Module = Module> = (module: any) => module is T;
1
+ import { Module, ModuleInstance } from './Module';
2
+ export type InstanceTypeCheck<T extends object = object> = (module: object) => module is T;
3
+ export type ModuleTypeCheck<T extends Module = Module> = InstanceTypeCheck<T>;
4
+ export type FieldType = 'string' | 'number' | 'object' | 'symbol' | 'symbol' | 'undefined' | 'null' | 'array' | 'function' | 'payload';
5
+ export type InstanceTypeShape = Record<string | number | symbol, FieldType>;
6
+ export declare const isType: (value: any, expectedType: FieldType) => boolean;
7
+ export declare const IsInstanceFactory: {
8
+ create: <T extends object = object>(shape?: InstanceTypeShape, additionalCheck?: ((module: any) => boolean) | undefined) => InstanceTypeCheck<T>;
9
+ };
3
10
  export declare const IsModuleFactory: {
4
- create: <T extends Module = Module>(baseCheck?: ModuleTypeCheck, expectedFunctions?: string[], additionalCheck?: ((module: any) => boolean) | undefined) => ModuleTypeCheck<T>;
11
+ create: <T extends ModuleInstance = ModuleInstance>(expectedQueries?: string[], additionalCheck?: ((module: any) => boolean) | undefined) => ModuleTypeCheck<T>;
5
12
  };
6
- export declare const isModule: ModuleTypeCheck<Module>;
13
+ export declare const isModuleInstance: InstanceTypeCheck<ModuleInstance>;
14
+ export declare const isModule: <T extends Module = Module>(module?: any, expectedQueries?: string[], additionalCheck?: ((module: any) => boolean) | undefined) => module is T;
7
15
  //# sourceMappingURL=isModule.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"isModule.d.ts","sourceRoot":"","sources":["../../src/isModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAGjC,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,MAAM,IAAI,CAAC,CAAA;AAErF,eAAO,MAAM,eAAe;oDAEZ,eAAe,sBACP,MAAM,EAAE,8BAED,GAAG,KAAK,OAAO;CAW7C,CAAA;AAED,eAAO,MAAM,QAAQ,EAAE,eAAe,CAAC,MAAM,CAAuG,CAAA"}
1
+ {"version":3,"file":"isModule.d.ts","sourceRoot":"","sources":["../../src/isModule.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAEjD,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,IAAI,CAAC,CAAA;AAE1F,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAA;AAE7E,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,CAAA;AAEtI,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,SAAS,CAAC,CAAA;AAE3E,eAAO,MAAM,MAAM,UAAW,GAAG,gBAAgB,SAAS,YAQzD,CAAA;AAED,eAAO,MAAM,iBAAiB;gDACgB,iBAAiB,8BAA6B,GAAG,KAAK,OAAO;CAQ1G,CAAA;AAED,eAAO,MAAM,eAAe;0EAC4C,MAAM,EAAE,8BAA6B,GAAG,KAAK,OAAO;CAS3H,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,iBAAiB,CAAC,cAAc,CAY7D,CAAA;AAEF,eAAO,MAAM,QAAQ,uCACX,GAAG,oBACO,MAAM,EAAE,8BACC,GAAG,KAAK,OAAO,6BAO3C,CAAA"}
@@ -1,7 +1,7 @@
1
- import { ModuleTypeCheck } from './isModule';
2
- import { Module } from './Module';
3
- export declare const WithModuleFactory: {
4
- create: <T extends Module = Module>(typeCheck: ModuleTypeCheck<T>) => <R extends void = void>(module: any, closure: (module: any) => R) => R | undefined;
1
+ import { InstanceTypeCheck } from './isModule';
2
+ export declare const WithFactory: {
3
+ create: <T extends object>(typeCheck: InstanceTypeCheck<T>) => <R>(module: any, closure: (module: T) => R) => R | undefined;
5
4
  };
6
- export declare const withModule: <R extends void = void>(module: any, closure: (module: any) => R) => R | undefined;
5
+ export declare const withModule: <R>(module: any, closure: (module: import("./Module").Module) => R) => R | undefined;
6
+ export declare const withModuleInstance: <R>(module: any, closure: (module: import("./Module").ModuleInstance) => R) => R | undefined;
7
7
  //# sourceMappingURL=withModule.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,eAAe,EAAE,MAAM,YAAY,CAAA;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,eAAO,MAAM,iBAAiB;0GAIhB,GAAG,oBAEO,GAAG;CAK1B,CAAA;AAED,eAAO,MAAM,UAAU,kCATT,GAAG,oBAEO,GAAG,wBAOiC,CAAA"}
1
+ {"version":3,"file":"withModule.d.ts","sourceRoot":"","sources":["../../src/withModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAA8B,MAAM,YAAY,CAAA;AAE1E,eAAO,MAAM,WAAW;+EAIV,GAAG;CAOhB,CAAA;AAED,eAAO,MAAM,UAAU,cATT,GAAG,qEASqC,CAAA;AACtD,eAAO,MAAM,kBAAkB,cAVjB,GAAG,6EAUqD,CAAA"}
package/package.json CHANGED
@@ -10,15 +10,16 @@
10
10
  "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
11
11
  },
12
12
  "dependencies": {
13
- "@xyo-network/account-model": "^2.64.6",
14
- "@xyo-network/address-payload-plugin": "^2.64.6",
15
- "@xyo-network/boundwitness-model": "^2.64.6",
16
- "@xyo-network/core": "^2.64.6",
17
- "@xyo-network/manifest-model": "^2.64.6",
18
- "@xyo-network/module-events": "^2.64.6",
19
- "@xyo-network/payload-model": "^2.64.6",
20
- "@xyo-network/promise": "^2.64.6",
21
- "@xyo-network/wallet-model": "^2.64.6"
13
+ "@xylabs/assert": "^2.9.3",
14
+ "@xyo-network/account-model": "^2.64.8",
15
+ "@xyo-network/address-payload-plugin": "^2.64.8",
16
+ "@xyo-network/boundwitness-model": "^2.64.8",
17
+ "@xyo-network/core": "^2.64.8",
18
+ "@xyo-network/manifest-model": "^2.64.8",
19
+ "@xyo-network/module-events": "^2.64.8",
20
+ "@xyo-network/payload-model": "^2.64.8",
21
+ "@xyo-network/promise": "^2.64.8",
22
+ "@xyo-network/wallet-model": "^2.64.8"
22
23
  },
23
24
  "devDependencies": {
24
25
  "@xylabs/ts-scripts-yarn3": "^2.18.5",
@@ -58,5 +59,5 @@
58
59
  },
59
60
  "sideEffects": false,
60
61
  "types": "dist/types/index.d.ts",
61
- "version": "2.64.6"
62
+ "version": "2.64.8"
62
63
  }
package/src/Module.ts CHANGED
@@ -5,9 +5,11 @@ import { Payload } from '@xyo-network/payload-model'
5
5
  import { Promisable } from '@xyo-network/promise'
6
6
 
7
7
  import { AnyConfigSchema, ModuleConfig } from './Config'
8
+ import { ModuleDescription } from './ModuleDescription'
8
9
  import { ModuleFilter } from './ModuleFilter'
9
10
  import { ModuleParams } from './ModuleParams'
10
11
  import { ModuleQueryResult } from './ModuleQueryResult'
12
+ import { AddressPreviousHashPayload } from './Queries'
11
13
  import { QueryBoundWitness } from './Query'
12
14
 
13
15
  export interface ModuleResolver {
@@ -19,15 +21,18 @@ export interface ModuleResolver {
19
21
  * is supplied, all modules are returned
20
22
  * @param filter Filter criteria for the desired modules
21
23
  */
22
- resolve<T extends Module = Module>(filter?: ModuleFilter): Promisable<T[]>
24
+ resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter): Promisable<T[]>
23
25
  /**
24
26
  * Resolves a single module, or undefined if no modules matched the filter.
25
27
  * @param filter The desired Module's Address or Name
26
28
  */
27
- resolveOne<T extends Module = Module>(filter: string): Promisable<T | undefined>
29
+ resolveOne<T extends ModuleInstance = ModuleInstance>(filter: string): Promisable<T | undefined>
28
30
  }
29
31
 
30
- export type ModuleEventArgs<TModule extends Module = Module, TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs
32
+ export type ModuleEventArgs<
33
+ TModule extends ModuleInstance = ModuleInstance,
34
+ TArgs extends EventArgs | undefined = undefined,
35
+ > = TArgs extends EventArgs
31
36
  ? {
32
37
  module: TModule
33
38
  } & TArgs
@@ -36,7 +41,7 @@ export type ModuleEventArgs<TModule extends Module = Module, TArgs extends Event
36
41
  }
37
42
 
38
43
  export type ModuleQueriedEventArgs = ModuleEventArgs<
39
- Module,
44
+ ModuleInstance,
40
45
  {
41
46
  payloads?: Payload[]
42
47
  query: QueryBoundWitness
@@ -48,20 +53,27 @@ export interface ModuleEventData extends EventData {
48
53
  moduleQueried: ModuleQueriedEventArgs
49
54
  }
50
55
 
56
+ export type ModuleQueryFunctions = {
57
+ addressPreviousHash: () => Promisable<AddressPreviousHashPayload>
58
+ discover: () => Promisable<Payload[]>
59
+ manifest: () => Promisable<ModuleManifest>
60
+ }
61
+
51
62
  export type ModuleFields<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>> = {
52
- account?: AccountInstance
53
63
  address: string
54
64
  config: TParams['config']
55
65
 
66
+ describe: () => Promise<ModuleDescription>
67
+
56
68
  /* The resolver is a 'down' resolver. It can resolve the module or any children (if it is a node for example), that are in the module*/
57
69
  readonly downResolver: ModuleResolver
58
70
 
59
71
  loadAccount?: () => Promisable<AccountInstance>
60
72
 
61
- manifest: () => Promisable<ModuleManifest>
62
-
63
73
  params: TParams
64
74
 
75
+ previousHash: () => Promisable<string | undefined>
76
+
65
77
  queries: string[]
66
78
  query: <T extends QueryBoundWitness = QueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(
67
79
  query: T,
@@ -84,4 +96,9 @@ export type ModuleFields<TParams extends ModuleParams<AnyConfigSchema<ModuleConf
84
96
  export type Module<
85
97
  TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,
86
98
  TEventData extends ModuleEventData = ModuleEventData,
87
- > = ModuleFields<TParams> & EventFunctions<TEventData>
99
+ > = ModuleFields<TParams> & EventFunctions<TEventData> & ModuleQueryFunctions
100
+
101
+ export type ModuleInstance<
102
+ TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>,
103
+ TEventData extends ModuleEventData = ModuleEventData,
104
+ > = Module<TParams, TEventData>
@@ -0,0 +1,8 @@
1
+ import { Query } from '../../Query'
2
+
3
+ export type ModuleAddressQuerySchema = 'network.xyo.query.module.address'
4
+ export const ModuleAddressQuerySchema: ModuleAddressQuerySchema = 'network.xyo.query.module.address'
5
+
6
+ export type ModuleAddressQuery = Query<{
7
+ schema: ModuleAddressQuerySchema
8
+ }>
@@ -1,12 +1,12 @@
1
1
  import { Query } from '../Query'
2
2
  import { ModuleDiscoverQuery } from './Discover'
3
- import { ModuleAccountQuery } from './ModuleAccount'
3
+ import { ModuleAddressQuery } from './ModuleAddress'
4
4
  import { ModuleSubscribeQuery } from './Subscribe'
5
5
 
6
6
  export * from './Discover'
7
- export * from './ModuleAccount'
7
+ export * from './ModuleAddress'
8
8
  export * from './Subscribe'
9
9
 
10
- export type ModuleQueryBase = ModuleDiscoverQuery | ModuleAccountQuery | ModuleSubscribeQuery
10
+ export type ModuleQueryBase = ModuleDiscoverQuery | ModuleAddressQuery | ModuleSubscribeQuery
11
11
 
12
12
  export type ModuleQuery<T extends Query | void = void> = T extends Query ? ModuleQueryBase | T : ModuleQueryBase
@@ -0,0 +1,39 @@
1
+ import { assertEx } from '@xylabs/assert'
2
+
3
+ import { InstanceTypeCheck, isModule, isModuleInstance } from './isModule'
4
+
5
+ export const AsFactory = {
6
+ create: <TModule extends object>(typeCheck: InstanceTypeCheck<TModule>) => {
7
+ function func(
8
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
9
+ module: any,
10
+ ): TModule | undefined
11
+ function func(
12
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
13
+ module: any,
14
+ assert: string | (() => string),
15
+ ): TModule
16
+ function func(
17
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
18
+ module: any,
19
+ assert?: string | (() => string),
20
+ ): TModule | undefined {
21
+ const result = typeCheck(module) ? module : undefined
22
+
23
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
24
+ const noUndefined = (assert: any): assert is TModule => {
25
+ return !!assert
26
+ }
27
+
28
+ if (noUndefined(assert)) {
29
+ return assertEx(result, typeof assert === 'function' ? assert() : assert)
30
+ } else {
31
+ return result
32
+ }
33
+ }
34
+ return func
35
+ },
36
+ }
37
+
38
+ export const asModule = AsFactory.create(isModule)
39
+ export const asModuleInstance = AsFactory.create(isModuleInstance)
package/src/index.ts CHANGED
@@ -1,3 +1,4 @@
1
+ export * from './asModule'
1
2
  export * from './Config'
2
3
  export * from './CreatableModule'
3
4
  export * from './Error'