@loopback/repository 4.0.0-alpha.8 → 4.1.0

package/dist/relations/relation.decorator.js

@@ -0,0 +1,88 @@
+"use strict";
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.referencesMany = exports.referencesOne = exports.embedsMany = exports.embedsOne = exports.getModelRelations = exports.relation = exports.RELATIONS_KEY = void 0;
+const core_1 = require("@loopback/core");
+const decorators_1 = require("../decorators");
+const relation_types_1 = require("./relation.types");
+exports.RELATIONS_KEY = 'loopback:relations';
+/**
+ * Decorator for relations
+ * @param definition
+ * @returns A property decorator
+ */
+function relation(definition) {
+    // Apply relation definition to the model class
+    return core_1.PropertyDecoratorFactory.createDecorator(exports.RELATIONS_KEY, definition, {
+        decoratorName: '@relation',
+    });
+}
+exports.relation = relation;
+/**
+ * Get metadata of all relations defined on a given model class.
+ *
+ * @param modelCtor - The model class (the constructor function).
+ * @returns A map of relation definitions
+ */
+function getModelRelations(modelCtor) {
+    // Build model definitions if `@model` is missing
+    const modelDef = (0, decorators_1.buildModelDefinition)(modelCtor);
+    return (modelDef === null || modelDef === void 0 ? void 0 : modelDef.relations) || {};
+}
+exports.getModelRelations = getModelRelations;
+//
+// placeholder decorators for relations that are not implemented yet
+// TODO: move these decorators to per-relation subdirectories
+//
+/**
+ * Decorator for embedsOne
+ * @param definition
+ * @returns A property decorator
+ */
+function embedsOne(definition) {
+    const rel = Object.assign({ type: relation_types_1.RelationType.embedsOne }, definition);
+    return core_1.PropertyDecoratorFactory.createDecorator(exports.RELATIONS_KEY, rel, {
+        decoratorName: '@embedsOne',
+    });
+}
+exports.embedsOne = embedsOne;
+/**
+ * Decorator for embedsMany
+ * @param definition
+ * @returns A property decorator
+ */
+function embedsMany(definition) {
+    const rel = Object.assign({ type: relation_types_1.RelationType.embedsMany }, definition);
+    return core_1.PropertyDecoratorFactory.createDecorator(exports.RELATIONS_KEY, rel, {
+        decoratorName: '@embedsMany',
+    });
+}
+exports.embedsMany = embedsMany;
+/**
+ * Decorator for referencesOne
+ * @param definition
+ * @returns A property decorator
+ */
+function referencesOne(definition) {
+    const rel = Object.assign({ type: relation_types_1.RelationType.referencesOne }, definition);
+    return core_1.PropertyDecoratorFactory.createDecorator(exports.RELATIONS_KEY, rel, {
+        decoratorName: '@referencesOne',
+    });
+}
+exports.referencesOne = referencesOne;
+/**
+ * Decorator for referencesMany
+ * @param definition
+ * @returns A property decorator
+ */
+function referencesMany(definition) {
+    const rel = Object.assign({ type: relation_types_1.RelationType.referencesMany }, definition);
+    return core_1.PropertyDecoratorFactory.createDecorator(exports.RELATIONS_KEY, rel, {
+        decoratorName: '@referencesMany',
+    });
+}
+exports.referencesMany = referencesMany;
+//# sourceMappingURL=relation.decorator.js.map

package/dist/relations/relation.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation.decorator.js","sourceRoot":"","sources":["../../src/relations/relation.decorator.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,yCAAwD;AACxD,8CAAmD;AAEnD,qDAA8C;AAEjC,QAAA,aAAa,GAAG,oBAAoB,CAAC;AAElD;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,UAAmB;IAC1C,+CAA+C;IAC/C,OAAO,+BAAwB,CAAC,eAAe,CAAC,qBAAa,EAAE,UAAU,EAAE;QACzE,aAAa,EAAE,WAAW;KAC3B,CAAC,CAAC;AACL,CAAC;AALD,4BAKC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,SAAuB;IAEvB,iDAAiD;IACjD,MAAM,QAAQ,GAAG,IAAA,iCAAoB,EAAC,SAAS,CAAC,CAAC;IACjD,OAAO,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,SAAS,KAAI,EAAE,CAAC;AACnC,CAAC;AAND,8CAMC;AAED,EAAE;AACF,oEAAoE;AACpE,6DAA6D;AAC7D,EAAE;AAEF;;;;GAIG;AACH,SAAgB,SAAS,CAAC,UAAmB;IAC3C,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,6BAAY,CAAC,SAAS,EAAC,EAAE,UAAU,CAAC,CAAC;IACtE,OAAO,+BAAwB,CAAC,eAAe,CAAC,qBAAa,EAAE,GAAG,EAAE;QAClE,aAAa,EAAE,YAAY;KAC5B,CAAC,CAAC;AACL,CAAC;AALD,8BAKC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAC,UAAmB;IAC5C,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,6BAAY,CAAC,UAAU,EAAC,EAAE,UAAU,CAAC,CAAC;IACvE,OAAO,+BAAwB,CAAC,eAAe,CAAC,qBAAa,EAAE,GAAG,EAAE;QAClE,aAAa,EAAE,aAAa;KAC7B,CAAC,CAAC;AACL,CAAC;AALD,gCAKC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,UAAmB;IAC/C,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,6BAAY,CAAC,aAAa,EAAC,EAAE,UAAU,CAAC,CAAC;IAC1E,OAAO,+BAAwB,CAAC,eAAe,CAAC,qBAAa,EAAE,GAAG,EAAE;QAClE,aAAa,EAAE,gBAAgB;KAChC,CAAC,CAAC;AACL,CAAC;AALD,sCAKC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,UAAmB;IAChD,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,6BAAY,CAAC,cAAc,EAAC,EAAE,UAAU,CAAC,CAAC;IAC3E,OAAO,+BAAwB,CAAC,eAAe,CAAC,qBAAa,EAAE,GAAG,EAAE;QAClE,aAAa,EAAE,iBAAiB;KACjC,CAAC,CAAC;AACL,CAAC;AALD,wCAKC"}

package/dist/relations/relation.helpers.d.ts

@@ -0,0 +1,105 @@
+import { AnyObject, Entity, EntityCrudRepository, Filter, InclusionFilter, Options } from '..';
+/**
+ * Finds model instances that contain any of the provided foreign key values.
+ *
+ * @param targetRepository - The target repository where the related model instances are found
+ * @param fkName - Name of the foreign key
+ * @param fkValues - One value or array of values of the foreign key to be included
+ * @param scope - Additional scope constraints
+ * @param options - Options for the operations
+ */
+export declare function findByForeignKeys<Target extends Entity, TargetRelations extends object, ForeignKey extends StringKeyOf<Target>>(targetRepository: EntityCrudRepository<Target, unknown, TargetRelations>, fkName: ForeignKey, fkValues: Target[ForeignKey][] | Target[ForeignKey], scope?: Filter<Target> & {
+    totalLimit?: number;
+}, options?: Options): Promise<(Target & TargetRelations)[]>;
+export declare type StringKeyOf<T> = Extract<keyof T, string>;
+/**
+ * Returns model instances that include related models that have a registered
+ * resolver.
+ *
+ * @param targetRepository - The target repository where the model instances are found
+ * @param entities - An array of entity instances or data
+ * @param include -Inclusion filter
+ * @param options - Options for the operations
+ */
+export declare function includeRelatedModels<T extends Entity, Relations extends object = {}>(targetRepository: EntityCrudRepository<T, unknown, Relations>, entities: T[], include?: InclusionFilter[], options?: Options): Promise<(T & Relations)[]>;
+/**
+ * Returns an array of instances. The order of arrays is based on
+ * the order of sourceIds
+ *
+ * @param sourceIds - One value or array of values of the target key
+ * @param targetEntities - target entities that satisfy targetKey's value (ids).
+ * @param targetKey - name of the target key
+ *
+ */
+export declare function flattenTargetsOfOneToOneRelation<Target extends Entity>(sourceIds: unknown[], targetEntities: Target[], targetKey: StringKeyOf<Target>): (Target | undefined)[];
+/**
+ * Returns an array of instances. The order of arrays is based on
+ * as a result of one to many relation. The order of arrays is based on
+ * the order of sourceIds
+ *
+ * @param sourceIds - One value or array of values of the target key
+ * @param targetEntities - target entities that satisfy targetKey's value (ids).
+ * @param targetKey - name of the target key
+ *
+ */
+export declare function flattenTargetsOfOneToManyRelation<Target extends Entity>(sourceIds: unknown[], targetEntities: Target[], targetKey: StringKeyOf<Target>): (Target[] | undefined)[];
+/**
+ * Returns an array of instances from the target map. The order of arrays is based on
+ * the order of sourceIds
+ *
+ * @param sourceIds - One value or array of values (of the target key)
+ * @param targetMap - a map that matches sourceIds with instances
+ */
+export declare function flattenMapByKeys<T>(sourceIds: unknown[], targetMap: Map<unknown, T>): (T | undefined)[];
+/**
+ * Returns a map which maps key values(ids) to instances. The instances can be
+ * grouped by different strategies.
+ *
+ * @param list - an array of instances
+ * @param keyName - key name of the source
+ * @param reducer - a strategy to reduce inputs to single item or array
+ */
+export declare function buildLookupMap<Key, InType, OutType = InType>(list: InType[], keyName: StringKeyOf<InType>, reducer: (accumulator: OutType | undefined, current: InType) => OutType): Map<Key, OutType>;
+/**
+ * Returns value of a keyName. Aims to resolve ObjectId problem of Mongo.
+ *
+ * @param model - target model
+ * @param keyName - target key that gets the value from
+ */
+export declare function getKeyValue(model: AnyObject, keyName: string): unknown;
+/**
+ * Workaround for MongoDB, where the connector returns ObjectID
+ * values even for properties configured with "type: string".
+ *
+ * @param rawKey
+ */
+export declare function normalizeKey(rawKey: unknown): unknown;
+/**
+ * Returns an array of instances. For HasMany relation usage.
+ *
+ * @param acc
+ * @param it
+ */
+export declare function reduceAsArray<T>(acc: T[] | undefined, it: T): T[];
+/**
+ * Returns a single of an instance. For HasOne and BelongsTo relation usage.
+ *
+ * @param _acc
+ * @param it
+ */
+export declare function reduceAsSingleItem<T>(_acc: T | undefined, it: T): T;
+/**
+ * Dedupe an array
+ * @param input - an array of sourceIds
+ * @returns an array with unique items
+ */
+export declare function deduplicate<T>(input: T[]): T[];
+/**
+ * Checks if the value is BsonType (mongodb)
+ * It uses a general way to check the type ,so that it can detect
+ * different versions of bson that might be used in the code base.
+ * Might need to update in the future.
+ *
+ * @param value
+ */
+export declare function isBsonType(value: unknown): value is object;

package/dist/relations/relation.helpers.js

@@ -0,0 +1,304 @@
+"use strict";
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBsonType = exports.deduplicate = exports.reduceAsSingleItem = exports.reduceAsArray = exports.normalizeKey = exports.getKeyValue = exports.buildLookupMap = exports.flattenMapByKeys = exports.flattenTargetsOfOneToManyRelation = exports.flattenTargetsOfOneToOneRelation = exports.includeRelatedModels = exports.findByForeignKeys = void 0;
+const tslib_1 = require("tslib");
+const assert_1 = (0, tslib_1.__importDefault)(require("assert"));
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const lodash_1 = (0, tslib_1.__importStar)(require("lodash"));
+const __1 = require("..");
+const debug = (0, debug_1.default)('loopback:repository:relation-helpers');
+/**
+ * Finds model instances that contain any of the provided foreign key values.
+ *
+ * @param targetRepository - The target repository where the related model instances are found
+ * @param fkName - Name of the foreign key
+ * @param fkValues - One value or array of values of the foreign key to be included
+ * @param scope - Additional scope constraints
+ * @param options - Options for the operations
+ */
+async function findByForeignKeys(targetRepository, fkName, fkValues, scope, options) {
+    let value;
+    scope = (0, lodash_1.cloneDeep)(scope);
+    if (Array.isArray(fkValues)) {
+        if (fkValues.length === 0)
+            return [];
+        value = fkValues.length === 1 ? fkValues[0] : { inq: fkValues };
+    }
+    else {
+        value = fkValues;
+    }
+    let useScopeFilterGlobally = false;
+    // If its an include from a through model, fkValues will be an array.
+    // However, in this case we DO want to use the scope in the entire query, not
+    // on a per-fk basis
+    if (options) {
+        useScopeFilterGlobally = options.isThroughModelInclude;
+    }
+    // If `scope.limit` is not defined, there is no reason to apply the scope to
+    // each fk. This is to prevent unecessarily high database query counts.
+    // See: https://github.com/loopbackio/loopback-next/issues/8074
+    if (!(scope === null || scope === void 0 ? void 0 : scope.limit)) {
+        useScopeFilterGlobally = true;
+    }
+    // This code is to keep backward compatability.
+    // See https://github.com/loopbackio/loopback-next/issues/6832 for more info.
+    if (scope === null || scope === void 0 ? void 0 : scope.totalLimit) {
+        scope.limit = scope.totalLimit;
+        useScopeFilterGlobally = true;
+        delete scope.totalLimit;
+    }
+    const isScopeSet = scope && !lodash_1.default.isEmpty(scope);
+    if (isScopeSet && Array.isArray(fkValues) && !useScopeFilterGlobally) {
+        // Since there is a scope, there could be a where filter, a limit, an order
+        // and we should run the scope in multiple queries so we can respect the
+        // scope filter params
+        const findPromises = fkValues.map(fk => {
+            const where = { [fkName]: fk };
+            let localScope = (0, lodash_1.cloneDeep)(scope);
+            // combine where clause to scope filter
+            localScope = new __1.FilterBuilder(localScope).impose({ where }).filter;
+            return targetRepository.find(localScope, options);
+        });
+        return Promise.all(findPromises).then(findResults => {
+            //findResults is an array of arrays for each scope result, so we need to flatten it before returning it
+            return lodash_1.default.flatten(findResults);
+        });
+    }
+    else {
+        const where = { [fkName]: value };
+        if (isScopeSet) {
+            // combine where clause to scope filter
+            scope = new __1.FilterBuilder(scope).impose({ where }).filter;
+        }
+        else {
+            scope = { where };
+        }
+        return targetRepository.find(scope, options);
+    }
+}
+exports.findByForeignKeys = findByForeignKeys;
+/**
+ * Returns model instances that include related models that have a registered
+ * resolver.
+ *
+ * @param targetRepository - The target repository where the model instances are found
+ * @param entities - An array of entity instances or data
+ * @param include -Inclusion filter
+ * @param options - Options for the operations
+ */
+async function includeRelatedModels(targetRepository, entities, include, options) {
+    entities = (0, lodash_1.cloneDeep)(entities);
+    include = (0, lodash_1.cloneDeep)(include);
+    const result = entities;
+    if (!include)
+        return result;
+    const invalidInclusions = include.filter(inclusionFilter => !isInclusionAllowed(targetRepository, inclusionFilter));
+    if (invalidInclusions.length) {
+        const msg = 'Invalid "filter.include" entries: ' +
+            invalidInclusions
+                .map(inclusionFilter => JSON.stringify(inclusionFilter))
+                .join('; ');
+        const err = new Error(msg);
+        Object.assign(err, {
+            code: 'INVALID_INCLUSION_FILTER',
+            statusCode: 400,
+        });
+        throw err;
+    }
+    const resolveTasks = include.map(async (inclusionFilter) => {
+        const relationName = typeof inclusionFilter === 'string'
+            ? inclusionFilter
+            : inclusionFilter.relation;
+        const resolver = targetRepository.inclusionResolvers.get(relationName);
+        const targets = await resolver(entities, inclusionFilter, options);
+        result.forEach((entity, ix) => {
+            const src = entity;
+            src[relationName] = targets[ix];
+        });
+    });
+    await Promise.all(resolveTasks);
+    return result;
+}
+exports.includeRelatedModels = includeRelatedModels;
+/**
+ * Checks if the resolver of the inclusion relation is registered
+ * in the inclusionResolver of the target repository
+ *
+ * @param targetRepository - The target repository where the relations are registered
+ * @param include - Inclusion filter
+ */
+function isInclusionAllowed(targetRepository, include) {
+    const relationName = typeof include === 'string' ? include : include.relation;
+    if (!relationName) {
+        debug('isInclusionAllowed for %j? No: missing relation name', include);
+        return false;
+    }
+    const allowed = targetRepository.inclusionResolvers.has(relationName);
+    debug('isInclusionAllowed for %j (relation %s)? %s', include, allowed);
+    return allowed;
+}
+/**
+ * Returns an array of instances. The order of arrays is based on
+ * the order of sourceIds
+ *
+ * @param sourceIds - One value or array of values of the target key
+ * @param targetEntities - target entities that satisfy targetKey's value (ids).
+ * @param targetKey - name of the target key
+ *
+ */
+function flattenTargetsOfOneToOneRelation(sourceIds, targetEntities, targetKey) {
+    const lookup = buildLookupMap(targetEntities, targetKey, reduceAsSingleItem);
+    return flattenMapByKeys(sourceIds, lookup);
+}
+exports.flattenTargetsOfOneToOneRelation = flattenTargetsOfOneToOneRelation;
+/**
+ * Returns an array of instances. The order of arrays is based on
+ * as a result of one to many relation. The order of arrays is based on
+ * the order of sourceIds
+ *
+ * @param sourceIds - One value or array of values of the target key
+ * @param targetEntities - target entities that satisfy targetKey's value (ids).
+ * @param targetKey - name of the target key
+ *
+ */
+function flattenTargetsOfOneToManyRelation(sourceIds, targetEntities, targetKey) {
+    debug('flattenTargetsOfOneToManyRelation');
+    debug('sourceIds', sourceIds);
+    debug('sourceId types', sourceIds.map(i => typeof i));
+    debug('targetEntities', targetEntities);
+    debug('targetKey', targetKey);
+    const lookup = buildLookupMap(targetEntities, targetKey, reduceAsArray);
+    debug('lookup map', lookup);
+    return flattenMapByKeys(sourceIds, lookup);
+}
+exports.flattenTargetsOfOneToManyRelation = flattenTargetsOfOneToManyRelation;
+/**
+ * Returns an array of instances from the target map. The order of arrays is based on
+ * the order of sourceIds
+ *
+ * @param sourceIds - One value or array of values (of the target key)
+ * @param targetMap - a map that matches sourceIds with instances
+ */
+function flattenMapByKeys(sourceIds, targetMap) {
+    const result = new Array(sourceIds.length);
+    // mongodb: use string as key of targetMap, and convert sourceId to strings
+    // to make sure it gets the related instances.
+    sourceIds.forEach((id, index) => {
+        const key = normalizeKey(id);
+        const target = targetMap.get(key);
+        result[index] = target;
+    });
+    return result;
+}
+exports.flattenMapByKeys = flattenMapByKeys;
+/**
+ * Returns a map which maps key values(ids) to instances. The instances can be
+ * grouped by different strategies.
+ *
+ * @param list - an array of instances
+ * @param keyName - key name of the source
+ * @param reducer - a strategy to reduce inputs to single item or array
+ */
+function buildLookupMap(list, keyName, reducer) {
+    const lookup = new Map();
+    for (const entity of list) {
+        // get a correct key value
+        const key = getKeyValue(entity, keyName);
+        // these 3 steps are to set up the map, the map differs according to the reducer.
+        const original = lookup.get(key);
+        const reduced = reducer(original, entity);
+        lookup.set(key, reduced);
+    }
+    return lookup;
+}
+exports.buildLookupMap = buildLookupMap;
+/**
+ * Returns value of a keyName. Aims to resolve ObjectId problem of Mongo.
+ *
+ * @param model - target model
+ * @param keyName - target key that gets the value from
+ */
+function getKeyValue(model, keyName) {
+    return normalizeKey(model[keyName]);
+}
+exports.getKeyValue = getKeyValue;
+/**
+ * Workaround for MongoDB, where the connector returns ObjectID
+ * values even for properties configured with "type: string".
+ *
+ * @param rawKey
+ */
+function normalizeKey(rawKey) {
+    if (isBsonType(rawKey)) {
+        return rawKey.toString();
+    }
+    return rawKey;
+}
+exports.normalizeKey = normalizeKey;
+/**
+ * Returns an array of instances. For HasMany relation usage.
+ *
+ * @param acc
+ * @param it
+ */
+function reduceAsArray(acc, it) {
+    if (acc)
+        acc.push(it);
+    else
+        acc = [it];
+    return acc;
+}
+exports.reduceAsArray = reduceAsArray;
+/**
+ * Returns a single of an instance. For HasOne and BelongsTo relation usage.
+ *
+ * @param _acc
+ * @param it
+ */
+function reduceAsSingleItem(_acc, it) {
+    return it;
+}
+exports.reduceAsSingleItem = reduceAsSingleItem;
+/**
+ * Dedupe an array
+ * @param input - an array of sourceIds
+ * @returns an array with unique items
+ */
+function deduplicate(input) {
+    const uniqArray = [];
+    if (!input) {
+        return uniqArray;
+    }
+    (0, assert_1.default)(Array.isArray(input), 'array argument is required');
+    const comparableArray = input.map(item => normalizeKey(item));
+    for (let i = 0, n = comparableArray.length; i < n; i++) {
+        if (comparableArray.indexOf(comparableArray[i]) === i) {
+            uniqArray.push(input[i]);
+        }
+    }
+    return uniqArray;
+}
+exports.deduplicate = deduplicate;
+/**
+ * Checks if the value is BsonType (mongodb)
+ * It uses a general way to check the type ,so that it can detect
+ * different versions of bson that might be used in the code base.
+ * Might need to update in the future.
+ *
+ * @param value
+ */
+function isBsonType(value) {
+    if (typeof value !== 'object' || !value)
+        return false;
+    // bson@1.x stores _bsontype on ObjectID instance, bson@4.x on prototype
+    return check(value) || check(value.constructor.prototype);
+    function check(target) {
+        return Object.prototype.hasOwnProperty.call(target, '_bsontype');
+    }
+}
+exports.isBsonType = isBsonType;
+//# sourceMappingURL=relation.helpers.js.map

package/dist/relations/relation.helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation.helpers.js","sourceRoot":"","sources":["../../src/relations/relation.helpers.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,iEAA4B;AAC5B,+DAAiC;AACjC,8DAAoC;AACpC,0BASY;AACZ,MAAM,KAAK,GAAG,IAAA,eAAY,EAAC,sCAAsC,CAAC,CAAC;AAEnE;;;;;;;;GAQG;AACI,KAAK,UAAU,iBAAiB,CAKrC,gBAAwE,EACxE,MAAkB,EAClB,QAAmD,EACnD,KAA8C,EAC9C,OAAiB;IAEjB,IAAI,KAAK,CAAC;IACV,KAAK,GAAG,IAAA,kBAAS,EAAC,KAAK,CAAC,CAAC;IACzB,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC3B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QACrC,KAAK,GAAG,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,GAAG,EAAE,QAAQ,EAAC,CAAC;KAC/D;SAAM;QACL,KAAK,GAAG,QAAQ,CAAC;KAClB;IACD,IAAI,sBAAsB,GAAG,KAAK,CAAC;IAEnC,qEAAqE;IACrE,6EAA6E;IAC7E,oBAAoB;IACpB,IAAI,OAAO,EAAE;QACX,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC;KACxD;IAED,4EAA4E;IAC5E,uEAAuE;IACvE,+DAA+D;IAC/D,IAAI,CAAC,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,CAAA,EAAE;QACjB,sBAAsB,GAAG,IAAI,CAAC;KAC/B;IAED,+CAA+C;IAC/C,6EAA6E;IAC7E,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,EAAE;QACrB,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC;QAC/B,sBAAsB,GAAG,IAAI,CAAC;QAC9B,OAAO,KAAK,CAAC,UAAU,CAAC;KACzB;IAED,MAAM,UAAU,GAAG,KAAK,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9C,IAAI,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,sBAAsB,EAAE;QACpE,2EAA2E;QAC3E,wEAAwE;QACxE,sBAAsB;QACtB,MAAM,YAAY,GAAG,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YACrC,MAAM,KAAK,GAAG,EAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAA6B,CAAC;YACzD,IAAI,UAAU,GAAG,IAAA,kBAAS,EAAC,KAAK,CAAC,CAAC;YAClC,uCAAuC;YACvC,UAAU,GAAG,IAAI,iBAAa,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,EAAC,KAAK,EAAC,CAAC,CAAC,MAAM,CAAC;YAClE,OAAO,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAClD,uGAAuG;YACvG,OAAO,gBAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;KACJ;SAAM;QACL,MAAM,KAAK,GAAG,EAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAA6B,CAAC;QAE5D,IAAI,UAAU,EAAE;YACd,uCAAuC;YACvC,KAAK,GAAG,IAAI,iBAAa,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,EAAC,KAAK,EAAC,CAAC,CAAC,MAAM,CAAC;SACzD;aAAM;YACL,KAAK,GAAG,EAAC,KAAK,EAAmB,CAAC;SACnC;QAED,OAAO,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;KAC9C;AACH,CAAC;AAvED,8CAuEC;AAID;;;;;;;;GAQG;AAEI,KAAK,UAAU,oBAAoB,CAIxC,gBAA6D,EAC7D,QAAa,EACb,OAA2B,EAC3B,OAAiB;IAEjB,QAAQ,GAAG,IAAA,kBAAS,EAAC,QAAQ,CAAC,CAAC;IAC/B,OAAO,GAAG,IAAA,kBAAS,EAAC,OAAO,CAAC,CAAC;IAC7B,MAAM,MAAM,GAAG,QAA6B,CAAC;IAC7C,IAAI,CAAC,OAAO;QAAE,OAAO,MAAM,CAAC;IAE5B,MAAM,iBAAiB,GAAG,OAAO,CAAC,MAAM,CACtC,eAAe,CAAC,EAAE,CAAC,CAAC,kBAAkB,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAC1E,CAAC;IACF,IAAI,iBAAiB,CAAC,MAAM,EAAE;QAC5B,MAAM,GAAG,GACP,oCAAoC;YACpC,iBAAiB;iBACd,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;iBACvD,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE;YACjB,IAAI,EAAE,0BAA0B;YAChC,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;QACH,MAAM,GAAG,CAAC;KACX;IAED,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,EAAC,eAAe,EAAC,EAAE;QACvD,MAAM,YAAY,GAChB,OAAO,eAAe,KAAK,QAAQ;YACjC,CAAC,CAAC,eAAe;YACjB,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC;QAC/B,MAAM,QAAQ,GAAG,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,CAAC,YAAY,CAAE,CAAC;QACxE,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;QAEnE,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE;YAC5B,MAAM,GAAG,GAAG,MAAmB,CAAC;YAChC,GAAG,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAEhC,OAAO,MAAM,CAAC;AAChB,CAAC;AAhDD,oDAgDC;AACD;;;;;;GAMG;AACH,SAAS,kBAAkB,CACzB,gBAA6D,EAC7D,OAAwB;IAExB,MAAM,YAAY,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC9E,IAAI,CAAC,YAAY,EAAE;QACjB,KAAK,CAAC,sDAAsD,EAAE,OAAO,CAAC,CAAC;QACvE,OAAO,KAAK,CAAC;KACd;IACD,MAAM,OAAO,GAAG,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IACtE,KAAK,CAAC,6CAA6C,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACvE,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,gCAAgC,CAC9C,SAAoB,EACpB,cAAwB,EACxB,SAA8B;IAE9B,MAAM,MAAM,GAAG,cAAc,CAC3B,cAAc,EACd,SAAS,EACT,kBAAkB,CACnB,CAAC;IAEF,OAAO,gBAAgB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAC7C,CAAC;AAZD,4EAYC;AAED;;;;;;;;;GASG;AACH,SAAgB,iCAAiC,CAC/C,SAAoB,EACpB,cAAwB,EACxB,SAA8B;IAE9B,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAC3C,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IAC9B,KAAK,CACH,gBAAgB,EAChB,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAC7B,CAAC;IACF,KAAK,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;IACxC,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IAE9B,MAAM,MAAM,GAAG,cAAc,CAC3B,cAAc,EACd,SAAS,EACT,aAAa,CACd,CAAC;IAEF,KAAK,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IAE5B,OAAO,gBAAgB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAC7C,CAAC;AAvBD,8EAuBC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,SAAoB,EACpB,SAA0B;IAE1B,MAAM,MAAM,GAAsB,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC9D,2EAA2E;IAC3E,8CAA8C;IAC9C,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;QAC9B,MAAM,GAAG,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;QAC7B,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAdD,4CAcC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAC5B,IAAc,EACd,OAA4B,EAC5B,OAAuE;IAEvE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAgB,CAAC;IACvC,KAAK,MAAM,MAAM,IAAI,IAAI,EAAE;QACzB,0BAA0B;QAC1B,MAAM,GAAG,GAAG,WAAW,CAAC,MAAM,EAAE,OAAO,CAAQ,CAAC;QAChD,iFAAiF;QACjF,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC1C,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;KAC1B;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAfD,wCAeC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,KAAgB,EAAE,OAAe;IAC3D,OAAO,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AACtC,CAAC;AAFD,kCAEC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAAC,MAAe;IAC1C,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE;QACtB,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;KAC1B;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AALD,oCAKC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAI,GAAoB,EAAE,EAAK;IAC1D,IAAI,GAAG;QAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;;QACjB,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,GAAG,CAAC;AACb,CAAC;AAJD,sCAIC;AACD;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAI,IAAmB,EAAE,EAAK;IAC9D,OAAO,EAAE,CAAC;AACZ,CAAC;AAFD,gDAEC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAI,KAAU;IACvC,MAAM,SAAS,GAAQ,EAAE,CAAC;IAC1B,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,SAAS,CAAC;KAClB;IACD,IAAA,gBAAM,EAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,4BAA4B,CAAC,CAAC;IAE3D,MAAM,eAAe,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QACtD,IAAI,eAAe,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;YACrD,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1B;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAdD,kCAcC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CAAC,KAAc;IACvC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IAEtD,wEAAwE;IACxE,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAE1D,SAAS,KAAK,CAAC,MAAe;QAC5B,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACnE,CAAC;AACH,CAAC;AATD,gCASC"}

package/dist/relations/relation.types.d.ts

@@ -0,0 +1,142 @@
+import { InclusionFilter } from '@loopback/filter';
+import { Options } from '../common-types';
+import { Entity } from '../model';
+import { TypeResolver } from '../type-resolver';
+export declare enum RelationType {
+    belongsTo = "belongsTo",
+    hasOne = "hasOne",
+    hasMany = "hasMany",
+    embedsOne = "embedsOne",
+    embedsMany = "embedsMany",
+    referencesOne = "referencesOne",
+    referencesMany = "referencesMany"
+}
+export interface RelationDefinitionBase {
+    /**
+     * The type of the relation, must be one of RelationType values.
+     */
+    type: RelationType;
+    /**
+     * True for relations targeting multiple instances (e.g. HasMany),
+     * false for relations with a single target (e.g. BelongsTo, HasOne).
+     * This property is needed by OpenAPI/JSON Schema generator.
+     */
+    targetsMany: boolean;
+    /**
+     * The relation name, typically matching the name of the accessor property
+     * defined on the source model. For example "orders" or "customer".
+     */
+    name: string;
+    /**
+     * The source model of this relation.
+     *
+     * E.g. when a Customer has many Order instances, then Customer is the source.
+     */
+    source: typeof Entity;
+    /**
+     * The target model of this relation.
+     *
+     * E.g. when a Customer has many Order instances, then Order is the target.
+     */
+    target: TypeResolver<Entity, typeof Entity>;
+}
+/**
+ * HasManyDefinition defines one-to-many relations and also possible defines
+ * many-to-many relations with through models.
+ */
+export interface HasManyDefinition extends RelationDefinitionBase {
+    type: RelationType.hasMany;
+    targetsMany: true;
+    /**
+     * keyTo: The foreign key used by the target model for this relation.
+     * keyFrom: The source key used by the source model for this relation.
+     *
+     * E.g. when a Customer has many Order instances, then keyTo is "customerId".
+     * Note that "customerId" is the default FK assumed by the framework, users
+     * can provide a custom FK name by setting "keyTo".
+     * And Customer.id is keyFrom. keyFrom defaults to the id property of a model.
+     * Users can provide a custom source key name by setting "keyTo".
+     *
+     */
+    keyTo?: string;
+    keyFrom?: string;
+    /**
+     * Description of the through model of the hasManyThrough relation.
+     *
+     * A `hasManyThrough` relation defines a many-to-many connection with another model.
+     * This relation indicates that the declaring model can be matched with zero or more
+     * instances of another model by proceeding through a third model.
+     *
+     * E.g a Category has many Products, and a Product can have many Categories.
+     * CategoryProductLink can be the through model.
+     * Such a through model has information of foreign keys of the source model(Category) and the target model(Product).
+     *
+     * Warning: The hasManyThrough interface is experimental and is subject to change.
+     * If backwards-incompatible changes are made, a new major version may not be
+     * released.
+     */
+    through?: {
+        /**
+         * The through model of this relation.
+         *
+         * E.g. when a Category has many CategoryProductLink instances and a Product has many CategoryProductLink instances,
+         * then CategoryProductLink is through.
+         */
+        model: TypeResolver<Entity, typeof Entity>;
+        /**
+         * The foreign key of the source model defined in the through model, e.g. CategoryProductLink#categoryId
+         */
+        keyFrom?: string;
+        /**
+         * The foreign key of the target model defined in the through model, e.g. CategoryProductLink#productId
+         */
+        keyTo?: string;
+    };
+}
+export interface BelongsToDefinition extends RelationDefinitionBase {
+    type: RelationType.belongsTo;
+    targetsMany: false;
+    keyFrom?: string;
+    keyTo?: string;
+}
+export interface HasOneDefinition extends RelationDefinitionBase {
+    type: RelationType.hasOne;
+    targetsMany: false;
+    /**
+     * keyTo: The foreign key used by the target model for this relation.
+     * keyFrom: The source key used by the source model for this relation.
+     *
+     * E.g. when a Customer has one Address instance, then keyTo is "customerId".
+     * Note that "customerId" is the default FK assumed by the framework, users
+     * can provide a custom FK name by setting "keyTo".
+     * And Customer.id is keyFrom. keyFrom defaults to the id property of a model.
+     * Users can provide a custom source key name by setting "keyTo".
+     */
+    keyTo?: string;
+    keyFrom?: string;
+}
+/**
+ * A union type describing all possible Relation metadata objects.
+ */
+export declare type RelationMetadata = HasManyDefinition | BelongsToDefinition | HasOneDefinition | RelationDefinitionBase;
+export { Getter } from '@loopback/core';
+/**
+ * @returns An array of resolved values, the items must be ordered in the same
+ * way as `sourceEntities`. The resolved value can be one of:
+ * - `undefined` when no target model(s) were found
+ * - `Entity` for relations targeting a single model
+ * - `Entity[]` for relations targeting multiple models
+ */
+export declare type InclusionResolver<S extends Entity, T extends Entity> = (
+/**
+ * List of source models as returned by the first database query.
+ */
+sourceEntities: S[], 
+/**
+ * Inclusion requested by the user (e.g. scope constraints to apply).
+ */
+inclusion: InclusionFilter, 
+/**
+ * Generic options object, e.g. carrying the Transaction object.
+ */
+options?: Options) => Promise<(T | undefined)[] | (T[] | undefined)[]>;

package/dist/relations/relation.types.js

@@ -0,0 +1,21 @@
+"use strict";
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/repository
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Getter = exports.RelationType = void 0;
+var RelationType;
+(function (RelationType) {
+    RelationType["belongsTo"] = "belongsTo";
+    RelationType["hasOne"] = "hasOne";
+    RelationType["hasMany"] = "hasMany";
+    RelationType["embedsOne"] = "embedsOne";
+    RelationType["embedsMany"] = "embedsMany";
+    RelationType["referencesOne"] = "referencesOne";
+    RelationType["referencesMany"] = "referencesMany";
+})(RelationType = exports.RelationType || (exports.RelationType = {}));
+// Re-export Getter so that users don't have to import from @loopback/context
+var core_1 = require("@loopback/core");
+Object.defineProperty(exports, "Getter", { enumerable: true, get: function () { return core_1.Getter; } });
+//# sourceMappingURL=relation.types.js.map