@loopback/repository 4.1.2 → 5.0.2

package/dist/types/type.js.map

@@ -1 +1 @@
-{"version":3,"file":"type.js","sourceRoot":"","sources":["../../src/types/type.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE"}
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../src/types/type.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE"}

package/dist/types/union.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright IBM Corp. 2017,2019. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2017,2019. All Rights Reserved.
 // Node module: @loopback/repository
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT

package/dist/types/union.js.map

@@ -1 +1 @@
-{"version":3,"file":"union.js","sourceRoot":"","sources":["../../src/types/union.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,wDAAwB;AAGxB,uDAAuD;AAEvD;;GAEG;AACH,MAAa,SAAS;IACpB,YAAmB,SAAsB;QAAtB,cAAS,GAAT,SAAS,CAAa;QAEhC,SAAI,GAAG,OAAO,CAAC;IAFoB,CAAC;IAI7C,UAAU,CAAC,KAAU;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IACvD,CAAC;IAED,WAAW,CAAC,KAAU;QACpB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,KAAU;QACf,uBAAuB;QACvB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE;YACjC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;gBAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC3B;SACF;QACD,gBAAgB;QAChB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE;YACjC,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;gBAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC3B;SACF;QACD,MAAM,GAAG,GAAG,cAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5D,MAAM,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,SAAS,CAAC,KAAU;QAClB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE;YACjC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;gBAC1B,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;aAC9B;SACF;IACH,CAAC;CACF;AAzCD,8BAyCC"}
+{"version":3,"file":"union.js","sourceRoot":"","sources":["../../src/types/union.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,wDAAwB;AAGxB,uDAAuD;AAEvD;;GAEG;AACH,MAAa,SAAS;IACpB,YAAmB,SAAsB;QAAtB,cAAS,GAAT,SAAS,CAAa;QAEhC,SAAI,GAAG,OAAO,CAAC;IAFoB,CAAC;IAI7C,UAAU,CAAC,KAAU;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IACvD,CAAC;IAED,WAAW,CAAC,KAAU;QACpB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,KAAU;QACf,uBAAuB;QACvB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE;YACjC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;gBAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC3B;SACF;QACD,gBAAgB;QAChB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE;YACjC,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;gBAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAC3B;SACF;QACD,MAAM,GAAG,GAAG,cAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5D,MAAM,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED,SAAS,CAAC,KAAU;QAClB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE;YACjC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;gBAC1B,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;aAC9B;SACF;IACH,CAAC;CACF;AAzCD,8BAyCC"}

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@loopback/repository",
   "description": "Define and implement a common set of interfaces for interacting with databases",
-  "version": "4.1.2",
+  "version": "5.0.2",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "author": "IBM Corp.",
-  "copyright.owner": "IBM Corp.",
+  "author": "IBM Corp. and LoopBack contributors",
+  "copyright.owner": "IBM Corp. and LoopBack contributors",
   "repository": {
     "type": "git",
     "url": "https://github.com/loopbackio/loopback-next.git",
     "directory": "packages/repository"
   },
   "engines": {
-    "node": "12 || 14 || 16 || 17"
+    "node": "14 || 16 || 17 || 18"
   },
   "scripts": {
     "acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
@@ -33,26 +33,26 @@
     "!*/__tests__"
   ],
   "peerDependencies": {
-    "@loopback/core": "^3.1.2"
+    "@loopback/core": "^4.0.2"
   },
   "dependencies": {
-    "@loopback/filter": "^2.1.2",
+    "@loopback/filter": "^3.0.2",
     "@types/debug": "^4.1.7",
     "debug": "^4.3.4",
     "lodash": "^4.17.21",
     "loopback-datasource-juggler": "^4.27.1",
-    "tslib": "^2.3.1"
+    "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@loopback/build": "^8.1.2",
-    "@loopback/core": "^3.1.2",
-    "@loopback/eslint-config": "^12.0.4",
-    "@loopback/testlab": "^4.1.2",
+    "@loopback/build": "^9.0.2",
+    "@loopback/core": "^4.0.2",
+    "@loopback/eslint-config": "^13.0.2",
+    "@loopback/testlab": "^5.0.2",
     "@types/bson": "^4.0.5",
     "@types/json-schema": "^7.0.11",
-    "@types/lodash": "^4.14.180",
-    "@types/node": "^12.20.47",
-    "bson": "4.6.2"
+    "@types/lodash": "^4.14.182",
+    "@types/node": "^14.18.21",
+    "bson": "4.6.4"
   },
-  "gitHead": "22d993c73a7b4ccdb36f2e26ea52460dc46fbd11"
+  "gitHead": "d2eddfc1319810f4c0126e613c24499b5685f7e4"
 }

package/src/connectors/connector.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2018,2019. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2018,2019. All Rights Reserved.
 // Node module: @loopback/repository
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT

package/src/connectors/crud.connector.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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

package/src/connectors/index.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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

package/src/connectors/kv.connector.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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

package/src/datasource.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2017,2019. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2017,2019. All Rights Reserved.
 // Node module: @loopback/repository
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT

package/src/decorators/index.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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

package/src/decorators/metadata.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2017,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2017,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

package/src/decorators/model.decorator.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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

package/src/decorators/repository.decorator.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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

package/src/define-model-class.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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

package/src/define-repository-class.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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

package/src/errors/entity-not-found.error.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2018,2019. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2018,2019. All Rights Reserved.
 // Node module: @loopback/repository
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT

package/src/errors/index.ts

@@ -1,7 +1,8 @@
-// Copyright IBM Corp. 2018. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2018. All Rights Reserved.
 // Node module: @loopback/repository
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
 export * from './entity-not-found.error';
+export * from './invalid-polymorphism.error';
 export * from './invalid-relation.error';

package/src/errors/invalid-polymorphism.error.ts

@@ -0,0 +1,28 @@
+export class InvalidPolymorphismError<Props extends object = {}> extends Error {
+  code: string;
+
+  constructor(
+    typeName: string,
+    discriminator?: string,
+    extraProperties?: Props,
+  ) {
+    const message = discriminator
+      ? `Invalid class name ${typeName} by discriminator ${discriminator}. Please check polymorphic types and the discriminator.`
+      : `Invalid class name ${typeName}. Please check polymorphic types and the discriminator.`;
+    super(message);
+
+    Error.captureStackTrace(this, this.constructor);
+
+    this.code = 'INVALID_POLYMORPHISM';
+
+    Object.assign(this, extraProperties);
+  }
+}
+
+export function isInvalidPolymorphismError(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  e: any,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+): e is InvalidPolymorphismError<any> {
+  return e instanceof InvalidPolymorphismError;
+}

package/src/errors/invalid-relation.error.ts

@@ -1,9 +1,9 @@
-// Copyright IBM Corp. 2018,2019. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2018,2019. All Rights Reserved.
 // Node module: @loopback/repository
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {RelationType, RelationMetadata} from '../relations';
+import {RelationMetadata, RelationType} from '../relations';
 
 export class InvalidRelationError<Props extends object = {}> extends Error {
   code: string;

package/src/index.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2017,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2017,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

package/src/mixins/index.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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

package/src/mixins/repository.mixin.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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
@@ -23,11 +23,6 @@ import {juggler, Repository} from '../repositories';
 
 const debug = debugFactory('loopback:repository:mixin');
 
-// FIXME(rfeng): Workaround for https://github.com/microsoft/rushstack/pull/1867
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import * as loopbackContext from '@loopback/core';
-import * as loopbackCore from '@loopback/core';
-
 /* eslint-enable @typescript-eslint/no-unused-vars */
 
 /**

package/src/model.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2017,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2017,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
@@ -9,6 +9,7 @@ import {
   HasManyDefinition,
   HasOneDefinition,
   JsonSchema,
+  ReferencesManyDefinition,
   RelationMetadata,
   RelationType,
 } from './index';
@@ -240,6 +241,24 @@ export class ModelDefinition {
     return this.addRelation(meta);
   }
 
+  /**
+   * Define a new referencesMany relation.
+   * @param name - The name of the referencesMany relation.
+   * @param definition - The definition of the referencesMany relation.
+   */
+  referencesMany(
+    name: string,
+    definition: Omit<ReferencesManyDefinition, 'name' | 'type' | 'targetsMany'>,
+  ): this {
+    const meta: ReferencesManyDefinition = {
+      ...definition,
+      name,
+      type: RelationType.referencesMany,
+      targetsMany: true,
+    };
+    return this.addRelation(meta);
+  }
+
   /**
    * Get an array of names of ID properties, which are specified in
    * the model settings or properties with `id` attribute.

package/src/relations/belongs-to/belongs-to.accessor.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2018,2019. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2018,2019. All Rights Reserved.
 // Node module: @loopback/repository
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
@@ -22,7 +22,7 @@ export interface BelongsToAccessor<Target extends Entity, SourceId> {
   /**
    * Invoke the function to obtain HasManyRepository.
    */
-  (sourceId: SourceId): Promise<Target>;
+  (sourceId: SourceId, polymorphicTypes?: string | string[]): Promise<Target>;
 
   /**
    * Use `resolver` property to obtain an InclusionResolver for this relation.
@@ -32,6 +32,8 @@ export interface BelongsToAccessor<Target extends Entity, SourceId> {
 
 /**
  * Enforces a BelongsTo constraint on a repository
+ * If the target model is polymorphic, i.e. stored within different repositories,
+ * supply the targetRepositoryGetter with a dictionary in the form of {[typeName: string]: repositoryGetter}
  */
 export function createBelongsToAccessor<
   Target extends Entity,
@@ -40,13 +42,35 @@ export function createBelongsToAccessor<
   SourceId,
 >(
   belongsToMetadata: BelongsToDefinition,
-  targetRepoGetter: Getter<EntityCrudRepository<Target, TargetId>>,
+  targetRepositoryGetter:
+    | Getter<EntityCrudRepository<Target, TargetId>>
+    | {
+        [repoType: string]: Getter<EntityCrudRepository<Target, TargetId>>;
+      },
   sourceRepository: EntityCrudRepository<Source, SourceId>,
 ): BelongsToAccessor<Target, SourceId> {
   const meta = resolveBelongsToMetadata(belongsToMetadata);
+  // resolve the repositoryGetter into a dictionary
+  if (typeof targetRepositoryGetter === 'function') {
+    targetRepositoryGetter = {
+      [meta.target().name]: targetRepositoryGetter as Getter<
+        EntityCrudRepository<Target, TargetId>
+      >,
+    };
+  }
   debug('Resolved BelongsTo relation metadata: %o', meta);
   const result: BelongsToAccessor<Target, SourceId> =
-    async function getTargetInstanceOfBelongsTo(sourceId: SourceId) {
+    async function getTargetInstanceOfBelongsTo(
+      sourceId: SourceId,
+      polymorphicTypes?: string | string[],
+    ) {
+      if (meta.polymorphic !== false) {
+        if (!polymorphicTypes || polymorphicTypes.length === 0) {
+          console.warn(
+            'It is highly recommended to specify the polymorphicTypes param when using polymorphic types.',
+          );
+        }
+      }
       const foreignKey = meta.keyFrom;
       const primaryKey = meta.keyTo;
       const sourceModel = await sourceRepository.findById(sourceId);
@@ -60,15 +84,20 @@ export function createBelongsToAccessor<
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       const constraint: any = {[primaryKey]: foreignKeyValue};
       const constrainedRepo = new DefaultBelongsToRepository(
-        targetRepoGetter,
+        targetRepositoryGetter as {
+          [repoType: string]: Getter<EntityCrudRepository<Target, TargetId>>;
+        },
         constraint as DataObject<Target>,
+        belongsToMetadata.target,
       );
-      return constrainedRepo.get();
+      return constrainedRepo.get({polymorphicType: polymorphicTypes});
     };
 
   result.inclusionResolver = createBelongsToInclusionResolver(
     meta,
-    targetRepoGetter,
+    targetRepositoryGetter as {
+      [repoType: string]: Getter<EntityCrudRepository<Target, TargetId>>;
+    },
   );
   return result;
 }

package/src/relations/belongs-to/belongs-to.decorator.ts

@@ -1,12 +1,12 @@
-// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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
 
 import {DecoratorFactory, MetadataInspector} from '@loopback/core';
 import {property} from '../../decorators';
-import {relation} from '../relation.decorator';
 import {Entity, EntityResolver, PropertyDefinition} from '../../model';
+import {relation} from '../relation.decorator';
 import {BelongsToDefinition, RelationType} from '../relation.types';
 
 /**

package/src/relations/belongs-to/belongs-to.helpers.ts

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2019. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 2019. All Rights Reserved.
 // Node module: @loopback/repository
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
@@ -18,6 +18,7 @@ const debug = debugFactory('loopback:repository:relations:belongs-to:helpers');
 export type BelongsToResolvedDefinition = BelongsToDefinition & {
   keyFrom: string;
   keyTo: string;
+  polymorphic: false | {discriminator: string};
 };
 
 /**
@@ -27,7 +28,9 @@ export type BelongsToResolvedDefinition = BelongsToDefinition & {
  * @param relationMeta - belongsTo metadata to resolve
  * @internal
  */
-export function resolveBelongsToMetadata(relationMeta: BelongsToDefinition) {
+export function resolveBelongsToMetadata(
+  relationMeta: BelongsToDefinition,
+): BelongsToResolvedDefinition {
   if ((relationMeta.type as RelationType) !== RelationType.belongsTo) {
     const reason = 'relation type must be BelongsTo';
     throw new InvalidRelationError(reason, relationMeta);
@@ -61,18 +64,42 @@ export function resolveBelongsToMetadata(relationMeta: BelongsToDefinition) {
   const targetProperties = targetModel.definition.properties;
   debug('relation metadata from %o: %o', targetName, targetProperties);
 
+  let keyTo;
   if (relationMeta.keyTo && targetProperties[relationMeta.keyTo]) {
     // The explicit cast is needed because of a limitation of type inference
-    return Object.assign(relationMeta, {
-      keyFrom,
-    }) as BelongsToResolvedDefinition;
+    keyTo = relationMeta.keyTo;
+  } else {
+    keyTo = targetModel.definition.idProperties()[0];
+    if (!keyTo) {
+      const reason = `${targetName} does not have any primary key (id property)`;
+      throw new InvalidRelationError(reason, relationMeta);
+    }
   }
 
-  const targetPrimaryKey = targetModel.definition.idProperties()[0];
-  if (!targetPrimaryKey) {
-    const reason = `${targetName} does not have any primary key (id property)`;
-    throw new InvalidRelationError(reason, relationMeta);
+  let polymorphic: false | {discriminator: string};
+  if (
+    relationMeta.polymorphic === undefined ||
+    relationMeta.polymorphic === false ||
+    !relationMeta.polymorphic
+  ) {
+    const polymorphicFalse = false as const;
+    polymorphic = polymorphicFalse;
+  } else {
+    if (relationMeta.polymorphic === true) {
+      const polymorphicObject: {discriminator: string} = {
+        discriminator: camelCase(relationMeta.target().name + '_type'),
+      };
+      polymorphic = polymorphicObject;
+    } else {
+      const polymorphicObject: {discriminator: string} =
+        relationMeta.polymorphic as {discriminator: string};
+      polymorphic = polymorphicObject;
+    }
   }
 
-  return Object.assign(relationMeta, {keyFrom, keyTo: targetPrimaryKey});
+  return Object.assign(relationMeta, {
+    keyFrom,
+    keyTo: keyTo,
+    polymorphic: polymorphic,
+  });
 }

package/src/relations/belongs-to/belongs-to.inclusion-resolver.ts

@@ -1,9 +1,10 @@
-// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Copyright IBM Corp. and LoopBack contributors 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
 
 import {Filter, InclusionFilter} from '@loopback/filter';
+import {includeFieldIfNot, InvalidPolymorphismError} from '../../';
 import {AnyObject, Options} from '../../common-types';
 import {Entity} from '../../model';
 import {EntityCrudRepository} from '../../repositories';
@@ -28,7 +29,8 @@ import {resolveBelongsToMetadata} from './belongs-to.helpers';
  * Notice: scope field for inclusion is not supported yet
  *
  * @param meta - resolved BelongsToMetadata
- * @param getTargetRepo - target repository i.e where related instances are
+ * @param getTargetRepoDict - dictionary of target model type - target repository
+ * i.e where related instances for different types are
  */
 export function createBelongsToInclusionResolver<
   Target extends Entity,
@@ -36,36 +38,125 @@ export function createBelongsToInclusionResolver<
   TargetRelations extends object,
 >(
   meta: BelongsToDefinition,
-  getTargetRepo: Getter<
-    EntityCrudRepository<Target, TargetID, TargetRelations>
-  >,
+  getTargetRepoDict: {
+    [repoType: string]: Getter<
+      EntityCrudRepository<Target, TargetID, TargetRelations>
+    >;
+  },
 ): InclusionResolver<Entity, Target> {
   const relationMeta = resolveBelongsToMetadata(meta);
 
-  return async function fetchIncludedModels(
+  return async function fetchBelongsToModel(
     entities: Entity[],
     inclusion: InclusionFilter,
     options?: Options,
-  ): Promise<((Target & TargetRelations) | undefined)[]> {
+  ): Promise<((Target & object) | undefined)[]> {
     if (!entities.length) return [];
 
+    // Source ids are grouped by their target polymorphic types
+    // Each type search for target instances and then merge together in a merge-sort-like manner
+
     const sourceKey = relationMeta.keyFrom;
-    const sourceIds = entities.map(e => (e as AnyObject)[sourceKey]);
     const targetKey = relationMeta.keyTo as StringKeyOf<Target>;
-    const dedupedSourceIds = deduplicate(sourceIds);
+    const targetDiscriminator: keyof Entity | undefined =
+      relationMeta.polymorphic
+        ? (relationMeta.polymorphic.discriminator as keyof Entity)
+        : undefined;
 
     const scope =
       typeof inclusion === 'string' ? {} : (inclusion.scope as Filter<Target>);
 
-    const targetRepo = await getTargetRepo();
-    const targetsFound = await findByForeignKeys(
-      targetRepo,
-      targetKey,
-      dedupedSourceIds.filter(e => e),
-      scope,
-      options,
-    );
+    // sourceIds in {targetType -> sourceId}
+    const sourceIdsCategorized: {
+      [concreteItemType: string]: Target[StringKeyOf<Target>][];
+    } = {};
+    if (targetDiscriminator) {
+      entities.forEach((value, index, allEntites) => {
+        const concreteType = String(value[targetDiscriminator]);
+        if (!getTargetRepoDict[concreteType]) {
+          throw new InvalidPolymorphismError(concreteType, targetDiscriminator);
+        }
+        if (!sourceIdsCategorized[concreteType]) {
+          sourceIdsCategorized[concreteType] = [];
+        }
+        sourceIdsCategorized[concreteType].push(
+          (value as AnyObject)[sourceKey],
+        );
+      });
+    } else {
+      const concreteType = relationMeta.target().name;
+      if (!getTargetRepoDict[concreteType]) {
+        throw new InvalidPolymorphismError(concreteType);
+      }
+      entities.forEach((value, index, allEntites) => {
+        if (!sourceIdsCategorized[concreteType]) {
+          sourceIdsCategorized[concreteType] = [];
+        }
+        sourceIdsCategorized[concreteType].push(
+          (value as AnyObject)[sourceKey],
+        );
+      });
+    }
+
+    // Ensure targetKey is included otherwise flatten function cannot work
+    const changedTargetKeyField = includeFieldIfNot(scope?.fields, targetKey);
+    let needToRemoveTargetKeyFieldLater = false;
+    if (changedTargetKeyField !== false) {
+      scope.fields = changedTargetKeyField;
+      needToRemoveTargetKeyFieldLater = true;
+    }
+    // Each sourceIds array with same target type extract target instances
+    const targetCategorized: {
+      [concreteItemType: string]: ((Target & TargetRelations) | undefined)[];
+    } = {};
+    for (const k of Object.keys(sourceIdsCategorized)) {
+      const targetRepo = await getTargetRepoDict[k]();
+      const targetsFound = await findByForeignKeys(
+        targetRepo,
+        targetKey,
+        deduplicate(sourceIdsCategorized[k]).filter(e => e),
+        scope,
+        options,
+      );
+      targetCategorized[k] = flattenTargetsOfOneToOneRelation(
+        sourceIdsCategorized[k],
+        targetsFound,
+        targetKey,
+      );
+
+      // Remove targetKey if should be excluded but included above
+      if (needToRemoveTargetKeyFieldLater) {
+        targetCategorized[k] = targetCategorized[k].map(e => {
+          if (e) {
+            delete e[targetKey];
+          }
+          return e;
+        });
+      }
+    }
 
-    return flattenTargetsOfOneToOneRelation(sourceIds, targetsFound, targetKey);
+    // Merge
+    // Why the order is correct:
+    // e.g. target model 1 = a, target model 2 = b
+    // all entities: [S(a-1), S(a-2), S(b-3), S(a-4), S(b-5)]
+    // a-result: [a-1, a-2, a-4]
+    // b-result: [b-3, b-4]
+    // merged:
+    // entities[1]->a => targets: [a-1 from a-result.shift()]
+    // entities[2]->a => targets: [a-1, a-2 from a-result.shift()]
+    // entities[3]->b => targets: [a-1, a-2, b-3 from b-result.shift()]
+    // entities[4]->a => targets: [a-1, a-2, b-3, a-4 from a-result.shift()]
+    // entities[5]->b => targets: [a-1, a-2, b-3, a-4, b-5 from b-result.shift()]
+    if (targetDiscriminator) {
+      const allTargets: ((Target & TargetRelations) | undefined)[] = [];
+      entities.forEach((value, index, allEntites) => {
+        allTargets.push(
+          targetCategorized[String(value[targetDiscriminator])].shift(),
+        );
+      });
+      return allTargets;
+    } else {
+      return targetCategorized[relationMeta.target().name];
+    }
   };
 }