mobx-keystone 0.69.2 → 0.69.3

package/dist/types/dataModel/BaseDataModel.d.ts

@@ -1,5 +1,5 @@
 import { propsTypeSymbol } from "../modelShared/BaseModelShared";
-import { ModelProps, ModelPropsToCreationData, ModelPropsToData, ModelPropsToTransformedCreationData } from "../modelShared/prop";
+import { ModelProps, ModelPropsToTransformedCreationData, ModelPropsToUntransformedCreationData, ModelPropsToUntransformedData } from "../modelShared/prop";
 import type { TypeCheckError } from "../types/TypeCheckError";
 /**
  * Base abstract class for data models. Use `DataModel` instead when extending.
@@ -19,7 +19,7 @@ export declare abstract class BaseDataModel<TProps extends ModelProps> {
      * Use it if one of the data properties matches one of the model properties/functions.
      * This also allows access to the backed values of transformed properties.
      */
-    readonly $: ModelPropsToData<TProps>;
+    readonly $: ModelPropsToUntransformedData<TProps>;
     /**
      * Performs a type check over the model instance.
      * For this to work a data type has to be declared as part of the model properties.
@@ -30,7 +30,7 @@ export declare abstract class BaseDataModel<TProps extends ModelProps> {
     /**
      * Creates an instance of a data model.
      */
-    constructor(data: ModelPropsToCreationData<TProps> | ModelPropsToTransformedCreationData<TProps>);
+    constructor(data: ModelPropsToUntransformedCreationData<TProps> | ModelPropsToTransformedCreationData<TProps>);
     toString(options?: {
         withData?: boolean;
     }): string;

package/dist/types/dataModel/DataModel.d.ts

@@ -1,7 +1,7 @@
-import type { AbstractModelClass, ModelCreationData, ModelTransformedCreationData } from "../modelShared/BaseModelShared";
-import type { ModelProps, ModelPropsToCreationData, ModelPropsToSetter, ModelPropsToTransformedCreationData, ModelPropsToTransformedData } from "../modelShared/prop";
+import type { AbstractModelClass, ModelCreationData, ModelUntransformedCreationData } from "../modelShared/BaseModelShared";
+import type { ModelProps, ModelPropsToSetter, ModelPropsToTransformedCreationData, ModelPropsToTransformedData, ModelPropsToUntransformedCreationData } from "../modelShared/prop";
 import type { AnyDataModel, BaseDataModel, BaseDataModelKeys } from "./BaseDataModel";
-export declare type _ComposedData<SuperModel, TProps extends ModelProps> = SuperModel extends AnyDataModel ? (ModelPropsToCreationData<TProps> & ModelCreationData<SuperModel>) | (ModelPropsToTransformedCreationData<TProps> & ModelTransformedCreationData<SuperModel>) : ModelPropsToCreationData<TProps> | ModelPropsToTransformedCreationData<TProps>;
+export declare type _ComposedData<SuperModel, TProps extends ModelProps> = SuperModel extends AnyDataModel ? (ModelPropsToUntransformedCreationData<TProps> & ModelUntransformedCreationData<SuperModel>) | (ModelPropsToTransformedCreationData<TProps> & ModelCreationData<SuperModel>) : ModelPropsToUntransformedCreationData<TProps> | ModelPropsToTransformedCreationData<TProps>;
 export interface _DataModel<SuperModel, TProps extends ModelProps> {
     new (data: _ComposedData<SuperModel, TProps>): SuperModel & BaseDataModel<TProps> & Omit<ModelPropsToTransformedData<TProps>, BaseDataModelKeys> & ModelPropsToSetter<TProps>;
 }

package/dist/types/model/BaseModel.d.ts

@@ -1,5 +1,5 @@
 import { fromSnapshotOverrideTypeSymbol, ModelClass, propsTypeSymbol, toSnapshotOverrideTypeSymbol } from "../modelShared/BaseModelShared";
-import type { ModelProps, ModelPropsToData, ModelPropsToTransformedCreationData } from "../modelShared/prop";
+import type { ModelProps, ModelPropsToTransformedCreationData, ModelPropsToUntransformedData } from "../modelShared/prop";
 import type { SnapshotInOfModel, SnapshotOutOfModel } from "../snapshot/SnapshotOf";
 import type { TypeCheckError } from "../types/TypeCheckError";
 import { modelIdKey, modelTypeKey } from "./metadata";
@@ -44,7 +44,7 @@ export declare abstract class BaseModel<TProps extends ModelProps, FromSnapshotO
      * Data part of the model, which is observable and will be serialized in snapshots.
      * Use it if one of the data properties matches one of the model properties/functions.
      */
-    readonly $: ModelPropsToData<TProps>;
+    readonly $: ModelPropsToUntransformedData<TProps>;
     /**
      * Optional hook that will run once this model instance is attached to the tree of a model marked as
      * root store via `registerRootStore`.

package/dist/types/model/Model.d.ts

@@ -1,7 +1,7 @@
-import type { AbstractModelClass, ModelTransformedCreationData } from "../modelShared/BaseModelShared";
+import type { AbstractModelClass, ModelCreationData } from "../modelShared/BaseModelShared";
 import type { ModelProps, ModelPropsToSetter, ModelPropsToSnapshotCreationData, ModelPropsToSnapshotData, ModelPropsToTransformedCreationData, ModelPropsToTransformedData } from "../modelShared/prop";
 import type { AnyModel, BaseModel, BaseModelKeys, ModelIdPropertyName } from "./BaseModel";
-export declare type _ComposedCreationData<SuperModel, TProps extends ModelProps> = SuperModel extends AnyModel ? ModelPropsToTransformedCreationData<TProps> & ModelTransformedCreationData<SuperModel> : ModelPropsToTransformedCreationData<TProps>;
+export declare type _ComposedCreationData<SuperModel, TProps extends ModelProps> = SuperModel extends AnyModel ? ModelPropsToTransformedCreationData<TProps> & ModelCreationData<SuperModel> : ModelPropsToTransformedCreationData<TProps>;
 /**
  * The default type used by fromSnapshot before processors are applied.
  */

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

@@ -2,7 +2,7 @@ import type { AnyDataModel } from "../dataModel/BaseDataModel";
 import type { AnyModel } from "../model/BaseModel";
 import type { modelTypeKey } from "../model/metadata";
 import type { Flatten, IsNeverType } from "../utils/types";
-import type { ModelPropsToCreationData, ModelPropsToSnapshotCreationData, ModelPropsToSnapshotData, ModelPropsToTransformedCreationData, ModelPropsToTransformedData } from "./prop";
+import type { ModelPropsToSnapshotCreationData, ModelPropsToSnapshotData, ModelPropsToTransformedCreationData, ModelPropsToTransformedData, ModelPropsToUntransformedCreationData } from "./prop";
 /**
  * @ignore
  */
@@ -32,21 +32,21 @@ export declare type AbstractModelClass<M extends AnyModel | AnyDataModel> = abst
  */
 export declare type ModelPropsOf<M extends AnyModel | AnyDataModel> = M[typeof propsTypeSymbol];
 /**
- * The data type of a model.
+ * The data type of a model, without transformations applied.
  */
-export declare type ModelData<M extends AnyModel | AnyDataModel> = Flatten<M["$"]>;
+export declare type ModelUntransformedData<M extends AnyModel | AnyDataModel> = Flatten<M["$"]>;
 /**
- * The creation data type of a model.
+ * The creation data type of a model, without transformations applied.
  */
-export declare type ModelCreationData<M extends AnyModel | AnyDataModel> = ModelPropsToCreationData<ModelPropsOf<M>>;
+export declare type ModelUntransformedCreationData<M extends AnyModel | AnyDataModel> = ModelPropsToUntransformedCreationData<ModelPropsOf<M>>;
 /**
- * The transformed data type of a model.
+ * The data type of a model, with transformations applied.
  */
-export declare type ModelTransformedData<M extends AnyModel | AnyDataModel> = ModelPropsToTransformedData<ModelPropsOf<M>>;
+export declare type ModelData<M extends AnyModel | AnyDataModel> = ModelPropsToTransformedData<ModelPropsOf<M>>;
 /**
- * The transformed creation data type of a model.
+ * The creation data type of a model, with transformations applied.
  */
-export declare type ModelTransformedCreationData<M extends AnyModel | AnyDataModel> = ModelPropsToTransformedCreationData<ModelPropsOf<M>>;
+export declare type ModelCreationData<M extends AnyModel | AnyDataModel> = ModelPropsToTransformedCreationData<ModelPropsOf<M>>;
 /**
  * The from snapshot type of a model.
  *

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

@@ -84,13 +84,13 @@ export interface ModelProps {
 export declare type RequiredModelProps<MP extends ModelProps> = {
     [K in keyof MP]: MP[K]["_internal"]["$isRequired"] & K;
 }[keyof MP];
-export declare type ModelPropsToData<MP extends ModelProps> = Flatten<{
+export declare type ModelPropsToUntransformedData<MP extends ModelProps> = Flatten<{
     [k in keyof MP]: MP[k]["_internal"]["$valueType"];
 }>;
 export declare type ModelPropsToSnapshotData<MP extends ModelProps> = Flatten<{
     [k in keyof MP]: ModelPropToSnapshot<MP[k]> extends infer R ? R : never;
 }>;
-export declare type ModelPropsToCreationData<MP extends ModelProps> = {
+export declare type ModelPropsToUntransformedCreationData<MP extends ModelProps> = {
     [k in keyof MP]?: MP[k]["_internal"]["$creationValueType"];
 } & {
     [k in RequiredModelProps<MP>]: MP[k]["_internal"]["$creationValueType"];

package/dist/types/types/objectBased/typesDataModelData.d.ts

@@ -1,5 +1,5 @@
 import type { AnyDataModel } from "../../dataModel/BaseDataModel";
-import type { ModelClass, ModelData } from "../../modelShared/BaseModelShared";
+import type { ModelClass, ModelData, ModelUntransformedData } from "../../modelShared/BaseModelShared";
 import type { AnyStandardType, IdentityType } from "../schemas";
 import { TypeInfo } from "../TypeChecker";
 declare type _Class<T> = abstract new (...args: any[]) => T;
@@ -19,7 +19,7 @@ declare type _ClassOrObject<M, K> = K extends M ? object : _Class<K> | (() => _C
  * @param modelClass Model class.
  * @returns
  */
-export declare function typesDataModelData<M = never, K = M>(modelClass: _ClassOrObject<M, K>): IdentityType<ModelData<K extends M ? (M extends AnyDataModel ? M : never) : K extends AnyDataModel ? K : never>>;
+export declare function typesDataModelData<M = never, K = M>(modelClass: _ClassOrObject<M, K>): IdentityType<ModelUntransformedData<K extends M ? (M extends AnyDataModel ? M : never) : K extends AnyDataModel ? K : never> | ModelData<K extends M ? (M extends AnyDataModel ? M : never) : K extends AnyDataModel ? K : never>>;
 /**
  * `types.dataModelData` type info for a model props.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mobx-keystone",
-  "version": "0.69.2",
+  "version": "0.69.3",
   "description": "A MobX powered state management solution based on data trees with first class support for TypeScript, snapshots, patches and much more",
   "keywords": [
     "mobx",
@@ -70,7 +70,7 @@
     "@babel/plugin-proposal-decorators": "^7.18.6",
     "@babel/preset-env": "^7.18.6",
     "@babel/preset-typescript": "^7.18.6",
-    "@swc/core": "^1.2.210",
+    "@swc/core": "^1.2.212",
     "@swc/jest": "^0.2.21",
     "@types/jest": "^28.1.4",
     "@types/node": "^18.0.3",
@@ -84,7 +84,7 @@
     "spec.ts": "^1.1.3",
     "ts-jest": "^28.0.5",
     "ts-node": "^10.8.2",
-    "typedoc": "^0.23.6",
+    "typedoc": "^0.23.7",
     "typescript": "^4.7.4",
     "vite": "^2.9.14"
   },

package/src/dataModel/BaseDataModel.ts

@@ -3,9 +3,9 @@ import { modelInfoByClass } from "../modelShared/modelInfo"
 import { getInternalModelClassPropsInfo } from "../modelShared/modelPropsInfo"
 import {
   ModelProps,
-  ModelPropsToCreationData,
-  ModelPropsToData,
   ModelPropsToTransformedCreationData,
+  ModelPropsToUntransformedCreationData,
+  ModelPropsToUntransformedData,
   noDefaultValue,
 } from "../modelShared/prop"
 import { getSnapshot } from "../snapshot/getSnapshot"
@@ -42,7 +42,7 @@ export abstract class BaseDataModel<TProps extends ModelProps> {
    * Use it if one of the data properties matches one of the model properties/functions.
    * This also allows access to the backed values of transformed properties.
    */
-  readonly $!: ModelPropsToData<TProps>
+  readonly $!: ModelPropsToUntransformedData<TProps>
 
   /**
    * Performs a type check over the model instance.
@@ -59,7 +59,9 @@ export abstract class BaseDataModel<TProps extends ModelProps> {
    * Creates an instance of a data model.
    */
   constructor(
-    data: ModelPropsToCreationData<TProps> | ModelPropsToTransformedCreationData<TProps>
+    data:
+      | ModelPropsToUntransformedCreationData<TProps>
+      | ModelPropsToTransformedCreationData<TProps>
   ) {
     if (!isObject(data)) {
       throw failure("data models can only work over data objects")
@@ -68,7 +70,7 @@ export abstract class BaseDataModel<TProps extends ModelProps> {
     const { modelClass: _modelClass }: DataModelConstructorOptions = arguments[1] as any
     const modelClass = _modelClass!
 
-    type Data = ModelPropsToData<TProps>
+    type Data = ModelPropsToUntransformedData<TProps>
     let tweakedData: Data
     if (isTreeNode(data)) {
       // in theory already initialized

package/src/dataModel/DataModel.ts

@@ -2,14 +2,14 @@ import type {
   AbstractModelClass,
   ModelClass,
   ModelCreationData,
-  ModelTransformedCreationData,
+  ModelUntransformedCreationData,
 } from "../modelShared/BaseModelShared"
 import type {
   ModelProps,
-  ModelPropsToCreationData,
   ModelPropsToSetter,
   ModelPropsToTransformedCreationData,
   ModelPropsToTransformedData,
+  ModelPropsToUntransformedCreationData,
 } from "../modelShared/prop"
 import { sharedInternalModel } from "../modelShared/sharedInternalModel"
 import type { AnyDataModel, BaseDataModel, BaseDataModelKeys } from "./BaseDataModel"
@@ -17,9 +17,9 @@ import { assertIsDataModelClass, isDataModelClass } from "./utils"
 
 export type _ComposedData<SuperModel, TProps extends ModelProps> = SuperModel extends AnyDataModel
   ?
-      | (ModelPropsToCreationData<TProps> & ModelCreationData<SuperModel>)
-      | (ModelPropsToTransformedCreationData<TProps> & ModelTransformedCreationData<SuperModel>)
-  : ModelPropsToCreationData<TProps> | ModelPropsToTransformedCreationData<TProps>
+      | (ModelPropsToUntransformedCreationData<TProps> & ModelUntransformedCreationData<SuperModel>)
+      | (ModelPropsToTransformedCreationData<TProps> & ModelCreationData<SuperModel>)
+  : ModelPropsToUntransformedCreationData<TProps> | ModelPropsToTransformedCreationData<TProps>
 
 export interface _DataModel<SuperModel, TProps extends ModelProps> {
   new (data: _ComposedData<SuperModel, TProps>): SuperModel &

package/src/dataModel/newDataModel.ts

@@ -1,7 +1,7 @@
 import { action } from "mobx"
 import type { O } from "ts-toolbelt"
 import { isModelAutoTypeCheckingEnabled } from "../globalConfig/globalConfig"
-import type { ModelData } from "../modelShared/BaseModelShared"
+import type { ModelUntransformedData } from "../modelShared/BaseModelShared"
 import { modelInfoByClass } from "../modelShared/modelInfo"
 import { applyModelInitializers } from "../modelShared/newModel"
 import { failure, inDevMode, makePropReadonly } from "../utils"
@@ -17,7 +17,7 @@ export const internalNewDataModel = action(
   "newModel",
   <M extends AnyDataModel>(
     origModelObj: M,
-    tweakedData: ModelData<M>,
+    tweakedData: ModelUntransformedData<M>,
     options: Pick<DataModelConstructorOptions, "modelClass">
   ): M => {
     const { modelClass: _modelClass } = options

package/src/model/BaseModel.ts

@@ -8,8 +8,8 @@ import {
 import { modelInfoByClass } from "../modelShared/modelInfo"
 import type {
   ModelProps,
-  ModelPropsToData,
   ModelPropsToTransformedCreationData,
+  ModelPropsToUntransformedData,
 } from "../modelShared/prop"
 import { getSnapshot } from "../snapshot/getSnapshot"
 import type { SnapshotInOfModel, SnapshotOutOfModel } from "../snapshot/SnapshotOf"
@@ -88,7 +88,7 @@ export abstract class BaseModel<
    * Data part of the model, which is observable and will be serialized in snapshots.
    * Use it if one of the data properties matches one of the model properties/functions.
    */
-  readonly $!: ModelPropsToData<TProps>
+  readonly $!: ModelPropsToUntransformedData<TProps>
 
   /**
    * Optional hook that will run once this model instance is attached to the tree of a model marked as

package/src/model/Model.ts

@@ -1,7 +1,7 @@
 import type {
   AbstractModelClass,
   ModelClass,
-  ModelTransformedCreationData,
+  ModelCreationData,
 } from "../modelShared/BaseModelShared"
 import type {
   ModelProps,
@@ -19,7 +19,7 @@ export type _ComposedCreationData<
   SuperModel,
   TProps extends ModelProps
 > = SuperModel extends AnyModel
-  ? ModelPropsToTransformedCreationData<TProps> & ModelTransformedCreationData<SuperModel>
+  ? ModelPropsToTransformedCreationData<TProps> & ModelCreationData<SuperModel>
   : ModelPropsToTransformedCreationData<TProps>
 
 /**

package/src/model/newModel.ts

@@ -1,7 +1,7 @@
 import { action, set } from "mobx"
 import type { O } from "ts-toolbelt"
 import { isModelAutoTypeCheckingEnabled } from "../globalConfig/globalConfig"
-import type { ModelTransformedCreationData } from "../modelShared/BaseModelShared"
+import type { ModelCreationData } from "../modelShared/BaseModelShared"
 import { modelInfoByClass } from "../modelShared/modelInfo"
 import { getInternalModelClassPropsInfo } from "../modelShared/modelPropsInfo"
 import { applyModelInitializers } from "../modelShared/newModel"
@@ -22,7 +22,7 @@ export const internalNewModel = action(
   "newModel",
   <M extends AnyModel>(
     origModelObj: M,
-    initialData: ModelTransformedCreationData<M> | undefined,
+    initialData: ModelCreationData<M> | undefined,
     options: Pick<ModelConstructorOptions, "modelClass" | "snapshotInitialData" | "generateNewIds">
   ): M => {
     const mode = initialData ? "new" : "fromSnapshot"

package/src/modelShared/BaseModelShared.ts

@@ -3,11 +3,11 @@ import type { AnyModel } from "../model/BaseModel"
 import type { modelTypeKey } from "../model/metadata"
 import type { Flatten, IsNeverType } from "../utils/types"
 import type {
-  ModelPropsToCreationData,
   ModelPropsToSnapshotCreationData,
   ModelPropsToSnapshotData,
   ModelPropsToTransformedCreationData,
   ModelPropsToTransformedData,
+  ModelPropsToUntransformedCreationData,
 } from "./prop"
 
 /**
@@ -53,28 +53,27 @@ export type AbstractModelClass<M extends AnyModel | AnyDataModel> = abstract new
 export type ModelPropsOf<M extends AnyModel | AnyDataModel> = M[typeof propsTypeSymbol]
 
 /**
- * The data type of a model.
+ * The data type of a model, without transformations applied.
  */
-export type ModelData<M extends AnyModel | AnyDataModel> = Flatten<M["$"]>
+export type ModelUntransformedData<M extends AnyModel | AnyDataModel> = Flatten<M["$"]>
 
 /**
- * The creation data type of a model.
+ * The creation data type of a model, without transformations applied.
  */
-export type ModelCreationData<M extends AnyModel | AnyDataModel> = ModelPropsToCreationData<
-  ModelPropsOf<M>
->
+export type ModelUntransformedCreationData<M extends AnyModel | AnyDataModel> =
+  ModelPropsToUntransformedCreationData<ModelPropsOf<M>>
 
 /**
- * The transformed data type of a model.
+ * The data type of a model, with transformations applied.
  */
-export type ModelTransformedData<M extends AnyModel | AnyDataModel> = ModelPropsToTransformedData<
+export type ModelData<M extends AnyModel | AnyDataModel> = ModelPropsToTransformedData<
   ModelPropsOf<M>
 >
 
 /**
- * The transformed creation data type of a model.
+ * The creation data type of a model, with transformations applied.
  */
-export type ModelTransformedCreationData<M extends AnyModel | AnyDataModel> =
+export type ModelCreationData<M extends AnyModel | AnyDataModel> =
   ModelPropsToTransformedCreationData<ModelPropsOf<M>>
 
 /**

package/src/modelShared/prop.ts

@@ -169,7 +169,7 @@ export type RequiredModelProps<MP extends ModelProps> = {
   [K in keyof MP]: MP[K]["_internal"]["$isRequired"] & K
 }[keyof MP]
 
-export type ModelPropsToData<MP extends ModelProps> = Flatten<{
+export type ModelPropsToUntransformedData<MP extends ModelProps> = Flatten<{
   [k in keyof MP]: MP[k]["_internal"]["$valueType"]
 }>
 
@@ -181,7 +181,7 @@ export type ModelPropsToSnapshotData<MP extends ModelProps> = Flatten<{
 // also if we use pick over the optional props we will loose the ability
 // to infer generics
 // we also don't use Flatten because if we do some generics won't work
-export type ModelPropsToCreationData<MP extends ModelProps> = {
+export type ModelPropsToUntransformedCreationData<MP extends ModelProps> = {
   [k in keyof MP]?: MP[k]["_internal"]["$creationValueType"]
 } & {
   [k in RequiredModelProps<MP>]: MP[k]["_internal"]["$creationValueType"]

package/src/types/objectBased/typesDataModelData.ts

@@ -2,7 +2,11 @@ import type { O } from "ts-toolbelt"
 import type { AnyDataModel } from "../../dataModel/BaseDataModel"
 import { getDataModelMetadata } from "../../dataModel/getDataModelMetadata"
 import { isDataModelClass } from "../../dataModel/utils"
-import type { ModelClass, ModelData } from "../../modelShared/BaseModelShared"
+import type {
+  ModelClass,
+  ModelData,
+  ModelUntransformedData,
+} from "../../modelShared/BaseModelShared"
 import { modelInfoByClass } from "../../modelShared/modelInfo"
 import { getInternalModelClassPropsInfo } from "../../modelShared/modelPropsInfo"
 import { noDefaultValue } from "../../modelShared/prop"
@@ -41,7 +45,12 @@ type _ClassOrObject<M, K> = K extends M ? object : _Class<K> | (() => _Class<K>)
 export function typesDataModelData<M = never, K = M>(
   modelClass: _ClassOrObject<M, K>
 ): IdentityType<
-  ModelData<K extends M ? (M extends AnyDataModel ? M : never) : K extends AnyDataModel ? K : never>
+  | ModelUntransformedData<
+      K extends M ? (M extends AnyDataModel ? M : never) : K extends AnyDataModel ? K : never
+    >
+  | ModelData<
+      K extends M ? (M extends AnyDataModel ? M : never) : K extends AnyDataModel ? K : never
+    >
 > {
   // if we type it any stronger then recursive defs and so on stop working