@jbrowse/mobx-state-tree 5.6.3 → 5.6.9

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 (126) hide show
  1. package/dist/core/action.d.ts +87 -0
  2. package/dist/core/action.js +228 -0
  3. package/dist/core/action.js.map +1 -0
  4. package/dist/core/actionContext.d.ts +27 -0
  5. package/dist/core/actionContext.js +42 -0
  6. package/dist/core/actionContext.js.map +1 -0
  7. package/dist/core/flow.d.ts +69 -0
  8. package/dist/core/flow.js +180 -0
  9. package/dist/core/flow.js.map +1 -0
  10. package/dist/core/json-patch.d.ts +46 -0
  11. package/dist/core/json-patch.js +133 -0
  12. package/dist/core/json-patch.js.map +1 -0
  13. package/dist/core/mst-operations.d.ts +459 -0
  14. package/dist/core/mst-operations.js +885 -0
  15. package/dist/core/mst-operations.js.map +1 -0
  16. package/dist/core/node/BaseNode.d.ts +62 -0
  17. package/dist/core/node/BaseNode.js +152 -0
  18. package/dist/core/node/BaseNode.js.map +1 -0
  19. package/dist/core/node/Hook.d.ts +17 -0
  20. package/dist/core/node/Hook.js +15 -0
  21. package/dist/core/node/Hook.js.map +1 -0
  22. package/dist/core/node/create-node.d.ts +16 -0
  23. package/dist/core/node/create-node.js +41 -0
  24. package/dist/core/node/create-node.js.map +1 -0
  25. package/dist/core/node/identifier-cache.d.ts +19 -0
  26. package/dist/core/node/identifier-cache.js +115 -0
  27. package/dist/core/node/identifier-cache.js.map +1 -0
  28. package/dist/core/node/livelinessChecking.d.ts +37 -0
  29. package/dist/core/node/livelinessChecking.js +38 -0
  30. package/dist/core/node/livelinessChecking.js.map +1 -0
  31. package/dist/core/node/node-utils.d.ts +83 -0
  32. package/dist/core/node/node-utils.js +165 -0
  33. package/dist/core/node/node-utils.js.map +1 -0
  34. package/dist/core/node/object-node.d.ts +99 -0
  35. package/dist/core/node/object-node.js +545 -0
  36. package/dist/core/node/object-node.js.map +1 -0
  37. package/dist/core/node/scalar-node.d.ts +19 -0
  38. package/dist/core/node/scalar-node.js +89 -0
  39. package/dist/core/node/scalar-node.js.map +1 -0
  40. package/dist/core/process.d.ts +50 -0
  41. package/dist/core/process.js +39 -0
  42. package/dist/core/process.js.map +1 -0
  43. package/dist/core/type/type-checker.d.ts +69 -0
  44. package/dist/core/type/type-checker.js +154 -0
  45. package/dist/core/type/type-checker.js.map +1 -0
  46. package/dist/core/type/type.d.ts +317 -0
  47. package/dist/core/type/type.js +251 -0
  48. package/dist/core/type/type.js.map +1 -0
  49. package/dist/index.d.ts +2 -0
  50. package/dist/index.js +85 -0
  51. package/dist/index.js.map +1 -0
  52. package/dist/internal.d.ts +39 -0
  53. package/dist/internal.js +60 -0
  54. package/dist/internal.js.map +1 -0
  55. package/dist/middlewares/create-action-tracking-middleware.d.ts +24 -0
  56. package/dist/middlewares/create-action-tracking-middleware.js +81 -0
  57. package/dist/middlewares/create-action-tracking-middleware.js.map +1 -0
  58. package/dist/middlewares/createActionTrackingMiddleware2.d.ts +34 -0
  59. package/dist/middlewares/createActionTrackingMiddleware2.js +133 -0
  60. package/dist/middlewares/createActionTrackingMiddleware2.js.map +1 -0
  61. package/dist/middlewares/on-action.d.ts +87 -0
  62. package/dist/middlewares/on-action.js +215 -0
  63. package/dist/middlewares/on-action.js.map +1 -0
  64. package/dist/mobx-state-tree.js +85 -0
  65. package/dist/mobx-state-tree.module.js +83 -0
  66. package/dist/types/complex-types/array.d.ts +80 -0
  67. package/dist/types/complex-types/array.js +352 -0
  68. package/dist/types/complex-types/array.js.map +1 -0
  69. package/dist/types/complex-types/map.d.ts +110 -0
  70. package/dist/types/complex-types/map.js +361 -0
  71. package/dist/types/complex-types/map.js.map +1 -0
  72. package/dist/types/complex-types/model.d.ts +192 -0
  73. package/dist/types/complex-types/model.js +477 -0
  74. package/dist/types/complex-types/model.js.map +1 -0
  75. package/dist/types/index.d.ts +33 -0
  76. package/dist/types/index.js +38 -0
  77. package/dist/types/index.js.map +1 -0
  78. package/dist/types/primitives.d.ts +124 -0
  79. package/dist/types/primitives.js +182 -0
  80. package/dist/types/primitives.js.map +1 -0
  81. package/dist/types/utility-types/custom.d.ts +74 -0
  82. package/dist/types/utility-types/custom.js +110 -0
  83. package/dist/types/utility-types/custom.js.map +1 -0
  84. package/dist/types/utility-types/enumeration.d.ts +5 -0
  85. package/dist/types/utility-types/enumeration.js +34 -0
  86. package/dist/types/utility-types/enumeration.js.map +1 -0
  87. package/dist/types/utility-types/frozen.d.ts +23 -0
  88. package/dist/types/utility-types/frozen.js +97 -0
  89. package/dist/types/utility-types/frozen.js.map +1 -0
  90. package/dist/types/utility-types/identifier.d.ts +86 -0
  91. package/dist/types/utility-types/identifier.js +129 -0
  92. package/dist/types/utility-types/identifier.js.map +1 -0
  93. package/dist/types/utility-types/late.d.ts +10 -0
  94. package/dist/types/utility-types/late.js +109 -0
  95. package/dist/types/utility-types/late.js.map +1 -0
  96. package/dist/types/utility-types/lazy.d.ts +22 -0
  97. package/dist/types/utility-types/lazy.js +76 -0
  98. package/dist/types/utility-types/lazy.js.map +1 -0
  99. package/dist/types/utility-types/literal.d.ts +37 -0
  100. package/dist/types/utility-types/literal.js +63 -0
  101. package/dist/types/utility-types/literal.js.map +1 -0
  102. package/dist/types/utility-types/maybe.d.ts +26 -0
  103. package/dist/types/utility-types/maybe.js +30 -0
  104. package/dist/types/utility-types/maybe.js.map +1 -0
  105. package/dist/types/utility-types/optional.d.ts +41 -0
  106. package/dist/types/utility-types/optional.js +140 -0
  107. package/dist/types/utility-types/optional.js.map +1 -0
  108. package/dist/types/utility-types/reference.d.ts +89 -0
  109. package/dist/types/utility-types/reference.js +392 -0
  110. package/dist/types/utility-types/reference.js.map +1 -0
  111. package/dist/types/utility-types/refinement.d.ts +10 -0
  112. package/dist/types/utility-types/refinement.js +85 -0
  113. package/dist/types/utility-types/refinement.js.map +1 -0
  114. package/dist/types/utility-types/resilient.d.ts +18 -0
  115. package/dist/types/utility-types/resilient.js +120 -0
  116. package/dist/types/utility-types/resilient.js.map +1 -0
  117. package/dist/types/utility-types/snapshotProcessor.d.ts +63 -0
  118. package/dist/types/utility-types/snapshotProcessor.js +161 -0
  119. package/dist/types/utility-types/snapshotProcessor.js.map +1 -0
  120. package/dist/types/utility-types/union.d.ts +77 -0
  121. package/dist/types/utility-types/union.js +245 -0
  122. package/dist/types/utility-types/union.js.map +1 -0
  123. package/dist/utils.d.ts +230 -0
  124. package/dist/utils.js +483 -0
  125. package/dist/utils.js.map +1 -0
  126. package/package.json +2 -2
@@ -0,0 +1,89 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ScalarNode = void 0;
4
+ const mobx_1 = require("mobx");
5
+ const internal_ts_1 = require("../../internal.js");
6
+ /**
7
+ * @internal
8
+ * @hidden
9
+ */
10
+ class ScalarNode extends internal_ts_1.BaseNode {
11
+ constructor(simpleType, parent, subpath, environment, initialSnapshot) {
12
+ super(simpleType, parent, subpath, environment);
13
+ try {
14
+ this.storedValue = simpleType.createNewInstance(initialSnapshot);
15
+ }
16
+ catch (e) {
17
+ // short-cut to die the instance, to avoid the snapshot computed starting to throw...
18
+ this.state = internal_ts_1.NodeLifeCycle.DEAD;
19
+ throw e;
20
+ }
21
+ this.state = internal_ts_1.NodeLifeCycle.CREATED;
22
+ // for scalar nodes there's no point in firing this event since it would fire on the constructor, before
23
+ // anybody can actually register for/listen to it
24
+ // this.fireHook(Hook.AfterCreate)
25
+ this.finalizeCreation();
26
+ }
27
+ get root() {
28
+ // future optimization: store root ref in the node and maintain it
29
+ if (!this.parent) {
30
+ throw (0, internal_ts_1.fail)(`This scalar node is not part of a tree`);
31
+ }
32
+ return this.parent.root;
33
+ }
34
+ setParent(newParent, subpath) {
35
+ const parentChanged = this.parent !== newParent;
36
+ const subpathChanged = this.subpath !== subpath;
37
+ if (!parentChanged && !subpathChanged) {
38
+ return;
39
+ }
40
+ if ((0, internal_ts_1.devMode)()) {
41
+ if (!subpath) {
42
+ // istanbul ignore next
43
+ throw (0, internal_ts_1.fail)("assertion failed: subpath expected");
44
+ }
45
+ if (!newParent) {
46
+ // istanbul ignore next
47
+ throw (0, internal_ts_1.fail)("assertion failed: parent expected");
48
+ }
49
+ if (parentChanged) {
50
+ // istanbul ignore next
51
+ throw (0, internal_ts_1.fail)("assertion failed: scalar nodes cannot change their parent");
52
+ }
53
+ }
54
+ this.environment = undefined; // use parent's
55
+ this.baseSetParent(this.parent, subpath);
56
+ }
57
+ get snapshot() {
58
+ return (0, internal_ts_1.freeze)(this.getSnapshot());
59
+ }
60
+ getSnapshot() {
61
+ return this.type.getSnapshot(this);
62
+ }
63
+ toString() {
64
+ const path = (this.isAlive ? this.path : this.pathUponDeath) || "<root>";
65
+ return `${this.type.name}@${path}${this.isAlive ? "" : " [dead]"}`;
66
+ }
67
+ die() {
68
+ if (!this.isAlive || this.state === internal_ts_1.NodeLifeCycle.DETACHING) {
69
+ return;
70
+ }
71
+ this.aboutToDie();
72
+ this.finalizeDeath();
73
+ }
74
+ finalizeCreation() {
75
+ this.baseFinalizeCreation();
76
+ }
77
+ aboutToDie() {
78
+ this.baseAboutToDie();
79
+ }
80
+ finalizeDeath() {
81
+ this.baseFinalizeDeath();
82
+ }
83
+ fireHook(name) {
84
+ this.fireInternalHook(name);
85
+ }
86
+ }
87
+ exports.ScalarNode = ScalarNode;
88
+ ScalarNode.prototype.die = (0, mobx_1.action)(ScalarNode.prototype.die);
89
+ //# sourceMappingURL=scalar-node.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"scalar-node.js","sourceRoot":"","sources":["../../../src/core/node/scalar-node.ts"],"names":[],"mappings":";;;AAAA,+BAA6B;AAE7B,mDAS0B;AAE1B;;;GAGG;AACH,MAAa,UAAoB,SAAQ,sBAAiB;IASxD,YACE,UAA+B,EAC/B,MAA4B,EAC5B,OAAe,EACf,WAAgB,EAChB,eAAkB;QAElB,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAA;QAC/C,IAAI,CAAC;YACH,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAA;QAClE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,qFAAqF;YACrF,IAAI,CAAC,KAAK,GAAG,2BAAa,CAAC,IAAI,CAAA;YAC/B,MAAM,CAAC,CAAA;QACT,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,2BAAa,CAAC,OAAO,CAAA;QAClC,wGAAwG;QACxG,iDAAiD;QACjD,kCAAkC;QAElC,IAAI,CAAC,gBAAgB,EAAE,CAAA;IACzB,CAAC;IAED,IAAI,IAAI;QACN,kEAAkE;QAClE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,IAAA,kBAAI,EAAC,wCAAwC,CAAC,CAAA;QACtD,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAA;IACzB,CAAC;IAED,SAAS,CAAC,SAAwB,EAAE,OAAe;QACjD,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,KAAK,SAAS,CAAA;QAC/C,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,KAAK,OAAO,CAAA;QAE/C,IAAI,CAAC,aAAa,IAAI,CAAC,cAAc,EAAE,CAAC;YACtC,OAAM;QACR,CAAC;QAED,IAAI,IAAA,qBAAO,GAAE,EAAE,CAAC;YACd,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,uBAAuB;gBACvB,MAAM,IAAA,kBAAI,EAAC,oCAAoC,CAAC,CAAA;YAClD,CAAC;YACD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,uBAAuB;gBACvB,MAAM,IAAA,kBAAI,EAAC,mCAAmC,CAAC,CAAA;YACjD,CAAC;YACD,IAAI,aAAa,EAAE,CAAC;gBAClB,uBAAuB;gBACvB,MAAM,IAAA,kBAAI,EAAC,2DAA2D,CAAC,CAAA;YACzE,CAAC;QACH,CAAC;QAED,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA,CAAC,eAAe;QAC5C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC1C,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAA,oBAAM,EAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;IACnC,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC;IAED,QAAQ;QACN,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,QAAQ,CAAA;QACxE,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,EAAE,CAAA;IACpE,CAAC;IAED,GAAG;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,KAAK,2BAAa,CAAC,SAAS,EAAE,CAAC;YAC5D,OAAM;QACR,CAAC;QACD,IAAI,CAAC,UAAU,EAAE,CAAA;QACjB,IAAI,CAAC,aAAa,EAAE,CAAA;IACtB,CAAC;IAED,gBAAgB;QACd,IAAI,CAAC,oBAAoB,EAAE,CAAA;IAC7B,CAAC;IAED,UAAU;QACR,IAAI,CAAC,cAAc,EAAE,CAAA;IACvB,CAAC;IAED,aAAa;QACX,IAAI,CAAC,iBAAiB,EAAE,CAAA;IAC1B,CAAC;IAES,QAAQ,CAAC,IAAU;QAC3B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;CACF;AAxGD,gCAwGC;AACD,UAAU,CAAC,SAAS,CAAC,GAAG,GAAG,IAAA,aAAM,EAAC,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA"}
@@ -0,0 +1,50 @@
1
+ /**
2
+ * @deprecated has been renamed to `flow()`.
3
+ * @hidden
4
+ */
5
+ export declare function process<R>(generator: () => IterableIterator<any>): () => Promise<R>;
6
+ /**
7
+ * @deprecated has been renamed to `flow()`.
8
+ * @hidden
9
+ */
10
+ export declare function process<A1>(generator: (a1: A1) => IterableIterator<any>): (a1: A1) => Promise<any>;
11
+ /**
12
+ * @deprecated has been renamed to `flow()`.
13
+ * @hidden
14
+ */
15
+ export declare function process<A1, A2>(generator: (a1: A1, a2: A2) => IterableIterator<any>): (a1: A1, a2: A2) => Promise<any>;
16
+ /**
17
+ * @deprecated has been renamed to `flow()`.
18
+ * @hidden
19
+ */
20
+ export declare function process<A1, A2, A3>(generator: (a1: A1, a2: A2, a3: A3) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3) => Promise<any>;
21
+ /**
22
+ * @deprecated has been renamed to `flow()`.
23
+ * @hidden
24
+ */
25
+ export declare function process<A1, A2, A3, A4>(generator: (a1: A1, a2: A2, a3: A3, a4: A4) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4) => Promise<any>;
26
+ /**
27
+ * @deprecated has been renamed to `flow()`.
28
+ * @hidden
29
+ */
30
+ export declare function process<A1, A2, A3, A4, A5>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5) => Promise<any>;
31
+ /**
32
+ * @deprecated has been renamed to `flow()`.
33
+ * @hidden
34
+ */
35
+ export declare function process<A1, A2, A3, A4, A5, A6>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6) => Promise<any>;
36
+ /**
37
+ * @deprecated has been renamed to `flow()`.
38
+ * @hidden
39
+ */
40
+ export declare function process<A1, A2, A3, A4, A5, A6, A7>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7) => Promise<any>;
41
+ /**
42
+ * @deprecated has been renamed to `flow()`.
43
+ * @hidden
44
+ */
45
+ export declare function process<A1, A2, A3, A4, A5, A6, A7, A8>(generator: (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8) => IterableIterator<any>): (a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, a6: A6, a7: A7, a8: A8) => Promise<any>;
46
+ /**
47
+ * @internal
48
+ * @hidden
49
+ */
50
+ export declare function createProcessSpawner(name: string, generator: Function): (this: any, ...flowArgs: any[]) => Promise<unknown>;
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.process = process;
4
+ exports.createProcessSpawner = createProcessSpawner;
5
+ const internal_ts_1 = require("../internal.js");
6
+ // based on: https://github.com/mobxjs/mobx-utils/blob/master/src/async-action.ts
7
+ /*
8
+ All contents of this file are deprecated.
9
+
10
+ The term `process` has been replaced with `flow` to avoid conflicts with the
11
+ global `process` object.
12
+
13
+ Refer to `flow.ts` for any further changes to this implementation.
14
+ */
15
+ const DEPRECATION_MESSAGE = "See https://github.com/mobxjs/mobx-state-tree/issues/399 for more information. " +
16
+ "Note that the middleware event types starting with `process` now start with `flow`.";
17
+ /**
18
+ * @hidden
19
+ *
20
+ * @deprecated has been renamed to `flow()`.
21
+ * See https://github.com/mobxjs/mobx-state-tree/issues/399 for more information.
22
+ * Note that the middleware event types starting with `process` now start with `flow`.
23
+ *
24
+ * @returns {Promise}
25
+ */
26
+ function process(asyncAction) {
27
+ (0, internal_ts_1.deprecated)("process", "`process()` has been renamed to `flow()`. " + DEPRECATION_MESSAGE);
28
+ return (0, internal_ts_1.flow)(asyncAction);
29
+ }
30
+ /**
31
+ * @internal
32
+ * @hidden
33
+ */
34
+ function createProcessSpawner(name, generator) {
35
+ (0, internal_ts_1.deprecated)("process", "`createProcessSpawner()` has been renamed to `createFlowSpawner()`. " +
36
+ DEPRECATION_MESSAGE);
37
+ return (0, internal_ts_1.createFlowSpawner)(name, generator);
38
+ }
39
+ //# sourceMappingURL=process.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"process.js","sourceRoot":"","sources":["../../src/core/process.ts"],"names":[],"mappings":";;AAyHA,0BAMC;AAMD,oDAOC;AA5ID,gDAAoE;AAEpE,iFAAiF;AACjF;;;;;;;EAOE;AAEF,MAAM,mBAAmB,GACvB,iFAAiF;IACjF,qFAAqF,CAAA;AAkGvF;;;;;;;;GAQG;AACH,SAAgB,OAAO,CAAC,WAAgB;IACtC,IAAA,wBAAU,EACR,SAAS,EACT,4CAA4C,GAAG,mBAAmB,CACnE,CAAA;IACD,OAAO,IAAA,kBAAI,EAAC,WAAW,CAAC,CAAA;AAC1B,CAAC;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAAC,IAAY,EAAE,SAAmB;IACpE,IAAA,wBAAU,EACR,SAAS,EACT,sEAAsE;QACpE,mBAAmB,CACtB,CAAA;IACD,OAAO,IAAA,+BAAiB,EAAC,IAAI,EAAE,SAAS,CAAC,CAAA;AAC3C,CAAC"}
@@ -0,0 +1,69 @@
1
+ import { type ExtractCSTWithSTN, type IAnyType } from "../../internal.ts";
2
+ /** Validation context entry, this is, where the validation should run against which type */
3
+ export interface IValidationContextEntry {
4
+ /** Subpath where the validation should be run, or an empty string to validate it all */
5
+ path: string;
6
+ /** Type to validate the subpath against */
7
+ type: IAnyType;
8
+ }
9
+ /** Array of validation context entries */
10
+ export type IValidationContext = IValidationContextEntry[];
11
+ /** Type validation error */
12
+ export interface IValidationError {
13
+ /** Validation context */
14
+ context: IValidationContext;
15
+ /** Value that was being validated, either a snapshot or an instance */
16
+ value: any;
17
+ /** Error message */
18
+ message?: string;
19
+ }
20
+ /** Type validation result, which is an array of type validation errors */
21
+ export type IValidationResult = IValidationError[];
22
+ /**
23
+ * @internal
24
+ * @hidden
25
+ */
26
+ export declare function prettyPrintValue(value: any): string;
27
+ /**
28
+ * @internal
29
+ * @hidden
30
+ * Pushes a new entry onto the context array (mutates in place for performance).
31
+ * Returns the same context array for chaining.
32
+ */
33
+ export declare function getContextForPath(context: IValidationContext, path: string, type: IAnyType): IValidationContext;
34
+ /**
35
+ * @internal
36
+ * @hidden
37
+ * Pops the last entry from the context array (mutates in place).
38
+ * Must be called after validation to restore context state.
39
+ */
40
+ export declare function popContext(context: IValidationContext): void;
41
+ /**
42
+ * @internal
43
+ * @hidden
44
+ */
45
+ export declare function typeCheckSuccess(): IValidationResult;
46
+ /**
47
+ * @internal
48
+ * @hidden
49
+ */
50
+ export declare function typeCheckFailure(context: IValidationContext, value: any, message?: string): IValidationResult;
51
+ /**
52
+ * @internal
53
+ * @hidden
54
+ */
55
+ export declare function flattenTypeErrors(errors: IValidationResult[]): IValidationResult;
56
+ /**
57
+ * @internal
58
+ * @hidden
59
+ */
60
+ export declare function typecheckInternal<IT extends IAnyType>(type: IAnyType, value: ExtractCSTWithSTN<IT>): void;
61
+ /**
62
+ * Run's the typechecker for the given type on the given value, which can be a snapshot or an instance.
63
+ * Throws if the given value is not according the provided type specification.
64
+ * Use this if you need typechecks even in a production build (by default all automatic runtime type checks will be skipped in production builds)
65
+ *
66
+ * @param type Type to check against.
67
+ * @param value Value to be checked, either a snapshot or an instance.
68
+ */
69
+ export declare function typecheck<IT extends IAnyType>(type: IT, value: ExtractCSTWithSTN<IT>): void;
@@ -0,0 +1,154 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.prettyPrintValue = prettyPrintValue;
4
+ exports.getContextForPath = getContextForPath;
5
+ exports.popContext = popContext;
6
+ exports.typeCheckSuccess = typeCheckSuccess;
7
+ exports.typeCheckFailure = typeCheckFailure;
8
+ exports.flattenTypeErrors = flattenTypeErrors;
9
+ exports.typecheckInternal = typecheckInternal;
10
+ exports.typecheck = typecheck;
11
+ const internal_ts_1 = require("../../internal.js");
12
+ const MAX_STRINGIFY_DEPTH = 3;
13
+ function safeStringify(value) {
14
+ try {
15
+ const ancestors = [];
16
+ return JSON.stringify(value, function (_key, val) {
17
+ if (val !== null && typeof val === "object") {
18
+ while (ancestors.length > 0 &&
19
+ ancestors[ancestors.length - 1] !== this) {
20
+ ancestors.pop();
21
+ }
22
+ if (ancestors.length >= MAX_STRINGIFY_DEPTH) {
23
+ return Array.isArray(val) ? "[…]" : "{…}";
24
+ }
25
+ ancestors.push(val);
26
+ }
27
+ return val;
28
+ });
29
+ }
30
+ catch (e) {
31
+ // istanbul ignore next
32
+ return `<Unserializable: ${e}>`;
33
+ }
34
+ }
35
+ /**
36
+ * @internal
37
+ * @hidden
38
+ */
39
+ function prettyPrintValue(value) {
40
+ return typeof value === "function"
41
+ ? `<function${value.name ? " " + value.name : ""}>`
42
+ : (0, internal_ts_1.isStateTreeNode)(value)
43
+ ? `<${value}>`
44
+ : `\`${safeStringify(value)}\``;
45
+ }
46
+ function shortenPrintValue(valueInString) {
47
+ return valueInString.length < 280
48
+ ? valueInString
49
+ : `${valueInString.substring(0, 272)}......${valueInString.substring(valueInString.length - 8)}`;
50
+ }
51
+ function toErrorString(error) {
52
+ const { value } = error;
53
+ const type = error.context[error.context.length - 1].type;
54
+ const fullPath = error.context
55
+ .map(({ path }) => path)
56
+ .filter(path => path.length > 0)
57
+ .join("/");
58
+ const pathPrefix = fullPath.length > 0 ? `at path "/${fullPath}" ` : ``;
59
+ const currentTypename = (0, internal_ts_1.isStateTreeNode)(value)
60
+ ? `value of type ${(0, internal_ts_1.getStateTreeNode)(value).type.name}:`
61
+ : (0, internal_ts_1.isPrimitive)(value)
62
+ ? "value"
63
+ : "snapshot";
64
+ const isSnapshotCompatible = type && (0, internal_ts_1.isStateTreeNode)(value) && type.is((0, internal_ts_1.getStateTreeNode)(value).snapshot);
65
+ return (`${pathPrefix}${currentTypename} ${shortenPrintValue(prettyPrintValue(value))} is not assignable ${type ? `to type: \`${type.name}\`` : ``}` +
66
+ (error.message ? ` (${error.message})` : "") +
67
+ (type
68
+ ? (0, internal_ts_1.isPrimitiveType)(type) || (0, internal_ts_1.isPrimitive)(value)
69
+ ? `.`
70
+ : `, expected an instance of \`${type.name}\` or a snapshot like \`${shortenPrintValue(type.describe())}\` instead.` +
71
+ (isSnapshotCompatible
72
+ ? " (Note that a snapshot of the provided value is compatible with the targeted type)"
73
+ : "")
74
+ : `.`));
75
+ }
76
+ /**
77
+ * @internal
78
+ * @hidden
79
+ * Pushes a new entry onto the context array (mutates in place for performance).
80
+ * Returns the same context array for chaining.
81
+ */
82
+ function getContextForPath(context, path, type) {
83
+ context.push({ path, type });
84
+ return context;
85
+ }
86
+ /**
87
+ * @internal
88
+ * @hidden
89
+ * Pops the last entry from the context array (mutates in place).
90
+ * Must be called after validation to restore context state.
91
+ */
92
+ function popContext(context) {
93
+ context.pop();
94
+ }
95
+ /**
96
+ * @internal
97
+ * @hidden
98
+ */
99
+ function typeCheckSuccess() {
100
+ return internal_ts_1.EMPTY_ARRAY;
101
+ }
102
+ /**
103
+ * @internal
104
+ * @hidden
105
+ */
106
+ function typeCheckFailure(context, value, message) {
107
+ // Clone context since it may be mutated after this error is created
108
+ return [{ context: context.slice(), value, message }];
109
+ }
110
+ /**
111
+ * @internal
112
+ * @hidden
113
+ */
114
+ function flattenTypeErrors(errors) {
115
+ return errors.flat();
116
+ }
117
+ // TODO; doublecheck: typecheck should only needed to be invoked from: type.create and array / map / value.property will change
118
+ /**
119
+ * @internal
120
+ * @hidden
121
+ */
122
+ function typecheckInternal(type, value) {
123
+ // runs typeChecking if it is in dev-mode or through a process.env.ENABLE_TYPE_CHECK flag
124
+ if ((0, internal_ts_1.isTypeCheckingEnabled)()) {
125
+ typecheck(type, value);
126
+ }
127
+ }
128
+ /**
129
+ * Run's the typechecker for the given type on the given value, which can be a snapshot or an instance.
130
+ * Throws if the given value is not according the provided type specification.
131
+ * Use this if you need typechecks even in a production build (by default all automatic runtime type checks will be skipped in production builds)
132
+ *
133
+ * @param type Type to check against.
134
+ * @param value Value to be checked, either a snapshot or an instance.
135
+ */
136
+ function typecheck(type, value) {
137
+ const errors = type.validate(value, [{ path: "", type }]);
138
+ if (errors.length > 0) {
139
+ throw (0, internal_ts_1.fail)(validationErrorsToString(type, value, errors));
140
+ }
141
+ }
142
+ const MAX_ERRORS_REPORTED = 10;
143
+ function validationErrorsToString(type, value, errors) {
144
+ if (errors.length === 0) {
145
+ return undefined;
146
+ }
147
+ const shown = errors.slice(0, MAX_ERRORS_REPORTED).map(toErrorString);
148
+ const overflow = errors.length - shown.length;
149
+ if (overflow > 0) {
150
+ shown.push(`(… and ${overflow} more error${overflow === 1 ? "" : "s"})`);
151
+ }
152
+ return (`Error while converting ${shortenPrintValue(prettyPrintValue(value))} to \`${type.name}\`:\n\n ` + shown.join("\n "));
153
+ }
154
+ //# sourceMappingURL=type-checker.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"type-checker.js","sourceRoot":"","sources":["../../../src/core/type/type-checker.ts"],"names":[],"mappings":";;AAkEA,4CAMC;AAkDD,8CAOC;AAQD,gCAEC;AAMD,4CAEC;AAMD,4CAOC;AAMD,8CAIC;AAOD,8CAQC;AAUD,8BASC;AA5MD,mDAU0B;AA0B1B,MAAM,mBAAmB,GAAG,CAAC,CAAA;AAE7B,SAAS,aAAa,CAAC,KAAU;IAC/B,IAAI,CAAC;QACH,MAAM,SAAS,GAAU,EAAE,CAAA;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,UAAU,IAAI,EAAE,GAAG;YAC9C,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5C,OACE,SAAS,CAAC,MAAM,GAAG,CAAC;oBACpB,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,IAAI,EACxC,CAAC;oBACD,SAAS,CAAC,GAAG,EAAE,CAAA;gBACjB,CAAC;gBACD,IAAI,SAAS,CAAC,MAAM,IAAI,mBAAmB,EAAE,CAAC;oBAC5C,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAA;gBAC3C,CAAC;gBACD,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACrB,CAAC;YACD,OAAO,GAAG,CAAA;QACZ,CAAC,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,uBAAuB;QACvB,OAAO,oBAAoB,CAAC,GAAG,CAAA;IACjC,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,KAAU;IACzC,OAAO,OAAO,KAAK,KAAK,UAAU;QAChC,CAAC,CAAC,YAAY,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG;QACnD,CAAC,CAAC,IAAA,6BAAe,EAAC,KAAK,CAAC;YACtB,CAAC,CAAC,IAAI,KAAK,GAAG;YACd,CAAC,CAAC,KAAK,aAAa,CAAC,KAAK,CAAC,IAAI,CAAA;AACrC,CAAC;AAED,SAAS,iBAAiB,CAAC,aAAqB;IAC9C,OAAO,aAAa,CAAC,MAAM,GAAG,GAAG;QAC/B,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,SAAS,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAA;AACpG,CAAC;AAED,SAAS,aAAa,CAAC,KAAuB;IAC5C,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAA;IACvB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAK,CAAA;IAC1D,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO;SAC3B,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC;SACvB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SAC/B,IAAI,CAAC,GAAG,CAAC,CAAA;IAEZ,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;IAEvE,MAAM,eAAe,GAAG,IAAA,6BAAe,EAAC,KAAK,CAAC;QAC5C,CAAC,CAAC,iBAAiB,IAAA,8BAAgB,EAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG;QACvD,CAAC,CAAC,IAAA,yBAAW,EAAC,KAAK,CAAC;YAClB,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,UAAU,CAAA;IAChB,MAAM,oBAAoB,GACxB,IAAI,IAAI,IAAA,6BAAe,EAAC,KAAK,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC,IAAA,8BAAgB,EAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAA;IAE7E,OAAO,CACL,GAAG,UAAU,GAAG,eAAe,IAAI,iBAAiB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,sBAC3E,IAAI,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EACvC,EAAE;QACF,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5C,CAAC,IAAI;YACH,CAAC,CAAC,IAAA,6BAAe,EAAC,IAAI,CAAC,IAAI,IAAA,yBAAW,EAAC,KAAK,CAAC;gBAC3C,CAAC,CAAC,GAAG;gBACL,CAAC,CAAC,+BAAgC,IAAiB,CAAC,IAAI,2BAA2B,iBAAiB,CAC/F,IAAiB,CAAC,QAAQ,EAAE,CAC9B,aAAa;oBACd,CAAC,oBAAoB;wBACnB,CAAC,CAAC,oFAAoF;wBACtF,CAAC,CAAC,EAAE,CAAC;YACX,CAAC,CAAC,GAAG,CAAC,CACT,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,OAA2B,EAC3B,IAAY,EACZ,IAAc;IAEd,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;IAC5B,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,OAA2B;IACpD,OAAO,CAAC,GAAG,EAAE,CAAA;AACf,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB;IAC9B,OAAO,yBAAkB,CAAA;AAC3B,CAAC;AAED;;;GAGG;AACH,SAAgB,gBAAgB,CAC9B,OAA2B,EAC3B,KAAU,EACV,OAAgB;IAEhB,oEAAoE;IACpE,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;AACvD,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAC/B,MAA2B;IAE3B,OAAO,MAAM,CAAC,IAAI,EAAE,CAAA;AACtB,CAAC;AAED,+HAA+H;AAC/H;;;GAGG;AACH,SAAgB,iBAAiB,CAC/B,IAAc,EACd,KAA4B;IAE5B,yFAAyF;IACzF,IAAI,IAAA,mCAAqB,GAAE,EAAE,CAAC;QAC5B,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IACxB,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,SAAS,CACvB,IAAQ,EACR,KAA4B;IAE5B,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IAEzD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAA,kBAAI,EAAC,wBAAwB,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;IAC3D,CAAC;AACH,CAAC;AAED,MAAM,mBAAmB,GAAG,EAAE,CAAA;AAE9B,SAAS,wBAAwB,CAC/B,IAAQ,EACR,KAA4B,EAC5B,MAA0B;IAE1B,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,mBAAmB,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;IACrE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAA;IAC7C,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACjB,KAAK,CAAC,IAAI,CAAC,UAAU,QAAQ,cAAc,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAA;IAC1E,CAAC;IAED,OAAO,CACL,0BAA0B,iBAAiB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,SAClE,IAAI,CAAC,IACP,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CACrC,CAAA;AACH,CAAC"}