mobx-state-tree 5.3.1-alpha.1 → 5.4.0

package/dist/types/utility-types/snapshotProcessor.d.ts

@@ -1,4 +1,4 @@
-import { IType, IAnyType } from "../../internal";
+import { IType, IAnyType, Instance } from "../../internal";
 /** @hidden */
 declare const $mstNotCustomized: unique symbol;
 /** @hidden */
@@ -15,16 +15,16 @@ export interface ISnapshotProcessor<IT extends IAnyType, CustomC, CustomS> exten
 /**
  * Snapshot processors.
  */
-export interface ISnapshotProcessors<C, CustomC, S, CustomS> {
+export interface ISnapshotProcessors<IT extends IAnyType, CustomC, CustomS> {
     /**
      * Function that transforms an input snapshot.
      */
-    preProcessor?(snapshot: CustomC): C;
+    preProcessor?(snapshot: CustomC): IT["CreationType"];
     /**
      * Function that transforms an output snapshot.
      * @param snapshot
      */
-    postProcessor?(snapshot: S): CustomS;
+    postProcessor?(snapshot: IT["SnapshotType"], node: Instance<IT>): CustomS;
 }
 /**
  * `types.snapshotProcessor` - Runs a pre/post snapshot processor before/after serializing a given type.
@@ -36,15 +36,17 @@ export interface ISnapshotProcessors<C, CustomC, S, CustomS> {
  * interface BackendTodo {
  *     text: string | null
  * }
+ *
  * const Todo2 = types.snapshotProcessor(Todo1, {
  *     // from snapshot to instance
- *     preProcessor(sn: BackendTodo) {
+ *     preProcessor(snapshot: BackendTodo) {
  *         return {
  *             text: sn.text || "";
  *         }
  *     },
+ *
  *     // from instance to snapshot
- *     postProcessor(sn): BackendTodo {
+ *     postProcessor(snapshot, node): BackendTodo {
  *         return {
  *             text: !sn.text ? null : sn.text
  *         }
@@ -57,5 +59,5 @@ export interface ISnapshotProcessors<C, CustomC, S, CustomS> {
  * @param name Type name, or undefined to inherit the inner type one.
  * @returns
  */
-export declare function snapshotProcessor<IT extends IAnyType, CustomC = _NotCustomized, CustomS = _NotCustomized>(type: IT, processors: ISnapshotProcessors<IT["CreationType"], CustomC, IT["SnapshotType"], CustomS>, name?: string): ISnapshotProcessor<IT, CustomC, CustomS>;
+export declare function snapshotProcessor<IT extends IAnyType, CustomC = _NotCustomized, CustomS = _NotCustomized>(type: IT, processors: ISnapshotProcessors<IT, CustomC, CustomS>, name?: string): ISnapshotProcessor<IT, CustomC, CustomS>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mobx-state-tree",
-  "version": "5.3.1-alpha.1",
+  "version": "5.4.0",
   "description": "Opinionated, transactional, MobX powered state container",
   "main": "dist/mobx-state-tree.js",
   "umd:main": "dist/mobx-state-tree.umd.js",
@@ -17,7 +17,6 @@
   "scripts": {
     "clean": "shx rm -rf dist && shx rm -rf lib",
     "build": "yarn clean && tsc && cpr lib dist --filter=\\.js$ && rollup -c",
-    "jest": "jest --testPathPattern=/__tests__/core/",
     "jest:perf": "jest --testPathPattern=/__tests__/perf/",
     "test:perf": "yarn build && yarn jest:perf && TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\"}' /usr/bin/time node --expose-gc --require ts-node/register __tests__/perf/report.ts",
     "test": "yarn test:dev && yarn test:prod",