@loopback/repository 2.2.1 → 2.5.1

package/src/relations/relation.types.ts

@@ -52,6 +52,10 @@ export interface RelationDefinitionBase {
   target: TypeResolver<Entity, typeof Entity>;
 }
 
+/**
+ * HasManyDefinition defines one-to-many relations and also possible defines
+ * many-to-many relations with through models.
+ */
 export interface HasManyDefinition extends RelationDefinitionBase {
   type: RelationType.hasMany;
   targetsMany: true;
@@ -69,49 +73,40 @@ export interface HasManyDefinition extends RelationDefinitionBase {
    */
   keyTo?: string;
   keyFrom?: string;
-}
-
-/**
- * A `hasManyThrough` relation defines a many-to-many connection with another model.
- * This relation indicates that the declaring model can be matched with zero or more
- * instances of another model by proceeding through a third model.
- *
- * 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.
- */
-export interface HasManyThroughDefinition extends RelationDefinitionBase {
-  type: RelationType.hasMany;
-  targetsMany: true;
 
   /**
-   * The foreign key in the source model, e.g. Customer#id.
-   */
-  keyFrom: string;
-
-  /**
-   * The primary key of the target model, e.g Seller#id.
+   * Description of the through model of the hasManyThrough relation.
+   *
+   * A `hasManyThrough` relation defines a many-to-many connection with another model.
+   * This relation indicates that the declaring model can be matched with zero or more
+   * instances of another model by proceeding through a third model.
+   *
+   * E.g a Category has many Products, and a Product can have many Categories.
+   * CategoryProductLink can be the through model.
+   * Such a through model has information of foreign keys of the source model(Category) and the target model(Product).
+   *
+   * Warning: The hasManyThrough interface is experimental and is subject to change.
+   * If backwards-incompatible changes are made, a new major version may not be
+   * released.
    */
-  keyTo: string;
-
-  through: {
+  through?: {
     /**
      * The through model of this relation.
      *
-     * E.g. when a Customer has many Order instances and a Seller has many Order instances,
-     * then Order is through.
+     * E.g. when a Category has many CategoryProductLink instances and a Product has many CategoryProductLink instances,
+     * then CategoryProductLink is through.
      */
     model: TypeResolver<Entity, typeof Entity>;
 
     /**
-     * The foreign key of the source model defined in the through model, e.g. Order#customerId
+     * The foreign key of the source model defined in the through model, e.g. CategoryProductLink#categoryId
      */
-    keyFrom: string;
+    keyFrom?: string;
 
     /**
-     * The foreign key of the target model defined in the through model, e.g. Order#sellerId
+     * The foreign key of the target model defined in the through model, e.g. CategoryProductLink#productId
      */
-    keyTo: string;
+    keyTo?: string;
   };
 }
 
@@ -153,7 +148,6 @@ export interface HasOneDefinition extends RelationDefinitionBase {
  */
 export type RelationMetadata =
   | HasManyDefinition
-  | HasManyThroughDefinition
   | BelongsToDefinition
   | HasOneDefinition
   // TODO(bajtos) add other relation types and remove RelationDefinitionBase once

package/src/repositories/legacy-juggler-bridge.ts

@@ -11,13 +11,19 @@ import {
   Command,
   Count,
   DataObject,
+  DeepPartial,
   NamedParameters,
   Options,
   PositionalParameters,
 } from '../common-types';
 import {EntityNotFoundError} from '../errors';
-import {Entity, Model, PropertyType} from '../model';
-import {Filter, Inclusion, Where, FilterExcludingWhere} from '../query';
+import {
+  Entity,
+  Model,
+  PropertyType,
+  rejectNavigationalPropertiesInData,
+} from '../model';
+import {Filter, FilterExcludingWhere, Inclusion, Where} from '../query';
 import {
   BelongsToAccessor,
   BelongsToDefinition,
@@ -109,8 +115,8 @@ export class DefaultCrudRepository<
 
   /**
    * Constructor of DefaultCrudRepository
-   * @param entityClass - Legacy entity class
-   * @param dataSource - Legacy data source
+   * @param entityClass - LoopBack 4 entity class
+   * @param dataSource - Legacy juggler data source
    */
   constructor(
     // entityClass should have type "typeof T", but that's not supported by TSC
@@ -458,6 +464,9 @@ export class DefaultCrudRepository<
     data: DataObject<T>,
     options?: Options,
   ): Promise<void> {
+    if (id === undefined) {
+      throw new Error('Invalid Argument: id cannot be undefined');
+    }
     const idProp = this.modelClass.definition.idName();
     const where = {} as Where<T>;
     (where as AnyObject)[idProp] = id;
@@ -587,27 +596,10 @@ export class DefaultCrudRepository<
     const data: AnyObject =
       typeof entity.toJSON === 'function' ? entity.toJSON() : {...entity};
     */
+    const data: DeepPartial<R> = new this.entityClass(entity);
+
+    rejectNavigationalPropertiesInData(this.entityClass, data);
 
-    const data: AnyObject = new this.entityClass(entity);
-
-    const def = this.entityClass.definition;
-    const props = def.properties;
-    for (const r in def.relations) {
-      const relName = def.relations[r].name;
-      if (relName in data) {
-        let invalidNameMsg = '';
-        if (relName in props) {
-          invalidNameMsg =
-            ` The error might be invoked by belongsTo relations, please make sure the relation name is not the same as` +
-            ` the property name.`;
-        }
-        throw new Error(
-          `Navigational properties are not allowed in model data (model "${this.entityClass.modelName}"` +
-            ` property "${relName}"), please remove it.` +
-            invalidNameMsg,
-        );
-      }
-    }
     return data;
   }
 

package/src/type-resolver.ts

@@ -51,6 +51,13 @@ export function isTypeResolver<T extends object>(
   return true;
 }
 
+/**
+ * A boxed type for `null`
+ */
+export function Null() {
+  return null;
+}
+
 /**
  * Check if the provided function is a built-in type provided by JavaScript
  * and/or Node.js. E.g. `Number`, `Array`, `Buffer`, etc.
@@ -67,6 +74,7 @@ export function isBuiltinType(fn: Function): boolean {
     fn === Date ||
     fn === RegExp ||
     fn === Buffer ||
+    fn === Null ||
     // function as a type
     fn === Function
   );

package/src/types/index.ts

@@ -15,17 +15,18 @@
  * - ArrayType: Array<T>
  * - UnionType: Union of types
  */
-import {Type} from './type';
-import {StringType} from './string';
-import {BooleanType} from './boolean';
-import {NumberType} from './number';
-import {DateType} from './date';
-import {BufferType} from './buffer';
 import {AnyType} from './any';
 import {ArrayType} from './array';
-import {UnionType} from './union';
-import {ObjectType} from './object';
+import {BooleanType} from './boolean';
+import {BufferType} from './buffer';
+import {DateType} from './date';
 import {ModelType} from './model';
+import {NullType} from './null';
+import {NumberType} from './number';
+import {ObjectType} from './object';
+import {StringType} from './string';
+import {Type} from './type';
+import {UnionType} from './union';
 
 export {
   Type,
@@ -38,6 +39,7 @@ export {
   ArrayType,
   UnionType,
   ModelType,
+  NullType,
   ObjectType,
 };
 
@@ -47,3 +49,4 @@ export const NUMBER = new NumberType();
 export const DATE = new DateType();
 export const BUFFER = new BufferType();
 export const ANY = new AnyType();
+export const NULL = new NullType();

package/src/types/null.ts

@@ -0,0 +1,35 @@
+// Copyright IBM Corp. 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
+
+import {Type} from './type';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+/**
+ * Null type
+ */
+export class NullType implements Type<null> {
+  readonly name = 'boolean';
+
+  isInstance(value: any) {
+    return value === null;
+  }
+
+  defaultValue() {
+    return null;
+  }
+
+  isCoercible(value: any): boolean {
+    return value == null;
+  }
+
+  coerce(value: any) {
+    return null;
+  }
+
+  serialize(value: boolean | null | undefined) {
+    return null;
+  }
+}

package/index.d.ts

@@ -1,6 +0,0 @@
-// Copyright IBM Corp. 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
-
-export * from './dist';

package/index.js

@@ -1,6 +0,0 @@
-// Copyright IBM Corp. 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
-
-module.exports = require('./dist');