@loopback/repository 1.15.4 → 1.18.0

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

@@ -4,8 +4,8 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {Getter} from '@loopback/context';
-import * as assert from 'assert';
-import * as legacy from 'loopback-datasource-juggler';
+import assert from 'assert';
+import legacy from 'loopback-datasource-juggler';
 import {
   AnyObject,
   Command,
@@ -339,14 +339,18 @@ export class DefaultCrudRepository<
   }
 
   async create(entity: DataObject<T>, options?: Options): Promise<T> {
-    const model = await ensurePromise(this.modelClass.create(entity, options));
+    // perform persist hook
+    const data = await this.entityToData(entity, options);
+    const model = await ensurePromise(this.modelClass.create(data, options));
     return this.toEntity(model);
   }
 
   async createAll(entities: DataObject<T>[], options?: Options): Promise<T[]> {
-    const models = await ensurePromise(
-      this.modelClass.create(entities, options),
+    // perform persist hook
+    const data = await Promise.all(
+      entities.map(e => this.entityToData(e, options)),
     );
+    const models = await ensurePromise(this.modelClass.create(data, options));
     return this.toEntities(models);
   }
 
@@ -364,7 +368,7 @@ export class DefaultCrudRepository<
     filter?: Filter<T>,
     options?: Options,
   ): Promise<(T & Relations)[]> {
-    const include = filter && filter.include;
+    const include = filter?.include;
     const models = await ensurePromise(
       this.modelClass.find(this.normalizeFilter(filter), options),
     );
@@ -381,7 +385,7 @@ export class DefaultCrudRepository<
     );
     if (!model) return null;
     const entity = this.toEntity(model);
-    const include = filter && filter.include;
+    const include = filter?.include;
     const resolved = await this.includeRelatedModels(
       [entity],
       include,
@@ -395,7 +399,7 @@ export class DefaultCrudRepository<
     filter?: Filter<T>,
     options?: Options,
   ): Promise<T & Relations> {
-    const include = filter && filter.include;
+    const include = filter?.include;
     const model = await ensurePromise(
       this.modelClass.findById(id, this.normalizeFilter(filter), options),
     );
@@ -415,7 +419,9 @@ export class DefaultCrudRepository<
     return this.updateById(entity.getId(), entity, options);
   }
 
-  delete(entity: T, options?: Options): Promise<void> {
+  async delete(entity: T, options?: Options): Promise<void> {
+    // perform persist hook
+    await this.entityToData(entity, options);
     return this.deleteById(entity.getId(), options);
   }
 
@@ -424,9 +430,10 @@ export class DefaultCrudRepository<
     where?: Where<T>,
     options?: Options,
   ): Promise<Count> {
-    where = where || {};
+    where = where ?? {};
+    const persistedData = await this.entityToData(data, options);
     const result = await ensurePromise(
-      this.modelClass.updateAll(where, data, options),
+      this.modelClass.updateAll(where, persistedData, options),
     );
     return {count: result.count};
   }
@@ -451,7 +458,8 @@ export class DefaultCrudRepository<
     options?: Options,
   ): Promise<void> {
     try {
-      await ensurePromise(this.modelClass.replaceById(id, data, options));
+      const payload = await this.entityToData(data, options);
+      await ensurePromise(this.modelClass.replaceById(id, payload, options));
     } catch (err) {
       if (err.statusCode === 404) {
         throw new EntityNotFoundError(this.entityClass, id);
@@ -528,6 +536,66 @@ export class DefaultCrudRepository<
     return includeRelatedModels<T, Relations>(this, entities, include, options);
   }
 
+  /**
+   * This function works as a persist hook.
+   * It converts an entity from the CRUD operations' caller
+   * to a persistable data that can will be stored in the
+   * back-end database.
+   *
+   * User can extend `DefaultCrudRepository` then override this
+   * function to execute custom persist hook.
+   * @param entity The entity passed from CRUD operations' caller.
+   * @param options
+   */
+  protected async entityToData<R extends T>(
+    entity: R | DataObject<R>,
+    options = {},
+  ): Promise<legacy.ModelData<legacy.PersistedModel>> {
+    return this.ensurePersistable(entity, options);
+  }
+
+  /** Converts an entity object to a JSON object to check if it contains navigational property.
+   * Throws an error if `entity` contains navigational property.
+   *
+   * @param entity The entity passed from CRUD operations' caller.
+   * @param options
+   */
+  protected ensurePersistable<R extends T>(
+    entity: R | DataObject<R>,
+    options = {},
+  ): legacy.ModelData<legacy.PersistedModel> {
+    // FIXME(bajtos) Ideally, we should call toJSON() to convert R to data object
+    // Unfortunately that breaks replaceById for MongoDB connector, where we
+    // would call replaceId with id *argument* set to ObjectID value but
+    // id *property* set to string value.
+    /*
+    const data: AnyObject =
+      typeof entity.toJSON === 'function' ? entity.toJSON() : {...entity};
+    */
+
+    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;
+  }
+
   /**
    * Removes juggler's "include" filter as it does not apply to LoopBack 4
    * relations.
@@ -555,7 +623,7 @@ export class DefaultTransactionalRepository<
   async beginTransaction(
     options?: IsolationLevel | Options,
   ): Promise<Transaction> {
-    const dsOptions: juggler.IsolationLevel | Options = options || {};
+    const dsOptions: juggler.IsolationLevel | Options = options ?? {};
     // juggler.Transaction still has the Promise/Callback variants of the
     // Transaction methods
     // so we need it cast it back

package/src/types/array.ts

@@ -3,8 +3,8 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+import util from 'util';
 import {Type} from './type';
-import * as util from 'util';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 

package/src/types/buffer.ts

@@ -3,9 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import * as util from 'util';
-import {Type} from './type';
+import util from 'util';
 import {Options} from '../common-types';
+import {Type} from './type';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
@@ -35,7 +35,7 @@ export class BufferType implements Type<Buffer> {
     if (value == null) return value;
     if (Buffer.isBuffer(value)) return value as Buffer;
     if (typeof value === 'string') {
-      options = options || {};
+      options = options ?? {};
       const encoding = options.encoding || 'utf-8';
       return Buffer.from(value, encoding);
     } else if (Array.isArray(value)) {
@@ -47,7 +47,7 @@ export class BufferType implements Type<Buffer> {
 
   serialize(value: Buffer | null | undefined, options?: Options) {
     if (value == null) return value;
-    const encoding = (options && options.encoding) || 'base64';
+    const encoding = options?.encoding || 'base64';
     return value.toString(encoding);
   }
 }

package/src/types/date.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import * as util from 'util';
+import util from 'util';
 import {Type} from './type';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */

package/src/types/number.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import * as util from 'util';
+import util from 'util';
 import {Type} from './type';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */

package/src/types/object.ts

@@ -3,8 +3,8 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import * as util from 'util';
-import {Class, AnyObject} from '../common-types';
+import util from 'util';
+import {AnyObject, Class} from '../common-types';
 import {Type} from './type';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */

package/src/types/union.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import * as util from 'util';
+import util from 'util';
 import {Type} from './type';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */