functional-models 2.1.2 → 2.1.4

package/interfaces.d.ts

@@ -53,11 +53,11 @@ declare type PropertyInstance<TValue extends Arrayable<FunctionalValue>, T exten
 declare type PropertiesList<T extends FunctionalModel> = {
     readonly [P in keyof T as T[P] extends Arrayable<FunctionalValue> ? P : never]: PropertyInstance<any>;
 };
-interface ModelReferencePropertyInstance<T extends FunctionalModel, TProperty extends Arrayable<FunctionalValue>, TModel extends Model<T> = Model<T>> extends PropertyInstance<TProperty> {
-    readonly getReferencedId: (instanceValues: ModelReference<T>) => Maybe<PrimaryKeyType>;
+interface ModelReferencePropertyInstance<T extends FunctionalModel, TProperty extends Arrayable<FunctionalValue>, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> extends PropertyInstance<TProperty> {
+    readonly getReferencedId: (instanceValues: ModelReference<T, TModel, TModelInstance>) => Maybe<PrimaryKeyType>;
     readonly getReferencedModel: () => TModel;
 }
-declare type ModelReference<T extends FunctionalModel> = T | TypedJsonObj<T> | PrimaryKeyType;
+declare type ModelReference<T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>> = T | TModelInstance | TypedJsonObj<T> | PrimaryKeyType;
 declare type DefaultPropertyValidators = Readonly<{
     required?: boolean;
     isInteger?: boolean;
@@ -81,7 +81,7 @@ declare type PropertyConfigContents<T extends Arrayable<FunctionalValue>> = Read
     autoNow?: boolean;
     fetcher?: ModelFetcher;
 }>;
-declare type ModelFetcher = <T extends FunctionalModel, TModel extends Model<T> = Model<T>>(model: TModel, primaryKey: PrimaryKeyType) => Promise<T | TypedJsonObj<T>> | Promise<null> | Promise<undefined>;
+declare type ModelFetcher = <T extends FunctionalModel, TModel extends Model<T> = Model<T>, TModelInstance extends ModelInstance<T, TModel> = ModelInstance<T, TModel>>(model: TModel, primaryKey: PrimaryKeyType) => Promise<T | TModelInstance | TypedJsonObj<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;

package/interfaces.js.map

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

package/lib.d.ts

@@ -4036,4 +4036,18 @@ declare const getValidatorFromConfigElseEmpty: <T extends FunctionalModel, TValu
 }>>;
 declare const getCommonNumberValidators: <TModifier extends PropertyModifier<number>>(config: PropertyConfig<TModifier>) => readonly PropertyValidatorComponent<any>[];
 declare const mergeValidators: <T extends Arrayable<FunctionalValue>>(config: PropertyConfig<T>, validators: readonly (PropertyValidatorComponent<any> | PropertyValidatorComponentTypeAdvanced<any, any>)[]) => PropertyValidatorComponent<any>[];
-export { isReferencedProperty, getValueForModelInstance, getValueForReferencedModel, getCommonTextValidators, getValidatorFromConfigElseEmpty, getCommonNumberValidators, mergeValidators, };
+declare const isModelInstance: (obj: any) => obj is Readonly<{
+    get: import("./interfaces").PropertyGetters<any> & {
+        id?: (() => import("./interfaces").MaybePromise<PrimaryKeyType>) | undefined;
+    };
+    references: Readonly<{
+        [s: string]: () => import("./interfaces").Maybe<PrimaryKeyType>;
+    }>;
+    toObj: import("./interfaces").toObj<any>;
+    getPrimaryKeyName: () => string;
+    getPrimaryKey: () => PrimaryKeyType;
+    validators: import("./interfaces").PropertyValidators<any, any>;
+    validate: (options?: object | undefined) => Promise<import("./interfaces").ModelErrors<any>>;
+    getModel: () => any;
+}>;
+export { isReferencedProperty, getValueForModelInstance, getValueForReferencedModel, getCommonTextValidators, getValidatorFromConfigElseEmpty, getCommonNumberValidators, mergeValidators, isModelInstance, };

package/lib.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeValidators = exports.getCommonNumberValidators = exports.getValidatorFromConfigElseEmpty = exports.getCommonTextValidators = exports.getValueForReferencedModel = exports.getValueForModelInstance = exports.isReferencedProperty = void 0;
+exports.isModelInstance = exports.mergeValidators = exports.getCommonNumberValidators = exports.getValidatorFromConfigElseEmpty = exports.getCommonTextValidators = exports.getValueForReferencedModel = exports.getValueForModelInstance = exports.isReferencedProperty = void 0;
 const get_1 = __importDefault(require("lodash/get"));
 const utils_1 = require("./utils");
 const validation_1 = require("./validation");
@@ -23,6 +23,14 @@ const getValueForReferencedModel = (modelInstance, path) => __awaiter(void 0, vo
         return modelInstance.references[head]();
     }
     const modelReference = yield modelInstance.get[head]();
+    if (modelReference.toObj) {
+        const [nestedHead, nestedTail] = (0, utils_1.createHeadAndTail)(tail.split('.'), '.');
+        const value = yield modelReference.get[nestedHead]();
+        if (nestedTail) {
+            return (0, get_1.default)(value, nestedTail);
+        }
+        return value;
+    }
     return (0, get_1.default)(modelReference, tail);
 });
 exports.getValueForReferencedModel = getValueForReferencedModel;
@@ -64,4 +72,9 @@ const mergeValidators = (config, validators) => {
     return [...validators, ...((config === null || config === void 0 ? void 0 : config.validators) ? config.validators : [])];
 };
 exports.mergeValidators = mergeValidators;
+const isModelInstance = (obj) => {
+    // @ts-ignore
+    return Boolean(obj && obj.getPrimaryKeyName);
+};
+exports.isModelInstance = isModelInstance;
 //# sourceMappingURL=lib.js.map

package/lib.js.map

@@ -1 +1 @@
-{"version":3,"file":"lib.js","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,qDAA4B;AAY5B,mCAA2C;AAC3C,6CAMqB;AAErB,MAAM,0BAA0B,GAAG,CACjC,aAAiC,EACjC,IAAY,EACmB,EAAE;IACjC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,IAAA,yBAAiB,EAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;IAC5D,6DAA6D;IAC7D,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAA;KACxC;IACD,MAAM,cAAc,GAAG,MAAM,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAA;IACtD,OAAO,IAAA,aAAG,EAAC,cAAc,EAAE,IAAI,CAAC,CAAA;AAClC,CAAC,CAAA,CAAA;AAgEC,gEAA0B;AA9D5B,MAAM,wBAAwB,GAAG,CAC/B,aAAiC,EACjC,IAAY,EACmB,EAAE;IACjC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,IAAA,yBAAiB,EAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;IAC5D,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAA;IAC7C,OAAO,IAAI,CAAC,CAAC,CAAC,IAAA,aAAG,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;AACxC,CAAC,CAAA,CAAA;AAsDC,4DAAwB;AApD1B,MAAM,oBAAoB,GAAG,CAC3B,aAAiC,EACjC,GAAW,EACX,EAAE;IACF,OAAO,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;AACtC,CAAC,CAAA;AA8CC,oDAAoB;AA5CtB,MAAM,uBAAuB,GAAG,CAC9B,MAAiC,EACW,EAAE;IAC9C,OAAO;QACL,+BAA+B,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,EAAE,0BAAa,CAAC;QACjE,+BAA+B,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,EAAE,0BAAa,CAAC;KAClE,CAAA;AACH,CAAC,CAAA;AAwCC,0DAAuB;AAtCzB,MAAM,+BAA+B,GAAG,CAItC,KAAyB;AACzB,0CAA0C;AAC1C,eAA6D,EAC9B,EAAE;IACjC,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,CAAA;QACxC,OAAO,SAAS,CAAA;KACjB;IACD,OAAO,2BAAc,CAAA;AACvB,CAAC,CAAA;AA0BC,0EAA+B;AAxBjC,MAAM,yBAAyB,GAAG,CAChC,MAAiC,EACW,EAAE;IAC9C,OAAO;QACL,+BAA+B,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,EAAE,sBAAS,CAAC;QAC5D,+BAA+B,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,EAAE,sBAAS,CAAC;KAC7D,CAAA;AACH,CAAC,CAAA;AAkBC,8DAAyB;AAhB3B,MAAM,eAAe,GAAG,CACtB,MAAqC,EACrC,UAGG,EACgC,EAAE;IACrC,OAAO,CAAC,GAAG,UAAU,EAAE,GAAG,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,EAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAC1E,CAAC,CAAA;AASC,0CAAe"}
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../src/lib.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,qDAA4B;AAY5B,mCAA2C;AAC3C,6CAMqB;AAErB,MAAM,0BAA0B,GAAG,CACjC,aAAiC,EACjC,IAAY,EACmB,EAAE;IACjC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,IAAA,yBAAiB,EAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;IAC5D,6DAA6D;IAC7D,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAA;KACxC;IACD,MAAM,cAAc,GAAG,MAAM,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAA;IACtD,IAAI,cAAc,CAAC,KAAK,EAAE;QACxB,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,IAAA,yBAAiB,EAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;QACxE,MAAM,KAAK,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAA;QACpD,IAAI,UAAU,EAAE;YACd,OAAO,IAAA,aAAG,EAAC,KAAK,EAAE,UAAU,CAAC,CAAA;SAC9B;QACD,OAAO,KAAK,CAAA;KACb;IACD,OAAO,IAAA,aAAG,EAAC,cAAc,EAAE,IAAI,CAAC,CAAA;AAClC,CAAC,CAAA,CAAA;AAqEC,gEAA0B;AAnE5B,MAAM,wBAAwB,GAAG,CAC/B,aAAiC,EACjC,IAAY,EACmB,EAAE;IACjC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,IAAA,yBAAiB,EAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;IAC5D,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAA;IAC7C,OAAO,IAAI,CAAC,CAAC,CAAC,IAAA,aAAG,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;AACxC,CAAC,CAAA,CAAA;AA2DC,4DAAwB;AAzD1B,MAAM,oBAAoB,GAAG,CAC3B,aAAiC,EACjC,GAAW,EACX,EAAE;IACF,OAAO,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;AACtC,CAAC,CAAA;AAmDC,oDAAoB;AAjDtB,MAAM,uBAAuB,GAAG,CAC9B,MAAiC,EACW,EAAE;IAC9C,OAAO;QACL,+BAA+B,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,EAAE,0BAAa,CAAC;QACjE,+BAA+B,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,EAAE,0BAAa,CAAC;KAClE,CAAA;AACH,CAAC,CAAA;AA6CC,0DAAuB;AA3CzB,MAAM,+BAA+B,GAAG,CAItC,KAAyB;AACzB,0CAA0C;AAC1C,eAA6D,EAC9B,EAAE;IACjC,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,CAAA;QACxC,OAAO,SAAS,CAAA;KACjB;IACD,OAAO,2BAAc,CAAA;AACvB,CAAC,CAAA;AA+BC,0EAA+B;AA7BjC,MAAM,yBAAyB,GAAG,CAChC,MAAiC,EACW,EAAE;IAC9C,OAAO;QACL,+BAA+B,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,EAAE,sBAAS,CAAC;QAC5D,+BAA+B,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,EAAE,sBAAS,CAAC;KAC7D,CAAA;AACH,CAAC,CAAA;AAuBC,8DAAyB;AArB3B,MAAM,eAAe,GAAG,CACtB,MAAqC,EACrC,UAGG,EACgC,EAAE;IACrC,OAAO,CAAC,GAAG,UAAU,EAAE,GAAG,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,EAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AAC1E,CAAC,CAAA;AAcC,0CAAe;AAZjB,MAAM,eAAe,GAAG,CAAC,GAAQ,EAAkC,EAAE;IACnE,aAAa;IACb,OAAO,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAA;AAC9C,CAAC,CAAA;AAUC,0CAAe"}

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "functional-models",
-  "version": "2.1.2",
+  "version": "2.1.4",
   "description": "A library for creating JavaScript function based models.",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
     "test": "mocha -r ts-node/register test/**/*.test.ts",
     "test:coverage": "nyc npm run test",
+    "test:watch": "nodemon -e '*' --watch test --watch src --exec npm run test:coverage",
     "commit": "cz",
     "feature-tests": "./node_modules/.bin/cucumber-js -p default",
     "coverage": "nyc --all --reporter=lcov npm test",