mobx-keystone 1.20.0 → 1.22.0

package/src/patch/jsonPatch.ts

@@ -1,108 +1,108 @@
-import type { Path } from "../parent/pathTypes"
-import { failure } from "../utils"
-import type { Patch } from "./Patch"
-
-export type JsonPatch =
-  | JsonPatchAddOperation<any>
-  | JsonPatchRemoveOperation
-  | JsonPatchReplaceOperation<any>
-
-export interface JsonPatchBaseOperation {
-  path: string
-}
-
-export interface JsonPatchAddOperation<T> extends JsonPatchBaseOperation {
-  op: "add"
-  value: T
-}
-
-export interface JsonPatchRemoveOperation extends JsonPatchBaseOperation {
-  op: "remove"
-}
-
-export interface JsonPatchReplaceOperation<T> extends JsonPatchBaseOperation {
-  op: "replace"
-  value: T
-}
-
-/**
- * Escapes a json pointer path.
- *
- * @param path The raw pointer
- * @return the Escaped path
- */
-function escapePathComponent(path: string | number): string {
-  if (typeof path === "number") {
-    return String(path)
-  }
-  if (!(path.includes("/") || path.includes("~"))) {
-    return path
-  }
-  return path.replace(/~/g, "~0").replace(/\//g, "~1")
-}
-
-/**
- * Unescapes a json pointer path.
- *
- * @param path The escaped pointer
- * @return The unescaped path
- */
-function unescapePathComponent(path: string): string {
-  return path.replace(/~1/g, "/").replace(/~0/g, "~")
-}
-
-/**
- * Converts a path into a JSON pointer.
- *
- * @param path Path to convert.
- * @returns Converted JSON pointer.
- */
-export function pathToJsonPointer(path: Path): string {
-  if (path.length <= 0) {
-    return ""
-  }
-  return "/" + path.map(escapePathComponent).join("/")
-}
-
-/**
- * Converts a JSON pointer into a path.
- *
- * @param jsonPointer JSON pointer to convert.
- * @returns Converted path.
- */
-export function jsonPointerToPath(jsonPointer: string): Path {
-  if (jsonPointer === "") {
-    return []
-  }
-  if (!jsonPointer.startsWith("/")) {
-    throw failure("a JSON pointer must start with '/' or be empty")
-  }
-  jsonPointer = jsonPointer.slice(1)
-  return jsonPointer.split("/").map(unescapePathComponent)
-}
-
-/**
- * Convert a patch into a JSON patch.
- *
- * @param patch A patch.
- * @returns A JSON patch.
- */
-export function patchToJsonPatch(patch: Patch): JsonPatch {
-  return {
-    ...patch,
-    path: pathToJsonPointer(patch.path),
-  }
-}
-
-/**
- * Converts a JSON patch into a patch.
- *
- * @param jsonPatch A JSON patch.
- * @returns A patch.
- */
-export function jsonPatchToPatch(jsonPatch: JsonPatch): Patch {
-  return {
-    ...jsonPatch,
-    path: jsonPointerToPath(jsonPatch.path),
-  }
-}
+import type { Path } from "../parent/pathTypes"
+import { failure } from "../utils"
+import type { Patch } from "./Patch"
+
+export type JsonPatch =
+  | JsonPatchAddOperation<any>
+  | JsonPatchRemoveOperation
+  | JsonPatchReplaceOperation<any>
+
+export interface JsonPatchBaseOperation {
+  path: string
+}
+
+export interface JsonPatchAddOperation<T> extends JsonPatchBaseOperation {
+  op: "add"
+  value: T
+}
+
+export interface JsonPatchRemoveOperation extends JsonPatchBaseOperation {
+  op: "remove"
+}
+
+export interface JsonPatchReplaceOperation<T> extends JsonPatchBaseOperation {
+  op: "replace"
+  value: T
+}
+
+/**
+ * Escapes a json pointer path.
+ *
+ * @param path The raw pointer
+ * @return the Escaped path
+ */
+function escapePathComponent(path: string | number): string {
+  if (typeof path === "number") {
+    return String(path)
+  }
+  if (!(path.includes("/") || path.includes("~"))) {
+    return path
+  }
+  return path.replace(/~/g, "~0").replace(/\//g, "~1")
+}
+
+/**
+ * Unescapes a json pointer path.
+ *
+ * @param path The escaped pointer
+ * @return The unescaped path
+ */
+function unescapePathComponent(path: string): string {
+  return path.replace(/~1/g, "/").replace(/~0/g, "~")
+}
+
+/**
+ * Converts a path into a JSON pointer.
+ *
+ * @param path Path to convert.
+ * @returns Converted JSON pointer.
+ */
+export function pathToJsonPointer(path: Path): string {
+  if (path.length <= 0) {
+    return ""
+  }
+  return "/" + path.map(escapePathComponent).join("/")
+}
+
+/**
+ * Converts a JSON pointer into a path.
+ *
+ * @param jsonPointer JSON pointer to convert.
+ * @returns Converted path.
+ */
+export function jsonPointerToPath(jsonPointer: string): Path {
+  if (jsonPointer === "") {
+    return []
+  }
+  if (!jsonPointer.startsWith("/")) {
+    throw failure("a JSON pointer must start with '/' or be empty")
+  }
+  jsonPointer = jsonPointer.slice(1)
+  return jsonPointer.split("/").map(unescapePathComponent)
+}
+
+/**
+ * Convert a patch into a JSON patch.
+ *
+ * @param patch A patch.
+ * @returns A JSON patch.
+ */
+export function patchToJsonPatch(patch: Patch): JsonPatch {
+  return {
+    ...patch,
+    path: pathToJsonPointer(patch.path),
+  }
+}
+
+/**
+ * Converts a JSON patch into a patch.
+ *
+ * @param jsonPatch A JSON patch.
+ * @returns A patch.
+ */
+export function jsonPatchToPatch(jsonPatch: JsonPatch): Patch {
+  return {
+    ...jsonPatch,
+    path: jsonPointerToPath(jsonPatch.path),
+  }
+}

package/src/patch/patchRecorder.ts

@@ -1,6 +1,11 @@
 import { observable } from "mobx"
 import { assertTweakedObject } from "../tweaker/core"
-import { onGlobalPatches, onPatches, OnPatchesDisposer, OnPatchesListener } from "./emitPatch"
+import {
+  type OnPatchesDisposer,
+  type OnPatchesListener,
+  onGlobalPatches,
+  onPatches,
+} from "./emitPatch"
 import type { Patch } from "./Patch"
 
 /**

package/src/redux/connectReduxDevTools.ts

@@ -2,33 +2,49 @@ import { ActionContextActionType } from "../action"
 import {
   ActionTrackingResult,
   actionTrackingMiddleware,
-  SimpleActionContext,
+  type SimpleActionContext,
 } from "../actionMiddlewares"
-import { fastGetRootPath, RootPath } from "../parent/path"
+import { fastGetRootPath, type RootPath } from "../parent/path"
 import { applySnapshot } from "../snapshot/applySnapshot"
 import { getSnapshot } from "../snapshot/getSnapshot"
 import { assertTweakedObject } from "../tweaker/core"
 
+export interface ConnectReduxDevToolsOptions {
+  /**
+   * If it should show the arguments near the action name.
+   *
+   * @default true
+   */
+  logArgsNearName?: boolean
+
+  /**
+   * If it should log child actions when they run inside another action tracked
+   * by the same target tree.
+   *
+   * @default true
+   */
+  logChildActions?: boolean
+}
+
 /**
  * Connects a tree node to a redux dev tools instance.
  *
  * @param remotedevPackage The remotedev package (usually the result of `require("remoteDev")`) (https://www.npmjs.com/package/remotedev).
  * @param remotedevConnection The result of a connect method from the remotedev package (usually the result of `remoteDev.connectViaExtension(...)`).
  * @param target Object to use as root.
- * @param [options] Optional options object. `logArgsNearName` if it should show the arguments near the action name (default is `true`).
+ * @param [options] Optional options object.
  */
 export function connectReduxDevTools(
   remotedevPackage: any,
   remotedevConnection: any,
   target: object,
-  options?: {
-    logArgsNearName?: boolean
-  }
+  options?: ConnectReduxDevToolsOptions
 ) {
   assertTweakedObject(target, "target")
 
   const opts = {
     logArgsNearName: true,
+    logChildActions: true,
     ...options,
   }
 
@@ -48,12 +64,15 @@ export function connectReduxDevTools(
   const actionIdSymbol = Symbol("actionId")
 
   actionTrackingMiddleware(target, {
+    filter(ctx) {
+      return opts.logChildActions || !hasDevToolsTrackedParentContext(ctx)
+    },
     onStart(ctx) {
       ctx.data[actionIdSymbol] = currentActionId++
     },
     onResume(ctx) {
       // give a chance to the parent to log its own changes before the child starts
-      if (ctx.parentContext) {
+      if (opts.logChildActions && ctx.parentContext) {
         log(ctx.parentContext, undefined)
       }
       log(ctx, undefined)
@@ -184,4 +203,17 @@ export function connectReduxDevTools(
 
     return name
   }
+
+  function hasDevToolsTrackedParentContext(ctx: SimpleActionContext) {
+    let parentContext = ctx.parentContext
+
+    while (parentContext) {
+      if (parentContext.data[actionIdSymbol] !== undefined) {
+        return true
+      }
+      parentContext = parentContext.parentContext
+    }
+
+    return false
+  }
 }

package/src/redux/redux.ts

@@ -1,6 +1,10 @@
-import { ActionCall, applyAction } from "../action"
+import { type ActionCall, applyAction } from "../action"
 import { getSnapshot } from "../snapshot/getSnapshot"
-import { onSnapshot, OnSnapshotDisposer, OnSnapshotListener } from "../snapshot/onSnapshot"
+import {
+  type OnSnapshotDisposer,
+  type OnSnapshotListener,
+  onSnapshot,
+} from "../snapshot/onSnapshot"
 import type { SnapshotOutOf } from "../snapshot/SnapshotOf"
 import { assertTweakedObject } from "../tweaker/core"
 import { failure } from "../utils"

package/src/ref/Ref.ts

@@ -1,6 +1,6 @@
 import { computed } from "mobx"
-import { modelTypeKey } from "../model/metadata"
 import { Model } from "../model/Model"
+import { modelTypeKey } from "../model/metadata"
 import type { ModelClass } from "../modelShared/BaseModelShared"
 import { typesString } from "../types/primitiveBased/typesPrimitive"
 import { tProp } from "../types/tProp"