mobx-keystone/dist/types/modelShared/BaseModelShared.d.ts

A MobX powered state management solution based on data trees with first class support for TypeScript, snapshots, patches and much more

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';
/**
 * @ignore
 */
export declare const propsTypeSymbol: unique symbol;
/**
 * @ignore
 */
export declare const fromSnapshotOverrideTypeSymbol: unique symbol;
/**
 * @ignore
 */
export declare const toSnapshotOverrideTypeSymbol: unique symbol;
/**
 * Extracts the instance type of a model class.
 */
export interface ModelClass<M extends AnyModel | AnyDataModel> {
    new (initialData: any): M;
    fromSnapshotProcessor?: (sn: any) => any;
    toSnapshotProcessor?: (sn: any, modelInstance: any) => any;
}
/**
 * Extracts the instance type of an abstract model class.
 */
export type AbstractModelClass<M extends AnyModel | AnyDataModel> = abstract new (initialData: any) => M;
/**
 * The props of a model.
 */
export type ModelPropsOf<M extends ModelWithProps> = M[typeof propsTypeSymbol];
/**
 * The data type of a model, without transformations applied.
 */
export type ModelUntransformedData<M extends {
    readonly $: any;
}> = Flatten<M["$"]>;
/**
 * The creation data type of a model, without transformations applied.
 */
export type ModelUntransformedCreationData<M extends ModelWithProps> = ModelPropsToUntransformedCreationData<ModelPropsOf<M>>;
/**
 * The data type of a model, with transformations applied.
 */
export type ModelData<M extends ModelWithProps> = ModelPropsToTransformedData<ModelPropsOf<M>>;
/**
 * The creation data type of a model, with transformations applied.
 */
export type ModelCreationData<M extends ModelWithProps> = ModelPropsToTransformedCreationData<ModelPropsOf<M>>;
/**
 * The from snapshot type of a model.
 *
 * @deprecated Use SnapshotInOf<Model> instead.
 */
export type ModelFromSnapshot<M extends ModelWithProps & {
    [fromSnapshotOverrideTypeSymbol]: any;
}> = IsNeverType<M[typeof fromSnapshotOverrideTypeSymbol], ModelPropsToSnapshotCreationData<ModelPropsOf<M>>, M[typeof fromSnapshotOverrideTypeSymbol]> & {
    [modelTypeKey]?: string;
};
/**
 * The to snapshot type of a model.
 *
 * @deprecated Use SnapshotOutOf<Model> instead.
 */
export type ModelToSnapshot<M extends ModelWithProps & {
    [toSnapshotOverrideTypeSymbol]: any;
}> = IsNeverType<M[typeof toSnapshotOverrideTypeSymbol], ModelPropsToSnapshotData<ModelPropsOf<M>>, M[typeof toSnapshotOverrideTypeSymbol]> & {
    [modelTypeKey]?: string;
};
/**
 * Tricks TypeScript into accepting a particular kind of generic class as a parameter for `ExtendedModel`.
 * Does nothing in runtime.
 *
 * @template T Generic model class type.
 * @param type Generic model class.
 * @returns
 */
export declare function modelClass<T extends AnyModel | AnyDataModel>(type: {
    prototype: T;
}): ModelClass<T>;