mobx-keystone 1.20.0 → 1.22.0

package/src/types/objectBased/typesRef.ts

@@ -1,89 +1,89 @@
-import { modelTypeKey } from "../../model/metadata"
-import { modelInfoByClass } from "../../modelShared/modelInfo"
-import { Ref, RefConstructor } from "../../ref/Ref"
-import { isObject } from "../../utils"
-import { typesString } from "../primitiveBased/typesPrimitive"
-import { resolveTypeChecker } from "../resolveTypeChecker"
-import type { ModelType } from "../schemas"
-import { TypeCheckError } from "../TypeCheckError"
-import { TypeChecker, TypeCheckerBaseType, TypeInfo } from "../TypeChecker"
-import { typesObject } from "./typesObject"
-
-/**
- * A type that represents a reference to an object or model.
- *
- * Example:
- * ```ts
- * const refToSomeObject = types.ref(SomeObject)
- * ```
- *
- * @template O Object or model type.
- * @param refConstructor Ref object type.
- * @returns
- */
-export function typesRef<O extends object>(refConstructor: RefConstructor<O>): ModelType<Ref<O>> {
-  const typeName = "Ref"
-
-  const modelInfo = modelInfoByClass.get(refConstructor.refClass)!
-
-  const refDataTypeChecker = resolveTypeChecker(
-    typesObject(() => ({
-      id: typesString,
-    }))
-  )
-
-  const thisTc: TypeChecker = new TypeChecker(
-    TypeCheckerBaseType.Object,
-
-    (value, path, typeCheckedValue) => {
-      if (!(value instanceof Ref)) {
-        return new TypeCheckError({
-          path,
-          expectedTypeName: typeName,
-          actualValue: value,
-          typeCheckedValue,
-        })
-      }
-
-      return refDataTypeChecker.check(value.$, path, typeCheckedValue)
-    },
-
-    () => typeName,
-    (t) => new RefTypeInfo(t),
-
-    (obj) => {
-      if (!isObject(obj)) {
-        return null
-      }
-
-      if (obj[modelTypeKey] !== undefined) {
-        // fast check
-        return obj[modelTypeKey] === modelInfo.name ? thisTc : null
-      }
-
-      return refDataTypeChecker.snapshotType(obj) ? thisTc : null
-    },
-
-    (sn: Record<string, unknown>) => {
-      if (sn[modelTypeKey]) {
-        return sn
-      } else {
-        return {
-          ...sn,
-          [modelTypeKey]: modelInfo.name,
-        }
-      }
-    },
-
-    (sn) => sn
-  )
-
-  return thisTc as any
-}
-
-/**
- * `types.ref` type info.
- */
-export class RefTypeInfo extends TypeInfo {
-  readonly kind = "ref"
-}
+import { modelTypeKey } from "../../model/metadata"
+import { modelInfoByClass } from "../../modelShared/modelInfo"
+import { Ref, type RefConstructor } from "../../ref/Ref"
+import { isObject } from "../../utils"
+import { typesString } from "../primitiveBased/typesPrimitive"
+import { resolveTypeChecker } from "../resolveTypeChecker"
+import type { ModelType } from "../schemas"
+import { TypeCheckError } from "../TypeCheckError"
+import { TypeChecker, TypeCheckerBaseType, TypeInfo } from "../TypeChecker"
+import { typesObject } from "./typesObject"
+
+/**
+ * A type that represents a reference to an object or model.
+ *
+ * Example:
+ * ```ts
+ * const refToSomeObject = types.ref(SomeObject)
+ * ```
+ *
+ * @template O Object or model type.
+ * @param refConstructor Ref object type.
+ * @returns
+ */
+export function typesRef<O extends object>(refConstructor: RefConstructor<O>): ModelType<Ref<O>> {
+  const typeName = "Ref"
+
+  const modelInfo = modelInfoByClass.get(refConstructor.refClass)!
+
+  const refDataTypeChecker = resolveTypeChecker(
+    typesObject(() => ({
+      id: typesString,
+    }))
+  )
+
+  const thisTc: TypeChecker = new TypeChecker(
+    TypeCheckerBaseType.Object,
+
+    (value, path, typeCheckedValue) => {
+      if (!(value instanceof Ref)) {
+        return new TypeCheckError({
+          path,
+          expectedTypeName: typeName,
+          actualValue: value,
+          typeCheckedValue,
+        })
+      }
+
+      return refDataTypeChecker.check(value.$, path, typeCheckedValue)
+    },
+
+    () => typeName,
+    (t) => new RefTypeInfo(t),
+
+    (obj) => {
+      if (!isObject(obj)) {
+        return null
+      }
+
+      if (obj[modelTypeKey] !== undefined) {
+        // fast check
+        return obj[modelTypeKey] === modelInfo.name ? thisTc : null
+      }
+
+      return refDataTypeChecker.snapshotType(obj) ? thisTc : null
+    },
+
+    (sn: Record<string, unknown>) => {
+      if (sn[modelTypeKey]) {
+        return sn
+      } else {
+        return {
+          ...sn,
+          [modelTypeKey]: modelInfo.name,
+        }
+      }
+    },
+
+    (sn) => sn
+  )
+
+  return thisTc as any
+}
+
+/**
+ * `types.ref` type info.
+ */
+export class RefTypeInfo extends TypeInfo {
+  readonly kind = "ref"
+}

package/src/types/primitiveBased/typesEnum.ts

@@ -1,63 +1,63 @@
-import { assertIsObject } from "../../utils"
-import type { IdentityType } from "../schemas"
-import { typesOr } from "../utility/typesOr"
-import { typesLiteral } from "./typesPrimitive"
-
-/**
- * @ignore
- * Enum like object.
- */
-export interface EnumLike {
-  [k: string]: number | string
-  [v: number]: string
-}
-
-/**
- * @internal
- */
-export function enumValues(e: EnumLike): (string | number)[] {
-  const vals: (string | number)[] = []
-  for (const k of Object.keys(e)) {
-    const v = e[k]
-    // we have to do this since TS does something weird
-    // to number values
-    // Hi = 0 -> { Hi: 0, 0: "Hi" }
-    // and SWC currently generates enum code inconsistent with TS/Babel
-    // https://github.com/swc-project/swc/issues/3711
-    if (!vals.includes(v) && ((typeof v !== "string" && v !== +k) || e[v] !== +k)) {
-      vals.push(v)
-    }
-  }
-  return vals
-}
-
-/**
- * @ignore
- * Extract enum values out of a enum object.
- */
-export type EnumValues<E extends EnumLike> = E extends Record<infer _K, infer V> ? V : never
-
-/**
- * An enum type, based on a TypeScript alike enum object.
- * Syntactic sugar for `types.or(...enum_values.map(types.literal))`
- *
- * Example:
- * ```ts
- * enum Color {
- *   Red = "red",
- *   Green = "green"
- * }
- *
- * const colorType = types.enum(Color)
- * ```
- *
- * @template E Enum type.
- * @param enumObject
- * @returns
- */
-export function typesEnum<E extends EnumLike>(enumObject: E): IdentityType<EnumValues<E>> {
-  assertIsObject(enumObject, "enumObject")
-
-  const literals = enumValues(enumObject).map((e) => typesLiteral(e))
-  return typesOr(...literals) as any
-}
+import { assertIsObject } from "../../utils"
+import type { IdentityType } from "../schemas"
+import { typesOr } from "../utility/typesOr"
+import { typesLiteral } from "./typesPrimitive"
+
+/**
+ * @ignore
+ * Enum like object.
+ */
+export interface EnumLike {
+  [k: string]: number | string
+  [v: number]: string
+}
+
+/**
+ * @internal
+ */
+export function enumValues(e: EnumLike): (string | number)[] {
+  const vals: (string | number)[] = []
+  for (const k of Object.keys(e)) {
+    const v = e[k]
+    // we have to do this since TS does something weird
+    // to number values
+    // Hi = 0 -> { Hi: 0, 0: "Hi" }
+    // and SWC currently generates enum code inconsistent with TS/Babel
+    // https://github.com/swc-project/swc/issues/3711
+    if (!vals.includes(v) && ((typeof v !== "string" && v !== +k) || e[v] !== +k)) {
+      vals.push(v)
+    }
+  }
+  return vals
+}
+
+/**
+ * @ignore
+ * Extract enum values out of a enum object.
+ */
+export type EnumValues<E extends EnumLike> = E extends Record<infer _K, infer V> ? V : never
+
+/**
+ * An enum type, based on a TypeScript alike enum object.
+ * Syntactic sugar for `types.or(...enum_values.map(types.literal))`
+ *
+ * Example:
+ * ```ts
+ * enum Color {
+ *   Red = "red",
+ *   Green = "green"
+ * }
+ *
+ * const colorType = types.enum(Color)
+ * ```
+ *
+ * @template E Enum type.
+ * @param enumObject
+ * @returns
+ */
+export function typesEnum<E extends EnumLike>(enumObject: E): IdentityType<EnumValues<E>> {
+  assertIsObject(enumObject, "enumObject")
+
+  const literals = enumValues(enumObject).map((e) => typesLiteral(e))
+  return typesOr(...literals) as any
+}