mobx-state-tree 6.0.1 → 7.0.0-pre.2

package/dist/core/type/type.d.ts

@@ -1,4 +1,5 @@
 import { IValidationContext, IValidationResult, IStateTreeNode, ModelPrimitive } from "../../internal";
+import type { WritableKeys } from "ts-essentials";
 /**
  * A state tree node value.
  * @hidden
@@ -6,6 +7,7 @@ import { IValidationContext, IValidationResult, IStateTreeNode, ModelPrimitive }
 export type STNValue<T, IT extends IAnyType> = T extends object ? T & IStateTreeNode<IT> : T;
 /** @hidden */
 declare const $type: unique symbol;
+type ExcludeReadonly<T> = T extends {} ? T[WritableKeys<T>] : T;
 /**
  * A type, either complex or simple.
  */
@@ -25,7 +27,7 @@ export interface IType<C, S, T> {
      *
      * @returns An instance of that type.
      */
-    create(snapshot?: C, env?: any): this["Type"];
+    create(snapshot?: C | ExcludeReadonly<T>, env?: any): this["Type"];
     /**
      * Checks if a given snapshot / instance is of the given type.
      *
@@ -40,7 +42,7 @@ export interface IType<C, S, T> {
      * @param context Validation context, an array of { subpaths, subtypes } that should be validated
      * @returns The validation result, an array with the list of validation errors.
      */
-    validate(thing: C, context: IValidationContext): IValidationResult;
+    validate(thing: C | T, context: IValidationContext): IValidationResult;
     /**
      * Gets the textual representation of the type as a string.
      */

package/dist/mobx-state-tree.js

@@ -4843,6 +4843,23 @@ var SnapshotProcessor = /** @class */ (function (_super) {
             return this._subtype;
         }
     });
+    /**
+     * MST considers a given value to "be" of a subtype is the value is either:
+     *
+     * 1. And instance of the subtype
+     * 2. A valid snapshot *in* of the subtype
+     *
+     * Before v7, we used to also consider processed models (as in, SnapshotOut values of this).
+     * This is no longer the case, and is more in line with our overall "is" philosophy, which you can
+     * see in `src/core/type/type.ts:104` (assuming lines don't change too much).
+     *
+     * For additonal commentary, see discussion in https://github.com/mobxjs/mobx-state-tree/pull/2182
+     *
+     * The `is` function specifically checks for `SnapshotIn` or `Instance` of a given type.
+     *
+     * @param thing
+     * @returns
+     */
     Object.defineProperty(SnapshotProcessor.prototype, "is", {
         enumerable: false,
         configurable: true,
@@ -4851,7 +4868,7 @@ var SnapshotProcessor = /** @class */ (function (_super) {
             var value = isType(thing)
                 ? this._subtype
                 : isStateTreeNode(thing)
-                    ? getSnapshot(thing, false)
+                    ? thing
                     : this.preProcessSnapshotSafe(thing);
             if (value === $preProcessorFailed) {
                 return false;