@loopback/rest 5.0.1 → 5.2.0

package/src/providers/parse-params.provider.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {inject, Provider} from '@loopback/context';
+import {inject, Provider} from '@loopback/core';
 import {RequestBodyParser} from '../body-parsers';
 import {RestBindings} from '../keys';
 import {parseOperationArgs} from '../parser';

package/src/providers/reject.provider.ts

@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {LogError, Reject, HandlerContext} from '../types';
-import {inject, Provider} from '@loopback/context';
+import {inject, Provider} from '@loopback/core';
 import {HttpError} from 'http-errors';
 import {RestBindings} from '../keys';
 import {writeErrorToResponse, ErrorWriterOptions} from 'strong-error-handler';

package/src/providers/send.provider.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {Provider, BoundValue} from '@loopback/context';
+import {Provider, BoundValue} from '@loopback/core';
 import {writeResultToResponse} from '../writer';
 /**
  * Provides the function that populates the response object with

package/src/request-context.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {Context} from '@loopback/context';
+import {Context} from '@loopback/core';
 import {
   HandlerContext,
   MiddlewareContext,

package/src/rest.application.ts

@@ -1,16 +1,18 @@
-// Copyright IBM Corp. 2018,2019. All Rights Reserved.
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
 // Node module: @loopback/rest
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
 import {
+  Application,
+  ApplicationConfig,
   Binding,
   BindingAddress,
   Constructor,
   Context,
   Provider,
-} from '@loopback/context';
-import {Application, ApplicationConfig, Server} from '@loopback/core';
+  Server,
+} from '@loopback/core';
 import {
   ExpressMiddlewareFactory,
   ExpressRequestHandler,
@@ -387,4 +389,18 @@ export class RestApplication extends Application implements HttpServerLike {
   ): void {
     this.restServer.mountExpressRouter(basePath, router, spec);
   }
+
+  /**
+   * Export the OpenAPI spec to the given json or yaml file
+   * @param outFile - File name for the spec. The extension of the file
+   * determines the format of the file.
+   * - `yaml` or `yml`: YAML
+   * - `json` or other: JSON
+   * If the outFile is not provided or its value is `''` or `'-'`, the spec is
+   * written to the console using the `log` function.
+   * @param log - Log function, default to `console.log`
+   */
+  async exportOpenApiSpec(outFile = '', log = console.log): Promise<void> {
+    return this.restServer.exportOpenApiSpec(outFile, log);
+  }
 }

package/src/rest.component.ts

@@ -8,7 +8,7 @@ import {
   Constructor,
   createBindingFromClass,
   inject,
-} from '@loopback/context';
+} from '@loopback/core';
 import {
   Application,
   Component,

package/src/rest.server.ts

@@ -4,18 +4,20 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {
+  Application,
   Binding,
   BindingAddress,
   BindingScope,
   Constructor,
   ContextObserver,
+  CoreBindings,
   createBindingFromClass,
   filterByKey,
   filterByTag,
   inject,
+  Server,
   Subscription,
-} from '@loopback/context';
-import {Application, CoreBindings, Server} from '@loopback/core';
+} from '@loopback/core';
 import {BaseMiddlewareRegistry, ExpressRequestHandler} from '@loopback/express';
 import {HttpServer, HttpServerOptions} from '@loopback/http-server';
 import {
@@ -32,6 +34,7 @@ import cors from 'cors';
 import debugFactory from 'debug';
 import express, {ErrorRequestHandler} from 'express';
 import {PathParams} from 'express-serve-static-core';
+import fs from 'fs';
 import {IncomingMessage, ServerResponse} from 'http';
 import {ServerOptions} from 'https';
 import {safeDump} from 'js-yaml';
@@ -124,6 +127,7 @@ export class RestServer extends BaseMiddlewareRegistry
    */
 
   protected _OASEnhancer: OASEnhancerService;
+  // eslint-disable-next-line @typescript-eslint/naming-convention
   public get OASEnhancer(): OASEnhancerService {
     this._setupOASEnhancerIfNeeded();
     return this._OASEnhancer;
@@ -176,7 +180,7 @@ export class RestServer extends BaseMiddlewareRegistry
    * will be 'http://localhost:3000' regardless of the `basePath`.
    */
   get rootUrl(): string | undefined {
-    return this._httpServer && this._httpServer.url;
+    return this._httpServer?.url;
   }
 
   /**
@@ -987,6 +991,34 @@ export class RestServer extends BaseMiddlewareRegistry
   ): void {
     this._externalRoutes.mountRouter(basePath, router, spec);
   }
+
+  /**
+   * Export the OpenAPI spec to the given json or yaml file
+   * @param outFile - File name for the spec. The extension of the file
+   * determines the format of the file.
+   * - `yaml` or `yml`: YAML
+   * - `json` or other: JSON
+   * If the outFile is not provided or its value is `''` or `'-'`, the spec is
+   * written to the console using the `log` function.
+   * @param log - Log function, default to `console.log`
+   */
+  async exportOpenApiSpec(outFile = '', log = console.log): Promise<void> {
+    const spec = await this.getApiSpec();
+    if (outFile === '-' || outFile === '') {
+      const json = JSON.stringify(spec, null, 2);
+      log('%s', json);
+      return;
+    }
+    const fileName = outFile.toLowerCase();
+    if (fileName.endsWith('.yaml') || fileName.endsWith('.yml')) {
+      const yaml = safeDump(spec);
+      fs.writeFileSync(outFile, yaml, 'utf-8');
+    } else {
+      const json = JSON.stringify(spec, null, 2);
+      fs.writeFileSync(outFile, json, 'utf-8');
+    }
+    log('The OpenAPI spec has been saved to %s.', outFile);
+  }
 }
 
 /**

package/src/router/base-route.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {Context, InvocationSource} from '@loopback/context';
+import {Context, InvocationSource} from '@loopback/core';
 import {OperationObject} from '@loopback/openapi-v3';
 import {OperationArgs, OperationRetval} from '../types';
 import {RouteEntry} from './route-entry';

package/src/router/controller-route.ts

@@ -7,11 +7,11 @@ import {
   BindingScope,
   Constructor,
   Context,
+  CoreBindings,
   instantiateClass,
   invokeMethod,
   ValueOrPromise,
-} from '@loopback/context';
-import {CoreBindings} from '@loopback/core';
+} from '@loopback/core';
 import {ControllerSpec, OperationObject} from '@loopback/openapi-v3';
 import assert from 'assert';
 import debugFactory from 'debug';

package/src/router/external-express-routes.ts

@@ -1,9 +1,9 @@
-// Copyright IBM Corp. 2019. All Rights Reserved.
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
 // Node module: @loopback/rest
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {Context} from '@loopback/context';
+import {Context} from '@loopback/core';
 import {
   executeExpressRequestHandler,
   ExpressRequestHandler,

package/src/router/handler-route.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {Context, invokeMethodWithInterceptors} from '@loopback/context';
+import {Context, invokeMethodWithInterceptors} from '@loopback/core';
 import {OperationObject} from '@loopback/openapi-v3';
 import {RestBindings} from '../keys';
 import {OperationArgs, OperationRetval} from '../types';

package/src/router/redirect-route.ts

@@ -54,8 +54,7 @@ export class RedirectRoute implements RouteEntry, ResolvedRoute {
     const redirectOptions = obj as RedirectRoute;
     if (
       redirectOptions?.targetLocation &&
-      redirectOptions.spec &&
-      redirectOptions.spec.description === 'LoopBack Redirect route'
+      redirectOptions.spec?.description === 'LoopBack Redirect route'
     ) {
       return true;
     }

package/src/router/regexp-router.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {inject} from '@loopback/context';
+import {inject} from '@loopback/core';
 import {inspect} from 'util';
 import {RestBindings} from '../keys';
 import {PathParameterValues} from '../types';

package/src/router/route-entry.ts

@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {Context} from '@loopback/context';
+import {Context} from '@loopback/core';
 import {OperationObject, SchemasObject} from '@loopback/openapi-v3';
 import {OperationArgs, OperationRetval, PathParameterValues} from '../types';
 

package/src/router/trie-router.ts

@@ -1,9 +1,9 @@
-// Copyright IBM Corp. 2018,2019. All Rights Reserved.
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
 // Node module: @loopback/rest
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {inject} from '@loopback/context';
+import {inject} from '@loopback/core';
 import {inspect} from 'util';
 import {RestBindings} from '../keys';
 import {RestRouterOptions} from './rest-router';

package/src/sequence.ts

@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 const debug = require('debug')('loopback:rest:sequence');
-import {inject, ValueOrPromise} from '@loopback/context';
+import {inject, ValueOrPromise} from '@loopback/core';
 import {InvokeMiddleware} from '@loopback/express';
 import {RestBindings} from './keys';
 import {RequestContext} from './request-context';

package/src/spec-enhancers/info.spec-enhancer.ts

@@ -4,13 +4,14 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {
+  ApplicationMetadata,
   bind,
   BindingScope,
+  CoreBindings,
   inject,
   JSONObject,
   JSONValue,
-} from '@loopback/context';
-import {ApplicationMetadata, CoreBindings} from '@loopback/core';
+} from '@loopback/core';
 import {
   asSpecEnhancer,
   ContactObject,

package/src/types.ts

@@ -108,6 +108,17 @@ export type AjvKeyword = KeywordDefinition & {name: string};
  */
 export type AjvFormat = FormatDefinition & {name: string};
 
+/**
+ * Options for any value validation using AJV
+ */
+export interface ValueValidationOptions extends RequestBodyValidationOptions {
+  /**
+   * Where the data comes from. It can be 'body', 'path', 'header',
+   * 'query', 'cookie', etc...
+   */
+  source?: string;
+}
+
 /**
  * Options for request body validation using AJV
  */

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

@@ -15,7 +15,11 @@ import debugModule from 'debug';
 import _ from 'lodash';
 import util from 'util';
 import {HttpErrors, RequestBody, RestHttpErrors} from '..';
-import {RequestBodyValidationOptions, SchemaValidatorCache} from '../types';
+import {
+  RequestBodyValidationOptions,
+  SchemaValidatorCache,
+  ValueValidationOptions,
+} from '../types';
 import {AjvFactoryProvider} from './ajv-factory.provider';
 
 const toJsonSchema = require('@openapi-contrib/openapi-schema-to-json-schema');
@@ -66,7 +70,10 @@ export async function validateRequestBody(
   if (!schema) return;
 
   options = {coerceTypes: !!body.coercionRequired, ...options};
-  await validateValueAgainstSchema(body.value, schema, globalSchemas, options);
+  await validateValueAgainstSchema(body.value, schema, globalSchemas, {
+    ...options,
+    source: 'body',
+  });
 }
 
 /**
@@ -115,12 +122,12 @@ function getKeyForOptions(options: RequestBodyValidationOptions) {
  * @param globalSchemas - Schema references.
  * @param options - Request body validation options.
  */
-async function validateValueAgainstSchema(
+export async function validateValueAgainstSchema(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  body: any,
+  value: any,
   schema: SchemaObject | ReferenceObject,
   globalSchemas: SchemasObject = {},
-  options: RequestBodyValidationOptions = {},
+  options: ValueValidationOptions = {},
 ) {
   let validate: ajv.ValidateFunction | undefined;
 
@@ -145,10 +152,10 @@ async function validateValueAgainstSchema(
 
   let validationErrors: ajv.ErrorObject[] = [];
   try {
-    const validationResult = await validate(body);
-    // When body is optional & values is empty / null, ajv returns null
+    const validationResult = await validate(value);
+    // When value is optional & values is empty / null, ajv returns null
     if (validationResult || validationResult === null) {
-      debug('Request body passed AJV validation.');
+      debug(`Value from ${options.source} passed AJV validation.`);
       return;
     }
   } catch (error) {
@@ -158,8 +165,8 @@ async function validateValueAgainstSchema(
   /* istanbul ignore if */
   if (debug.enabled) {
     debug(
-      'Invalid request body: %s. Errors: %s',
-      util.inspect(body, {depth: null}),
+      'Invalid value: %s. Errors: %s',
+      util.inspect(value, {depth: null}),
       util.inspect(validationErrors),
     );
   }
@@ -168,7 +175,24 @@ async function validateValueAgainstSchema(
     validationErrors = options.ajvErrorTransformer(validationErrors);
   }
 
-  const error = RestHttpErrors.invalidRequestBody();
+  // Throw invalid request body error
+  if (options.source === 'body') {
+    const error = RestHttpErrors.invalidRequestBody();
+    addErrorDetails(error, validationErrors);
+    throw error;
+  }
+
+  // Throw invalid value error
+  const error = new HttpErrors.BadRequest('Invalid value.');
+  addErrorDetails(error, validationErrors);
+  throw error;
+}
+
+function addErrorDetails(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  error: any,
+  validationErrors: ajv.ErrorObject[],
+) {
   error.details = _.map(validationErrors, e => {
     return {
       path: e.dataPath,
@@ -177,7 +201,6 @@ async function validateValueAgainstSchema(
       info: e.params,
     };
   });
-  throw error;
 }
 
 /**