@loopback/rest 9.3.0 → 10.1.0

package/src/validation/request-body.validator.ts

@@ -10,7 +10,8 @@ import {
   SchemaObject,
   SchemasObject,
 } from '@loopback/openapi-v3';
-import ajv, {Ajv} from 'ajv';
+import Ajv, {AsyncValidateFunction, ErrorObject} from 'ajv';
+import {AnyValidateFunction, AsyncSchema} from 'ajv/dist/core';
 import debugModule from 'debug';
 import util from 'util';
 import {HttpErrors, RequestBody, RestHttpErrors} from '..';
@@ -131,12 +132,12 @@ export async function validateValueAgainstSchema(
   globalSchemas: SchemasObject = {},
   options: ValueValidationOptions = {},
 ) {
-  let validate: ajv.ValidateFunction | undefined;
+  let validate: AnyValidateFunction | undefined;
 
   const cache = options.compiledSchemaCache ?? DEFAULT_COMPILED_SCHEMA_CACHE;
   const key = getKeyForOptions(options);
 
-  let validatorMap: Map<string, ajv.ValidateFunction> | undefined;
+  let validatorMap: Map<string, AnyValidateFunction> | undefined;
   if (cache.has(schema)) {
     validatorMap = cache.get(schema)!;
     validate = validatorMap.get(key);
@@ -152,14 +153,14 @@ export async function validateValueAgainstSchema(
     cache.set(schema, validatorMap);
   }
 
-  let validationErrors: ajv.ErrorObject[] = [];
+  let validationErrors: ErrorObject[] = [];
   try {
-    const validationResult = await validate(value);
+    const validationResult = validate(value);
     debug(
       `Value from ${options.source} passed AJV validation.`,
       validationResult,
     );
-    return validationResult;
+    return await validationResult;
   } catch (error) {
     validationErrors = error.errors;
   }
@@ -193,12 +194,12 @@ export async function validateValueAgainstSchema(
 }
 
 function buildErrorDetails(
-  validationErrors: ajv.ErrorObject[],
+  validationErrors: ErrorObject[],
 ): RestHttpErrors.ValidationErrorDetails[] {
   return validationErrors.map(
-    (e: ajv.ErrorObject): RestHttpErrors.ValidationErrorDetails => {
+    (e: ErrorObject): RestHttpErrors.ValidationErrorDetails => {
       return {
-        path: e.dataPath,
+        path: e.instancePath,
         code: e.keyword,
         message: e.message ?? `must pass validation rule ${e.keyword}`,
         info: e.params,
@@ -217,18 +218,18 @@ function createValidator(
   schema: SchemaObject,
   globalSchemas: SchemasObject = {},
   ajvInst: Ajv,
-): ajv.ValidateFunction {
+): AsyncValidateFunction {
   const jsonSchema = convertToJsonSchema(schema);
 
   // Clone global schemas to set `$async: true` flag
   const schemas: SchemasObject = {};
   for (const name in globalSchemas) {
-    // See https://github.com/strongloop/loopback-next/issues/4939
+    // See https://github.com/loopbackio/loopback-next/issues/4939
     schemas[name] = {...globalSchemas[name], $async: true};
   }
-  const schemaWithRef = {components: {schemas}, ...jsonSchema};
+  const schemaWithRef: AsyncSchema = {components: {schemas}, ...jsonSchema};
 
-  // See https://ajv.js.org/#asynchronous-validation for async validation
+  // See https://js.org/#asynchronous-validation for async validation
   schemaWithRef.$async = true;
 
   return ajvInst.compile(schemaWithRef);

package/src/writer.ts

@@ -3,8 +3,8 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {OperationRetval, Response} from './types';
 import {Readable} from 'stream';
+import {OperationRetval, Response} from './types';
 
 /**
  * Writes the result from Application controller method
@@ -48,7 +48,7 @@ export function writeResultToResponse(
         response.setHeader('Content-Type', 'application/octet-stream');
       } else {
         // TODO(ritch) remove this, should be configurable
-        // See https://github.com/strongloop/loopback-next/issues/436
+        // See https://github.com/loopbackio/loopback-next/issues/436
         response.setHeader('Content-Type', 'application/json');
         // TODO(bajtos) handle errors - JSON.stringify can throw
         result = JSON.stringify(result);