functional-models 2.0.2 → 2.0.3

package/interfaces.d.ts

@@ -32,11 +32,11 @@ declare type RemoveType<T, TRemove> = {
     readonly [P in keyof T as T[P] extends TRemove ? never : P]: T[P];
 };
 declare type NotModelMethods<T extends FunctionalModel, TModel extends Model<T> = Model<T>> = RemoveType<T, ModelMethod | ModelMethod<T> | ModelMethod<T, TModel>>;
-declare type InstanceMethodGetters<T extends FunctionalModel, TModel extends Model<T> = Model<T>> = {
-    readonly [P in keyof NotModelMethods<T, TModel> as NotModelMethods<T, TModel>[P] extends ModelInstanceMethod | ModelInstanceMethod<T, TModel> | ModelInstanceMethod<T, TModel, any> ? P : never]: ModelInstanceMethodClient;
+declare type InstanceMethodGetters<T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> = {
+    readonly [P in keyof NotModelMethods<T, TModel> as NotModelMethods<T, TModel>[P] extends ModelInstanceMethod | ModelInstanceMethod<T, TModel> | ModelInstanceMethod<T, TModel, TModelInstance> | ModelInstanceMethod<T, TModel, any> ? P : never]: ModelInstanceMethodClient;
 };
 declare type ModelMethodTypes<T extends FunctionalModel, TModel extends Model<T> = Model<T>> = ModelMethod | ModelMethod<T> | ModelMethod<T, TModel> | ModelInstanceMethod | ModelInstanceMethod<T> | ModelInstanceMethod<T, TModel> | ModelInstanceMethod<T, TModel, any>;
-declare type InstanceMethods<T extends FunctionalModel, TModel extends Model<T> = Model<T>> = ValueIsOfType<T, ModelInstanceMethod | ModelInstanceMethod<T> | ModelInstanceMethod<T, TModel>>;
+declare type InstanceMethods<T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> = ValueIsOfType<T, ModelInstanceMethod | ModelInstanceMethod<T> | ModelInstanceMethod<T, TModel> | ModelInstanceMethod<T, TModel, TModelInstance>>;
 declare type PropertyGetters<T extends FunctionalModel, TModel extends Model<T> = Model<T>> = {
     readonly [Property in keyof T as T[Property] extends ModelMethodTypes<T, TModel> ? never : Property]: () => T[Property];
 };
@@ -60,23 +60,22 @@ declare type ModelErrors<T extends FunctionalModel, TModel extends Model<T> = Mo
 } & {
     readonly overall?: readonly string[] | undefined;
 };
-declare type PropertyValidatorComponentTypeAdvanced<TValue, TModel extends FunctionalModel> = (value: TValue, instance: ModelInstance<TModel, any>, instanceData: TModel | JsonAble, configurations: ValidatorConfiguration) => ValidationErrorResponse;
-declare type PropertyValidatorComponentType<TValue> = (value: TValue, instance: ModelInstance<any, any>, instanceData: FunctionalModel | JsonAble, configurations: ValidatorConfiguration) => ValidationErrorResponse;
-declare type PropertyValidatorComponentSync<T extends FunctionalModel> = PropertyValidatorComponentTypeAdvanced<any, T>;
+declare type PropertyValidatorComponentTypeAdvanced<TValue, T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> = (value: TValue, instance: TModelInstance, instanceData: T | JsonAble, configurations: ValidatorConfiguration) => ValidationErrorResponse;
+declare type PropertyValidatorComponentSync<T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> = PropertyValidatorComponentTypeAdvanced<any, T, TModel, TModelInstance>;
 declare type ValuePropertyValidatorComponent<T extends Arrayable<FunctionalValue>> = (value: T) => ValidationErrorResponse;
-declare type PropertyValidatorComponentAsync<T extends FunctionalModel> = (value: Arrayable<FunctionalValue>, instance: ModelInstance<T, any>, instanceData: T | JsonAble, configurations: ValidatorConfiguration) => Promise<ValidationErrorResponse>;
-declare type PropertyValidatorComponent<T extends FunctionalModel> = PropertyValidatorComponentSync<T> | PropertyValidatorComponentAsync<T>;
-declare type PropertyValidator<T extends FunctionalModel, TModel extends Model<T> = Model<T>> = (instance: ModelInstance<T, TModel>, instanceData: T | JsonAble, configurations: ValidatorConfiguration) => Promise<ValidationErrors>;
-declare type ModelValidatorComponent<T extends FunctionalModel, TModel extends Model<T> = Model<T>> = (instance: ModelInstance<T, TModel>, instanceData: T | JsonAble, configurations: ValidatorConfiguration) => Promise<ModelError>;
+declare type PropertyValidatorComponentAsync<T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> = (value: Arrayable<FunctionalValue>, instance: TModelInstance, instanceData: T | JsonAble, configurations: ValidatorConfiguration) => Promise<ValidationErrorResponse>;
+declare type PropertyValidatorComponent<T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> = PropertyValidatorComponentSync<T, TModel, TModelInstance> | PropertyValidatorComponentAsync<T, TModel, TModelInstance>;
+declare type PropertyValidator<T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> = (instance: TModelInstance, instanceData: T | JsonAble, configurations: ValidatorConfiguration) => Promise<ValidationErrors>;
+declare type ModelValidatorComponent<T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> = (instance: TModelInstance, instanceData: T | JsonAble, configurations: ValidatorConfiguration) => Promise<ModelError>;
 declare type ValueGetter<T extends Arrayable<FunctionalValue>> = () => MaybePromise<T | ModelInstance<any, any>>;
-declare type PropertyInstance<T extends Arrayable<FunctionalValue>> = {
+declare type PropertyInstance<TValue extends Arrayable<FunctionalValue>> = {
     readonly getConfig: () => object;
     readonly getChoices: () => readonly VeryPrimitivesTypes[];
-    readonly getDefaultValue: () => T;
-    readonly getConstantValue: () => T;
+    readonly getDefaultValue: () => TValue;
+    readonly getConstantValue: () => TValue;
     readonly getPropertyType: () => string;
-    readonly createGetter: (value: T) => ValueGetter<T>;
-    readonly getValidator: <TModel extends FunctionalModel>(valueGetter: ValueGetter<T>) => PropertyValidator<TModel>;
+    readonly createGetter: (value: TValue) => ValueGetter<TValue>;
+    readonly getValidator: <TModel extends FunctionalModel>(valueGetter: ValueGetter<TValue>) => PropertyValidator<TModel>;
 };
 declare type PropertiesList<T extends FunctionalModel> = {
     readonly [P in keyof T as T[P] extends Arrayable<FunctionalValue> ? P : never]: PropertyInstance<any>;
@@ -85,7 +84,7 @@ interface ReferencePropertyInstance<T extends FunctionalModel, TProperty extends
     readonly getReferencedId: (instanceValues: ReferenceValueType<T>) => Maybe<PrimaryKeyType>;
     readonly getReferencedModel: () => Model<T>;
 }
-declare type ReferenceValueType<T extends FunctionalModel, TModel extends Model<T> = Model<T>> = ModelInstance<T, TModel> | ModelInstanceInputData<T> | PrimaryKeyType;
+declare type ReferenceValueType<T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> = TModelInstance | ModelInstanceInputData<T> | PrimaryKeyType;
 declare type DefaultPropertyValidators = {
     readonly required?: boolean;
     readonly isInteger?: boolean;
@@ -109,17 +108,17 @@ declare type PropertyConfigContents<T extends Arrayable<FunctionalValue>> = {
     readonly autoNow?: boolean;
     readonly fetcher?: ModelFetcher;
 };
-declare type ModelFetcher = <T extends FunctionalModel>(model: Model<T>, primaryKey: PrimaryKeyType) => Promise<ModelInstance<T, Model<T>> | ModelInstanceInputData<T> | null | undefined>;
+declare type ModelFetcher = <T extends FunctionalModel, TModel extends Model<T> = Model<T>>(model: TModel, primaryKey: PrimaryKeyType) => Promise<ModelInstance<T, TModel>> | Promise<ModelInstanceInputData<T>> | Promise<null> | Promise<undefined>;
 declare type PropertyConfig<T extends Arrayable<FunctionalValue>> = (PropertyConfigContents<T> & DefaultPropertyValidators) | undefined;
 declare type PrimaryKeyPropertyInstanceType = PropertyInstance<string> | PropertyInstance<number>;
 declare type PrimaryKeyType = string | number;
-declare type ModelDefinition<T extends FunctionalModel, TModel extends Model<T> = Model<T>> = {
+declare type ModelDefinition<T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> = {
     readonly getPrimaryKeyName?: () => string;
     readonly properties: PropertiesList<T> & {
         readonly id?: PrimaryKeyPropertyInstanceType;
     };
     readonly modelMethods?: ModelMethods<T, TModel>;
-    readonly instanceMethods?: InstanceMethods<T, TModel>;
+    readonly instanceMethods?: InstanceMethods<T, TModel, TModelInstance>;
     readonly modelValidators?: readonly ModelValidatorComponent<T, TModel>[];
 };
 declare type ModelFactory = <T extends FunctionalModel, TModel extends Model<T> = Model<T>>(modelName: string, modelDefinition: ModelDefinition<T, TModel>, options?: OptionalModelOptions<T, TModel>) => TModel;
@@ -168,4 +167,4 @@ declare type OptionalModelOptions<T extends FunctionalModel, TModel extends Mode
     readonly instanceCreatedCallback?: Nullable<Arrayable<(instance: ModelInstance<T, TModel>) => void>>;
     readonly [s: string]: any;
 } | undefined;
-export { MaybeFunction, Maybe, MaybePromise, Nullable, Arrayable, MaybeLazy, JsonAble, toObj, ModelInstance, Model, PropertyValidatorComponent, PropertyValidatorComponentSync, PropertyValidatorComponentAsync, PropertyValidatorComponentType, PropertyValidator, ModelValidatorComponent, PropertyInstance, PropertyConfig, FunctionalValue, ValueGetter, ReferenceValueType, ModelDefinition, ModelOptions, ModelMethod, OptionalModelOptions, ReferencePropertyInstance, PropertyGetters, PropertyValidators, PropertyValidatorComponentTypeAdvanced, ModelInstanceMethod, FunctionalModel, ModelInstanceInputData, ModelMethodGetters, InstanceMethodGetters, ReferenceFunctions, ModelErrors, PrimaryKeyType, ModelFactory, ModelFetcher, CreateParams, ValidatorConfiguration, ValuePropertyValidatorComponent, ValueRequired, ValueOptional, ValueOptionalR, ValueRequiredR, PropertyModifier, ValidationErrors, ModelError, IsAsync, ModelInstanceMethodClient, ModelMethodClient, TypedJsonObj, };
+export { MaybeFunction, Maybe, MaybePromise, Nullable, Arrayable, MaybeLazy, JsonAble, toObj, ModelInstance, Model, PropertyValidatorComponent, PropertyValidatorComponentSync, PropertyValidatorComponentAsync, PropertyValidator, ModelValidatorComponent, PropertyInstance, PropertyConfig, FunctionalValue, ValueGetter, ReferenceValueType, ModelDefinition, ModelOptions, ModelMethod, OptionalModelOptions, ReferencePropertyInstance, PropertyGetters, PropertyValidators, PropertyValidatorComponentTypeAdvanced, ModelInstanceMethod, FunctionalModel, ModelInstanceInputData, ModelMethodGetters, InstanceMethodGetters, ReferenceFunctions, ModelErrors, PrimaryKeyType, ModelFactory, ModelFetcher, CreateParams, ValidatorConfiguration, ValuePropertyValidatorComponent, ValueRequired, ValueOptional, ValueOptionalR, ValueRequiredR, PropertyModifier, ValidationErrors, ModelError, IsAsync, ModelInstanceMethodClient, ModelMethodClient, TypedJsonObj, };

package/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";;AAscA,kCAAkC"}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";;AAydA,kCAAkC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "functional-models",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "A library for creating JavaScript function based models.",
   "main": "index.js",
   "types": "index.d.ts",

package/properties.d.ts

@@ -36,5 +36,5 @@ declare const ReferenceProperty: <T extends {
     }>> | null | undefined;
 } & {
     readonly id?: PrimaryKeyType | undefined;
-}, TModifier extends PropertyModifier<ReferenceValueType<T, Model<T>>>>(model: MaybeFunction<Model<T>>, config?: PropertyConfig<TModifier>, additionalMetadata?: {}) => ReferencePropertyInstance<T, TModifier>;
+}, TModifier extends PropertyModifier<ReferenceValueType<T, Model<T>, ModelInstance<T, Model<T>>>>>(model: MaybeFunction<Model<T>>, config?: PropertyConfig<TModifier>, additionalMetadata?: {}) => ReferencePropertyInstance<T, TModifier>;
 export { Property, UniqueId, DateProperty, ArrayProperty, ReferenceProperty, IntegerProperty, TextProperty, ConstantValueProperty, NumberProperty, ObjectProperty, EmailProperty, BooleanProperty, };

package/validation.d.ts

@@ -45,7 +45,7 @@ declare const referenceTypeMatch: <TModel extends {
     }>> | null | undefined;
 } & {
     readonly id?: import("./interfaces").PrimaryKeyType | undefined;
-}>(referencedModel: MaybeFunction<Model<TModel>>) => PropertyValidatorComponentTypeAdvanced<ModelInstance<TModel, any>, TModel>;
+}>(referencedModel: MaybeFunction<Model<TModel>>) => PropertyValidatorComponentTypeAdvanced<ModelInstance<TModel, any>, TModel, Model<TModel>, ModelInstance<TModel, Model<TModel>>>;
 declare const aggregateValidator: <T extends {
     readonly [s: string]: string | number | boolean | readonly string[] | (any & {
         readonly id?: import("./interfaces").PrimaryKeyType | undefined;
@@ -70,7 +70,7 @@ declare const aggregateValidator: <T extends {
     }>> | null | undefined;
 } & {
     readonly id?: import("./interfaces").PrimaryKeyType | undefined;
-}>(value: any, methodOrMethods: PropertyValidatorComponent<T> | readonly PropertyValidatorComponent<T>[]) => PropertyValidator<T, Model<T>>;
+}>(value: any, methodOrMethods: PropertyValidatorComponent<T, Model<T>, ModelInstance<T, Model<T>>> | readonly PropertyValidatorComponent<T, Model<T>, ModelInstance<T, Model<T>>>[]) => PropertyValidator<T, Model<T>, ModelInstance<T, Model<T>>>;
 declare const emptyValidator: PropertyValidatorComponentSync<any>;
 declare const createPropertyValidator: <T extends Arrayable<FunctionalValue>>(valueGetter: ValueGetter<T>, config: PropertyConfig<T>) => <TModel extends {
     readonly [s: string]: string | number | boolean | readonly string[] | (any & {
@@ -121,5 +121,5 @@ declare const createModelValidator: <T extends {
     }>> | null | undefined;
 } & {
     readonly id?: import("./interfaces").PrimaryKeyType | undefined;
-}, TModel extends Model<T> = Model<T>>(validators: PropertyValidators<T, TModel>, modelValidators?: readonly ModelValidatorComponent<T, TModel>[] | undefined) => (instance: ModelInstance<T, TModel>, propertyConfiguration: ValidatorConfiguration) => Promise<ModelErrors<T, TModel>>;
+}, TModel extends Model<T> = Model<T>>(validators: PropertyValidators<T, TModel>, modelValidators?: readonly ModelValidatorComponent<T, TModel, ModelInstance<T, TModel>>[] | undefined) => (instance: ModelInstance<T, TModel>, propertyConfiguration: ValidatorConfiguration) => Promise<ModelErrors<T, TModel>>;
 export { isNumber, isBoolean, isString, isInteger, isType, isDate, isArray, isRequired, maxNumber, minNumber, choices, maxTextLength, minTextLength, meetsRegex, aggregateValidator, emptyValidator, createPropertyValidator, createModelValidator, arrayType, referenceTypeMatch, TYPE_PRIMITIVES, };