@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,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=CreatableModuleDictionary.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"CreatableModuleDictionary.js","sourceRoot":"","sources":["../../src/CreatableModuleDictionary.ts"],"names":[],"mappings":""}
@@ -1,3 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=Payload.js.map
3
+ //# sourceMappingURL=ModuleBusy.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ModuleBusy.js","sourceRoot":"","sources":["../../../src/Events/ModuleBusy.ts"],"names":[],"mappings":""}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ModuleQueried.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ModuleQueried.js","sourceRoot":"","sources":["../../../src/Events/ModuleQueried.ts"],"names":[],"mappings":""}
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const tslib_1 = require("tslib");
4
+ tslib_1.__exportStar(require("./ModuleBusy"), exports);
5
+ tslib_1.__exportStar(require("./ModuleQueried"), exports);
6
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Events/index.ts"],"names":[],"mappings":";;;AAAA,uDAA4B;AAC5B,0DAA+B"}
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ModuleFactory = void 0;
4
+ const tslib_1 = require("tslib");
5
+ const merge_1 = tslib_1.__importDefault(require("lodash/merge"));
6
+ class ModuleFactory {
7
+ constructor(creatableModule, params) {
8
+ this.creatableModule = creatableModule;
9
+ this.defaultParams = params;
10
+ this.configSchemas = creatableModule.configSchemas;
11
+ }
12
+ get configSchema() {
13
+ return this.configSchemas[0];
14
+ }
15
+ static withParams(creatableModule, params) {
16
+ return new ModuleFactory(creatableModule, params);
17
+ }
18
+ create(params) {
19
+ var _a;
20
+ const factory = this;
21
+ const schema = factory.creatableModule.configSchema;
22
+ const mergedParams = (0, merge_1.default)((_a = factory.defaultParams) !== null && _a !== void 0 ? _a : {}, params, { config: { schema } });
23
+ return factory.creatableModule.create(mergedParams);
24
+ }
25
+ factory(_params) {
26
+ throw new Error('Method not implemented.');
27
+ }
28
+ }
29
+ exports.ModuleFactory = ModuleFactory;
30
+ //# sourceMappingURL=ModuleFactory.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ModuleFactory.js","sourceRoot":"","sources":["../../src/ModuleFactory.ts"],"names":[],"mappings":";;;;AACA,iEAAgC;AAKhC,MAAa,aAAa;IASxB,YAAY,eAAyC,EAAE,MAA0B;QAC/E,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QACtC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAA;QAC3B,IAAI,CAAC,aAAa,GAAG,eAAe,CAAC,aAAa,CAAA;IACpD,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;IAC9B,CAAC;IAED,MAAM,CAAC,UAAU,CAA2B,eAAmC,EAAE,MAAoB;QACnG,OAAO,IAAI,aAAa,CAAC,eAAe,EAAE,MAAM,CAAC,CAAA;IACnD,CAAC;IAED,MAAM,CAA4D,MAAsC;;QACtG,MAAM,OAAO,GAAG,IAAwB,CAAA;QACxC,MAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,YAAY,CAAA;QACnD,MAAM,YAAY,GAAsB,IAAA,eAAK,EAAC,MAAA,OAAO,CAAC,aAAa,mCAAI,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAA;QAC1G,OAAO,OAAO,CAAC,eAAe,CAAC,MAAM,CAAI,YAAY,CAAC,CAAA;IACxD,CAAC;IAED,OAAO,CAAqD,OAAiC;QAC3F,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;IAC5C,CAAC;CACF;AAjCD,sCAiCC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Queries/index.ts"],"names":[],"mappings":";;;AAMA,qDAA0B;AAC1B,qDAA0B;AAC1B,qDAA0B;AAC1B,0DAA+B;AAC/B,sDAA2B"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Queries/index.ts"],"names":[],"mappings":";;;AAOA,qDAA0B;AAC1B,qDAA0B;AAC1B,qDAA0B;AAC1B,0DAA+B;AAC/B,sDAA2B"}
package/dist/cjs/index.js CHANGED
@@ -4,15 +4,17 @@ const tslib_1 = require("tslib");
4
4
  tslib_1.__exportStar(require("./asModule"), exports);
5
5
  tslib_1.__exportStar(require("./Config"), exports);
6
6
  tslib_1.__exportStar(require("./CreatableModule"), exports);
7
- tslib_1.__exportStar(require("./Error"), exports);
7
+ tslib_1.__exportStar(require("./CreatableModuleDictionary"), exports);
8
+ tslib_1.__exportStar(require("./Events"), exports);
8
9
  tslib_1.__exportStar(require("./isModule"), exports);
10
+ tslib_1.__exportStar(require("./lib"), exports);
9
11
  tslib_1.__exportStar(require("./Module"), exports);
10
12
  tslib_1.__exportStar(require("./ModuleDescription"), exports);
13
+ tslib_1.__exportStar(require("./ModuleFactory"), exports);
11
14
  tslib_1.__exportStar(require("./ModuleFilter"), exports);
12
15
  tslib_1.__exportStar(require("./ModuleParams"), exports);
13
16
  tslib_1.__exportStar(require("./ModuleQueryResult"), exports);
14
17
  tslib_1.__exportStar(require("./ModuleRepository"), exports);
15
18
  tslib_1.__exportStar(require("./Queries"), exports);
16
- tslib_1.__exportStar(require("./Query"), exports);
17
19
  tslib_1.__exportStar(require("./withModule"), exports);
18
20
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAA0B;AAC1B,mDAAwB;AACxB,4DAAiC;AACjC,kDAAuB;AACvB,qDAA0B;AAC1B,mDAAwB;AACxB,8DAAmC;AACnC,yDAA8B;AAC9B,yDAA8B;AAC9B,8DAAmC;AACnC,6DAAkC;AAClC,oDAAyB;AACzB,kDAAuB;AACvB,uDAA4B"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAA0B;AAC1B,mDAAwB;AACxB,4DAAiC;AACjC,sEAA2C;AAC3C,mDAAwB;AACxB,qDAA0B;AAC1B,gDAAqB;AACrB,mDAAwB;AACxB,8DAAmC;AACnC,0DAA+B;AAC/B,yDAA8B;AAC9B,yDAA8B;AAC9B,8DAAmC;AACnC,6DAAkC;AAClC,oDAAyB;AACzB,uDAA4B"}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.duplicateModules = void 0;
4
+ /**
5
+ * Used to filter duplicates from an array of modules
6
+ * @example: modulesArray.filter(duplicateModules)
7
+ * @param value Current Module
8
+ * @param index Current Module's index
9
+ * @param array Module Array
10
+ * @returns True if the Module's address is the first occurrence of
11
+ * that address in the array, false otherwise
12
+ */
13
+ const duplicateModules = (value, index, array) => {
14
+ return array.findIndex((v) => v.address === value.address) === index;
15
+ };
16
+ exports.duplicateModules = duplicateModules;
17
+ //# sourceMappingURL=duplicateModules.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"duplicateModules.js","sourceRoot":"","sources":["../../../src/lib/duplicateModules.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;GAQG;AACI,MAAM,gBAAgB,GAAG,CAAC,KAAqB,EAAE,KAAa,EAAE,KAAuB,EAA2B,EAAE;IACzH,OAAO,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC,KAAK,KAAK,CAAA;AACtE,CAAC,CAAA;AAFY,QAAA,gBAAgB,oBAE5B"}
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const tslib_1 = require("tslib");
4
+ tslib_1.__exportStar(require("./duplicateModules"), exports);
5
+ tslib_1.__exportStar(require("./serializable"), exports);
6
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":";;;AAAA,6DAAkC;AAClC,yDAA8B"}
@@ -0,0 +1,38 @@
1
+ "use strict";
2
+ // Inspired by https://stackoverflow.com/a/49079549/2803259
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.serializableField = exports.serializable = void 0;
5
+ const tslib_1 = require("tslib");
6
+ const every_1 = tslib_1.__importDefault(require("lodash/every"));
7
+ const isArray_1 = tslib_1.__importDefault(require("lodash/isArray"));
8
+ const isBoolean_1 = tslib_1.__importDefault(require("lodash/isBoolean"));
9
+ const isNull_1 = tslib_1.__importDefault(require("lodash/isNull"));
10
+ const isNumber_1 = tslib_1.__importDefault(require("lodash/isNumber"));
11
+ const isPlainObject_1 = tslib_1.__importDefault(require("lodash/isPlainObject"));
12
+ const isString_1 = tslib_1.__importDefault(require("lodash/isString"));
13
+ const isUndefined_1 = tslib_1.__importDefault(require("lodash/isUndefined"));
14
+ const overSome_1 = tslib_1.__importDefault(require("lodash/overSome"));
15
+ const JSONPrimitiveChecks = [isUndefined_1.default, isNull_1.default, isBoolean_1.default, isNumber_1.default, isString_1.default];
16
+ const JSONComplexChecks = [isPlainObject_1.default, isArray_1.default];
17
+ const serializable = (field, depth) => {
18
+ let depthExceeded = false;
19
+ const decrementDepth = () => (depth ? depth-- : undefined);
20
+ const recursiveSerializable = (field) => {
21
+ if (depth !== undefined && depth < 1) {
22
+ depthExceeded = true;
23
+ return false;
24
+ }
25
+ // decrement during every recursion
26
+ decrementDepth();
27
+ const nestedSerializable = (field) => (0, overSome_1.default)(JSONComplexChecks)(field) && (0, every_1.default)(field, recursiveSerializable);
28
+ return (0, overSome_1.default)([...JSONPrimitiveChecks, nestedSerializable])(field);
29
+ };
30
+ const valid = recursiveSerializable(field);
31
+ return depthExceeded ? null : valid;
32
+ };
33
+ exports.serializable = serializable;
34
+ const serializableField = (field) => {
35
+ return (0, overSome_1.default)([...JSONPrimitiveChecks, ...JSONComplexChecks])(field);
36
+ };
37
+ exports.serializableField = serializableField;
38
+ //# sourceMappingURL=serializable.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"serializable.js","sourceRoot":"","sources":["../../../src/lib/serializable.ts"],"names":[],"mappings":";AAAA,2DAA2D;;;;AAE3D,iEAAgC;AAChC,qEAAoC;AACpC,yEAAwC;AACxC,mEAAkC;AAClC,uEAAsC;AACtC,iFAAgD;AAChD,uEAAsC;AACtC,6EAA4C;AAC5C,uEAAsC;AAEtC,MAAM,mBAAmB,GAAG,CAAC,qBAAW,EAAE,gBAAM,EAAE,mBAAS,EAAE,kBAAQ,EAAE,kBAAQ,CAAC,CAAA;AAChF,MAAM,iBAAiB,GAAG,CAAC,uBAAa,EAAE,iBAAO,CAAC,CAAA;AAE3C,MAAM,YAAY,GAAG,CAAC,KAAc,EAAE,KAAc,EAAkB,EAAE;IAC7E,IAAI,aAAa,GAAG,KAAK,CAAA;IACzB,MAAM,cAAc,GAAG,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;IAE1D,MAAM,qBAAqB,GAAG,CAAC,KAAc,EAAE,EAAE;QAC/C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,GAAG,CAAC,EAAE;YACpC,aAAa,GAAG,IAAI,CAAA;YACpB,OAAO,KAAK,CAAA;SACb;QAED,mCAAmC;QACnC,cAAc,EAAE,CAAA;QAEhB,MAAM,kBAAkB,GAAG,CAAC,KAAc,EAAW,EAAE,CAAC,IAAA,kBAAQ,EAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,IAAI,IAAA,eAAK,EAAC,KAAe,EAAE,qBAAqB,CAAC,CAAA;QAE3I,OAAO,IAAA,kBAAQ,EAAC,CAAC,GAAG,mBAAmB,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IACtE,CAAC,CAAA;IAED,MAAM,KAAK,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAA;IAE1C,OAAO,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAA;AACrC,CAAC,CAAA;AArBY,QAAA,YAAY,gBAqBxB;AAEM,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAAE,EAAE;IAClD,OAAO,IAAA,kBAAQ,EAAC,CAAC,GAAG,mBAAmB,EAAE,GAAG,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AACxE,CAAC,CAAA;AAFY,QAAA,iBAAiB,qBAE7B"}