mobx-keystone 1.24.0 → 1.25.0

package/src/snapshot/reconcileModelSnapshot.ts

@@ -1,4 +1,4 @@
-import { remove } from "mobx"
+import { remove, set } from "mobx"
 import type { AnyModel } from "../model/BaseModel"
 import { getModelIdPropertyName } from "../model/getModelMetadata"
 import { isReservedModelKey, modelIdKey, modelTypeKey } from "../model/metadata"
@@ -17,7 +17,7 @@ import {
   runTypeCheckingAfterChange,
 } from "../tweaker/typeChecking"
 import { withoutTypeChecking } from "../tweaker/withoutTypeChecking"
-import { isArray } from "../utils"
+import { isArray, isPrimitive } from "../utils"
 import { withErrorModelTrailEntry, withErrorPathSegment } from "../utils/errorDiagnostics"
 import type { ModelPool } from "../utils/ModelPool"
 import { setIfDifferent } from "../utils/setIfDifferent"
@@ -51,7 +51,7 @@ function reconcileModelSnapshot(
   // the canonical output snapshot. A successful canonical no-op therefore
   // cannot produce a diagnostic, so keep this hottest path outside the
   // model-trail bookkeeping and defer id metadata until needed. The
-  // positional value was already flushed by the getSnapshot call in
+  // positional value was already flushed by the internal snapshot read in
   // reconcileSnapshot, so its transformed snapshot is current.
   if (isCanonicalSnapshotNoOp(value, type, sn)) {
     return value
@@ -157,6 +157,14 @@ function reconcileModelSnapshot(
           const v = processedSn[k]
 
           const oldValue = data[k]
+          // Non-null primitives need neither reconciliation nor detachment.
+          // Nullish values must still pass through default handling below.
+          if (v != null && isPrimitive(v)) {
+            if (v !== oldValue) {
+              set(data, k, v)
+            }
+            continue
+          }
           let newValue = withErrorPathSegment(k, () =>
             reconcileSnapshot(oldValue, v, modelPool, modelObj)
           )

package/src/snapshot/reconcileSnapshot.ts

@@ -5,6 +5,7 @@ import { fastGetParentPathIncludingDataObjects } from "../parent"
 import { isMap, isPrimitive, isSet } from "../utils"
 import type { ModelPool } from "../utils/ModelPool"
 import { getSnapshot } from "./getSnapshot"
+import { flushInternalSnapshot, getInternalSnapshot } from "./internal"
 import { registerDefaultReconcilers } from "./registerDefaultReconcilers"
 import { SnapshotProcessingError } from "./SnapshotProcessingError"
 
@@ -28,10 +29,18 @@ export function reconcileSnapshot(value: any, sn: any, modelPool: ModelPool, par
     return sn
   }
 
-  // if the snapshot passed is exactly the same as the current one
-  // then it is already reconciled
-  if (getSnapshot(value) === sn) {
-    return value
+  // Unlike getSnapshot, this comparison never exposes the snapshot, so it needs
+  // neither freezing nor observation registration.
+  const currentSnapshot = getInternalSnapshot(value)
+  if (currentSnapshot) {
+    flushInternalSnapshot(value, false)
+    if (currentSnapshot.transformed === sn) {
+      return value
+    }
+  } else if (!isPrimitive(value)) {
+    // A non-primitive without an internal snapshot is not a valid reconciliation
+    // target (e.g. a non-node object); let getSnapshot raise the proper error.
+    getSnapshot(value)
   }
 
   registerDefaultReconcilers()

package/src/tweaker/tweak.ts

@@ -86,16 +86,11 @@ export function registerTweaker<T>(priority: number, tweaker: Tweaker<T>): void
 }
 
 function internalTweak<T>(value: T, parentPath: ParentPath<any> | undefined): T {
-  if (isPrimitive(value)) {
-    return value
-  }
-
   // already tweaked
   if (isTweakedObject(value, true)) {
     value = setParent(
       value,
       parentPath,
-      false, // indexChangeAllowed
       false, // isDataObject
       true // cloneIfApplicable
     )
@@ -135,10 +130,15 @@ function internalTweak<T>(value: T, parentPath: ParentPath<any> | undefined): T
   )
 }
 
+const tweakNonPrimitive = action("tweak", internalTweak)
+
 /**
  * @internal
  */
-export const tweak = action("tweak", internalTweak)
+export function tweak<T>(value: T, parentPath: ParentPath<any> | undefined): T {
+  // Primitives need no tree bookkeeping or MobX action boundary.
+  return isPrimitive(value) ? value : tweakNonPrimitive(value, parentPath)
+}
 
 /**
  * @internal
@@ -169,7 +169,6 @@ export function tryUntweak(value: any): (() => void) | undefined {
     setParent(
       children[i], // value
       undefined, // parentPath
-      false, // indexChangeAllowed
       false, // isDataObject
       // no need to clone if unsetting the parent
       false // cloneIfApplicable

package/src/tweaker/tweakArray.ts

@@ -12,7 +12,7 @@ import { assertCanWrite } from "../action/protection"
 import { emitArraySpliceDeepChange, emitArrayUpdateDeepChange } from "../deepChange/onDeepChange"
 import { getGlobalConfig } from "../globalConfig"
 import type { ParentPath } from "../parent/path"
-import { setParent } from "../parent/setParent"
+import { reindexArrayChildren, setParent } from "../parent/setParent"
 import { hasPatchListenersFor, InternalPatchRecorder } from "../patch/emitPatch"
 import type { Patch } from "../patch/Patch"
 import {
@@ -62,7 +62,6 @@ export function tweakArray<T extends any[]>(
   setParent(
     tweakedArr, // value
     parentPath,
-    false, // indexChangeAllowed
     false, // isDataObject
     // arrays shouldn't be cloned anyway
     false // cloneIfApplicable
@@ -97,7 +96,6 @@ export function tweakArray<T extends any[]>(
         setParent(
           tweakedValue, // value
           path, // parentPath
-          false, // indexChangeAllowed
           false, // isDataObject
           // the value is already a new value (the result of a fromSnapshot)
           false // cloneIfApplicable
@@ -482,20 +480,8 @@ function interceptArrayMutationSplice(change: IArrayWillSplice) {
   const oldNextIndex = change.index + change.removedCount
   const newNextIndex = change.index + change.added.length
 
-  if (oldNextIndex !== newNextIndex) {
-    for (let i = oldNextIndex, j = newNextIndex; i < change.object.length; i++, j++) {
-      setParent(
-        change.object[i], // value
-        {
-          parent: change.object,
-          path: j,
-        }, // parentPath
-        true, // indexChangeAllowed
-        false, // isDataObject
-        // just re-indexing
-        false // cloneIfApplicable
-      )
-    }
+  if (oldNextIndex !== newNextIndex && oldNextIndex < change.object.length) {
+    reindexArrayChildren(change.object, oldNextIndex, newNextIndex)
   }
 }
 

package/src/tweaker/tweakFrozen.ts

@@ -17,7 +17,6 @@ export function tweakFrozen<T extends Frozen<any>>(
   setParent(
     frozenObj, // value
     parentPath,
-    false, // indexChangeAllowed
     false, // isDataObject
     // a frozen is not a value-type
     false // cloneIfApplicable

package/src/tweaker/tweakModel.ts

@@ -13,7 +13,6 @@ export function tweakModel<T extends object>(value: T, parentPath: ParentPath<an
   setParent(
     value,
     parentPath,
-    false, // indexChangeAllowed
     false, // isDataObject
     true // cloneIfApplicable
   )

package/src/tweaker/tweakPlainObject.ts

@@ -59,7 +59,6 @@ export function tweakPlainObject<T extends Record<string, any>>(
   setParent(
     tweakedObj, // value
     parentPath,
-    false, // indexChangeAllowed
     isDataObject,
     // an object shouldn't be cloned
     false // cloneIfApplicable
@@ -67,12 +66,10 @@ export function tweakPlainObject<T extends Record<string, any>>(
 
   const initialDataSnapshot =
     isDataObject && snapshotModelType ? takeModelInitialDataSnapshot(tweakedObj) : undefined
-  const reuseInitialDataSnapshot =
-    !!initialDataSnapshot?.reusable && initialDataSnapshot.allValuesPrimitive
-  const untransformedSn: any = reuseInitialDataSnapshot ? initialDataSnapshot.snapshot : {}
+  const untransformedSn: any = initialDataSnapshot ?? {}
 
   // substitute initial values by tweaked values
-  const originalObjKeys = reuseInitialDataSnapshot ? [] : Object.keys(originalObj)
+  const originalObjKeys = initialDataSnapshot ? [] : Object.keys(originalObj)
   const originalObjKeysLen = originalObjKeys.length
   for (let i = 0; i < originalObjKeysLen; i++) {
     const k = originalObjKeys[i]
@@ -96,7 +93,6 @@ export function tweakPlainObject<T extends Record<string, any>>(
         setParent(
           tweakedValue, // value
           path, // parentPath
-          false, // indexChangeAllowed
           false, // isDataObject
           // the value is already a new value (the result of a fromSnapshot)
           false // cloneIfApplicable

package/src/tweaker/typeChecking.ts

@@ -3,8 +3,7 @@ import type { AnyModel } from "../model/BaseModel"
 import { getModelMetadata } from "../model/getModelMetadata"
 import { isModel } from "../model/utils"
 import { dataToModelNode } from "../parent/core"
-import { fastGetParentPathIncludingDataObjects } from "../parent/path"
-import type { PathElement } from "../parent/pathTypes"
+import { fastGetParent } from "../parent/path"
 import { internalApplyPatches } from "../patch/applyPatches"
 import type { InternalPatchRecorder } from "../patch/emitPatch"
 import { internalApplySnapshot } from "../snapshot/applySnapshot"
@@ -39,29 +38,20 @@ function isModelWithTypeChecker(obj: object): obj is AnyModel {
  */
 function forEachTypedModelAncestor(obj: object, callback: (model: AnyModel) => void): void {
   // obj might be a $ data object, so resolve to the model if applicable
-  let current: object | undefined = dataToModelNode(obj)
-  let lastAncestor: AnyModel | undefined
+  const start = dataToModelNode(obj)
 
   // If we started from a $ data object, check the model itself
-  if (current !== obj && isModelWithTypeChecker(current)) {
-    lastAncestor = current
-    callback(current)
+  if (start !== obj && isModelWithTypeChecker(start)) {
+    callback(start)
   }
 
-  // Walk up parent chain
-  while (current !== undefined) {
-    const parentPath: { parent: object; path: PathElement } | undefined =
-      fastGetParentPathIncludingDataObjects(current, false)
-    if (!parentPath) break
-
-    const parent: object = parentPath.parent
-
-    if (isModelWithTypeChecker(parent) && parent !== lastAncestor) {
-      lastAncestor = parent
+  // Raw parents never point to model $ objects, so each model is visited once.
+  let parent: object | undefined = fastGetParent(start, false)
+  while (parent) {
+    if (isModelWithTypeChecker(parent)) {
       callback(parent)
     }
-
-    current = parent
+    parent = fastGetParent(parent, false)
   }
 }
 

package/src/types/TypeChecker.ts

@@ -6,7 +6,7 @@ import type { TypeCheckError } from "./TypeCheckError"
 
 type CheckFunction = (value: any, path: Path, typeCheckedValue: any) => TypeCheckError | null
 
-/** @internal */
+/** @ignore */
 export type SnapshotProcessor = (snapshot: any) => unknown
 
 /**
@@ -14,7 +14,7 @@ export type SnapshotProcessor = (snapshot: any) => unknown
  * TypeCheckers rather than processors so recursive graphs can be discovered
  * before any processor body is compiled.
  *
- * @internal
+ * @ignore
  */
 export interface SnapshotProcessorPlan {
   readonly intrinsic?: boolean
@@ -36,7 +36,7 @@ export function snapshotProcessorPlan(
 type SnapshotProcessorSource = SnapshotProcessor | SnapshotProcessorPlan | undefined
 type SnapshotProcessorDirection = "from" | "to"
 
-/** @internal */
+/** @ignore */
 export class SnapshotProcessorPlanNode {
   private readonly owner: TypeChecker | undefined
   private readonly direction: SnapshotProcessorDirection
@@ -196,7 +196,7 @@ export class SnapshotProcessorPlanNode {
 const absentSnapshotProcessorPlanNode = new SnapshotProcessorPlanNode(undefined, "from", undefined)
 
 /**
- * @internal
+ * @ignore
  */
 export enum TypeCheckerBaseType {
   Object = "object",
@@ -243,7 +243,7 @@ export function invalidateCachedToSnapshotProcessorResult(obj: object) {
 }
 
 /**
- * @internal
+ * @ignore
  */
 export class TypeChecker {
   unchecked: boolean
@@ -443,6 +443,6 @@ export class TypeInfo {
 }
 
 /**
- * @internal
+ * @ignore
  */
 export type TypeInfoGen = (t: AnyStandardType) => TypeInfo

package/src/types/schemas.ts

@@ -64,7 +64,7 @@ export interface ObjectOfTypes {
 
 /**
  * Name of the properties of an object that can be set to undefined, any or unknown.
- * @internal
+ * @ignore
  */
 export type UndefinablePropsNames<T> = {
   [K in keyof T]: IsOptionalValue<T[K], K, never>
@@ -72,7 +72,7 @@ export type UndefinablePropsNames<T> = {
 
 /**
  * Computes the optional keys for an object type schema.
- * @internal
+ * @ignore
  */
 export type ObjectOptionalKeys<S> = UndefinablePropsNames<{
   [k in keyof S]: TypeToDataOpt<S[k]> extends infer R ? R : never