mobx-keystone 0.67.4 → 0.68.1-alpha

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 (394) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/_virtual/_tslib.mjs +12 -0
  3. package/dist/mobx-keystone.umd.js +5339 -5261
  4. package/dist/model/utils.d.ts +1 -1
  5. package/dist/node_modules/fast-deep-equal/es6/index.mjs +68 -0
  6. package/dist/node_modules/nanoid/non-secure/index.mjs +11 -0
  7. package/dist/snapshot/index.d.ts +0 -8
  8. package/dist/{dataModel/_BaseDataModel.d.ts → snapshot/registerDefaultReconcilers.d.ts} +0 -0
  9. package/dist/{model/_BaseModel.d.ts → snapshot/registerDefaultSnapshotters.d.ts} +0 -0
  10. package/dist/src/action/actionDecoratorUtils.mjs +25 -0
  11. package/dist/src/action/applyAction.mjs +54 -0
  12. package/dist/src/action/applyDelete.mjs +20 -0
  13. package/dist/src/action/applyMethodCall.mjs +19 -0
  14. package/dist/src/action/applySet.mjs +25 -0
  15. package/dist/src/action/builtInActions.mjs +15 -0
  16. package/dist/src/action/context.mjs +22 -0
  17. package/dist/src/action/hookActions.mjs +13 -0
  18. package/dist/src/action/isModelAction.mjs +6 -0
  19. package/dist/src/action/middleware.mjs +84 -0
  20. package/dist/src/action/modelAction.mjs +34 -0
  21. package/dist/src/action/modelFlow.mjs +251 -0
  22. package/dist/src/action/pendingActions.mjs +30 -0
  23. package/dist/src/action/protection.mjs +19 -0
  24. package/dist/src/action/runUnprotected.mjs +24 -0
  25. package/dist/src/action/wrapInAction.mjs +90 -0
  26. package/dist/src/actionMiddlewares/actionSerialization/actionSerialization.mjs +131 -0
  27. package/dist/src/actionMiddlewares/actionSerialization/applySerializedAction.mjs +110 -0
  28. package/dist/src/actionMiddlewares/actionSerialization/arraySerializer.mjs +15 -0
  29. package/dist/src/actionMiddlewares/actionSerialization/core.mjs +3 -0
  30. package/dist/src/actionMiddlewares/actionSerialization/dateSerializer.mjs +15 -0
  31. package/dist/src/actionMiddlewares/actionSerialization/mapSerializer.mjs +32 -0
  32. package/dist/src/actionMiddlewares/actionSerialization/objectPathSerializer.mjs +33 -0
  33. package/dist/src/actionMiddlewares/actionSerialization/objectSnapshotSerializer.mjs +18 -0
  34. package/dist/src/actionMiddlewares/actionSerialization/plainObjectSerializer.mjs +27 -0
  35. package/dist/src/actionMiddlewares/actionSerialization/primitiveSerializer.mjs +39 -0
  36. package/dist/src/actionMiddlewares/actionSerialization/setSerializer.mjs +29 -0
  37. package/dist/src/actionMiddlewares/actionTrackingMiddleware.mjs +239 -0
  38. package/dist/src/actionMiddlewares/onActionMiddleware.mjs +44 -0
  39. package/dist/src/actionMiddlewares/readonlyMiddleware.mjs +49 -0
  40. package/dist/src/actionMiddlewares/transactionMiddleware.mjs +69 -0
  41. package/dist/src/actionMiddlewares/undoMiddleware.mjs +472 -0
  42. package/dist/src/actionMiddlewares/utils.mjs +25 -0
  43. package/dist/src/computedTree/computedTree.mjs +63 -0
  44. package/dist/src/context/context.mjs +141 -0
  45. package/dist/src/dataModel/BaseDataModel.mjs +108 -0
  46. package/dist/src/dataModel/DataModel.mjs +32 -0
  47. package/dist/src/dataModel/actions.mjs +12 -0
  48. package/dist/src/dataModel/getDataModelMetadata.mjs +14 -0
  49. package/dist/src/dataModel/newDataModel.mjs +31 -0
  50. package/dist/src/dataModel/utils.mjs +29 -0
  51. package/dist/src/frozen/Frozen.mjs +68 -0
  52. package/dist/src/globalConfig/globalConfig.mjs +57 -0
  53. package/dist/src/index.mjs +97 -0
  54. package/dist/src/model/BaseModel.mjs +118 -0
  55. package/dist/src/model/Model.mjs +36 -0
  56. package/dist/src/model/getModelMetadata.mjs +19 -0
  57. package/dist/src/model/metadata.mjs +7 -0
  58. package/dist/src/model/newModel.mjs +95 -0
  59. package/dist/src/model/utils.mjs +33 -0
  60. package/dist/src/modelShared/BaseModelShared.mjs +9 -0
  61. package/dist/src/modelShared/Model.mjs +249 -0
  62. package/dist/src/modelShared/checkModelDecoratorArgs.mjs +21 -0
  63. package/dist/src/modelShared/modelClassInitializer.mjs +14 -0
  64. package/dist/src/modelShared/modelDecorator.mjs +117 -0
  65. package/dist/src/modelShared/modelInfo.mjs +7 -0
  66. package/dist/src/modelShared/modelPropsInfo.mjs +9 -0
  67. package/dist/src/modelShared/modelSymbols.mjs +5 -0
  68. package/dist/src/modelShared/newModel.mjs +13 -0
  69. package/dist/src/modelShared/prop.mjs +138 -0
  70. package/dist/src/modelShared/utils.mjs +10 -0
  71. package/dist/src/parent/core.mjs +34 -0
  72. package/dist/src/parent/coreObjectChildren.mjs +98 -0
  73. package/dist/src/parent/detach.mjs +32 -0
  74. package/dist/src/parent/findChildren.mjs +16 -0
  75. package/dist/src/parent/findParent.mjs +30 -0
  76. package/dist/src/parent/getChildrenObjects.mjs +12 -0
  77. package/dist/src/parent/onChildAttachedTo.mjs +101 -0
  78. package/dist/src/parent/path.mjs +149 -0
  79. package/dist/src/parent/path2.mjs +12 -0
  80. package/dist/src/parent/setParent.mjs +83 -0
  81. package/dist/src/parent/walkTree.mjs +104 -0
  82. package/dist/src/patch/applyPatches.mjs +118 -0
  83. package/dist/src/patch/emitPatch.mjs +100 -0
  84. package/dist/src/patch/jsonPatch.mjs +60 -0
  85. package/dist/src/patch/patchRecorder.mjs +75 -0
  86. package/dist/src/redux/connectReduxDevTools.mjs +153 -0
  87. package/dist/src/redux/redux.mjs +60 -0
  88. package/dist/src/ref/Ref.mjs +38 -0
  89. package/dist/src/ref/core.mjs +179 -0
  90. package/dist/src/ref/customRef.mjs +9 -0
  91. package/dist/src/ref/rootRef.mjs +34 -0
  92. package/dist/src/rootStore/attachDetach.mjs +53 -0
  93. package/dist/src/rootStore/rootStore.mjs +50 -0
  94. package/dist/src/snapshot/SnapshotterAndReconcilerPriority.mjs +9 -0
  95. package/dist/src/snapshot/applySnapshot.mjs +92 -0
  96. package/dist/src/snapshot/clone.mjs +29 -0
  97. package/dist/src/snapshot/fromArraySnapshot.mjs +23 -0
  98. package/dist/src/snapshot/fromFrozenSnapshot.mjs +13 -0
  99. package/dist/src/snapshot/fromModelSnapshot.mjs +38 -0
  100. package/dist/src/snapshot/fromPlainObjectSnapshot.mjs +26 -0
  101. package/dist/src/snapshot/fromSnapshot.mjs +91 -0
  102. package/dist/src/snapshot/getSnapshot.mjs +27 -0
  103. package/dist/src/snapshot/internal.mjs +97 -0
  104. package/dist/src/snapshot/onSnapshot.mjs +16 -0
  105. package/dist/src/snapshot/reconcileArraySnapshot.mjs +40 -0
  106. package/dist/src/snapshot/reconcileFrozenSnapshot.mjs +19 -0
  107. package/dist/src/snapshot/reconcileModelSnapshot.mjs +77 -0
  108. package/dist/src/snapshot/reconcilePlainObjectSnapshot.mjs +47 -0
  109. package/dist/src/snapshot/reconcileSnapshot.mjs +49 -0
  110. package/dist/src/snapshot/registerDefaultReconcilers.mjs +17 -0
  111. package/dist/src/snapshot/registerDefaultSnapshotters.mjs +17 -0
  112. package/dist/src/standardActions/actions.mjs +35 -0
  113. package/dist/src/standardActions/arrayActions.mjs +66 -0
  114. package/dist/src/standardActions/objectActions.mjs +36 -0
  115. package/dist/src/standardActions/standaloneActions.mjs +9 -0
  116. package/dist/src/transforms/ImmutableDate.mjs +51 -0
  117. package/dist/src/transforms/asMap.mjs +29 -0
  118. package/dist/src/transforms/asSet.mjs +12 -0
  119. package/dist/src/transforms/bigint.mjs +14 -0
  120. package/dist/src/transforms/date.mjs +27 -0
  121. package/dist/src/treeUtils/deepEquals.mjs +40 -0
  122. package/dist/src/treeUtils/draft.mjs +116 -0
  123. package/dist/src/treeUtils/sandbox.mjs +158 -0
  124. package/dist/src/tweaker/TweakerPriority.mjs +9 -0
  125. package/dist/src/tweaker/core.mjs +38 -0
  126. package/dist/src/tweaker/registerDefaultTweakers.mjs +17 -0
  127. package/dist/src/tweaker/tweak.mjs +109 -0
  128. package/dist/src/tweaker/tweakArray.mjs +272 -0
  129. package/dist/src/tweaker/tweakFrozen.mjs +28 -0
  130. package/dist/src/tweaker/tweakModel.mjs +26 -0
  131. package/dist/src/tweaker/tweakPlainObject.mjs +205 -0
  132. package/dist/src/tweaker/typeChecking.mjs +46 -0
  133. package/dist/src/tweaker/withoutTypeChecking.mjs +15 -0
  134. package/dist/src/types/TypeCheckError.mjs +31 -0
  135. package/dist/src/types/TypeChecker.mjs +165 -0
  136. package/dist/src/types/arrayBased/array.mjs +68 -0
  137. package/dist/src/types/arrayBased/tuple.mjs +71 -0
  138. package/dist/src/types/getTypeInfo.mjs +12 -0
  139. package/dist/src/types/objectBased/arraySet.mjs +83 -0
  140. package/dist/src/types/objectBased/dataModelData.mjs +95 -0
  141. package/dist/src/types/objectBased/model.mjs +133 -0
  142. package/dist/src/types/objectBased/object.mjs +119 -0
  143. package/dist/src/types/objectBased/objectMap.mjs +90 -0
  144. package/dist/src/types/objectBased/record.mjs +80 -0
  145. package/dist/src/types/objectBased/ref.mjs +62 -0
  146. package/dist/src/types/primitiveBased/enum.mjs +20 -0
  147. package/dist/src/types/primitiveBased/primitives.mjs +59 -0
  148. package/dist/src/types/primitiveBased/refinedPrimitives.mjs +6 -0
  149. package/dist/src/types/registerDefaultStandardTypeResolvers.mjs +13 -0
  150. package/dist/src/types/resolveTypeChecker.mjs +52 -0
  151. package/dist/src/types/tProp.mjs +53 -0
  152. package/dist/src/types/typeCheck.mjs +11 -0
  153. package/dist/src/types/types.mjs +69 -0
  154. package/dist/src/types/utility/maybe.mjs +10 -0
  155. package/dist/src/types/utility/or.mjs +99 -0
  156. package/dist/src/types/utility/refinement.mjs +52 -0
  157. package/dist/src/types/utility/unchecked.mjs +10 -0
  158. package/dist/src/utils/ModelPool.mjs +50 -0
  159. package/dist/src/utils/chainFns.mjs +15 -0
  160. package/dist/src/utils/index.mjs +228 -0
  161. package/dist/src/utils/mapUtils.mjs +10 -0
  162. package/dist/src/utils/tag.mjs +16 -0
  163. package/dist/src/wrappers/ArraySet.mjs +85 -0
  164. package/dist/src/wrappers/ObjectMap.mjs +96 -0
  165. package/dist/src/wrappers/asMap.mjs +181 -0
  166. package/dist/src/wrappers/asSet.mjs +97 -0
  167. package/dist/tweaker/index.d.ts +0 -4
  168. package/dist/tweaker/registerDefaultTweakers.d.ts +1 -0
  169. package/dist/types/registerDefaultStandardTypeResolvers.d.ts +1 -0
  170. package/package.json +12 -14
  171. package/src/actionMiddlewares/actionSerialization/actionSerialization.ts +24 -9
  172. package/src/dataModel/BaseDataModel.ts +0 -3
  173. package/src/dataModel/utils.ts +4 -4
  174. package/src/dist/action/actionDecoratorUtils.d.ts +5 -0
  175. package/src/dist/action/applyAction.d.ts +36 -0
  176. package/src/dist/action/applyDelete.d.ts +7 -0
  177. package/src/dist/action/applyMethodCall.d.ts +9 -0
  178. package/src/dist/action/applySet.d.ts +8 -0
  179. package/src/dist/action/builtInActions.d.ts +39 -0
  180. package/src/dist/action/context.d.ts +85 -0
  181. package/src/dist/action/hookActions.d.ts +32 -0
  182. package/src/dist/action/index.d.ts +12 -0
  183. package/src/dist/action/isModelAction.d.ts +7 -0
  184. package/src/dist/action/middleware.d.ts +34 -0
  185. package/src/dist/action/modelAction.d.ts +9 -0
  186. package/src/dist/action/modelFlow.d.ts +34 -0
  187. package/src/dist/action/pendingActions.d.ts +1 -0
  188. package/src/dist/action/protection.d.ts +1 -0
  189. package/src/dist/action/runUnprotected.d.ts +19 -0
  190. package/src/dist/action/wrapInAction.d.ts +1 -0
  191. package/src/dist/actionMiddlewares/actionSerialization/actionSerialization.d.ts +84 -0
  192. package/src/dist/actionMiddlewares/actionSerialization/applySerializedAction.d.ts +45 -0
  193. package/src/dist/actionMiddlewares/actionSerialization/arraySerializer.d.ts +3 -0
  194. package/src/dist/actionMiddlewares/actionSerialization/core.d.ts +28 -0
  195. package/src/dist/actionMiddlewares/actionSerialization/dateSerializer.d.ts +2 -0
  196. package/src/dist/actionMiddlewares/actionSerialization/index.d.ts +3 -0
  197. package/src/dist/actionMiddlewares/actionSerialization/mapSerializer.d.ts +6 -0
  198. package/src/dist/actionMiddlewares/actionSerialization/objectPathSerializer.d.ts +8 -0
  199. package/src/dist/actionMiddlewares/actionSerialization/objectSnapshotSerializer.d.ts +2 -0
  200. package/src/dist/actionMiddlewares/actionSerialization/plainObjectSerializer.d.ts +2 -0
  201. package/src/dist/actionMiddlewares/actionSerialization/primitiveSerializer.d.ts +2 -0
  202. package/src/dist/actionMiddlewares/actionSerialization/setSerializer.d.ts +3 -0
  203. package/src/dist/actionMiddlewares/actionTrackingMiddleware.d.ts +122 -0
  204. package/src/dist/actionMiddlewares/index.d.ts +6 -0
  205. package/src/dist/actionMiddlewares/onActionMiddleware.d.ts +26 -0
  206. package/src/dist/actionMiddlewares/readonlyMiddleware.d.ts +35 -0
  207. package/src/dist/actionMiddlewares/transactionMiddleware.d.ts +21 -0
  208. package/src/dist/actionMiddlewares/undoMiddleware.d.ts +283 -0
  209. package/src/dist/actionMiddlewares/utils.d.ts +1 -0
  210. package/src/dist/computedTree/computedTree.d.ts +16 -0
  211. package/src/dist/computedTree/index.d.ts +1 -0
  212. package/src/dist/context/context.d.ts +84 -0
  213. package/src/dist/context/index.d.ts +1 -0
  214. package/src/dist/dataModel/BaseDataModel.d.ts +52 -0
  215. package/src/dist/dataModel/DataModel.d.ts +47 -0
  216. package/src/dist/dataModel/DataModelConstructorOptions.d.ts +1 -0
  217. package/src/dist/dataModel/actions.d.ts +1 -0
  218. package/src/dist/dataModel/getDataModelMetadata.d.ts +19 -0
  219. package/src/dist/dataModel/index.d.ts +4 -0
  220. package/src/dist/dataModel/newDataModel.d.ts +1 -0
  221. package/src/dist/dataModel/utils.d.ts +8 -0
  222. package/src/dist/frozen/Frozen.d.ts +50 -0
  223. package/src/dist/frozen/index.d.ts +1 -0
  224. package/src/dist/globalConfig/globalConfig.d.ts +51 -0
  225. package/src/dist/globalConfig/index.d.ts +1 -0
  226. package/src/dist/index.d.ts +23 -0
  227. package/src/dist/mobx-keystone.umd.js +8201 -0
  228. package/src/dist/model/BaseModel.d.ts +125 -0
  229. package/src/dist/model/Model.d.ts +94 -0
  230. package/src/dist/model/ModelConstructorOptions.d.ts +1 -0
  231. package/src/dist/model/getModelMetadata.d.ts +27 -0
  232. package/src/dist/model/index.d.ts +5 -0
  233. package/src/dist/model/metadata.d.ts +8 -0
  234. package/src/dist/model/newModel.d.ts +1 -0
  235. package/src/dist/model/utils.d.ts +8 -0
  236. package/src/dist/modelShared/BaseModelShared.d.ts +76 -0
  237. package/src/dist/modelShared/Model.d.ts +15 -0
  238. package/src/dist/modelShared/checkModelDecoratorArgs.d.ts +1 -0
  239. package/src/dist/modelShared/index.d.ts +3 -0
  240. package/src/dist/modelShared/modelClassInitializer.d.ts +1 -0
  241. package/src/dist/modelShared/modelDecorator.d.ts +24 -0
  242. package/src/dist/modelShared/modelInfo.d.ts +1 -0
  243. package/src/dist/modelShared/modelPropsInfo.d.ts +1 -0
  244. package/src/dist/modelShared/modelSymbols.d.ts +3 -0
  245. package/src/dist/modelShared/newModel.d.ts +4 -0
  246. package/src/dist/modelShared/prop.d.ts +179 -0
  247. package/src/dist/modelShared/utils.d.ts +1 -0
  248. package/src/dist/parent/core.d.ts +1 -0
  249. package/src/dist/parent/coreObjectChildren.d.ts +1 -0
  250. package/src/dist/parent/detach.d.ts +9 -0
  251. package/src/dist/parent/findChildren.d.ts +13 -0
  252. package/src/dist/parent/findParent.d.ts +41 -0
  253. package/src/dist/parent/getChildrenObjects.d.ts +11 -0
  254. package/src/dist/parent/index.d.ts +9 -0
  255. package/src/dist/parent/onChildAttachedTo.d.ts +22 -0
  256. package/src/dist/parent/path.d.ts +107 -0
  257. package/src/dist/parent/path2.d.ts +16 -0
  258. package/src/dist/parent/pathTypes.d.ts +12 -0
  259. package/src/dist/parent/setParent.d.ts +1 -0
  260. package/src/dist/parent/walkTree.d.ts +25 -0
  261. package/src/dist/patch/Patch.d.ts +16 -0
  262. package/src/dist/patch/applyPatches.d.ts +9 -0
  263. package/src/dist/patch/emitPatch.d.ts +29 -0
  264. package/src/dist/patch/index.d.ts +5 -0
  265. package/src/dist/patch/jsonPatch.d.ts +45 -0
  266. package/src/dist/patch/patchRecorder.d.ts +70 -0
  267. package/src/dist/redux/connectReduxDevTools.d.ts +12 -0
  268. package/src/dist/redux/index.d.ts +2 -0
  269. package/src/dist/redux/redux.d.ts +47 -0
  270. package/src/dist/ref/Ref.d.ts +53 -0
  271. package/src/dist/ref/core.d.ts +46 -0
  272. package/src/dist/ref/customRef.d.ts +38 -0
  273. package/src/dist/ref/index.d.ts +4 -0
  274. package/src/dist/ref/rootRef.d.ts +33 -0
  275. package/src/dist/rootStore/attachDetach.d.ts +1 -0
  276. package/src/dist/rootStore/index.d.ts +1 -0
  277. package/src/dist/rootStore/rootStore.d.ts +33 -0
  278. package/src/dist/snapshot/SnapshotOf.d.ts +47 -0
  279. package/src/dist/snapshot/SnapshotterAndReconcilerPriority.d.ts +1 -0
  280. package/src/dist/snapshot/applySnapshot.d.ts +17 -0
  281. package/src/dist/snapshot/clone.d.ts +18 -0
  282. package/src/dist/snapshot/fromArraySnapshot.d.ts +1 -0
  283. package/src/dist/snapshot/fromFrozenSnapshot.d.ts +1 -0
  284. package/src/dist/snapshot/fromModelSnapshot.d.ts +1 -0
  285. package/src/dist/snapshot/fromPlainObjectSnapshot.d.ts +1 -0
  286. package/src/dist/snapshot/fromSnapshot.d.ts +36 -0
  287. package/src/dist/snapshot/getSnapshot.d.ts +22 -0
  288. package/src/dist/snapshot/index.d.ts +6 -0
  289. package/src/dist/snapshot/internal.d.ts +1 -0
  290. package/src/dist/snapshot/onSnapshot.d.ts +18 -0
  291. package/src/dist/snapshot/reconcileArraySnapshot.d.ts +1 -0
  292. package/src/dist/snapshot/reconcileFrozenSnapshot.d.ts +1 -0
  293. package/src/dist/snapshot/reconcileModelSnapshot.d.ts +1 -0
  294. package/src/dist/snapshot/reconcilePlainObjectSnapshot.d.ts +1 -0
  295. package/src/dist/snapshot/reconcileSnapshot.d.ts +1 -0
  296. package/src/dist/snapshot/registerDefaultReconcilers.d.ts +1 -0
  297. package/src/dist/snapshot/registerDefaultSnapshotters.d.ts +1 -0
  298. package/src/dist/standardActions/actions.d.ts +1 -0
  299. package/src/dist/standardActions/arrayActions.d.ts +18 -0
  300. package/src/dist/standardActions/index.d.ts +3 -0
  301. package/src/dist/standardActions/objectActions.d.ts +7 -0
  302. package/src/dist/standardActions/standaloneActions.d.ts +16 -0
  303. package/src/dist/transforms/ImmutableDate.d.ts +1 -0
  304. package/src/dist/transforms/asMap.d.ts +3 -0
  305. package/src/dist/transforms/asSet.d.ts +2 -0
  306. package/src/dist/transforms/bigint.d.ts +2 -0
  307. package/src/dist/transforms/date.d.ts +3 -0
  308. package/src/dist/transforms/index.d.ts +4 -0
  309. package/src/dist/treeUtils/deepEquals.d.ts +20 -0
  310. package/src/dist/treeUtils/draft.d.ts +70 -0
  311. package/src/dist/treeUtils/index.d.ts +3 -0
  312. package/src/dist/treeUtils/sandbox.d.ts +85 -0
  313. package/src/dist/tweaker/TweakerPriority.d.ts +1 -0
  314. package/src/dist/tweaker/core.d.ts +14 -0
  315. package/src/dist/tweaker/index.d.ts +2 -0
  316. package/src/dist/tweaker/registerDefaultTweakers.d.ts +1 -0
  317. package/src/dist/tweaker/tweak.d.ts +22 -0
  318. package/src/dist/tweaker/tweakArray.d.ts +1 -0
  319. package/src/dist/tweaker/tweakFrozen.d.ts +1 -0
  320. package/src/dist/tweaker/tweakModel.d.ts +1 -0
  321. package/src/dist/tweaker/tweakPlainObject.d.ts +1 -0
  322. package/src/dist/tweaker/typeChecking.d.ts +1 -0
  323. package/src/dist/tweaker/withoutTypeChecking.d.ts +2 -0
  324. package/src/dist/types/TypeCheckError.d.ts +22 -0
  325. package/src/dist/types/TypeChecker.d.ts +8 -0
  326. package/src/dist/types/arrayBased/array.d.ts +23 -0
  327. package/src/dist/types/arrayBased/tuple.d.ts +24 -0
  328. package/src/dist/types/getTypeInfo.d.ts +9 -0
  329. package/src/dist/types/index.d.ts +5 -0
  330. package/src/dist/types/objectBased/arraySet.d.ts +24 -0
  331. package/src/dist/types/objectBased/dataModelData.d.ts +44 -0
  332. package/src/dist/types/objectBased/model.d.ts +43 -0
  333. package/src/dist/types/objectBased/object.d.ts +63 -0
  334. package/src/dist/types/objectBased/objectMap.d.ts +24 -0
  335. package/src/dist/types/objectBased/record.d.ts +24 -0
  336. package/src/dist/types/objectBased/ref.d.ts +21 -0
  337. package/src/dist/types/primitiveBased/enum.d.ts +34 -0
  338. package/src/dist/types/primitiveBased/primitives.d.ts +81 -0
  339. package/src/dist/types/primitiveBased/refinedPrimitives.d.ts +18 -0
  340. package/src/dist/types/registerDefaultStandardTypeResolvers.d.ts +1 -0
  341. package/src/dist/types/resolveTypeChecker.d.ts +1 -0
  342. package/src/dist/types/schemas.d.ts +53 -0
  343. package/src/dist/types/tProp.d.ts +92 -0
  344. package/src/dist/types/typeCheck.d.ts +11 -0
  345. package/src/dist/types/types.d.ts +51 -0
  346. package/src/dist/types/utility/maybe.d.ts +29 -0
  347. package/src/dist/types/utility/or.d.ts +35 -0
  348. package/src/dist/types/utility/refinement.d.ts +45 -0
  349. package/src/dist/types/utility/unchecked.d.ts +22 -0
  350. package/src/dist/utils/ModelPool.d.ts +7 -0
  351. package/src/dist/utils/chainFns.d.ts +1 -0
  352. package/src/dist/utils/index.d.ts +6 -0
  353. package/src/dist/utils/mapUtils.d.ts +2 -0
  354. package/src/dist/utils/tag.d.ts +13 -0
  355. package/src/dist/utils/types.d.ts +39 -0
  356. package/src/dist/wrappers/ArraySet.d.ts +29 -0
  357. package/src/dist/wrappers/ObjectMap.d.ts +32 -0
  358. package/src/dist/wrappers/asMap.d.ts +29 -0
  359. package/src/dist/wrappers/asSet.d.ts +15 -0
  360. package/src/dist/wrappers/index.d.ts +4 -0
  361. package/src/model/BaseModel.ts +0 -3
  362. package/src/model/utils.ts +4 -5
  363. package/src/modelShared/checkModelDecoratorArgs.ts +6 -6
  364. package/src/parent/setParent.ts +2 -2
  365. package/src/rootStore/attachDetach.ts +2 -3
  366. package/src/snapshot/fromArraySnapshot.ts +11 -6
  367. package/src/snapshot/fromFrozenSnapshot.ts +11 -6
  368. package/src/snapshot/fromModelSnapshot.ts +11 -6
  369. package/src/snapshot/fromPlainObjectSnapshot.ts +11 -6
  370. package/src/snapshot/fromSnapshot.ts +3 -0
  371. package/src/snapshot/index.ts +0 -10
  372. package/src/snapshot/reconcileArraySnapshot.ts +11 -6
  373. package/src/snapshot/reconcileFrozenSnapshot.ts +11 -6
  374. package/src/snapshot/reconcileModelSnapshot.ts +11 -6
  375. package/src/snapshot/reconcilePlainObjectSnapshot.ts +11 -6
  376. package/src/snapshot/reconcileSnapshot.ts +3 -0
  377. package/src/snapshot/registerDefaultReconcilers.ts +21 -0
  378. package/src/snapshot/registerDefaultSnapshotters.ts +21 -0
  379. package/src/tweaker/index.ts +0 -6
  380. package/src/tweaker/registerDefaultTweakers.ts +21 -0
  381. package/src/tweaker/tweak.ts +3 -0
  382. package/src/tweaker/tweakArray.ts +406 -401
  383. package/src/tweaker/tweakFrozen.ts +11 -6
  384. package/src/tweaker/tweakModel.ts +11 -6
  385. package/src/tweaker/tweakPlainObject.ts +288 -283
  386. package/src/types/objectBased/model.ts +6 -1
  387. package/src/types/objectBased/ref.ts +1 -1
  388. package/src/types/primitiveBased/primitives.ts +177 -166
  389. package/src/types/registerDefaultStandardTypeResolvers.ts +17 -0
  390. package/src/types/resolveTypeChecker.ts +7 -1
  391. package/dist/mobx-keystone.es.js +0 -7856
  392. package/dist/mobx-keystone.es.mjs +0 -7856
  393. package/src/dataModel/_BaseDataModel.ts +0 -15
  394. package/src/model/_BaseModel.ts +0 -15
@@ -0,0 +1,26 @@
1
+ import type { ActionCall } from "../action/applyAction";
2
+ import type { ActionMiddlewareDisposer } from "../action/middleware";
3
+ import { ActionTrackingReturn, SimpleActionContext } from "./actionTrackingMiddleware";
4
+ /**
5
+ * Attaches an action middleware that invokes a listener for all actions of a given tree.
6
+ * Note that the listener will only be invoked for the topmost level actions, so it won't run for child actions or intermediary flow steps.
7
+ * Also it won't trigger the listener for calls to hooks such as `onAttachedToRootStore` or its returned disposer.
8
+ *
9
+ * Its main use is to keep track of top level actions that can be later replicated via `applyAction` somewhere else (another machine, etc.).
10
+ *
11
+ * There are two kind of possible listeners, `onStart` and `onFinish` listeners.
12
+ * `onStart` listeners are called before the action executes and allow cancellation by returning a new return value (which might be a return or a throw).
13
+ * `onFinish` listeners are called after the action executes, have access to the action actual return value and allow overriding by returning a
14
+ * new return value (which might be a return or a throw).
15
+ *
16
+ * If you want to ensure that the actual action calls are serializable you should use either `serializeActionCallArgument` over the arguments
17
+ * or `serializeActionCall` over the whole action before sending the action call over the wire / storing them .
18
+ *
19
+ * @param subtreeRoot Subtree root target object.
20
+ * @param listeners Listener functions that will be invoked everytime a topmost action is invoked on the model or any children.
21
+ * @returns The middleware disposer.
22
+ */
23
+ export declare function onActionMiddleware(subtreeRoot: object, listeners: {
24
+ onStart?: (actionCall: ActionCall, actionContext: SimpleActionContext) => void | ActionTrackingReturn;
25
+ onFinish?: (actionCall: ActionCall, actionContext: SimpleActionContext, ret: ActionTrackingReturn) => void | ActionTrackingReturn;
26
+ }): ActionMiddlewareDisposer;
@@ -0,0 +1,35 @@
1
+ import type { ActionMiddlewareDisposer } from "../action/middleware";
2
+ /**
3
+ * Return type for readonly middleware.
4
+ */
5
+ export interface ReadonlyMiddlewareReturn {
6
+ allowWrite<R>(fn: () => R): R;
7
+ dispose: ActionMiddlewareDisposer;
8
+ }
9
+ /**
10
+ * Attaches an action middleware that will throw when any action is started
11
+ * over the node or any of the child nodes, thus effectively making the subtree
12
+ * readonly.
13
+ *
14
+ * It will return an object with a `dispose` function to remove the middleware and a `allowWrite` function
15
+ * that will allow actions to be started inside the provided code block.
16
+ *
17
+ * Example:
18
+ * ```ts
19
+ * // given a model instance named todo
20
+ * const { dispose, allowWrite } = readonlyMiddleware(todo)
21
+ *
22
+ * // this will throw
23
+ * todo.setDone(false)
24
+ * await todo.setDoneAsync(false)
25
+ *
26
+ * // this will work
27
+ * allowWrite(() => todo.setDone(false))
28
+ * // note: for async always use one action invocation per allowWrite!
29
+ * await allowWrite(() => todo.setDoneAsync(false))
30
+ * ```
31
+ *
32
+ * @param subtreeRoot Subtree root target object.
33
+ * @returns An object with the middleware disposer (`dispose`) and a `allowWrite` function.
34
+ */
35
+ export declare function readonlyMiddleware(subtreeRoot: object): ReadonlyMiddlewareReturn;
@@ -0,0 +1,21 @@
1
+ import type { ActionMiddlewareDisposer } from "../action/middleware";
2
+ import type { AnyModel } from "../model/BaseModel";
3
+ /**
4
+ * Creates a transaction middleware, which reverts changes made by an action / child
5
+ * actions when the root action throws an exception by applying inverse patches.
6
+ *
7
+ * @typeparam M Model
8
+ * @param target Object with the root target model object (`model`) and root action name (`actionName`).
9
+ * @returns The middleware disposer.
10
+ */
11
+ export declare function transactionMiddleware<M extends AnyModel>(target: {
12
+ model: M;
13
+ actionName: keyof M;
14
+ }): ActionMiddlewareDisposer;
15
+ /**
16
+ * Transaction middleware as a decorator.
17
+ *
18
+ * @param target
19
+ * @param propertyKey
20
+ */
21
+ export declare function transaction(target: any, propertyKey: string): void;
@@ -0,0 +1,283 @@
1
+ import type { ActionMiddlewareDisposer } from "../action/middleware";
2
+ import type { Path } from "../parent/pathTypes";
3
+ import { Patch } from "../patch";
4
+ /**
5
+ * An undo/redo event without attached state.
6
+ */
7
+ export declare type UndoEventWithoutAttachedState = UndoSingleEvent | UndoEventGroup;
8
+ /**
9
+ * An undo/redo event.
10
+ */
11
+ export declare type UndoEvent = UndoEventWithoutAttachedState & {
12
+ /**
13
+ * The state saved before the event actions started / after the event actions finished.
14
+ */
15
+ attachedState: {
16
+ /**
17
+ * The state saved before the event actions started.
18
+ */
19
+ beforeEvent?: unknown;
20
+ /**
21
+ * The state saved after the event actions finished.
22
+ */
23
+ afterEvent?: unknown;
24
+ };
25
+ };
26
+ /**
27
+ * Undo event type.
28
+ */
29
+ export declare enum UndoEventType {
30
+ Single = "single",
31
+ Group = "group"
32
+ }
33
+ /**
34
+ * An undo/redo single event.
35
+ */
36
+ export interface UndoSingleEvent {
37
+ /**
38
+ * Expresses this is a single event.
39
+ */
40
+ readonly type: UndoEventType.Single;
41
+ /**
42
+ * Path to the object that invoked the action from its root.
43
+ */
44
+ readonly targetPath: Path;
45
+ /**
46
+ * Name of the action that was invoked.
47
+ */
48
+ readonly actionName: string;
49
+ /**
50
+ * Patches with changes done inside the action.
51
+ * Use `redo()` in the `UndoManager` to apply them.
52
+ */
53
+ readonly patches: ReadonlyArray<Patch>;
54
+ /**
55
+ * Patches to undo the changes done inside the action.
56
+ * Use `undo()` in the `UndoManager` to apply them.
57
+ */
58
+ readonly inversePatches: ReadonlyArray<Patch>;
59
+ }
60
+ /**
61
+ * An undo/redo event group.
62
+ */
63
+ export interface UndoEventGroup {
64
+ /**
65
+ * Expresses this is an event group.
66
+ */
67
+ readonly type: UndoEventType.Group;
68
+ /**
69
+ * Name of the group (if any).
70
+ */
71
+ readonly groupName?: string;
72
+ /**
73
+ * Events that conform this group (might be single events or other nested groups).
74
+ */
75
+ readonly events: ReadonlyArray<UndoEventWithoutAttachedState>;
76
+ }
77
+ declare const UndoStore_base: import("../model/Model")._Model<unknown, {
78
+ undoEvents: import("..").OptionalModelProp<UndoEvent[]>;
79
+ redoEvents: import("..").OptionalModelProp<UndoEvent[]>;
80
+ }, never, never>;
81
+ /**
82
+ * Store model instance for undo/redo actions.
83
+ * Do not manipulate directly, other that creating it.
84
+ */
85
+ export declare class UndoStore extends UndoStore_base {
86
+ /**
87
+ * @ignore
88
+ */
89
+ _clearUndo(): void;
90
+ /**
91
+ * @ignore
92
+ */
93
+ _clearRedo(): void;
94
+ /**
95
+ * @ignore
96
+ */
97
+ _undo(): void;
98
+ /**
99
+ * @ignore
100
+ */
101
+ _redo(): void;
102
+ /**
103
+ * @ignore
104
+ */
105
+ _addUndo(event: UndoEvent): void;
106
+ private _groupStack;
107
+ /**
108
+ * @ignore
109
+ */
110
+ _addUndoToParentGroup(parentGroup: UndoEventGroup, event: UndoEventWithoutAttachedState): void;
111
+ /**
112
+ * @ignore
113
+ */
114
+ get _currentGroup(): UndoEventGroup | undefined;
115
+ /**
116
+ * @ignore
117
+ */
118
+ _startGroup(groupName: string | undefined, startRunning: boolean, options: UndoMiddlewareOptions<unknown> | undefined): {
119
+ pause: () => void;
120
+ resume: () => void;
121
+ end: () => void;
122
+ };
123
+ }
124
+ /**
125
+ * Manager class returned by `undoMiddleware` that allows you to perform undo/redo actions.
126
+ */
127
+ export declare class UndoManager {
128
+ private readonly disposer;
129
+ private readonly subtreeRoot;
130
+ private readonly options;
131
+ /**
132
+ * The store currently being used to store undo/redo action events.
133
+ */
134
+ readonly store: UndoStore;
135
+ /**
136
+ * The undo stack, where the first operation to undo will be the last of the array.
137
+ * Do not manipulate this array directly.
138
+ */
139
+ get undoQueue(): ReadonlyArray<UndoEvent>;
140
+ /**
141
+ * The redo stack, where the first operation to redo will be the last of the array.
142
+ * Do not manipulate this array directly.
143
+ */
144
+ get redoQueue(): ReadonlyArray<UndoEvent>;
145
+ /**
146
+ * The number of undo actions available.
147
+ */
148
+ get undoLevels(): number;
149
+ /**
150
+ * If undo can be performed (if there is at least one undo action available).
151
+ */
152
+ get canUndo(): boolean;
153
+ /**
154
+ * Clears the undo queue.
155
+ */
156
+ clearUndo(): void;
157
+ /**
158
+ * The number of redo actions available.
159
+ */
160
+ get redoLevels(): number;
161
+ /**
162
+ * If redo can be performed (if there is at least one redo action available)
163
+ */
164
+ get canRedo(): boolean;
165
+ /**
166
+ * Clears the redo queue.
167
+ */
168
+ clearRedo(): void;
169
+ /**
170
+ * Undoes the last action.
171
+ * Will throw if there is no action to undo.
172
+ */
173
+ undo(): void;
174
+ /**
175
+ * Redoes the previous action.
176
+ * Will throw if there is no action to redo.
177
+ */
178
+ redo(): void;
179
+ /**
180
+ * Disposes the undo middleware.
181
+ */
182
+ dispose(): void;
183
+ private _isUndoRecordingDisabled;
184
+ /**
185
+ * Returns if undo recording is currently disabled or not for this particular `UndoManager`.
186
+ */
187
+ get isUndoRecordingDisabled(): boolean;
188
+ /**
189
+ * Skips the undo recording mechanism for the code block that gets run synchronously inside.
190
+ *
191
+ * @typeparam T Code block return type.
192
+ * @param fn Code block to run.
193
+ * @returns The value returned by the code block.
194
+ */
195
+ withoutUndo<T>(fn: () => T): T;
196
+ /**
197
+ * Creates a custom group that can be continued multiple times and then ended.
198
+ * @param groupName Optional group name.
199
+ * @returns An API to continue/end the group.
200
+ */
201
+ createGroup(groupName?: string): {
202
+ continue<T>(fn: () => T): T;
203
+ end(): void;
204
+ };
205
+ /**
206
+ * Runs a synchronous code block as an undo group.
207
+ * Note that nested groups are allowed.
208
+ *
209
+ * @param groupName Group name.
210
+ * @param fn Code block.
211
+ * @returns Code block return value.
212
+ */
213
+ withGroup<T>(groupName: string, fn: () => T): T;
214
+ /**
215
+ * Runs a synchronous code block as an undo group.
216
+ * Note that nested groups are allowed.
217
+ *
218
+ * @param fn Code block.
219
+ * @returns Code block return value.
220
+ */
221
+ withGroup<T>(fn: () => T): T;
222
+ /**
223
+ * Runs an asynchronous code block as an undo group.
224
+ * Note that nested groups are allowed.
225
+ *
226
+ * @param groupName Group name.
227
+ * @param fn Flow function.
228
+ * @returns Flow function return value.
229
+ */
230
+ withGroupFlow<R>(groupName: string, fn: () => Generator<any, R, any>): Promise<R>;
231
+ /**
232
+ * Runs an asynchronous code block as an undo group.
233
+ * Note that nested groups are allowed.
234
+ *
235
+ * @param fn Flow function.
236
+ * @returns Flow function return value.
237
+ */
238
+ withGroupFlow<R>(fn: () => Generator<any, R, any>): Promise<R>;
239
+ /**
240
+ * Creates an instance of `UndoManager`.
241
+ * Do not use directly, use `undoMiddleware` instead.
242
+ *
243
+ * @param disposer
244
+ * @param subtreeRoot
245
+ * @param [store]
246
+ */
247
+ constructor(disposer: ActionMiddlewareDisposer, subtreeRoot: object, store: UndoStore | undefined, options: UndoMiddlewareOptions<unknown> | undefined);
248
+ }
249
+ /**
250
+ * Undo middleware options.
251
+ */
252
+ export interface UndoMiddlewareOptions<S> {
253
+ attachedState?: {
254
+ save(): S;
255
+ restore(s: S): void;
256
+ };
257
+ }
258
+ /**
259
+ * Creates an undo middleware.
260
+ *
261
+ * @param subtreeRoot Subtree root target object.
262
+ * @param store Optional `UndoStore` where to store the undo/redo queues. Use this if you want to
263
+ * store such queues somewhere in your models. If none is provided it will reside in memory.
264
+ * @param options Extra options, such as how to save / restore certain snapshot of the state to be restored when undoing/redoing.
265
+ * @returns An `UndoManager` which allows you to do the manage the undo/redo operations and dispose of the middleware.
266
+ */
267
+ export declare function undoMiddleware<S>(subtreeRoot: object, store?: UndoStore, options?: UndoMiddlewareOptions<S>): UndoManager;
268
+ /**
269
+ * Returns if the undo recording mechanism is currently disabled.
270
+ *
271
+ * @returns `true` if it is currently disabled, `false` otherwise.
272
+ */
273
+ export declare function isGlobalUndoRecordingDisabled(): boolean;
274
+ /**
275
+ * Globally skips the undo recording mechanism for the code block that gets run synchronously inside.
276
+ * Consider using the `withoutUndo` method of a particular `UndoManager` instead.
277
+ *
278
+ * @typeparam T Code block return type.
279
+ * @param fn Code block to run.
280
+ * @returns The value returned by the code block.
281
+ */
282
+ export declare function withoutUndo<T>(fn: () => T): T;
283
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Returns if a given node is a computed tree node.
3
+ *
4
+ * @param node Node to check.
5
+ * @returns `true` if it is a computed tree node, `false` otherwise.
6
+ */
7
+ export declare function isComputedTreeNode(node: object): boolean;
8
+ /**
9
+ * Decorator for turning a computed property into a computed tree which supports tree traversal
10
+ * functions, contexts, references, etc.
11
+ *
12
+ * @param target Prototype of the class.
13
+ * @param propertyKey Name of the member.
14
+ * @param descriptor Property descriptor for the member.
15
+ */
16
+ export declare function computedTree(target: any, propertyKey: string, descriptor: PropertyDescriptor): void;
@@ -0,0 +1 @@
1
+ export * from "./computedTree";
@@ -0,0 +1,84 @@
1
+ /**
2
+ * A context.
3
+ */
4
+ export interface Context<T> {
5
+ /**
6
+ * Gets the context default value.
7
+ *
8
+ * @returns
9
+ */
10
+ getDefault(): T;
11
+ /**
12
+ * Sets the context default value.
13
+ * @param value
14
+ */
15
+ setDefault(value: T): void;
16
+ /**
17
+ * Sets the context default value resolver.
18
+ * @param valueFn
19
+ */
20
+ setDefaultComputed(valueFn: () => T): void;
21
+ /**
22
+ * Gets the context value for a given node.
23
+ * @param node
24
+ */
25
+ get(node: object): T;
26
+ /**
27
+ * Gets node that will provide the context value, or `undefined`
28
+ * if it comes from the default.
29
+ * @param node
30
+ */
31
+ getProviderNode(node: object): object | undefined;
32
+ /**
33
+ * Sets the context value for a given node, effectively making it a provider.
34
+ * @param node
35
+ * @param value
36
+ */
37
+ set(node: object, value: T): void;
38
+ /**
39
+ * Sets the context value resolver for a given node, effectively making it a provider.
40
+ * @param node
41
+ * @param valueFn
42
+ */
43
+ setComputed(node: object, valueFn: () => T): void;
44
+ /**
45
+ * Unsets the context value for a given node, therefore it won't be a provider anymore.
46
+ * @param node
47
+ */
48
+ unset(node: object): void;
49
+ /**
50
+ * Applies a value override while the given function is running and, if a node is returned,
51
+ * sets the node as a provider of the value.
52
+ *
53
+ * @typeparam R
54
+ * @param fn Function to run.
55
+ * @param value Value to apply.
56
+ * @returns The value returned from the function.
57
+ */
58
+ apply<R>(fn: () => R, value: T): R;
59
+ /**
60
+ * Applies a computed value override while the given function is running and, if a node is returned,
61
+ * sets the node as a provider of the computed value.
62
+ *
63
+ * @typeparam R
64
+ * @param fn Function to run.
65
+ * @param value Value to apply.
66
+ * @returns The value returned from the function.
67
+ */
68
+ applyComputed<R>(fn: () => R, valueFn: () => T): R;
69
+ }
70
+ /**
71
+ * Creates a new context with no default value, thus making its default value undefined.
72
+ *
73
+ * @typeparam T Context value type.
74
+ * @returns
75
+ */
76
+ export declare function createContext<T>(): Context<T | undefined>;
77
+ /**
78
+ * Creates a new context with a default value.
79
+ *
80
+ * @typeparam T Context value type.
81
+ * @param defaultValue
82
+ * @returns
83
+ */
84
+ export declare function createContext<T>(defaultValue: T): Context<T>;
@@ -0,0 +1 @@
1
+ export * from "./context";
@@ -0,0 +1,52 @@
1
+ import { propsTypeSymbol } from "../modelShared/BaseModelShared";
2
+ import { ModelProps, ModelPropsToCreationData, ModelPropsToData, ModelPropsToTransformedCreationData } from "../modelShared/prop";
3
+ import type { TypeCheckError } from "../types/TypeCheckError";
4
+ /**
5
+ * Base abstract class for data models. Use `DataModel` instead when extending.
6
+ *
7
+ * Never override the constructor, use `onLazyInit` instead.
8
+ *
9
+ * @typeparam Data Props data type.
10
+ */
11
+ export declare abstract class BaseDataModel<TProps extends ModelProps> {
12
+ [propsTypeSymbol]: TProps;
13
+ /**
14
+ * Called after the instance is created when there's the first call to `fn(M, data)`.
15
+ */
16
+ protected onLazyInit?(): void;
17
+ /**
18
+ * Data part of the model, which is observable and will be serialized in snapshots.
19
+ * Use it if one of the data properties matches one of the model properties/functions.
20
+ * This also allows access to the backed values of transformed properties.
21
+ */
22
+ readonly $: ModelPropsToData<TProps>;
23
+ /**
24
+ * Performs a type check over the model instance.
25
+ * For this to work a data type has to be declared as part of the model properties.
26
+ *
27
+ * @returns A `TypeCheckError` or `null` if there is no error.
28
+ */
29
+ typeCheck(): TypeCheckError | null;
30
+ /**
31
+ * Creates an instance of a data model.
32
+ */
33
+ constructor(data: ModelPropsToCreationData<TProps> | ModelPropsToTransformedCreationData<TProps>);
34
+ toString(options?: {
35
+ withData?: boolean;
36
+ }): string;
37
+ }
38
+ /**
39
+ * @ignore
40
+ */
41
+ export declare type BaseDataModelKeys = keyof AnyDataModel | "onLazyInit";
42
+ /**
43
+ * Any kind of data model instance.
44
+ */
45
+ export interface AnyDataModel extends BaseDataModel<any> {
46
+ }
47
+ /**
48
+ * A data model class declaration, made of a base model and the model interface.
49
+ */
50
+ export declare type DataModelClassDeclaration<BaseModelClass, ModelInterface> = BaseModelClass & {
51
+ (...args: any[]): ModelInterface;
52
+ };
@@ -0,0 +1,47 @@
1
+ import type { AbstractModelClass, ModelCreationData, ModelTransformedCreationData } from "../modelShared/BaseModelShared";
2
+ import type { ModelProps, ModelPropsToCreationData, ModelPropsToSetter, ModelPropsToTransformedCreationData, ModelPropsToTransformedData } from "../modelShared/prop";
3
+ import type { AnyDataModel, BaseDataModel, BaseDataModelKeys } from "./BaseDataModel";
4
+ export declare type _ComposedData<SuperModel, TProps extends ModelProps> = SuperModel extends AnyDataModel ? (ModelPropsToCreationData<TProps> & ModelCreationData<SuperModel>) | (ModelPropsToTransformedCreationData<TProps> & ModelTransformedCreationData<SuperModel>) : ModelPropsToCreationData<TProps> | ModelPropsToTransformedCreationData<TProps>;
5
+ export interface _DataModel<SuperModel, TProps extends ModelProps> {
6
+ new (data: _ComposedData<SuperModel, TProps>): SuperModel & BaseDataModel<TProps> & Omit<ModelPropsToTransformedData<TProps>, BaseDataModelKeys> & ModelPropsToSetter<TProps>;
7
+ }
8
+ /**
9
+ * Base abstract class for data models that extends another model.
10
+ *
11
+ * @typeparam TProps New model properties type.
12
+ * @typeparam TModel Model type.
13
+ * @param genFn Function that returns the base model and model properties.
14
+ * @returns
15
+ */
16
+ export declare function ExtendedDataModel<TProps extends ModelProps, TModel extends AnyDataModel, A extends []>(genFn: (...args: A) => {
17
+ baseModel: AbstractModelClass<TModel>;
18
+ props: TProps;
19
+ }): _DataModel<TModel, TProps>;
20
+ /**
21
+ * Base abstract class for data models that extends another model.
22
+ *
23
+ * @typeparam TProps New model properties type.
24
+ * @typeparam TModel Model type.
25
+ * @param baseModel Base model type.
26
+ * @param modelProps Model properties.
27
+ * @returns
28
+ */
29
+ export declare function ExtendedDataModel<TProps extends ModelProps, TModel extends AnyDataModel>(baseModel: AbstractModelClass<TModel>, modelProps: TProps): _DataModel<TModel, TProps>;
30
+ /**
31
+ * Base abstract class for data models.
32
+ *
33
+ * Never override the constructor, use `onLazyInit` or `onLazyAttachedToRootStore` instead.
34
+ *
35
+ * @typeparam TProps Model properties type.
36
+ * @param fnModelProps Function that generates model properties.
37
+ */
38
+ export declare function DataModel<TProps extends ModelProps, A extends []>(fnModelProps: (...args: A) => TProps): _DataModel<unknown, TProps>;
39
+ /**
40
+ * Base abstract class for data models.
41
+ *
42
+ * Never override the constructor, use `onLazyInit` or `onLazyAttachedToRootStore` instead.
43
+ *
44
+ * @typeparam TProps Model properties type.
45
+ * @param modelProps Model properties.
46
+ */
47
+ export declare function DataModel<TProps extends ModelProps>(modelProps: TProps): _DataModel<unknown, TProps>;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,19 @@
1
+ import type { ModelClass } from "../modelShared/BaseModelShared";
2
+ import type { AnyType } from "../types/schemas";
3
+ import type { AnyDataModel } from "./BaseDataModel";
4
+ /**
5
+ * Associated data model metadata.
6
+ */
7
+ export interface DataModelMetadata {
8
+ /**
9
+ * Associated data type for runtime checking (if any).
10
+ */
11
+ dataType?: AnyType;
12
+ }
13
+ /**
14
+ * Returns the associated metadata for a data model instance or class.
15
+ *
16
+ * @param modelClassOrInstance Data model class or instance.
17
+ * @returns The associated metadata.
18
+ */
19
+ export declare function getDataModelMetadata(modelClassOrInstance: AnyDataModel | ModelClass<AnyDataModel>): DataModelMetadata;
@@ -0,0 +1,4 @@
1
+ export * from "./BaseDataModel";
2
+ export * from "./DataModel";
3
+ export * from "./getDataModelMetadata";
4
+ export * from "./utils";
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,8 @@
1
+ import type { AnyDataModel } from "./BaseDataModel";
2
+ /**
3
+ * Checks if an object is a data model instance.
4
+ *
5
+ * @param model
6
+ * @returns
7
+ */
8
+ export declare function isDataModel(model: unknown): model is AnyDataModel;
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Should freeze and plain json checks be done when creating the frozen object?
3
+ */
4
+ export declare enum FrozenCheckMode {
5
+ /** Only when in dev mode */
6
+ DevModeOnly = "devModeOnly",
7
+ /** Always */
8
+ On = "on",
9
+ /** Never */
10
+ Off = "off"
11
+ }
12
+ /**
13
+ * @ignore
14
+ */
15
+ export declare const frozenKey = "$frozen";
16
+ /**
17
+ * A class that contains frozen data.
18
+ * Use `frozen` to create an instance of this class.
19
+ *
20
+ * @typeparam T Data type.
21
+ */
22
+ export declare class Frozen<T> {
23
+ /**
24
+ * Frozen data, deeply immutable.
25
+ */
26
+ readonly data: T;
27
+ /**
28
+ * Creates an instance of Frozen.
29
+ * Do not use directly, use `frozen` instead.
30
+ *
31
+ * @param dataToFreeze
32
+ * @param checkMode
33
+ */
34
+ constructor(dataToFreeze: T, checkMode?: FrozenCheckMode);
35
+ }
36
+ /**
37
+ * Marks some data as frozen. Frozen data becomes immutable (at least in dev mode), and is not enhanced
38
+ * with capabilities such as getting the parent of the objects (except for the root object), it is not
39
+ * made deeply observable (though the root object is observable by reference), etc.
40
+ * On the other hand, this means it will be much faster to create/access. Use this for big data pieces
41
+ * that are unlikely to change unless all of them change (for example lists of points for a polygon, etc).
42
+ *
43
+ * Note that data passed to frozen must be serializable to JSON, this is:
44
+ * - primitive, plain object, or array
45
+ * - without cycles
46
+ *
47
+ * @param data
48
+ * @param checkMode
49
+ */
50
+ export declare function frozen<T>(data: T, checkMode?: FrozenCheckMode): Frozen<T>;
@@ -0,0 +1 @@
1
+ export * from "./Frozen";