mobx-keystone 1.24.0 → 1.24.1

package/dist/types/modelShared/BaseModelShared.d.ts

@@ -2,7 +2,7 @@ import { AnyDataModel } from '../dataModel/BaseDataModel';
 import { AnyModel } from '../model/BaseModel';
 import { modelTypeKey } from '../model/metadata';
 import { Flatten, IsNeverType } from '../utils/types';
-import { ModelPropsToSnapshotCreationData, ModelPropsToSnapshotData, ModelPropsToTransformedCreationData, ModelPropsToTransformedData, ModelPropsToUntransformedCreationData } from './prop';
+import { ModelProps, ModelPropsToSnapshotCreationData, ModelPropsToSnapshotData, ModelPropsToTransformedCreationData, ModelPropsToTransformedData, ModelPropsToUntransformedCreationData } from './prop';
 /**
  * @ignore
  */
@@ -27,6 +27,12 @@ export interface ModelClass<M extends AnyModel | AnyDataModel> {
  * Extracts the instance type of an abstract model class.
  */
 export type AbstractModelClass<M extends AnyModel | AnyDataModel> = abstract new (initialData: any) => M;
+/**
+ * @ignore
+ */
+export interface ModelWithProps {
+    [propsTypeSymbol]: ModelProps;
+}
 /**
  * The props of a model.
  */

package/dist/types/modelShared/prop.d.ts

@@ -7,6 +7,11 @@ import { Flatten, IsNeverType, IsOptionalValue } from '../utils/types';
 export declare const noDefaultValue: unique symbol;
 type SetterMode = boolean | "assign";
 export type ModelPropSetterValueTransform<T> = (value: T) => T;
+/** @ignore */
+export interface FullModelPropTransform {
+    transform: (original: unknown, model: object, propName: PropertyKey, setOriginalValue: (newOriginalValue: unknown) => void) => unknown;
+    untransform: (transformed: unknown, model: object, propName: PropertyKey) => unknown;
+}
 /**
  * A model property.
  */

package/dist/types/types/TypeChecker.d.ts

@@ -1,4 +1,78 @@
+import { Path } from '../parent/pathTypes';
 import { AnyStandardType } from './schemas';
+import { TypeCheckError } from './TypeCheckError';
+type CheckFunction = (value: any, path: Path, typeCheckedValue: any) => TypeCheckError | null;
+/** @ignore */
+export type SnapshotProcessor = (snapshot: any) => unknown;
+/**
+ * A lazily discovered snapshot-processor node. Dependencies are deliberately
+ * TypeCheckers rather than processors so recursive graphs can be discovered
+ * before any processor body is compiled.
+ *
+ * @ignore
+ */
+export interface SnapshotProcessorPlan {
+    readonly intrinsic?: boolean;
+    readonly getDependencies: () => ReadonlyArray<TypeChecker>;
+    readonly compile: (dependencyProcessors: ReadonlyArray<SnapshotProcessor | undefined>) => SnapshotProcessor | undefined;
+}
+type SnapshotProcessorSource = SnapshotProcessor | SnapshotProcessorPlan | undefined;
+type SnapshotProcessorDirection = "from" | "to";
+/** @ignore */
+export declare class SnapshotProcessorPlanNode {
+    private readonly owner;
+    private readonly direction;
+    private readonly source;
+    private presence;
+    private dependencies;
+    private discovering;
+    private compiling;
+    private compiled;
+    private compiledProcessor;
+    private forwardingProcessor;
+    constructor(owner: TypeChecker | undefined, direction: SnapshotProcessorDirection, source: SnapshotProcessorSource);
+    resolve(): SnapshotProcessor | undefined;
+    private discover;
+    private compile;
+    private compileForDependency;
+}
+/**
+ * @ignore
+ */
+export declare enum TypeCheckerBaseType {
+    Object = "object",
+    Array = "array",
+    Primitive = "primitive",
+    Any = "any"
+}
+/**
+ * @ignore
+ */
+export declare class TypeChecker {
+    unchecked: boolean;
+    skipCheck: boolean;
+    readonly baseType: TypeCheckerBaseType;
+    private readonly _check;
+    readonly getTypeName: (...recursiveTypeCheckers: TypeChecker[]) => string;
+    readonly typeInfoGen: TypeInfoGen;
+    readonly snapshotType: (sn: unknown) => TypeChecker | null;
+    private readonly fromSnapshotProcessorSource;
+    private readonly toSnapshotProcessorSource;
+    private fromSnapshotProcessorPlanNode;
+    private toSnapshotProcessorPlanNode;
+    check(value: any, path: Path, typeCheckedValue: any): TypeCheckError | null;
+    private _cachedTypeInfoGen;
+    get typeInfo(): TypeInfo;
+    constructor(baseType: TypeCheckerBaseType, _check: CheckFunction | null, getTypeName: (...recursiveTypeCheckers: TypeChecker[]) => string, typeInfoGen: TypeInfoGen, snapshotType: (sn: unknown) => TypeChecker | null, fromSnapshotProcessor: SnapshotProcessorSource, toSnapshotProcessor: SnapshotProcessorSource);
+    getSnapshotProcessorPlanNode(direction: SnapshotProcessorDirection): SnapshotProcessorPlanNode;
+    private resolveSnapshotProcessor;
+    getFromSnapshotProcessor(): SnapshotProcessor | undefined;
+    getToSnapshotProcessor(): SnapshotProcessor | undefined;
+    fromSnapshotProcessor: (sn: any) => unknown;
+    private readonly _toSnapshotProcessorCache;
+    invalidateSnapshotProcessorCachedResult(obj: object): void;
+    toSnapshotProcessor: (sn: any) => unknown;
+}
 /**
  * Type info base class.
  */
@@ -7,3 +81,8 @@ export declare class TypeInfo {
     readonly thisType: AnyStandardType;
     constructor(thisType: AnyStandardType);
 }
+/**
+ * @ignore
+ */
+export type TypeInfoGen = (t: AnyStandardType) => TypeInfo;
+export {};

package/dist/types/types/schemas.d.ts

@@ -3,6 +3,7 @@ import { AnyDataModel } from '../dataModel/BaseDataModel';
 import { AnyModel } from '../model/BaseModel';
 import { ModelClass } from '../modelShared/BaseModelShared';
 import { SnapshotInOf, SnapshotOutOf } from '../snapshot/SnapshotOf';
+import { IsOptionalValue } from '../utils/types';
 export interface Type<Name, Data> {
     /** @ignore */
     $$type: Name;
@@ -36,6 +37,20 @@ export interface ObjectOfTypes {
     /** @ignore */
     [k: string]: AnyType;
 }
+/**
+ * Name of the properties of an object that can be set to undefined, any or unknown.
+ * @ignore
+ */
+export type UndefinablePropsNames<T> = {
+    [K in keyof T]: IsOptionalValue<T[K], K, never>;
+}[keyof T];
+/**
+ * Computes the optional keys for an object type schema.
+ * @ignore
+ */
+export type ObjectOptionalKeys<S> = UndefinablePropsNames<{
+    [k in keyof S]: TypeToDataOpt<S[k]> extends infer R ? R : never;
+}>;
 type ObjectData<S> = O.Optional<{
     [k in keyof S]: TypeToData<S[k]> extends infer R ? R : never;
 }, ObjectOptionalKeys<S>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mobx-keystone",
-  "version": "1.24.0",
+  "version": "1.24.1",
   "description": "A MobX powered state management solution based on data trees with first class support for TypeScript, snapshots, patches and much more",
   "keywords": [
     "mobx",
@@ -54,7 +54,8 @@
     "quick-build": "tsc",
     "quick-build-tests": "tsc -p test",
     "copy-root-files": "shx cp ../../README.md . && shx cp ../../LICENSE . && shx cp ../../CHANGELOG.md .",
-    "build": "pnpm run quick-build && pnpm run copy-root-files && shx rm -rf dist && vite build && shx cp dist/mobx-keystone.esm.mjs dist/mobx-keystone.esm.js",
+    "build": "pnpm run quick-build && pnpm run copy-root-files && shx rm -rf dist && vite build && pnpm run check-declarations && shx cp dist/mobx-keystone.esm.mjs dist/mobx-keystone.esm.js",
+    "check-declarations": "tsc -p scripts/tsconfig.check-declarations.json",
     "test": "vitest run",
     "test:ci": "vitest run --coverage",
     "test:perf": "pnpm run build && pnpm run test:perf:run",
@@ -68,13 +69,13 @@
   "devDependencies": {
     "@babel/core": "^8.0.1",
     "@babel/plugin-proposal-decorators": "^8.0.2",
-    "@babel/plugin-transform-class-static-block": "^8.0.1",
     "@babel/plugin-transform-class-properties": "^8.0.1",
+    "@babel/plugin-transform-class-static-block": "^8.0.1",
     "@babel/plugin-transform-typescript": "^8.0.1",
     "@babel/preset-env": "^8.0.2",
-    "@swc/core": "^1.15.43",
+    "@swc/core": "^1.16.0",
     "@types/babel__core": "^7.20.5",
-    "@types/node": "^26.1.1",
+    "@types/node": "^26.2.0",
     "@typescript/typescript6": "^6.0.2",
     "@vitest/coverage-v8": "^4.1.10",
     "mobx-v4": "npm:mobx@^4.15.7",
@@ -86,7 +87,7 @@
     "ts-node": "^10.9.2",
     "typedoc": "^0.28.20",
     "typescript": "^7.0.2",
-    "vite": "^8.1.4",
+    "vite": "^8.2.1",
     "vite-plugin-dts": "^5.0.3",
     "vitest": "^4.1.10"
   },

package/src/modelShared/BaseModelShared.ts

@@ -49,7 +49,7 @@ export type AbstractModelClass<M extends AnyModel | AnyDataModel> = abstract new
 ) => M
 
 /**
- * @internal
+ * @ignore
  */
 export interface ModelWithProps {
   [propsTypeSymbol]: ModelProps

package/src/modelShared/prop.ts

@@ -14,7 +14,7 @@ type SetterMode = boolean | "assign"
 
 export type ModelPropSetterValueTransform<T> = (value: T) => T
 
-/** @internal */
+/** @ignore */
 export interface FullModelPropTransform {
   transform: (
     original: unknown,

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