@loopback/repository 4.0.0-alpha.9 → 4.0.0

package/dist/relations/belongs-to/belongs-to.inclusion-resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"belongs-to.inclusion-resolver.js","sourceRoot":"","sources":["../../../src/relations/belongs-to/belongs-to.inclusion-resolver.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAMhE,0DAK6B;AAM7B,6DAA8D;AAE9D;;;;;;;;;GASG;AACH,SAAgB,gCAAgC,CAK9C,IAAyB,EACzB,aAEC;IAED,MAAM,YAAY,GAAG,IAAA,6CAAwB,EAAC,IAAI,CAAC,CAAC;IAEpD,OAAO,KAAK,UAAU,mBAAmB,CACvC,QAAkB,EAClB,SAA0B,EAC1B,OAAiB;QAEjB,IAAI,CAAC,QAAQ,CAAC,MAAM;YAAE,OAAO,EAAE,CAAC;QAEhC,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC;QACvC,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAE,CAAe,CAAC,SAAS,CAAC,CAAC,CAAC;QACjE,MAAM,SAAS,GAAG,YAAY,CAAC,KAA4B,CAAC;QAC5D,MAAM,gBAAgB,GAAG,IAAA,8BAAW,EAAC,SAAS,CAAC,CAAC;QAEhD,MAAM,KAAK,GACT,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAE,SAAS,CAAC,KAAwB,CAAC;QAE3E,MAAM,UAAU,GAAG,MAAM,aAAa,EAAE,CAAC;QACzC,MAAM,YAAY,GAAG,MAAM,IAAA,oCAAiB,EAC1C,UAAU,EACV,SAAS,EACT,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAC/B,KAAK,EACL,OAAO,CACR,CAAC;QAEF,OAAO,IAAA,mDAAgC,EAAC,SAAS,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;IAC9E,CAAC,CAAC;AACJ,CAAC;AAtCD,4EAsCC"}

package/dist/relations/belongs-to/belongs-to.repository.d.ts

@@ -0,0 +1,28 @@
+import { Getter } from '@loopback/core';
+import { DataObject, Options } from '../../common-types';
+import { Entity } from '../../model';
+import { EntityCrudRepository } from '../../repositories';
+/**
+ * CRUD operations for a target repository of a BelongsTo relation
+ */
+export interface BelongsToRepository<Target extends Entity> {
+    /**
+     * Gets the target model instance
+     * @param options
+     * @returns A promise resolved with the target object or rejected
+     * with an EntityNotFoundError when target model instance was not found.
+     */
+    get(options?: Options): Promise<Target>;
+}
+export declare class DefaultBelongsToRepository<TargetEntity extends Entity, TargetId, TargetRepository extends EntityCrudRepository<TargetEntity, TargetId>> implements BelongsToRepository<TargetEntity> {
+    getTargetRepository: Getter<TargetRepository>;
+    constraint: DataObject<TargetEntity>;
+    /**
+     * Constructor of DefaultBelongsToEntityCrudRepository
+     * @param getTargetRepository - the getter of the related target model repository instance
+     * @param constraint - the key value pair representing foreign key name to constrain
+     * the target repository instance
+     */
+    constructor(getTargetRepository: Getter<TargetRepository>, constraint: DataObject<TargetEntity>);
+    get(options?: Options): Promise<TargetEntity>;
+}

package/dist/relations/belongs-to/belongs-to.repository.js

@@ -0,0 +1,33 @@
+"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.DefaultBelongsToRepository = void 0;
+const errors_1 = require("../../errors");
+const repositories_1 = require("../../repositories");
+class DefaultBelongsToRepository {
+    /**
+     * Constructor of DefaultBelongsToEntityCrudRepository
+     * @param getTargetRepository - the getter of the related target model repository instance
+     * @param constraint - the key value pair representing foreign key name to constrain
+     * the target repository instance
+     */
+    constructor(getTargetRepository, constraint) {
+        this.getTargetRepository = getTargetRepository;
+        this.constraint = constraint;
+    }
+    async get(options) {
+        const targetRepo = await this.getTargetRepository();
+        const result = await targetRepo.find((0, repositories_1.constrainFilter)(undefined, this.constraint), options);
+        if (!result.length) {
+            // We don't have a direct access to the foreign key value here :(
+            const id = 'constraint ' + JSON.stringify(this.constraint);
+            throw new errors_1.EntityNotFoundError(targetRepo.entityClass, id);
+        }
+        return result[0];
+    }
+}
+exports.DefaultBelongsToRepository = DefaultBelongsToRepository;
+//# sourceMappingURL=belongs-to.repository.js.map

package/dist/relations/belongs-to/belongs-to.repository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"belongs-to.repository.js","sourceRoot":"","sources":["../../../src/relations/belongs-to/belongs-to.repository.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAIhE,yCAAiD;AAEjD,qDAAyE;AAezE,MAAa,0BAA0B;IAMrC;;;;;OAKG;IACH,YACS,mBAA6C,EAC7C,UAAoC;QADpC,wBAAmB,GAAnB,mBAAmB,CAA0B;QAC7C,eAAU,GAAV,UAAU,CAA0B;IAC1C,CAAC;IAEJ,KAAK,CAAC,GAAG,CAAC,OAAiB;QACzB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,IAAI,CAClC,IAAA,8BAAe,EAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,EAC3C,OAAO,CACR,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAClB,iEAAiE;YACjE,MAAM,EAAE,GAAG,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC3D,MAAM,IAAI,4BAAmB,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;SAC3D;QACD,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC;CACF;AA9BD,gEA8BC"}

package/dist/relations/belongs-to/index.d.ts

@@ -0,0 +1,4 @@
+export * from './belongs-to.decorator';
+export * from './belongs-to.repository';
+export * from './belongs-to.accessor';
+export * from './belongs-to.inclusion-resolver';

package/dist/relations/belongs-to/index.js

@@ -0,0 +1,12 @@
+"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 });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./belongs-to.decorator"), exports);
+(0, tslib_1.__exportStar)(require("./belongs-to.repository"), exports);
+(0, tslib_1.__exportStar)(require("./belongs-to.accessor"), exports);
+(0, tslib_1.__exportStar)(require("./belongs-to.inclusion-resolver"), exports);
+//# sourceMappingURL=index.js.map

package/dist/relations/belongs-to/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/relations/belongs-to/index.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;AAEhE,sEAAuC;AACvC,uEAAwC;AACxC,qEAAsC;AACtC,+EAAgD"}

package/dist/relations/has-many/has-many-through.helpers.d.ts

@@ -0,0 +1,182 @@
+import { DataObject, Entity, HasManyDefinition } from '../..';
+export declare type HasManyThroughResolvedDefinition = HasManyDefinition & {
+    keyTo: string;
+    keyFrom: string;
+    through: {
+        keyTo: string;
+        keyFrom: string;
+    };
+};
+/**
+ * Creates target constraint based on through models
+ * @param relationMeta - resolved hasManyThrough metadata
+ * @param throughInstances - an array of through instances
+ *
+ * @example
+ * ```ts
+ * const resolvedMetadata = {
+ *  // .. other props
+ *  keyFrom: 'id',
+ *  keyTo: 'id',
+ *  through: {
+ *    model: () => CategoryProductLink,
+ *    keyFrom: 'categoryId',
+ *    keyTo: 'productId',
+ *  },
+ * };
+ * createTargetConstraintFromThrough(resolvedMetadata,[{
+        id: 2,
+        categoryId: 2,
+        productId: 8,
+      }]);
+ * >>> {id: 8}
+ * createTargetConstraintFromThrough(resolvedMetadata, [
+      {
+        id: 2,
+        categoryId: 2,
+        productId: 8,
+      }, {
+        id: 1,
+        categoryId: 2,
+        productId: 9,
+      }
+  ]);
+
+  >>> {id: {inq: [9, 8]}}
+ * ```
+ */
+export declare function createTargetConstraintFromThrough<Target extends Entity, Through extends Entity>(relationMeta: HasManyThroughResolvedDefinition, throughInstances: Through[]): DataObject<Target>;
+/**
+ * Returns an array of target fks of the given throughInstances.
+ *
+ * @param relationMeta - resolved hasManyThrough metadata
+ * @param throughInstances - an array of through instances
+ *
+ * @example
+ * ```ts
+ * const resolvedMetadata = {
+ *  // .. other props
+ *  keyFrom: 'id',
+ *  keyTo: 'id',
+ *  through: {
+ *    model: () => CategoryProductLink,
+ *    keyFrom: 'categoryId',
+ *    keyTo: 'productId',
+ *  },
+ * };
+ * getTargetKeysFromThroughModels(resolvedMetadata,[{
+        id: 2,
+        categoryId: 2,
+        productId: 8,
+      }]);
+ * >>> [8]
+ * getTargetKeysFromThroughModels(resolvedMetadata, [
+      {
+        id: 2,
+        categoryId: 2,
+        productId: 8,
+      }, {
+        id: 1,
+        categoryId: 2,
+        productId: 9,
+      }
+  ]);
+  >>> [8, 9]
+ */
+export declare function getTargetKeysFromThroughModels<Through extends Entity, TargetID>(relationMeta: HasManyThroughResolvedDefinition, throughInstances: Through[]): TargetID[];
+/**
+ * Creates through constraint based on the source key
+ *
+ * @param relationMeta - resolved hasManyThrough metadata
+ * @param fkValue - foreign key of the source instance
+ * @internal
+ *
+ * @example
+ * ```ts
+ * const resolvedMetadata = {
+ *  // .. other props
+ *  keyFrom: 'id',
+ *  keyTo: 'id',
+ *  through: {
+ *    model: () => CategoryProductLink,
+ *    keyFrom: 'categoryId',
+ *    keyTo: 'productId',
+ *  },
+ * };
+ * createThroughConstraintFromSource(resolvedMetadata, 1);
+ *
+ * >>> {categoryId: 1}
+ * ```
+ */
+export declare function createThroughConstraintFromSource<Through extends Entity, SourceID>(relationMeta: HasManyThroughResolvedDefinition, fkValue: SourceID): DataObject<Through>;
+/**
+ * Returns an array of target ids of the given target instances.
+ *
+ * @param relationMeta - resolved hasManyThrough metadata
+ * @param targetInstances - an array of target instances
+ *
+ * @example
+ * ```ts
+ * const resolvedMetadata = {
+ *  // .. other props
+ *  keyFrom: 'id',
+ *  keyTo: 'id',
+ *  through: {
+ *    model: () => CategoryProductLink,
+ *    keyFrom: 'categoryId',
+ *    keyTo: 'productId',
+ *  },
+ * };
+ * getTargetKeysFromTargetModels(resolvedMetadata,[{
+        id: 2,
+        des: 'a target',
+      }]);
+ * >>> [2]
+ * getTargetKeysFromTargetModels(resolvedMetadata, [
+      {
+        id: 2,
+        des: 'a target',
+      }, {
+        id: 1,
+        des: 'a target',
+      }
+  ]);
+  >>> [2, 1]
+ */
+export declare function getTargetIdsFromTargetModels<Target extends Entity, TargetID>(relationMeta: HasManyThroughResolvedDefinition, targetInstances: Target[]): TargetID[];
+/**
+ * Creates through constraint based on the target foreign key
+ *
+ * @param relationMeta - resolved hasManyThrough metadata
+ * @param fkValue an array of the target instance foreign keys
+ * @internal
+ *
+ * @example
+ * ```ts
+ * const resolvedMetadata = {
+ *  // .. other props
+ *  keyFrom: 'id',
+ *  keyTo: 'id',
+ *  through: {
+ *    model: () => CategoryProductLink,
+ *    keyFrom: 'categoryId',
+ *    keyTo: 'productId',
+ *  },
+ * };
+ * createThroughConstraintFromTarget(resolvedMetadata, [3]);
+ *
+ * >>> {productId: 3}
+ *
+ * createThroughConstraintFromTarget(resolvedMetadata, [3,4]);
+ *
+ * >>> {productId: {inq:[3,4]}}
+ */
+export declare function createThroughConstraintFromTarget<Through extends Entity, TargetID>(relationMeta: HasManyThroughResolvedDefinition, fkValues: TargetID[]): DataObject<Through>;
+/**
+ * Resolves given hasMany metadata if target is specified to be a resolver.
+ * Mainly used to infer what the `keyTo` property should be from the target's
+ * belongsTo metadata
+ * @param relationMeta - hasManyThrough metadata to resolve
+ * @internal
+ */
+export declare function resolveHasManyThroughMetadata(relationMeta: HasManyDefinition): HasManyThroughResolvedDefinition;

package/dist/relations/has-many/has-many-through.helpers.js

@@ -0,0 +1,282 @@
+"use strict";
+// Copyright IBM Corp. 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.resolveHasManyThroughMetadata = exports.createThroughConstraintFromTarget = exports.getTargetIdsFromTargetModels = exports.createThroughConstraintFromSource = exports.getTargetKeysFromThroughModels = exports.createTargetConstraintFromThrough = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const lodash_1 = require("lodash");
+const __1 = require("../..");
+const has_many_helpers_1 = require("./has-many.helpers");
+const debug = (0, debug_1.default)('loopback:repository:relations:has-many-through:helpers');
+/**
+ * Creates target constraint based on through models
+ * @param relationMeta - resolved hasManyThrough metadata
+ * @param throughInstances - an array of through instances
+ *
+ * @example
+ * ```ts
+ * const resolvedMetadata = {
+ *  // .. other props
+ *  keyFrom: 'id',
+ *  keyTo: 'id',
+ *  through: {
+ *    model: () => CategoryProductLink,
+ *    keyFrom: 'categoryId',
+ *    keyTo: 'productId',
+ *  },
+ * };
+ * createTargetConstraintFromThrough(resolvedMetadata,[{
+        id: 2,
+        categoryId: 2,
+        productId: 8,
+      }]);
+ * >>> {id: 8}
+ * createTargetConstraintFromThrough(resolvedMetadata, [
+      {
+        id: 2,
+        categoryId: 2,
+        productId: 8,
+      }, {
+        id: 1,
+        categoryId: 2,
+        productId: 9,
+      }
+  ]);
+
+  >>> {id: {inq: [9, 8]}}
+ * ```
+ */
+function createTargetConstraintFromThrough(relationMeta, throughInstances) {
+    const fkValues = getTargetKeysFromThroughModels(relationMeta, throughInstances);
+    const targetPrimaryKey = relationMeta.keyTo;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const constraint = {
+        [targetPrimaryKey]: fkValues.length === 1 ? fkValues[0] : { inq: fkValues },
+    };
+    return constraint;
+}
+exports.createTargetConstraintFromThrough = createTargetConstraintFromThrough;
+/**
+ * Returns an array of target fks of the given throughInstances.
+ *
+ * @param relationMeta - resolved hasManyThrough metadata
+ * @param throughInstances - an array of through instances
+ *
+ * @example
+ * ```ts
+ * const resolvedMetadata = {
+ *  // .. other props
+ *  keyFrom: 'id',
+ *  keyTo: 'id',
+ *  through: {
+ *    model: () => CategoryProductLink,
+ *    keyFrom: 'categoryId',
+ *    keyTo: 'productId',
+ *  },
+ * };
+ * getTargetKeysFromThroughModels(resolvedMetadata,[{
+        id: 2,
+        categoryId: 2,
+        productId: 8,
+      }]);
+ * >>> [8]
+ * getTargetKeysFromThroughModels(resolvedMetadata, [
+      {
+        id: 2,
+        categoryId: 2,
+        productId: 8,
+      }, {
+        id: 1,
+        categoryId: 2,
+        productId: 9,
+      }
+  ]);
+  >>> [8, 9]
+ */
+function getTargetKeysFromThroughModels(relationMeta, throughInstances) {
+    const targetFkName = relationMeta.through.keyTo;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let fkValues = throughInstances.map((throughInstance) => throughInstance[targetFkName]);
+    fkValues = (0, __1.deduplicate)(fkValues);
+    return fkValues;
+}
+exports.getTargetKeysFromThroughModels = getTargetKeysFromThroughModels;
+/**
+ * Creates through constraint based on the source key
+ *
+ * @param relationMeta - resolved hasManyThrough metadata
+ * @param fkValue - foreign key of the source instance
+ * @internal
+ *
+ * @example
+ * ```ts
+ * const resolvedMetadata = {
+ *  // .. other props
+ *  keyFrom: 'id',
+ *  keyTo: 'id',
+ *  through: {
+ *    model: () => CategoryProductLink,
+ *    keyFrom: 'categoryId',
+ *    keyTo: 'productId',
+ *  },
+ * };
+ * createThroughConstraintFromSource(resolvedMetadata, 1);
+ *
+ * >>> {categoryId: 1}
+ * ```
+ */
+function createThroughConstraintFromSource(relationMeta, fkValue) {
+    const sourceFkName = relationMeta.through.keyFrom;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const constraint = { [sourceFkName]: fkValue };
+    return constraint;
+}
+exports.createThroughConstraintFromSource = createThroughConstraintFromSource;
+/**
+ * Returns an array of target ids of the given target instances.
+ *
+ * @param relationMeta - resolved hasManyThrough metadata
+ * @param targetInstances - an array of target instances
+ *
+ * @example
+ * ```ts
+ * const resolvedMetadata = {
+ *  // .. other props
+ *  keyFrom: 'id',
+ *  keyTo: 'id',
+ *  through: {
+ *    model: () => CategoryProductLink,
+ *    keyFrom: 'categoryId',
+ *    keyTo: 'productId',
+ *  },
+ * };
+ * getTargetKeysFromTargetModels(resolvedMetadata,[{
+        id: 2,
+        des: 'a target',
+      }]);
+ * >>> [2]
+ * getTargetKeysFromTargetModels(resolvedMetadata, [
+      {
+        id: 2,
+        des: 'a target',
+      }, {
+        id: 1,
+        des: 'a target',
+      }
+  ]);
+  >>> [2, 1]
+ */
+function getTargetIdsFromTargetModels(relationMeta, targetInstances) {
+    const targetId = relationMeta.keyTo;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let ids = [];
+    ids = targetInstances.map((targetInstance) => targetInstance[targetId]);
+    ids = (0, __1.deduplicate)(ids);
+    return ids;
+}
+exports.getTargetIdsFromTargetModels = getTargetIdsFromTargetModels;
+/**
+ * Creates through constraint based on the target foreign key
+ *
+ * @param relationMeta - resolved hasManyThrough metadata
+ * @param fkValue an array of the target instance foreign keys
+ * @internal
+ *
+ * @example
+ * ```ts
+ * const resolvedMetadata = {
+ *  // .. other props
+ *  keyFrom: 'id',
+ *  keyTo: 'id',
+ *  through: {
+ *    model: () => CategoryProductLink,
+ *    keyFrom: 'categoryId',
+ *    keyTo: 'productId',
+ *  },
+ * };
+ * createThroughConstraintFromTarget(resolvedMetadata, [3]);
+ *
+ * >>> {productId: 3}
+ *
+ * createThroughConstraintFromTarget(resolvedMetadata, [3,4]);
+ *
+ * >>> {productId: {inq:[3,4]}}
+ */
+function createThroughConstraintFromTarget(relationMeta, fkValues) {
+    if (fkValues === undefined || fkValues.length === 0) {
+        throw new Error('"fkValue" must be provided');
+    }
+    const targetFkName = relationMeta.through.keyTo;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const constraint = fkValues.length === 1
+        ? { [targetFkName]: fkValues[0] }
+        : { [targetFkName]: { inq: fkValues } };
+    return constraint;
+}
+exports.createThroughConstraintFromTarget = createThroughConstraintFromTarget;
+/**
+ * Resolves given hasMany metadata if target is specified to be a resolver.
+ * Mainly used to infer what the `keyTo` property should be from the target's
+ * belongsTo metadata
+ * @param relationMeta - hasManyThrough metadata to resolve
+ * @internal
+ */
+function resolveHasManyThroughMetadata(relationMeta) {
+    var _a, _b, _c, _d, _e, _f;
+    // some checks and relationMeta.keyFrom are handled in here
+    relationMeta = (0, has_many_helpers_1.resolveHasManyMetaHelper)(relationMeta);
+    if (!relationMeta.through) {
+        const reason = 'through must be specified';
+        throw new __1.InvalidRelationError(reason, relationMeta);
+    }
+    if (!(0, __1.isTypeResolver)((_a = relationMeta.through) === null || _a === void 0 ? void 0 : _a.model)) {
+        const reason = 'through.model must be a type resolver';
+        throw new __1.InvalidRelationError(reason, relationMeta);
+    }
+    const throughModel = relationMeta.through.model();
+    const throughModelProperties = (_b = throughModel.definition) === null || _b === void 0 ? void 0 : _b.properties;
+    const targetModel = relationMeta.target();
+    const targetModelProperties = (_c = targetModel.definition) === null || _c === void 0 ? void 0 : _c.properties;
+    // check if metadata is already complete
+    if (relationMeta.through.keyTo &&
+        throughModelProperties[relationMeta.through.keyTo] &&
+        relationMeta.through.keyFrom &&
+        throughModelProperties[relationMeta.through.keyFrom] &&
+        relationMeta.keyTo &&
+        targetModelProperties[relationMeta.keyTo]) {
+        // The explicit cast is needed because of a limitation of type inference
+        return relationMeta;
+    }
+    const sourceModel = relationMeta.source;
+    debug('Resolved model %s from given metadata: %o', targetModel.modelName, targetModel);
+    debug('Resolved model %s from given metadata: %o', throughModel.modelName, throughModel);
+    const sourceFkName = (_d = relationMeta.through.keyFrom) !== null && _d !== void 0 ? _d : (0, lodash_1.camelCase)(sourceModel.modelName + '_id');
+    if (!throughModelProperties[sourceFkName]) {
+        const reason = `through model ${throughModel.name} is missing definition of source foreign key`;
+        throw new __1.InvalidRelationError(reason, relationMeta);
+    }
+    const targetFkName = (_e = relationMeta.through.keyTo) !== null && _e !== void 0 ? _e : (0, lodash_1.camelCase)(targetModel.modelName + '_id');
+    if (!throughModelProperties[targetFkName]) {
+        const reason = `through model ${throughModel.name} is missing definition of target foreign key`;
+        throw new __1.InvalidRelationError(reason, relationMeta);
+    }
+    const targetPrimaryKey = (_f = relationMeta.keyTo) !== null && _f !== void 0 ? _f : targetModel.definition.idProperties()[0];
+    if (!targetPrimaryKey || !targetModelProperties[targetPrimaryKey]) {
+        const reason = `target model ${targetModel.modelName} does not have any primary key (id property)`;
+        throw new __1.InvalidRelationError(reason, relationMeta);
+    }
+    return Object.assign(relationMeta, {
+        keyTo: targetPrimaryKey,
+        keyFrom: relationMeta.keyFrom,
+        through: {
+            ...relationMeta.through,
+            keyTo: targetFkName,
+            keyFrom: sourceFkName,
+        },
+    });
+}
+exports.resolveHasManyThroughMetadata = resolveHasManyThroughMetadata;
+//# sourceMappingURL=has-many-through.helpers.js.map

package/dist/relations/has-many/has-many-through.helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"has-many-through.helpers.js","sourceRoot":"","sources":["../../../src/relations/has-many/has-many-through.helpers.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+DAAiC;AACjC,mCAAiC;AACjC,6BAOe;AACf,yDAA4D;AAE5D,MAAM,KAAK,GAAG,IAAA,eAAY,EACxB,wDAAwD,CACzD,CAAC;AAWF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,iCAAiC,CAI/C,YAA8C,EAC9C,gBAA2B;IAE3B,MAAM,QAAQ,GAAG,8BAA8B,CAC7C,YAAY,EACZ,gBAAgB,CACjB,CAAC;IACF,MAAM,gBAAgB,GAAG,YAAY,CAAC,KAAK,CAAC;IAE5C,8DAA8D;IAC9D,MAAM,UAAU,GAAQ;QACtB,CAAC,gBAAgB,CAAC,EAAE,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,GAAG,EAAE,QAAQ,EAAC;KAC1E,CAAC;IACF,OAAO,UAAU,CAAC;AACpB,CAAC;AAlBD,8EAkBC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,SAAgB,8BAA8B,CAI5C,YAA8C,EAC9C,gBAA2B;IAE3B,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC;IAChD,8DAA8D;IAC9D,IAAI,QAAQ,GAAQ,gBAAgB,CAAC,GAAG,CACtC,CAAC,eAAwB,EAAE,EAAE,CAC3B,eAAe,CAAC,YAA6B,CAAC,CACjD,CAAC;IACF,QAAQ,GAAG,IAAA,eAAW,EAAC,QAAQ,CAAC,CAAC;IACjC,OAAO,QAAsB,CAAC;AAChC,CAAC;AAfD,wEAeC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,iCAAiC,CAI/C,YAA8C,EAC9C,OAAiB;IAEjB,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC;IAClD,8DAA8D;IAC9D,MAAM,UAAU,GAAQ,EAAC,CAAC,YAAY,CAAC,EAAE,OAAO,EAAC,CAAC;IAClD,OAAO,UAAU,CAAC;AACpB,CAAC;AAXD,8EAWC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,SAAgB,4BAA4B,CAC1C,YAA8C,EAC9C,eAAyB;IAEzB,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC;IACpC,8DAA8D;IAC9D,IAAI,GAAG,GAAG,EAAS,CAAC;IACpB,GAAG,GAAG,eAAe,CAAC,GAAG,CACvB,CAAC,cAAsB,EAAE,EAAE,CAAC,cAAc,CAAC,QAAwB,CAAC,CACrE,CAAC;IACF,GAAG,GAAG,IAAA,eAAW,EAAC,GAAG,CAAC,CAAC;IACvB,OAAO,GAAiB,CAAC;AAC3B,CAAC;AAZD,oEAYC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,iCAAiC,CAI/C,YAA8C,EAC9C,QAAoB;IAEpB,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;QACnD,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;KAC/C;IACD,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC;IAEhD,8DAA8D;IAC9D,MAAM,UAAU,GACd,QAAQ,CAAC,MAAM,KAAK,CAAC;QACnB,CAAC,CAAC,EAAC,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAC;QAC/B,CAAC,CAAC,EAAC,CAAC,YAAY,CAAC,EAAE,EAAC,GAAG,EAAE,QAAQ,EAAC,EAAC,CAAC;IAExC,OAAO,UAAiC,CAAC;AAC3C,CAAC;AAnBD,8EAmBC;AAED;;;;;;GAMG;AACH,SAAgB,6BAA6B,CAC3C,YAA+B;;IAE/B,2DAA2D;IAC3D,YAAY,GAAG,IAAA,2CAAwB,EAAC,YAAY,CAAC,CAAC;IAEtD,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;QACzB,MAAM,MAAM,GAAG,2BAA2B,CAAC;QAC3C,MAAM,IAAI,wBAAoB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACtD;IACD,IAAI,CAAC,IAAA,kBAAc,EAAC,MAAA,YAAY,CAAC,OAAO,0CAAE,KAAK,CAAC,EAAE;QAChD,MAAM,MAAM,GAAG,uCAAuC,CAAC;QACvD,MAAM,IAAI,wBAAoB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACtD;IAED,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IAClD,MAAM,sBAAsB,GAAG,MAAA,YAAY,CAAC,UAAU,0CAAE,UAAU,CAAC;IAEnE,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;IAC1C,MAAM,qBAAqB,GAAG,MAAA,WAAW,CAAC,UAAU,0CAAE,UAAU,CAAC;IAEjE,wCAAwC;IACxC,IACE,YAAY,CAAC,OAAO,CAAC,KAAK;QAC1B,sBAAsB,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC;QAClD,YAAY,CAAC,OAAO,CAAC,OAAO;QAC5B,sBAAsB,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC;QACpD,YAAY,CAAC,KAAK;QAClB,qBAAqB,CAAC,YAAY,CAAC,KAAK,CAAC,EACzC;QACA,wEAAwE;QACxE,OAAO,YAAgD,CAAC;KACzD;IAED,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC;IAExC,KAAK,CACH,2CAA2C,EAC3C,WAAW,CAAC,SAAS,EACrB,WAAW,CACZ,CAAC;IAEF,KAAK,CACH,2CAA2C,EAC3C,YAAY,CAAC,SAAS,EACtB,YAAY,CACb,CAAC;IAEF,MAAM,YAAY,GAChB,MAAA,YAAY,CAAC,OAAO,CAAC,OAAO,mCAAI,IAAA,kBAAS,EAAC,WAAW,CAAC,SAAS,GAAG,KAAK,CAAC,CAAC;IAC3E,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,EAAE;QACzC,MAAM,MAAM,GAAG,iBAAiB,YAAY,CAAC,IAAI,8CAA8C,CAAC;QAChG,MAAM,IAAI,wBAAoB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACtD;IAED,MAAM,YAAY,GAChB,MAAA,YAAY,CAAC,OAAO,CAAC,KAAK,mCAAI,IAAA,kBAAS,EAAC,WAAW,CAAC,SAAS,GAAG,KAAK,CAAC,CAAC;IACzE,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,EAAE;QACzC,MAAM,MAAM,GAAG,iBAAiB,YAAY,CAAC,IAAI,8CAA8C,CAAC;QAChG,MAAM,IAAI,wBAAoB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACtD;IAED,MAAM,gBAAgB,GACpB,MAAA,YAAY,CAAC,KAAK,mCAAI,WAAW,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC;IACjE,IAAI,CAAC,gBAAgB,IAAI,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,EAAE;QACjE,MAAM,MAAM,GAAG,gBAAgB,WAAW,CAAC,SAAS,8CAA8C,CAAC;QACnG,MAAM,IAAI,wBAAoB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;KACtD;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE;QACjC,KAAK,EAAE,gBAAgB;QACvB,OAAO,EAAE,YAAY,CAAC,OAAQ;QAC9B,OAAO,EAAE;YACP,GAAG,YAAY,CAAC,OAAO;YACvB,KAAK,EAAE,YAAY;YACnB,OAAO,EAAE,YAAY;SACtB;KACF,CAAC,CAAC;AACL,CAAC;AA9ED,sEA8EC"}

package/dist/relations/has-many/has-many-through.inclusion-resolver.d.ts

@@ -0,0 +1,16 @@
+import { Entity } from '../../model';
+import { EntityCrudRepository } from '../../repositories';
+import { Getter, HasManyDefinition, InclusionResolver } from '../relation.types';
+/**
+ * Creates InclusionResolver for HasManyThrough relation.
+ * Notice that this function only generates the inclusionResolver.
+ * It doesn't register it for the source repository.
+ *
+ *
+ * @param meta - metadata of the hasMany relation (including through)
+ * @param getThroughRepo - through repository getter i.e. where through
+ * instances are
+ * @param getTargetRepo - target repository getter i.e where target instances
+ * are
+ */
+export declare function createHasManyThroughInclusionResolver<Through extends Entity, ThroughID, ThroughRelations extends object, Target extends Entity, TargetID, TargetRelations extends object>(meta: HasManyDefinition, getThroughRepo: Getter<EntityCrudRepository<Through, ThroughID, ThroughRelations>>, getTargetRepo: Getter<EntityCrudRepository<Target, TargetID, TargetRelations>>): InclusionResolver<Entity, Target>;

package/dist/relations/has-many/has-many-through.inclusion-resolver.js

@@ -0,0 +1,78 @@
+"use strict";
+// Copyright IBM Corp. 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.createHasManyThroughInclusionResolver = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = (0, tslib_1.__importDefault)(require("debug"));
+const relation_helpers_1 = require("../relation.helpers");
+const has_many_helpers_1 = require("./has-many.helpers");
+const debug = (0, debug_1.default)('loopback:repository:relations:has-many-through:inclusion-resolver');
+/**
+ * Creates InclusionResolver for HasManyThrough relation.
+ * Notice that this function only generates the inclusionResolver.
+ * It doesn't register it for the source repository.
+ *
+ *
+ * @param meta - metadata of the hasMany relation (including through)
+ * @param getThroughRepo - through repository getter i.e. where through
+ * instances are
+ * @param getTargetRepo - target repository getter i.e where target instances
+ * are
+ */
+function createHasManyThroughInclusionResolver(meta, getThroughRepo, getTargetRepo) {
+    const relationMeta = (0, has_many_helpers_1.resolveHasManyMetadata)(meta);
+    return async function fetchHasManyThroughModels(entities, inclusion, options) {
+        if (!entities.length)
+            return [];
+        debug('Fetching target models for entities:', entities);
+        debug('Relation metadata:', relationMeta);
+        const sourceKey = relationMeta.keyFrom;
+        const sourceIds = entities.map(e => e[sourceKey]);
+        const targetKey = relationMeta.keyTo;
+        if (!relationMeta.through) {
+            throw new Error(`relationMeta.through must be defined on ${relationMeta}`);
+        }
+        const throughKeyTo = relationMeta.through.keyTo;
+        const throughKeyFrom = relationMeta.through.keyFrom;
+        debug('Parameters:', {
+            sourceKey,
+            sourceIds,
+            targetKey,
+            throughKeyTo,
+            throughKeyFrom,
+        });
+        debug('sourceId types', sourceIds.map(i => typeof i));
+        const throughRepo = await getThroughRepo();
+        const targetRepo = await getTargetRepo();
+        // find through models
+        const throughFound = await (0, relation_helpers_1.findByForeignKeys)(throughRepo, throughKeyFrom, sourceIds, {}, // scope will be applied at the target level
+        options);
+        const throughResult = (0, relation_helpers_1.flattenTargetsOfOneToManyRelation)(sourceIds, throughFound, throughKeyFrom);
+        const result = [];
+        const scope = typeof inclusion === 'string' ? {} : inclusion.scope;
+        // convert from through entities to the target entities
+        for (const entityList of throughResult) {
+            if (entityList) {
+                // get target ids from the through entities by foreign key
+                const targetIds = entityList.map(entity => entity[throughKeyTo]);
+                // the explicit types and casts are needed
+                const targetEntityList = await (0, relation_helpers_1.findByForeignKeys)(targetRepo, targetKey, targetIds, scope, {
+                    ...options,
+                    isThroughModelInclude: true,
+                });
+                result.push(targetEntityList);
+            }
+            else {
+                // no entities found, add undefined to results
+                result.push(entityList);
+            }
+        }
+        debug('fetchHasManyThroughModels result', result);
+        return result;
+    };
+}
+exports.createHasManyThroughInclusionResolver = createHasManyThroughInclusionResolver;
+//# sourceMappingURL=has-many-through.inclusion-resolver.js.map

package/dist/relations/has-many/has-many-through.inclusion-resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"has-many-through.inclusion-resolver.js","sourceRoot":"","sources":["../../../src/relations/has-many/has-many-through.inclusion-resolver.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAGhE,+DAAiC;AAIjC,0DAI6B;AAE7B,yDAA0D;AAE1D,MAAM,KAAK,GAAG,IAAA,eAAY,EACxB,mEAAmE,CACpE,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,SAAgB,qCAAqC,CAQnD,IAAuB,EACvB,cAEC,EACD,aAEC;IAED,MAAM,YAAY,GAAG,IAAA,yCAAsB,EAAC,IAAI,CAAC,CAAC;IAElD,OAAO,KAAK,UAAU,yBAAyB,CAC7C,QAAkB,EAClB,SAA0B,EAC1B,OAAiB;QAEjB,IAAI,CAAC,QAAQ,CAAC,MAAM;YAAE,OAAO,EAAE,CAAC;QAEhC,KAAK,CAAC,sCAAsC,EAAE,QAAQ,CAAC,CAAC;QACxD,KAAK,CAAC,oBAAoB,EAAE,YAAY,CAAC,CAAC;QAE1C,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC;QACvC,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAE,CAAe,CAAC,SAAS,CAAC,CAAC,CAAC;QACjE,MAAM,SAAS,GAAG,YAAY,CAAC,KAA4B,CAAC;QAC5D,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE;YACzB,MAAM,IAAI,KAAK,CACb,2CAA2C,YAAY,EAAE,CAC1D,CAAC;SACH;QACD,MAAM,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,KAA6B,CAAC;QACxE,MAAM,cAAc,GAAG,YAAY,CAAC,OAAO,CAAC,OAA+B,CAAC;QAE5E,KAAK,CAAC,aAAa,EAAE;YACnB,SAAS;YACT,SAAS;YACT,SAAS;YACT,YAAY;YACZ,cAAc;SACf,CAAC,CAAC;QAEH,KAAK,CACH,gBAAgB,EAChB,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAC7B,CAAC;QAEF,MAAM,WAAW,GAAG,MAAM,cAAc,EAAE,CAAC;QAC3C,MAAM,UAAU,GAAG,MAAM,aAAa,EAAE,CAAC;QAEzC,sBAAsB;QACtB,MAAM,YAAY,GAAG,MAAM,IAAA,oCAAiB,EAC1C,WAAW,EACX,cAAc,EACd,SAAS,EACT,EAAE,EAAE,4CAA4C;QAChD,OAAO,CACR,CAAC;QAEF,MAAM,aAAa,GAAG,IAAA,oDAAiC,EACrD,SAAS,EACT,YAAY,EACZ,cAAc,CACf,CAAC;QAEF,MAAM,MAAM,GAAG,EAAE,CAAC;QAElB,MAAM,KAAK,GACT,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAE,SAAS,CAAC,KAAwB,CAAC;QAE3E,uDAAuD;QACvD,KAAK,MAAM,UAAU,IAAI,aAAa,EAAE;YACtC,IAAI,UAAU,EAAE;gBACd,0DAA0D;gBAC1D,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;gBAEjE,0CAA0C;gBAC1C,MAAM,gBAAgB,GAAG,MAAM,IAAA,oCAAiB,EAI9C,UAAU,EAAE,SAAS,EAAE,SAA0B,EAAE,KAAK,EAAE;oBAC1D,GAAG,OAAO;oBACV,qBAAqB,EAAE,IAAI;iBAC5B,CAAC,CAAC;gBACH,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC/B;iBAAM;gBACL,8CAA8C;gBAC9C,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aACzB;SACF;QAED,KAAK,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AApGD,sFAoGC"}