mobx-keystone 1.20.0 → 1.22.0

package/src/frozen/Frozen.ts

@@ -1,146 +1,146 @@
-import { isObservable, toJS } from "mobx"
-import { getGlobalConfig } from "../globalConfig"
-import type { FrozenData } from "../snapshot"
-import { tweak } from "../tweaker/tweak"
-import { failure, inDevMode, isPlainObject, isPrimitive } from "../utils"
-
-/**
- * Should freeze and plain json checks be done when creating the frozen object?
- */
-export enum FrozenCheckMode {
-  /** Only when in dev mode */
-  DevModeOnly = "devModeOnly",
-  /** Always */
-  On = "on",
-  /** Never */
-  Off = "off",
-}
-
-/**
- * @ignore
- */
-export const frozenKey = "$frozen"
-
-/**
- * A class that contains frozen data.
- * Use `frozen` to create an instance of this class.
- *
- * @template T Data type.
- */
-export class Frozen<T> {
-  /**
-   * Frozen data, deeply immutable.
-   */
-  readonly data: T
-
-  /**
-   * Creates an instance of Frozen.
-   * Do not use directly, use `frozen` instead.
-   *
-   * @param dataToFreeze
-   * @param checkMode
-   */
-  constructor(dataToFreeze: T, checkMode: FrozenCheckMode = FrozenCheckMode.DevModeOnly) {
-    if (isObservable(dataToFreeze)) {
-      dataToFreeze = toJS(dataToFreeze)
-    }
-
-    const check =
-      checkMode === FrozenCheckMode.On || (inDevMode && checkMode === FrozenCheckMode.DevModeOnly)
-    if (check) {
-      checkDataIsSerializableAndFreeze(dataToFreeze)
-    }
-
-    this.data = dataToFreeze
-
-    if (check) {
-      Object.freeze(this.data)
-    }
-
-    tweak(this, undefined)
-  }
-}
-
-/**
- * Marks some data as frozen. Frozen data becomes immutable (at least in dev mode), and is not enhanced
- * with capabilities such as getting the parent of the objects (except for the root object), it is not
- * made deeply observable (though the root object is observable by reference), etc.
- * On the other hand, this means it will be much faster to create/access. Use this for big data pieces
- * that are unlikely to change unless all of them change (for example lists of points for a polygon, etc).
- *
- * Note that data passed to frozen must be serializable to JSON, this is:
- * - primitive, plain object, or array
- * - without cycles
- *
- * @param data
- * @param checkMode
- */
-export function frozen<T>(
-  data: T,
-  checkMode: FrozenCheckMode = FrozenCheckMode.DevModeOnly
-): Frozen<T> {
-  return new Frozen<T>(data, checkMode)
-}
-
-/**
- * Converts some data into a frozen snapshot.
- *
- * @param data Data to convert.
- * @returns The frozen snapshot.
- */
-export function toFrozenSnapshot<T>(data: T): FrozenData<T> {
-  return {
-    [frozenKey]: true,
-    data,
-  }
-}
-
-function checkDataIsSerializableAndFreeze(data: any) {
-  // TODO: detect cycles and throw if present?
-
-  // primitives are ok
-  if (isPrimitive(data)) {
-    return
-  }
-
-  if (Array.isArray(data)) {
-    const arrLen = data.length
-    for (let i = 0; i < arrLen; i++) {
-      const v = data[i]
-      if (v === undefined && !getGlobalConfig().allowUndefinedArrayElements) {
-        throw failure(
-          "undefined is not supported inside arrays since it is not serializable in JSON, consider using null instead"
-        )
-      }
-      checkDataIsSerializableAndFreeze(v)
-    }
-    Object.freeze(data)
-    return
-  }
-
-  if (isPlainObject(data)) {
-    const dataKeys = Object.keys(data)
-    const dataKeysLen = dataKeys.length
-    for (let i = 0; i < dataKeysLen; i++) {
-      const k = dataKeys[i]
-      const v = data[k]
-
-      checkDataIsSerializableAndFreeze(k)
-      checkDataIsSerializableAndFreeze(v)
-    }
-    Object.freeze(data)
-    return
-  }
-
-  throw failure(`frozen data must be plainly serializable to JSON, but ${data} is not`)
-}
-
-/**
- * Checks if an snapshot is an snapshot for a frozen data.
- *
- * @param snapshot
- * @returns
- */
-export function isFrozenSnapshot<T = unknown>(snapshot: unknown): snapshot is FrozenData<T> {
-  return isPlainObject(snapshot) && frozenKey in snapshot
-}
+import { isObservable, toJS } from "mobx"
+import { getGlobalConfig } from "../globalConfig"
+import type { FrozenData } from "../snapshot"
+import { tweak } from "../tweaker/tweak"
+import { failure, inDevMode, isPlainObject, isPrimitive } from "../utils"
+
+/**
+ * Should freeze and plain json checks be done when creating the frozen object?
+ */
+export enum FrozenCheckMode {
+  /** Only when in dev mode */
+  DevModeOnly = "devModeOnly",
+  /** Always */
+  On = "on",
+  /** Never */
+  Off = "off",
+}
+
+/**
+ * @ignore
+ */
+export const frozenKey = "$frozen"
+
+/**
+ * A class that contains frozen data.
+ * Use `frozen` to create an instance of this class.
+ *
+ * @template T Data type.
+ */
+export class Frozen<T> {
+  /**
+   * Frozen data, deeply immutable.
+   */
+  readonly data: T
+
+  /**
+   * Creates an instance of Frozen.
+   * Do not use directly, use `frozen` instead.
+   *
+   * @param dataToFreeze
+   * @param checkMode
+   */
+  constructor(dataToFreeze: T, checkMode: FrozenCheckMode = FrozenCheckMode.DevModeOnly) {
+    if (isObservable(dataToFreeze)) {
+      dataToFreeze = toJS(dataToFreeze)
+    }
+
+    const check =
+      checkMode === FrozenCheckMode.On || (inDevMode && checkMode === FrozenCheckMode.DevModeOnly)
+    if (check) {
+      checkDataIsSerializableAndFreeze(dataToFreeze)
+    }
+
+    this.data = dataToFreeze
+
+    if (check) {
+      Object.freeze(this.data)
+    }
+
+    tweak(this, undefined)
+  }
+}
+
+/**
+ * Marks some data as frozen. Frozen data becomes immutable (at least in dev mode), and is not enhanced
+ * with capabilities such as getting the parent of the objects (except for the root object), it is not
+ * made deeply observable (though the root object is observable by reference), etc.
+ * On the other hand, this means it will be much faster to create/access. Use this for big data pieces
+ * that are unlikely to change unless all of them change (for example lists of points for a polygon, etc).
+ *
+ * Note that data passed to frozen must be serializable to JSON, this is:
+ * - primitive, plain object, or array
+ * - without cycles
+ *
+ * @param data
+ * @param checkMode
+ */
+export function frozen<T>(
+  data: T,
+  checkMode: FrozenCheckMode = FrozenCheckMode.DevModeOnly
+): Frozen<T> {
+  return new Frozen<T>(data, checkMode)
+}
+
+/**
+ * Converts some data into a frozen snapshot.
+ *
+ * @param data Data to convert.
+ * @returns The frozen snapshot.
+ */
+export function toFrozenSnapshot<T>(data: T): FrozenData<T> {
+  return {
+    [frozenKey]: true,
+    data,
+  }
+}
+
+function checkDataIsSerializableAndFreeze(data: any) {
+  // TODO: detect cycles and throw if present?
+
+  // primitives are ok
+  if (isPrimitive(data)) {
+    return
+  }
+
+  if (Array.isArray(data)) {
+    const arrLen = data.length
+    for (let i = 0; i < arrLen; i++) {
+      const v = data[i]
+      if (v === undefined && !getGlobalConfig().allowUndefinedArrayElements) {
+        throw failure(
+          "undefined is not supported inside arrays since it is not serializable in JSON, consider using null instead"
+        )
+      }
+      checkDataIsSerializableAndFreeze(v)
+    }
+    Object.freeze(data)
+    return
+  }
+
+  if (isPlainObject(data)) {
+    const dataKeys = Object.keys(data)
+    const dataKeysLen = dataKeys.length
+    for (let i = 0; i < dataKeysLen; i++) {
+      const k = dataKeys[i]
+      const v = data[k]
+
+      checkDataIsSerializableAndFreeze(k)
+      checkDataIsSerializableAndFreeze(v)
+    }
+    Object.freeze(data)
+    return
+  }
+
+  throw failure(`frozen data must be plainly serializable to JSON, but ${data} is not`)
+}
+
+/**
+ * Checks if an snapshot is an snapshot for a frozen data.
+ *
+ * @param snapshot
+ * @returns
+ */
+export function isFrozenSnapshot<T = unknown>(snapshot: unknown): snapshot is FrozenData<T> {
+  return isPlainObject(snapshot) && frozenKey in snapshot
+}

package/src/globalConfig/globalConfig.ts

@@ -1,107 +1,107 @@
-import { nanoid } from "nanoid/non-secure"
-import { failure, inDevMode } from "../utils"
-
-/**
- * Model auto type-checking mode.
- */
-export enum ModelAutoTypeCheckingMode {
-  /**
-   * Auto type check models only in dev mode
-   */
-  DevModeOnly = "devModeOnly",
-  /**
-   * Auto type check models no matter the current environment
-   */
-  AlwaysOn = "alwaysOn",
-  /**
-   * Do not auto type check models no matter the current environment
-   */
-  AlwaysOff = "alwaysOff",
-}
-
-/**
- * Global config object.
- */
-export interface GlobalConfig {
-  /**
-   * Model auto type-checking mode.
-   */
-  modelAutoTypeChecking: ModelAutoTypeCheckingMode
-
-  /**
-   * ID generator function for model ids.
-   */
-  modelIdGenerator(): string
-
-  /**
-   * Allow array elements to be `undefined`.
-   */
-  allowUndefinedArrayElements: boolean
-
-  /**
-   * Enables/disables warnings related to duplicated model names (defaults to `true`).
-   * Usually set to false in test environments (e.g. vitest).
-   */
-  showDuplicateModelNameWarnings: boolean
-}
-
-let localId = 0
-const localBaseId = nanoid()
-
-function defaultModelIdGenerator(): string {
-  // we use base 36 for local id since it is short and fast
-  const id = localId.toString(36) + "-" + localBaseId
-  localId++
-  return id
-}
-
-// defaults
-let globalConfig: GlobalConfig = {
-  modelAutoTypeChecking: ModelAutoTypeCheckingMode.DevModeOnly,
-  modelIdGenerator: defaultModelIdGenerator,
-  allowUndefinedArrayElements: false,
-  showDuplicateModelNameWarnings: true,
-}
-
-/**
- * Partially sets the current global config.
- *
- * @param config Partial object with the new configurations. Options not included in the object won't be changed.
- */
-export function setGlobalConfig(config: Partial<GlobalConfig>) {
-  globalConfig = Object.freeze({
-    ...globalConfig,
-    ...config,
-  })
-}
-
-/**
- * Returns the current global config object.
- *
- * @returns
- */
-export function getGlobalConfig(): Readonly<GlobalConfig> {
-  return globalConfig
-}
-
-/**
- * @internal
- *
- * Returns if the auto type checking for models is enabled.
- *
- * @returns
- */
-export function isModelAutoTypeCheckingEnabled() {
-  switch (getGlobalConfig().modelAutoTypeChecking) {
-    case ModelAutoTypeCheckingMode.DevModeOnly:
-      return inDevMode
-    case ModelAutoTypeCheckingMode.AlwaysOff:
-      return false
-    case ModelAutoTypeCheckingMode.AlwaysOn:
-      return true
-    default:
-      throw failure(
-        `invalid 'modelAutoTypeChecking' config value - ${globalConfig.modelAutoTypeChecking}`
-      )
-  }
-}
+import { nanoid } from "nanoid/non-secure"
+import { failure, inDevMode } from "../utils"
+
+/**
+ * Model auto type-checking mode.
+ */
+export enum ModelAutoTypeCheckingMode {
+  /**
+   * Auto type check models only in dev mode
+   */
+  DevModeOnly = "devModeOnly",
+  /**
+   * Auto type check models no matter the current environment
+   */
+  AlwaysOn = "alwaysOn",
+  /**
+   * Do not auto type check models no matter the current environment
+   */
+  AlwaysOff = "alwaysOff",
+}
+
+/**
+ * Global config object.
+ */
+export interface GlobalConfig {
+  /**
+   * Model auto type-checking mode.
+   */
+  modelAutoTypeChecking: ModelAutoTypeCheckingMode
+
+  /**
+   * ID generator function for model ids.
+   */
+  modelIdGenerator(): string
+
+  /**
+   * Allow array elements to be `undefined`.
+   */
+  allowUndefinedArrayElements: boolean
+
+  /**
+   * Enables/disables warnings related to duplicated model names (defaults to `true`).
+   * Usually set to false in test environments (e.g. vitest).
+   */
+  showDuplicateModelNameWarnings: boolean
+}
+
+let localId = 0
+const localBaseId = nanoid()
+
+function defaultModelIdGenerator(): string {
+  // we use base 36 for local id since it is short and fast
+  const id = localId.toString(36) + "-" + localBaseId
+  localId++
+  return id
+}
+
+// defaults
+let globalConfig: GlobalConfig = {
+  modelAutoTypeChecking: ModelAutoTypeCheckingMode.DevModeOnly,
+  modelIdGenerator: defaultModelIdGenerator,
+  allowUndefinedArrayElements: false,
+  showDuplicateModelNameWarnings: true,
+}
+
+/**
+ * Partially sets the current global config.
+ *
+ * @param config Partial object with the new configurations. Options not included in the object won't be changed.
+ */
+export function setGlobalConfig(config: Partial<GlobalConfig>) {
+  globalConfig = Object.freeze({
+    ...globalConfig,
+    ...config,
+  })
+}
+
+/**
+ * Returns the current global config object.
+ *
+ * @returns
+ */
+export function getGlobalConfig(): Readonly<GlobalConfig> {
+  return globalConfig
+}
+
+/**
+ * @internal
+ *
+ * Returns if the auto type checking for models is enabled.
+ *
+ * @returns
+ */
+export function isModelAutoTypeCheckingEnabled() {
+  switch (getGlobalConfig().modelAutoTypeChecking) {
+    case ModelAutoTypeCheckingMode.DevModeOnly:
+      return inDevMode
+    case ModelAutoTypeCheckingMode.AlwaysOff:
+      return false
+    case ModelAutoTypeCheckingMode.AlwaysOn:
+      return true
+    default:
+      throw failure(
+        `invalid 'modelAutoTypeChecking' config value - ${globalConfig.modelAutoTypeChecking}`
+      )
+  }
+}

package/src/index.ts

@@ -1,24 +1,24 @@
-export * from "./action"
-export * from "./actionMiddlewares"
-export * from "./computedTree"
-export * from "./context"
-export * from "./dataModel"
-export * from "./deepChange"
-export * from "./frozen"
-export * from "./globalConfig"
-export * from "./model"
-export * from "./modelShared"
-export * from "./parent"
-export * from "./patch"
-export * from "./redux"
-export * from "./ref"
-export * from "./rootStore"
-export * from "./snapshot"
-export * from "./standardActions"
-export * from "./transforms"
-export * from "./treeUtils"
-export * from "./tweaker"
-export * from "./types"
-export * from "./utils"
-export * from "./utils/tag"
-export * from "./wrappers"
+export * from "./action"
+export * from "./actionMiddlewares"
+export * from "./computedTree"
+export * from "./context"
+export * from "./dataModel"
+export * from "./deepChange"
+export * from "./frozen"
+export * from "./globalConfig"
+export * from "./model"
+export * from "./modelShared"
+export * from "./parent"
+export * from "./patch"
+export * from "./redux"
+export * from "./ref"
+export * from "./rootStore"
+export * from "./snapshot"
+export * from "./standardActions"
+export * from "./transforms"
+export * from "./treeUtils"
+export * from "./tweaker"
+export * from "./types"
+export * from "./utils"
+export * from "./utils/tag"
+export * from "./wrappers"