@loopback/docs 4.0.4 → 5.1.1

package/site/apidocs/repository.hasmanythroughrepository.patch.md

@@ -18,8 +18,14 @@ Patch multiple target model instances
 <b>Signature:</b>
 
 ```typescript
-patch(dataObject: DataObject<Target>, where?: Where<Target>, options?: Options & {
-        throughOptions?: Options;
+patch(dataObject: DataObject<Target> | {
+        [polymorphicType: string]: DataObject<Target>;
+    }, where?: Where<Target>, options?: Options & {
+        throughOptions?: Options & {
+            discriminator?: string;
+        };
+    } & {
+        isPolymorphic?: boolean;
     }): Promise<Count>;
 ```
 
@@ -27,9 +33,9 @@ patch(dataObject: DataObject<Target>, where?: Where<Target>, options?: Options &
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; | The fields and their new values to patch |
-|  where | [Where](./filter.where.md)<!-- -->&lt;Target&gt; | Instances within the where scope are patched |
-|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } |  |
+|  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; \| { \[polymorphicType: string\]: [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt;; } | The fields and their new values to patch |
+|  where | [Where](./filter.where.md)<!-- -->&lt;Target&gt; | <i>(Optional)</i> Instances within the where scope are patched |
+|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md) &amp; { discriminator?: string; }; } &amp; { isPolymorphic?: boolean; } | <i>(Optional)</i> options.throughOptions.discriminator - target discriminator field on through options.isPolymorphic - whether dataObject is a dictionary |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasmanythroughrepository.unlink.md

@@ -28,7 +28,7 @@ unlink(targetModelId: TargetID, options?: Options & {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetModelId | TargetID | The target model to unlink |
-|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } |  |
+|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasmanythroughrepository.unlinkall.md

@@ -27,7 +27,7 @@ unlinkAll(options?: Options & {
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } |  A promise which resolves to void |
+|  options | [Options](./repository.options.md) &amp; { throughOptions?: [Options](./repository.options.md)<!-- -->; } | <i>(Optional)</i>  A promise which resolves to void |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasone.md

@@ -24,7 +24,7 @@ export declare function hasOne<T extends Entity>(targetResolver: EntityResolver<
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetResolver | [EntityResolver](./repository.entityresolver.md)<!-- -->&lt;T&gt; |  |
-|  definition | Partial&lt;[HasOneDefinition](./repository.hasonedefinition.md)<!-- -->&gt; |  |
+|  definition | Partial&lt;[HasOneDefinition](./repository.hasonedefinition.md)<!-- -->&gt; | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasonedefinition.md

@@ -26,6 +26,7 @@ export interface HasOneDefinition extends RelationDefinitionBase
 |  --- | --- | --- |
 |  [keyFrom?](./repository.hasonedefinition.keyfrom.md) | string | <i>(Optional)</i> |
 |  [keyTo?](./repository.hasonedefinition.keyto.md) | string | <i>(Optional)</i> 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". |
+|  [polymorphic?](./repository.hasonedefinition.polymorphic.md) | boolean \| { discriminator: string; } | <i>(Optional)</i> The polymorphism of the target model. The discriminator is a key of source model. If the target model is not polymorphic, then the value should be left undefined or false; If the key on source model indicating the concrete class of the target instance is default i.e. camelCase(classNameOf(throughModelInstance)) + "Id" Then the discriminator field can be undefined |
 |  [targetsMany](./repository.hasonedefinition.targetsmany.md) | false |  |
 |  [type](./repository.hasonedefinition.type.md) | [RelationType.hasOne](./repository.relationtype.md) |  |
 

package/site/apidocs/repository.hasonedefinition.polymorphic.md

@@ -0,0 +1,25 @@
+---
+lang: en
+title: 'API docs: repository.hasonedefinition.polymorphic'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
+permalink: /doc/en/lb4/apidocs.repository.hasonedefinition.polymorphic.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [HasOneDefinition](./repository.hasonedefinition.md) &gt; [polymorphic](./repository.hasonedefinition.polymorphic.md)
+
+## HasOneDefinition.polymorphic property
+
+The polymorphism of the target model. The discriminator is a key of source model. If the target model is not polymorphic, then the value should be left undefined or false; If the key on source model indicating the concrete class of the target instance is default i.e. camelCase(classNameOf(throughModelInstance)) + "Id" Then the discriminator field can be undefined
+
+<b>Signature:</b>
+
+```typescript
+polymorphic?: boolean | {
+        discriminator: string;
+    };
+```
+

package/site/apidocs/repository.hasonerepository.create.md

@@ -18,7 +18,9 @@ Create a target model instance
 <b>Signature:</b>
 
 ```typescript
-create(targetModelData: DataObject<Target>, options?: Options): Promise<Target>;
+create(targetModelData: DataObject<Target>, options?: Options & {
+        polymorphicType?: string;
+    }): Promise<Target>;
 ```
 
 ## Parameters
@@ -26,7 +28,7 @@ create(targetModelData: DataObject<Target>, options?: Options): Promise<Target>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetModelData | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; | The target model data |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) &amp; { polymorphicType?: string; } | <i>(Optional)</i> Options for the operation options.polymorphicType - If polymorphic target model, specify of which concrete model the created instance should be |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasonerepository.delete.md

@@ -18,14 +18,16 @@ Delete the related target model instance
 <b>Signature:</b>
 
 ```typescript
-delete(options?: Options): Promise<Count>;
+delete(options?: Options & {
+        polymorphicType?: string | string[];
+    }): Promise<Count>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [Options](./repository.options.md) |  |
+|  options | [Options](./repository.options.md) &amp; { polymorphicType?: string \| string\[\]; } | <i>(Optional)</i> options.polymorphicType - a string or a string array of polymorphic type names to specify which repositories should are expected to be searched It is highly recommended to contain this param especially for datasources using deplicated ids across tables |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasonerepository.get.md

@@ -18,15 +18,17 @@ Find the only target model instance that belongs to the declaring model.
 <b>Signature:</b>
 
 ```typescript
-get(filter?: Pick<Filter<Target>, Exclude<keyof Filter<Target>, 'where'>>, options?: Options): Promise<Target>;
+get(filter?: Pick<Filter<Target>, Exclude<keyof Filter<Target>, 'where'>>, options?: Options & {
+        polymorphicType?: string | string[];
+    }): Promise<Target>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  filter | Pick&lt;[Filter](./filter.filter.md)<!-- -->&lt;Target&gt;, Exclude&lt;keyof [Filter](./filter.filter.md)<!-- -->&lt;Target&gt;, 'where'&gt;&gt; | Query filter without a Where condition |
-|  options | [Options](./repository.options.md) | Options for the operations |
+|  filter | Pick&lt;[Filter](./filter.filter.md)<!-- -->&lt;Target&gt;, Exclude&lt;keyof [Filter](./filter.filter.md)<!-- -->&lt;Target&gt;, 'where'&gt;&gt; | <i>(Optional)</i> Query filter without a Where condition |
+|  options | [Options](./repository.options.md) &amp; { polymorphicType?: string \| string\[\]; } | <i>(Optional)</i> Options for the operations options.polymorphicType - a string or a string array of polymorphic type names to specify which repositories should are expected to be searched It is highly recommended to contain this param especially for datasources using deplicated ids across tables |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.hasonerepository.patch.md

@@ -18,15 +18,19 @@ Patch the related target model instance
 <b>Signature:</b>
 
 ```typescript
-patch(dataObject: DataObject<Target>, options?: Options): Promise<Count>;
+patch(dataObject: DataObject<Target> | {
+        [polymorphicType: string]: DataObject<Target>;
+    }, options?: Options & {
+        isPolymorphic?: boolean;
+    }): Promise<Count>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; | The target model fields and their new values to patch |
-|  options | [Options](./repository.options.md) |  |
+|  dataObject | [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt; \| { \[polymorphicType: string\]: [DataObject](./repository.dataobject.md)<!-- -->&lt;Target&gt;; } | The target model fields and their new values to patch If the target models are of different types, this should be a dictionary |
+|  options | [Options](./repository.options.md) &amp; { isPolymorphic?: boolean; } | <i>(Optional)</i> options.isPolymorphic - whether dataObject is a dictionary |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.includefieldifnot.md

@@ -0,0 +1,33 @@
+---
+lang: en
+title: 'API docs: repository.includefieldifnot'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
+permalink: /doc/en/lb4/apidocs.repository.includefieldifnot.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [includeFieldIfNot](./repository.includefieldifnot.md)
+
+## includeFieldIfNot() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function includeFieldIfNot<MT>(fields: Fields<MT> | undefined, fieldToInclude: Extract<keyof MT, string>): false | Fields<MT>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fields | [Fields](./filter.fields.md)<!-- -->&lt;MT&gt; \| undefined |  |
+|  fieldToInclude | Extract&lt;keyof MT, string&gt; |  |
+
+<b>Returns:</b>
+
+false \| [Fields](./filter.fields.md)<!-- -->&lt;MT&gt;
+
+

package/site/apidocs/repository.includerelatedmodels.md

@@ -27,8 +27,8 @@ export declare function includeRelatedModels<T extends Entity, Relations extends
 |  --- | --- | --- |
 |  targetRepository | [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;T, unknown, Relations&gt; | The target repository where the model instances are found |
 |  entities | T\[\] | An array of entity instances or data |
-|  include | [InclusionFilter](./filter.inclusionfilter.md)<!-- -->\[\] | Inclusion filter |
-|  options | [Options](./repository.options.md) | Options for the operations |
+|  include | [InclusionFilter](./filter.inclusionfilter.md)<!-- -->\[\] | <i>(Optional)</i> Inclusion filter |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operations |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.invalidpolymorphismerror._constructor_.md

@@ -0,0 +1,32 @@
+---
+lang: en
+title: 'API docs: repository.invalidpolymorphismerror._constructor_'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
+permalink: /doc/en/lb4/apidocs.repository.invalidpolymorphismerror._constructor_.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [InvalidPolymorphismError](./repository.invalidpolymorphismerror.md) &gt; [(constructor)](./repository.invalidpolymorphismerror._constructor_.md)
+
+## InvalidPolymorphismError.(constructor)
+
+Constructs a new instance of the `InvalidPolymorphismError` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(typeName: string, discriminator?: string, extraProperties?: Props);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  typeName | string |  |
+|  discriminator | string | <i>(Optional)</i> |
+|  extraProperties | Props | <i>(Optional)</i> |
+
+

package/site/apidocs/repository.invalidpolymorphismerror.code.md

@@ -0,0 +1,21 @@
+---
+lang: en
+title: 'API docs: repository.invalidpolymorphismerror.code'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
+permalink: /doc/en/lb4/apidocs.repository.invalidpolymorphismerror.code.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [InvalidPolymorphismError](./repository.invalidpolymorphismerror.md) &gt; [code](./repository.invalidpolymorphismerror.code.md)
+
+## InvalidPolymorphismError.code property
+
+<b>Signature:</b>
+
+```typescript
+code: string;
+```
+

package/site/apidocs/repository.invalidpolymorphismerror.md

@@ -0,0 +1,35 @@
+---
+lang: en
+title: 'API docs: repository.invalidpolymorphismerror'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
+permalink: /doc/en/lb4/apidocs.repository.invalidpolymorphismerror.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [InvalidPolymorphismError](./repository.invalidpolymorphismerror.md)
+
+## InvalidPolymorphismError class
+
+<b>Signature:</b>
+
+```typescript
+export declare class InvalidPolymorphismError<Props extends object = {}> extends Error 
+```
+<b>Extends:</b> Error
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(typeName, discriminator, extraProperties)](./repository.invalidpolymorphismerror._constructor_.md) |  | Constructs a new instance of the <code>InvalidPolymorphismError</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [code](./repository.invalidpolymorphismerror.code.md) |  | string |  |
+
+

package/site/apidocs/repository.invalidrelationerror._constructor_.md

@@ -27,6 +27,6 @@ constructor(reason: string, relationMeta: RelationMetadata, extraProperties?: Pr
 |  --- | --- | --- |
 |  reason | string |  |
 |  relationMeta | [RelationMetadata](./repository.relationmetadata.md) |  |
-|  extraProperties | Props |  |
+|  extraProperties | Props | <i>(Optional)</i> |
 
 

package/site/apidocs/repository.isinvalidpolymorphismerror.md

@@ -0,0 +1,32 @@
+---
+lang: en
+title: 'API docs: repository.isinvalidpolymorphismerror'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
+permalink: /doc/en/lb4/apidocs.repository.isinvalidpolymorphismerror.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [isInvalidPolymorphismError](./repository.isinvalidpolymorphismerror.md)
+
+## isInvalidPolymorphismError() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function isInvalidPolymorphismError(e: any): e is InvalidPolymorphismError<any>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  e | any |  |
+
+<b>Returns:</b>
+
+e is [InvalidPolymorphismError](./repository.invalidpolymorphismerror.md)<!-- -->&lt;any&gt;
+
+

package/site/apidocs/repository.keyvaluerepository.delete.md

@@ -26,7 +26,7 @@ delete(key: string, options?: Options): Promise<void>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | string | Key for the entry |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.keyvaluerepository.deleteall.md

@@ -25,7 +25,7 @@ deleteAll(options?: Options): Promise<void>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.keyvaluerepository.expire.md

@@ -27,7 +27,7 @@ expire(key: string, ttl: number, options?: Options): Promise<void>;
 |  --- | --- | --- |
 |  key | string | Key for the entry |
 |  ttl | number | Ttl for the entry |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.keyvaluerepository.get.md

@@ -26,7 +26,7 @@ get(key: string, options?: Options): Promise<T>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | string | Key for the entry |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.keyvaluerepository.keys.md

@@ -25,8 +25,8 @@ keys?(filter?: KeyValueFilter, options?: Options): AsyncIterable<string>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  filter | [KeyValueFilter](./repository.keyvaluefilter.md) | Filter for keys |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  filter | [KeyValueFilter](./repository.keyvaluefilter.md) | <i>(Optional)</i> Filter for keys |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.keyvaluerepository.md

@@ -20,7 +20,7 @@ Key/Value operations for connector implementations
 ```typescript
 export interface KeyValueRepository<T extends Model> extends Repository<T> 
 ```
-<b>Extends:</b> [Repository](./repository.repository.md)<!-- -->&lt;T&gt;
+<b>Extends:</b> [Repository](./repository.repository.md)
 
 ## Methods
 

package/site/apidocs/repository.keyvaluerepository.set.md

@@ -27,7 +27,7 @@ set(key: string, value: DataObject<T>, options?: Options): Promise<void>;
 |  --- | --- | --- |
 |  key | string | Key for the entry |
 |  value | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt; | Value for the entry |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.keyvaluerepository.ttl.md

@@ -26,7 +26,7 @@ ttl?(key: string, options?: Options): Promise<number>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | string | Key for the entry |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.kvconnector.delete.md

@@ -27,7 +27,7 @@ delete(modelClass: Class<Entity>, key: string, options?: Options): Promise<boole
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
 |  key | string | Key for the entry |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.kvconnector.deleteall.md

@@ -26,7 +26,7 @@ deleteAll(modelClass: Class<Entity>, options?: Options): Promise<number>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.kvconnector.expire.md

@@ -28,7 +28,7 @@ expire(modelClass: Class<Entity>, key: string, ttl: number, options?: Options):
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
 |  key | string | Key for the entry |
 |  ttl | number |  |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.kvconnector.get.md

@@ -27,7 +27,7 @@ get(modelClass: Class<Entity>, key: string, options?: Options): Promise<T>;
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
 |  key | string | Key for the entry |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.kvconnector.iteratekeys.md

@@ -26,8 +26,8 @@ iterateKeys?(modelClass: Class<Entity>, filter?: Filter, options?: Options): Pro
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
-|  filter | [Filter](./filter.filter.md) | Matching filter |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  filter | [Filter](./filter.filter.md) | <i>(Optional)</i> Matching filter |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.kvconnector.keys.md

@@ -26,7 +26,7 @@ keys?(modelClass: Class<Entity>, options?: Options): Promise<string[]>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.kvconnector.set.md

@@ -28,7 +28,7 @@ set(modelClass: Class<Entity>, key: string, value: EntityData, options?: Options
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
 |  key | string | Key for the entry |
 |  value | [EntityData](./repository.entitydata.md) | Value for the entry |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.kvconnector.ttl.md

@@ -28,7 +28,7 @@ ttl?(modelClass: Class<Entity>, key: string, ttl: number, options?: Options): Pr
 |  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
 |  key | string | Key for the entry |
 |  ttl | number | Time to live in millisenconds |
-|  options | [Options](./repository.options.md) | Options for the operation |
+|  options | [Options](./repository.options.md) | <i>(Optional)</i> Options for the operation |
 
 <b>Returns:</b>
 

package/site/apidocs/repository.md

@@ -33,10 +33,12 @@ This module provides data access facilities to various databases and services as
 |  [DefaultHasManyThroughRepository](./repository.defaulthasmanythroughrepository.md) | a class for CRUD operations for hasManyThrough relation.<!-- -->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. |
 |  [DefaultHasOneRepository](./repository.defaulthasonerepository.md) |  |
 |  [DefaultKeyValueRepository](./repository.defaultkeyvaluerepository.md) | An implementation of KeyValueRepository based on loopback-datasource-juggler |
+|  [DefaultReferencesManyRepository](./repository.defaultreferencesmanyrepository.md) |  |
 |  [DefaultTransactionalRepository](./repository.defaulttransactionalrepository.md) | Default implementation of CRUD repository using legacy juggler model and data source with beginTransaction() method for connectors which support Transactions |
 |  [Entity](./repository.entity.md) | Base class for entities which have unique ids |
 |  [EntityNotFoundError](./repository.entitynotfounderror.md) |  |
 |  [Event](./repository.event.md) | Domain events |
+|  [InvalidPolymorphismError](./repository.invalidpolymorphismerror.md) |  |
 |  [InvalidRelationError](./repository.invalidrelationerror.md) |  |
 |  [Model](./repository.model.md) | Base class for models |
 |  [ModelDefinition](./repository.modeldefinition.md) | Definition for a model |
@@ -71,13 +73,15 @@ This module provides data access facilities to various databases and services as
 |  [constrainFilter(originalFilter, constraint)](./repository.constrainfilter.md) | A utility function which takes a filter and enforces constraint(s) on it |
 |  [constrainWhere(originalWhere, constraint)](./repository.constrainwhere.md) | A utility function which takes a where filter and enforces constraint(s) on it |
 |  [constrainWhereOr(originalWhere, constraint)](./repository.constrainwhereor.md) | A utility function which takes a where filter and enforces constraint(s) on it with OR clause |
-|  [createBelongsToAccessor(belongsToMetadata, targetRepoGetter, sourceRepository)](./repository.createbelongstoaccessor.md) | Enforces a BelongsTo constraint on a repository |
-|  [createBelongsToInclusionResolver(meta, getTargetRepo)](./repository.createbelongstoinclusionresolver.md) | Creates InclusionResolver for BelongsTo relation. Notice that this function only generates the inclusionResolver. It doesn't register it for the source repository.<!-- -->Notice: scope field for inclusion is not supported yet |
+|  [createBelongsToAccessor(belongsToMetadata, targetRepositoryGetter, sourceRepository)](./repository.createbelongstoaccessor.md) | 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<!-- -->} |
+|  [createBelongsToInclusionResolver(meta, getTargetRepoDict)](./repository.createbelongstoinclusionresolver.md) | Creates InclusionResolver for BelongsTo relation. Notice that this function only generates the inclusionResolver. It doesn't register it for the source repository.<!-- -->Notice: scope field for inclusion is not supported yet |
 |  [createHasManyInclusionResolver(meta, getTargetRepo)](./repository.createhasmanyinclusionresolver.md) | Creates InclusionResolver for HasMany relation. Notice that this function only generates the inclusionResolver. It doesn't register it for the source repository.<!-- -->Notice: scope field for inclusion is not supported yet. |
 |  [createHasManyRepositoryFactory(relationMetadata, targetRepositoryGetter)](./repository.createhasmanyrepositoryfactory.md) | Enforces a constraint on a repository based on a relationship contract between models. For example, if a Customer model is related to an Order model via a HasMany relation, then, the relational repository returned by the factory function would be constrained by a Customer model instance's id(s). |
 |  [createHasManyThroughRepositoryFactory(relationMetadata, targetRepositoryGetter, throughRepositoryGetter)](./repository.createhasmanythroughrepositoryfactory.md) |  |
-|  [createHasOneRepositoryFactory(relationMetadata, targetRepositoryGetter)](./repository.createhasonerepositoryfactory.md) | Enforces a constraint on a repository based on a relationship contract between models. For example, if a Customer model is related to an Address model via a HasOne relation, then, the relational repository returned by the factory function would be constrained by a Customer model instance's id(s). |
+|  [createHasOneRepositoryFactory(relationMetadata, targetRepositoryGetter)](./repository.createhasonerepositoryfactory.md) | Enforces a constraint on a repository based on a relationship contract between models. For example, if a Customer model is related to an Address model via a HasOne relation, then, the relational repository returned by the factory function would be constrained by a Customer model instance's id(s).<!-- -->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<!-- -->} |
 |  [createModelClassBinding(modelClass)](./repository.createmodelclassbinding.md) | Create a binding for the given model class |
+|  [createReferencesManyAccessor(referencesManyMetadata, targetRepoGetter, sourceRepository)](./repository.createreferencesmanyaccessor.md) | Enforces a ReferencesMany constraint on a repository |
+|  [createReferencesManyInclusionResolver(meta, getTargetRepo)](./repository.createreferencesmanyinclusionresolver.md) | Creates InclusionResolver for ReferencesMany relation. Notice that this function only generates the inclusionResolver. It doesn't register it for the source repository.<!-- -->Notice: scope field for inclusion is not supported yet |
 |  [deduplicate(input)](./repository.deduplicate.md) | Dedupe an array |
 |  [defineCrudRepositoryClass(entityClass)](./repository.definecrudrepositoryclass.md) | Create (define) an entity CRUD repository class for the given model. This function always uses <code>DefaultCrudRepository</code> as the base class, use <code>defineRepositoryClass</code> if you want to use your own base repository. |
 |  [defineKeyValueRepositoryClass(modelClass)](./repository.definekeyvaluerepositoryclass.md) | Create (define) a KeyValue repository class for the given entity. This function always uses <code>DefaultKeyValueRepository</code> as the base class, use <code>defineRepositoryClass</code> if you want to use your own base repository. |
@@ -94,10 +98,12 @@ This module provides data access facilities to various databases and services as
 |  [getModelRelations(modelCtor)](./repository.getmodelrelations.md) | Get metadata of all relations defined on a given model class. |
 |  [hasMany(targetResolver, definition)](./repository.hasmany.md) | Decorator for hasMany Calls property.array decorator underneath the hood and infers foreign key name from target model name unless explicitly specified |
 |  [hasOne(targetResolver, definition)](./repository.hasone.md) |  |
+|  [includeFieldIfNot(fields, fieldToInclude)](./repository.includefieldifnot.md) |  |
 |  [includeRelatedModels(targetRepository, entities, include, options)](./repository.includerelatedmodels.md) | Returns model instances that include related models that have a registered resolver. |
 |  [isBsonType(value)](./repository.isbsontype.md) | 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. |
 |  [isBuiltinType(fn)](./repository.isbuiltintype.md) | Check if the provided function is a built-in type provided by JavaScript and/or Node.js. E.g. <code>Number</code>, <code>Array</code>, <code>Buffer</code>, etc. |
 |  [isEntityNotFoundError(e)](./repository.isentitynotfounderror.md) |  |
+|  [isInvalidPolymorphismError(e)](./repository.isinvalidpolymorphismerror.md) |  |
 |  [isInvalidRelationError(e)](./repository.isinvalidrelationerror.md) |  |
 |  [isTypeResolver(fn)](./repository.istyperesolver.md) | A function that checks whether a function is a TypeResolver or not. |
 |  [model(definition)](./repository.model.md) | Decorator for model definitions |
@@ -106,7 +112,7 @@ This module provides data access facilities to various databases and services as
 |  [property(definition)](./repository.property.md) | Decorator for model properties |
 |  [reduceAsArray(acc, it)](./repository.reduceasarray.md) | Returns an array of instances. For HasMany relation usage. |
 |  [reduceAsSingleItem(\_acc, it)](./repository.reduceassingleitem.md) | Returns a single of an instance. For HasOne and BelongsTo relation usage. |
-|  [referencesMany(definition)](./repository.referencesmany.md) | Decorator for referencesMany |
+|  [referencesMany(targetResolver, definition, propertyDefinition)](./repository.referencesmany.md) | Decorator for referencesMany |
 |  [referencesOne(definition)](./repository.referencesone.md) | Decorator for referencesOne |
 |  [rejectNavigationalPropertiesInData(modelClass, data)](./repository.rejectnavigationalpropertiesindata.md) | Check model data for navigational properties linking to related models. Throw a descriptive error if any such property is found. |
 |  [relation(definition)](./repository.relation.md) | Decorator for relations |
@@ -152,6 +158,9 @@ This module provides data access facilities to various databases and services as
 |  [Persistable](./repository.persistable.md) |  |
 |  [PropertyDefinition](./repository.propertydefinition.md) | Property definition for a model |
 |  [PropertyForm](./repository.propertyform.md) | See https://github.com/loopbackio/loopback-datasource-juggler/issues/432 |
+|  [ReferencesManyAccessor](./repository.referencesmanyaccessor.md) |  |
+|  [ReferencesManyDefinition](./repository.referencesmanydefinition.md) |  |
+|  [ReferencesManyRepository](./repository.referencesmanyrepository.md) | CRUD operations for a target repository of a ReferencesMany relation |
 |  [RelationDefinitionBase](./repository.relationdefinitionbase.md) |  |
 |  [Repository](./repository.repository.md) |  |
 |  [RepositoryComponent](./repository.repositorycomponent.md) | This interface describes additional Component properties allowing components to contribute Repository-related artifacts. |

package/site/apidocs/repository.model._constructor_.md

@@ -25,6 +25,6 @@ constructor(data?: DataObject<Model>);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  data | [DataObject](./repository.dataobject.md)<!-- -->&lt;[Model](./repository.model.md)<!-- -->&gt; |  |
+|  data | [DataObject](./repository.dataobject.md)<!-- -->&lt;[Model](./repository.model.md)<!-- -->&gt; | <i>(Optional)</i> |