@loopback/rest 4.0.0-alpha.8 → 5.0.1

package/dist/rest-http-error.js

@@ -0,0 +1,51 @@
+"use strict";
+// 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
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestHttpErrors = void 0;
+const tslib_1 = require("tslib");
+const http_errors_1 = tslib_1.__importDefault(require("http-errors"));
+var RestHttpErrors;
+(function (RestHttpErrors) {
+    function invalidData(data, name, extraProperties) {
+        const msg = `Invalid data ${JSON.stringify(data)} for parameter ${name}!`;
+        return Object.assign(new http_errors_1.default.BadRequest(msg), {
+            code: 'INVALID_PARAMETER_VALUE',
+            parameterName: name,
+        }, extraProperties);
+    }
+    RestHttpErrors.invalidData = invalidData;
+    function unsupportedMediaType(contentType, allowedTypes = []) {
+        const msg = (allowedTypes === null || allowedTypes === void 0 ? void 0 : allowedTypes.length) ? `Content-type ${contentType} does not match [${allowedTypes}].`
+            : `Content-type ${contentType} is not supported.`;
+        return Object.assign(new http_errors_1.default.UnsupportedMediaType(msg), {
+            code: 'UNSUPPORTED_MEDIA_TYPE',
+            contentType: contentType,
+            allowedMediaTypes: allowedTypes,
+        });
+    }
+    RestHttpErrors.unsupportedMediaType = unsupportedMediaType;
+    function missingRequired(name) {
+        const msg = `Required parameter ${name} is missing!`;
+        return Object.assign(new http_errors_1.default.BadRequest(msg), {
+            code: 'MISSING_REQUIRED_PARAMETER',
+            parameterName: name,
+        });
+    }
+    RestHttpErrors.missingRequired = missingRequired;
+    function invalidParamLocation(location) {
+        const msg = `Parameters with "in: ${location}" are not supported yet.`;
+        return new http_errors_1.default.NotImplemented(msg);
+    }
+    RestHttpErrors.invalidParamLocation = invalidParamLocation;
+    RestHttpErrors.INVALID_REQUEST_BODY_MESSAGE = 'The request body is invalid. See error object `details` property for more info.';
+    function invalidRequestBody() {
+        return Object.assign(new http_errors_1.default.UnprocessableEntity(RestHttpErrors.INVALID_REQUEST_BODY_MESSAGE), {
+            code: 'VALIDATION_FAILED',
+        });
+    }
+    RestHttpErrors.invalidRequestBody = invalidRequestBody;
+})(RestHttpErrors = exports.RestHttpErrors || (exports.RestHttpErrors = {}));
+//# sourceMappingURL=rest-http-error.js.map

package/dist/rest-http-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-http-error.js","sourceRoot":"","sources":["../src/rest-http-error.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,sEAAqC;AAErC,IAAiB,cAAc,CA+E9B;AA/ED,WAAiB,cAAc;IAC7B,SAAgB,WAAW,CACzB,IAAO,EACP,IAAY,EACZ,eAAuB;QAEvB,MAAM,GAAG,GAAG,gBAAgB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,kBAAkB,IAAI,GAAG,CAAC;QAC1E,OAAO,MAAM,CAAC,MAAM,CAClB,IAAI,qBAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAC9B;YACE,IAAI,EAAE,yBAAyB;YAC/B,aAAa,EAAE,IAAI;SACpB,EACD,eAAe,CAChB,CAAC;IACJ,CAAC;IAde,0BAAW,cAc1B,CAAA;IAED,SAAgB,oBAAoB,CAClC,WAAmB,EACnB,eAAyB,EAAE;QAE3B,MAAM,GAAG,GAAG,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,EAC9B,CAAC,CAAC,gBAAgB,WAAW,oBAAoB,YAAY,IAAI;YACjE,CAAC,CAAC,gBAAgB,WAAW,oBAAoB,CAAC;QACpD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,qBAAU,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE;YAC7D,IAAI,EAAE,wBAAwB;YAC9B,WAAW,EAAE,WAAW;YACxB,iBAAiB,EAAE,YAAY;SAChC,CAAC,CAAC;IACL,CAAC;IAZe,mCAAoB,uBAYnC,CAAA;IAED,SAAgB,eAAe,CAAC,IAAY;QAC1C,MAAM,GAAG,GAAG,sBAAsB,IAAI,cAAc,CAAC;QACrD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,qBAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACnD,IAAI,EAAE,4BAA4B;YAClC,aAAa,EAAE,IAAI;SACpB,CAAC,CAAC;IACL,CAAC;IANe,8BAAe,kBAM9B,CAAA;IAED,SAAgB,oBAAoB,CAAC,QAAgB;QACnD,MAAM,GAAG,GAAG,wBAAwB,QAAQ,0BAA0B,CAAC;QACvE,OAAO,IAAI,qBAAU,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAHe,mCAAoB,uBAGnC,CAAA;IAEY,2CAA4B,GACvC,iFAAiF,CAAC;IACpF,SAAgB,kBAAkB;QAChC,OAAO,MAAM,CAAC,MAAM,CAClB,IAAI,qBAAU,CAAC,mBAAmB,CAAC,eAAA,4BAA4B,CAAC,EAChE;YACE,IAAI,EAAE,mBAAmB;SAC1B,CACF,CAAC;IACJ,CAAC;IAPe,iCAAkB,qBAOjC,CAAA;AA0BH,CAAC,EA/EgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QA+E9B"}

package/dist/rest.application.d.ts

@@ -0,0 +1,232 @@
+import { Binding, BindingAddress, Constructor, Context, Provider } from '@loopback/context';
+import { Application, ApplicationConfig, Server } from '@loopback/core';
+import { ExpressMiddlewareFactory, ExpressRequestHandler, Middleware, MiddlewareBindingOptions } from '@loopback/express';
+import { OpenApiSpec, OperationObject } from '@loopback/openapi-v3';
+import { PathParams } from 'express-serve-static-core';
+import { ServeStaticOptions } from 'serve-static';
+import { BodyParser } from './body-parsers';
+import { RestBindings } from './keys';
+import { HttpRequestListener, HttpServerLike, RestServer } from './rest.server';
+import { ControllerClass, ControllerFactory, RouteEntry } from './router';
+import { RouterSpec } from './router/router-spec';
+import { SequenceFunction, SequenceHandler } from './sequence';
+export declare const ERR_NO_MULTI_SERVER: string;
+export declare const SequenceActions: typeof RestBindings.SequenceActions;
+/**
+ * An implementation of the Application class that automatically provides
+ * an instance of a REST server. This application class is intended to be
+ * a single-server implementation. Any attempt to bind additional servers
+ * will throw an error.
+ *
+ */
+export declare class RestApplication extends Application implements HttpServerLike {
+    /**
+     * The main REST server instance providing REST API for this application.
+     */
+    get restServer(): RestServer;
+    /**
+     * Handle incoming HTTP(S) request by invoking the corresponding
+     * Controller method via the configured Sequence.
+     *
+     * @example
+     *
+     * ```ts
+     * const app = new RestApplication();
+     * // setup controllers, etc.
+     *
+     * const server = http.createServer(app.requestHandler);
+     * server.listen(3000);
+     * ```
+     *
+     * @param req - The request.
+     * @param res - The response.
+     */
+    get requestHandler(): HttpRequestListener;
+    /**
+     * Create a REST application with the given parent context
+     * @param parent - Parent context
+     */
+    constructor(parent: Context);
+    /**
+     * Create a REST application with the given configuration and parent context
+     * @param config - Application configuration
+     * @param parent - Parent context
+     */
+    constructor(config?: ApplicationConfig, parent?: Context);
+    server(server: Constructor<Server>, name?: string): Binding;
+    sequence(sequence: Constructor<SequenceHandler>): Binding;
+    handler(handlerFn: SequenceFunction): void;
+    /**
+     * Mount static assets to the REST server.
+     * See https://expressjs.com/en/4x/api.html#express.static
+     * @param path - The path(s) to serve the asset.
+     * See examples at https://expressjs.com/en/4x/api.html#path-examples
+     * To avoid performance penalty, `/` is not allowed for now.
+     * @param rootDir - The root directory from which to serve static assets
+     * @param options - Options for serve-static
+     */
+    static(path: PathParams, rootDir: string, options?: ServeStaticOptions): void;
+    /**
+     * Bind a body parser to the server context
+     * @param parserClass - Body parser class
+     * @param address - Optional binding address
+     */
+    bodyParser(bodyParserClass: Constructor<BodyParser>, address?: BindingAddress<BodyParser>): Binding<BodyParser>;
+    /**
+     * Configure the `basePath` for the rest server
+     * @param path - Base path
+     */
+    basePath(path?: string): void;
+    /**
+     * Bind an Express middleware to this server context
+     *
+     * @example
+     * ```ts
+     * import myExpressMiddlewareFactory from 'my-express-middleware';
+     * const myExpressMiddlewareConfig= {};
+     * const myExpressMiddleware = myExpressMiddlewareFactory(myExpressMiddlewareConfig);
+     * server.expressMiddleware('middleware.express.my', myExpressMiddleware);
+     * ```
+     * @param key - Middleware binding key
+     * @param middleware - Express middleware handler function(s)
+     *
+     */
+    expressMiddleware(key: BindingAddress, middleware: ExpressRequestHandler | ExpressRequestHandler[], options?: MiddlewareBindingOptions): Binding<Middleware>;
+    /**
+     * Bind an Express middleware to this server context
+     *
+     * @example
+     * ```ts
+     * import myExpressMiddlewareFactory from 'my-express-middleware';
+     * const myExpressMiddlewareConfig= {};
+     * server.expressMiddleware(myExpressMiddlewareFactory, myExpressMiddlewareConfig);
+     * ```
+     * @param middlewareFactory - Middleware module name or factory function
+     * @param middlewareConfig - Middleware config
+     * @param options - Options for registration
+     *
+     * @typeParam CFG - Configuration type
+     */
+    expressMiddleware<CFG>(middlewareFactory: ExpressMiddlewareFactory<CFG>, middlewareConfig?: CFG, options?: MiddlewareBindingOptions): Binding<Middleware>;
+    /**
+     * Register a middleware function or provider class
+     *
+     * @example
+     * ```ts
+     * const log: Middleware = async (requestCtx, next) {
+     *   // ...
+     * }
+     * server.middleware(log);
+     * ```
+     *
+     * @param middleware - Middleware function or provider class
+     * @param options - Middleware binding options
+     */
+    middleware(middleware: Middleware | Constructor<Provider<Middleware>>, options?: MiddlewareBindingOptions): Binding<Middleware>;
+    /**
+     * Register a new Controller-based route.
+     *
+     * @example
+     * ```ts
+     * class MyController {
+     *   greet(name: string) {
+     *     return `hello ${name}`;
+     *   }
+     * }
+     * app.route('get', '/greet', operationSpec, MyController, 'greet');
+     * ```
+     *
+     * @param verb - HTTP verb of the endpoint
+     * @param path - URL path of the endpoint
+     * @param spec - The OpenAPI spec describing the endpoint (operation)
+     * @param controllerCtor - Controller constructor
+     * @param controllerFactory - A factory function to create controller instance
+     * @param methodName - The name of the controller method
+     */
+    route<T>(verb: string, path: string, spec: OperationObject, controllerCtor: ControllerClass<T>, controllerFactory: ControllerFactory<T>, methodName: string): Binding;
+    /**
+     * Register a new route invoking a handler function.
+     *
+     * @example
+     * ```ts
+     * function greet(name: string) {
+     *  return `hello ${name}`;
+     * }
+     * app.route('get', '/', operationSpec, greet);
+     * ```
+     *
+     * @param verb - HTTP verb of the endpoint
+     * @param path - URL path of the endpoint
+     * @param spec - The OpenAPI spec describing the endpoint (operation)
+     * @param handler - The function to invoke with the request parameters
+     * described in the spec.
+     */
+    route(verb: string, path: string, spec: OperationObject, handler: Function): Binding;
+    /**
+     * Register a new route.
+     *
+     * @example
+     * ```ts
+     * function greet(name: string) {
+     *  return `hello ${name}`;
+     * }
+     * const route = new Route('get', '/', operationSpec, greet);
+     * app.route(route);
+     * ```
+     *
+     * @param route - The route to add.
+     */
+    route(route: RouteEntry): Binding;
+    /**
+     * Register a new route.
+     *
+     * @example
+     * ```ts
+     * function greet(name: string) {
+     *  return `hello ${name}`;
+     * }
+     * app.route('get', '/', operationSpec, greet);
+     * ```
+     */
+    route(verb: string, path: string, spec: OperationObject, handler: Function): Binding;
+    /**
+     * Register a route redirecting callers to a different URL.
+     *
+     * @example
+     * ```ts
+     * app.redirect('/explorer', '/explorer/');
+     * ```
+     *
+     * @param fromPath - URL path of the redirect endpoint
+     * @param toPathOrUrl - Location (URL path or full URL) where to redirect to.
+     * If your server is configured with a custom `basePath`, then the base path
+     * is prepended to the target location.
+     * @param statusCode - HTTP status code to respond with,
+     *   defaults to 303 (See Other).
+     */
+    redirect(fromPath: string, toPathOrUrl: string, statusCode?: number): Binding;
+    /**
+     * Set the OpenAPI specification that defines the REST API schema for this
+     * application. All routes, parameter definitions and return types will be
+     * defined in this way.
+     *
+     * Note that this will override any routes defined via decorators at the
+     * controller level (this function takes precedent).
+     *
+     * @param spec - The OpenAPI specification, as an object.
+     * @returns Binding for the api spec
+     */
+    api(spec: OpenApiSpec): Binding;
+    /**
+     * Mount an Express router to expose additional REST endpoints handled
+     * via legacy Express-based stack.
+     *
+     * @param basePath - Path where to mount the router at, e.g. `/` or `/api`.
+     * @param router - The Express router to handle the requests.
+     * @param spec - A partial OpenAPI spec describing endpoints provided by the
+     * router. LoopBack will prepend `basePath` to all endpoints automatically.
+     * This argument is optional. You can leave it out if you don't want to
+     * document the routes.
+     */
+    mountExpressRouter(basePath: string, router: ExpressRequestHandler, spec?: RouterSpec): void;
+}

package/dist/rest.application.js

@@ -0,0 +1,174 @@
+"use strict";
+// Copyright IBM Corp. 2018,2019. All Rights Reserved.
+// Node module: @loopback/rest
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestApplication = exports.SequenceActions = exports.ERR_NO_MULTI_SERVER = void 0;
+const core_1 = require("@loopback/core");
+const util_1 = require("util");
+const keys_1 = require("./keys");
+const rest_component_1 = require("./rest.component");
+exports.ERR_NO_MULTI_SERVER = util_1.format('RestApplication does not support multiple servers!', 'To create your own server bindings, please extend the Application class.');
+// To help cut down on verbosity!
+exports.SequenceActions = keys_1.RestBindings.SequenceActions;
+/**
+ * An implementation of the Application class that automatically provides
+ * an instance of a REST server. This application class is intended to be
+ * a single-server implementation. Any attempt to bind additional servers
+ * will throw an error.
+ *
+ */
+class RestApplication extends core_1.Application {
+    /**
+     * The main REST server instance providing REST API for this application.
+     */
+    get restServer() {
+        // FIXME(kjdelisle): I attempted to mimic the pattern found in RestServer
+        // with no success, so until I've got a better way, this is functional.
+        return this.getSync('servers.RestServer');
+    }
+    /**
+     * Handle incoming HTTP(S) request by invoking the corresponding
+     * Controller method via the configured Sequence.
+     *
+     * @example
+     *
+     * ```ts
+     * const app = new RestApplication();
+     * // setup controllers, etc.
+     *
+     * const server = http.createServer(app.requestHandler);
+     * server.listen(3000);
+     * ```
+     *
+     * @param req - The request.
+     * @param res - The response.
+     */
+    get requestHandler() {
+        return this.restServer.requestHandler;
+    }
+    constructor(configOrParent, parent) {
+        super(configOrParent, parent);
+        this.component(rest_component_1.RestComponent);
+    }
+    server(server, name) {
+        if (this.findByTag('server').length > 0) {
+            throw new Error(exports.ERR_NO_MULTI_SERVER);
+        }
+        return super.server(server, name);
+    }
+    sequence(sequence) {
+        return this.bind(keys_1.RestBindings.SEQUENCE).toClass(sequence);
+    }
+    handler(handlerFn) {
+        this.restServer.handler(handlerFn);
+    }
+    /**
+     * Mount static assets to the REST server.
+     * See https://expressjs.com/en/4x/api.html#express.static
+     * @param path - The path(s) to serve the asset.
+     * See examples at https://expressjs.com/en/4x/api.html#path-examples
+     * To avoid performance penalty, `/` is not allowed for now.
+     * @param rootDir - The root directory from which to serve static assets
+     * @param options - Options for serve-static
+     */
+    static(path, rootDir, options) {
+        this.restServer.static(path, rootDir, options);
+    }
+    /**
+     * Bind a body parser to the server context
+     * @param parserClass - Body parser class
+     * @param address - Optional binding address
+     */
+    bodyParser(bodyParserClass, address) {
+        return this.restServer.bodyParser(bodyParserClass, address);
+    }
+    /**
+     * Configure the `basePath` for the rest server
+     * @param path - Base path
+     */
+    basePath(path = '') {
+        this.restServer.basePath(path);
+    }
+    expressMiddleware(factoryOrKey, configOrHandlers, options = {}) {
+        return this.restServer.expressMiddleware(factoryOrKey, configOrHandlers, options);
+    }
+    /**
+     * Register a middleware function or provider class
+     *
+     * @example
+     * ```ts
+     * const log: Middleware = async (requestCtx, next) {
+     *   // ...
+     * }
+     * server.middleware(log);
+     * ```
+     *
+     * @param middleware - Middleware function or provider class
+     * @param options - Middleware binding options
+     */
+    middleware(middleware, options = {}) {
+        return this.restServer.middleware(middleware, options);
+    }
+    route(routeOrVerb, path, spec, controllerCtorOrHandler, controllerFactory, methodName) {
+        const server = this.restServer;
+        if (typeof routeOrVerb === 'object') {
+            return server.route(routeOrVerb);
+        }
+        else if (arguments.length === 4) {
+            return server.route(routeOrVerb, path, spec, controllerCtorOrHandler);
+        }
+        else {
+            return server.route(routeOrVerb, path, spec, controllerCtorOrHandler, controllerFactory, methodName);
+        }
+    }
+    /**
+     * Register a route redirecting callers to a different URL.
+     *
+     * @example
+     * ```ts
+     * app.redirect('/explorer', '/explorer/');
+     * ```
+     *
+     * @param fromPath - URL path of the redirect endpoint
+     * @param toPathOrUrl - Location (URL path or full URL) where to redirect to.
+     * If your server is configured with a custom `basePath`, then the base path
+     * is prepended to the target location.
+     * @param statusCode - HTTP status code to respond with,
+     *   defaults to 303 (See Other).
+     */
+    redirect(fromPath, toPathOrUrl, statusCode) {
+        return this.restServer.redirect(fromPath, toPathOrUrl, statusCode);
+    }
+    /**
+     * Set the OpenAPI specification that defines the REST API schema for this
+     * application. All routes, parameter definitions and return types will be
+     * defined in this way.
+     *
+     * Note that this will override any routes defined via decorators at the
+     * controller level (this function takes precedent).
+     *
+     * @param spec - The OpenAPI specification, as an object.
+     * @returns Binding for the api spec
+     */
+    api(spec) {
+        return this.bind(keys_1.RestBindings.API_SPEC).to(spec);
+    }
+    /**
+     * Mount an Express router to expose additional REST endpoints handled
+     * via legacy Express-based stack.
+     *
+     * @param basePath - Path where to mount the router at, e.g. `/` or `/api`.
+     * @param router - The Express router to handle the requests.
+     * @param spec - A partial OpenAPI spec describing endpoints provided by the
+     * router. LoopBack will prepend `basePath` to all endpoints automatically.
+     * This argument is optional. You can leave it out if you don't want to
+     * document the routes.
+     */
+    mountExpressRouter(basePath, router, spec) {
+        this.restServer.mountExpressRouter(basePath, router, spec);
+    }
+}
+exports.RestApplication = RestApplication;
+//# sourceMappingURL=rest.application.js.map

package/dist/rest.application.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest.application.js","sourceRoot":"","sources":["../src/rest.application.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAShE,yCAAsE;AAUtE,+BAA4B;AAE5B,iCAAoC;AACpC,qDAA+C;AAMlC,QAAA,mBAAmB,GAAG,aAAM,CACvC,oDAAoD,EACpD,0EAA0E,CAC3E,CAAC;AAEF,iCAAiC;AACpB,QAAA,eAAe,GAAG,mBAAY,CAAC,eAAe,CAAC;AAE5D;;;;;;GAMG;AACH,MAAa,eAAgB,SAAQ,kBAAW;IAC9C;;OAEG;IACH,IAAI,UAAU;QACZ,yEAAyE;QACzE,uEAAuE;QACvE,OAAO,IAAI,CAAC,OAAO,CAAa,oBAAoB,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IACxC,CAAC;IAcD,YAAY,cAA4C,EAAE,MAAgB;QACxE,KAAK,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QAC9B,IAAI,CAAC,SAAS,CAAC,8BAAa,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,MAA2B,EAAE,IAAa;QAC/C,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YACvC,MAAM,IAAI,KAAK,CAAC,2BAAmB,CAAC,CAAC;SACtC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,QAAQ,CAAC,QAAsC;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAY,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,CAAC,SAA2B;QACjC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAgB,EAAE,OAAe,EAAE,OAA4B;QACpE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,UAAU,CACR,eAAwC,EACxC,OAAoC;QAEpC,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAI,GAAG,EAAE;QAChB,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IA2CD,iBAAiB,CACf,YAAwE,EACxE,gBAAuE,EACvE,UAAoC,EAAE;QAEtC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,CACtC,YAAY,EACZ,gBAAgB,EAChB,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CACR,UAA0D,EAC1D,UAAoC,EAAE;QAEtC,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAyFD,KAAK,CACH,WAAgC,EAChC,IAAa,EACb,IAAsB,EACtB,uBAAuD,EACvD,iBAAwC,EACxC,UAAmB;QAEnB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/B,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;YACnC,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;SAClC;aAAM,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;YACjC,OAAO,MAAM,CAAC,KAAK,CACjB,WAAW,EACX,IAAK,EACL,IAAK,EACL,uBAAmC,CACpC,CAAC;SACH;aAAM;YACL,OAAO,MAAM,CAAC,KAAK,CACjB,WAAW,EACX,IAAK,EACL,IAAK,EACL,uBAA6C,EAC7C,iBAAkB,EAClB,UAAW,CACZ,CAAC;SACH;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,QAAgB,EAChB,WAAmB,EACnB,UAAmB;QAEnB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,IAAiB;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAY,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;;OAUG;IACH,kBAAkB,CAChB,QAAgB,EAChB,MAA6B,EAC7B,IAAiB;QAEjB,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;CACF;AAvVD,0CAuVC"}

package/dist/rest.component.d.ts

@@ -0,0 +1,15 @@
+import { Binding, Constructor } from '@loopback/context';
+import { Application, Component, ProviderMap, Server } from '@loopback/core';
+import { RestServerConfig } from './rest.server';
+export declare class RestComponent implements Component {
+    providers: ProviderMap;
+    /**
+     * Add built-in body parsers
+     */
+    bindings: Binding[];
+    servers: {
+        [name: string]: Constructor<Server>;
+    };
+    constructor(app: Application, config?: RestComponentConfig);
+}
+export declare type RestComponentConfig = RestServerConfig;

package/dist/rest.component.js

@@ -0,0 +1,72 @@
+"use strict";
+// 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
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestComponent = void 0;
+const tslib_1 = require("tslib");
+const context_1 = require("@loopback/context");
+const core_1 = require("@loopback/core");
+const express_1 = require("@loopback/express");
+const openapi_v3_1 = require("@loopback/openapi-v3");
+const body_parsers_1 = require("./body-parsers");
+const body_parser_raw_1 = require("./body-parsers/body-parser.raw");
+const keys_1 = require("./keys");
+const providers_1 = require("./providers");
+const rest_server_1 = require("./rest.server");
+const sequence_1 = require("./sequence");
+const consolidate_spec_enhancer_1 = require("./spec-enhancers/consolidate.spec-enhancer");
+const info_spec_enhancer_1 = require("./spec-enhancers/info.spec-enhancer");
+const ajv_factory_provider_1 = require("./validation/ajv-factory.provider");
+let RestComponent = /** @class */ (() => {
+    let RestComponent = class RestComponent {
+        constructor(app, config) {
+            var _a;
+            this.providers = {
+                [keys_1.RestBindings.SequenceActions.LOG_ERROR.key]: providers_1.LogErrorProvider,
+                [keys_1.RestBindings.SequenceActions.INVOKE_MIDDLEWARE
+                    .key]: express_1.InvokeMiddlewareProvider,
+                [keys_1.RestBindings.SequenceActions.FIND_ROUTE.key]: providers_1.FindRouteProvider,
+                [keys_1.RestBindings.SequenceActions.INVOKE_METHOD.key]: providers_1.InvokeMethodProvider,
+                [keys_1.RestBindings.SequenceActions.REJECT.key]: providers_1.RejectProvider,
+                [keys_1.RestBindings.SequenceActions.PARSE_PARAMS.key]: providers_1.ParseParamsProvider,
+                [keys_1.RestBindings.SequenceActions.SEND.key]: providers_1.SendProvider,
+                [keys_1.RestBindings.AJV_FACTORY.key]: ajv_factory_provider_1.AjvFactoryProvider,
+            };
+            /**
+             * Add built-in body parsers
+             */
+            this.bindings = [
+                // FIXME(rfeng): We now register request body parsers in TRANSIENT scope
+                // so that they can be bound at application or server level
+                context_1.Binding.bind(keys_1.RestBindings.REQUEST_BODY_PARSER).toClass(body_parsers_1.RequestBodyParser),
+                rest_server_1.createBodyParserBinding(body_parsers_1.JsonBodyParser, keys_1.RestBindings.REQUEST_BODY_PARSER_JSON),
+                rest_server_1.createBodyParserBinding(body_parsers_1.TextBodyParser, keys_1.RestBindings.REQUEST_BODY_PARSER_TEXT),
+                rest_server_1.createBodyParserBinding(body_parsers_1.UrlEncodedBodyParser, keys_1.RestBindings.REQUEST_BODY_PARSER_URLENCODED),
+                rest_server_1.createBodyParserBinding(body_parser_raw_1.RawBodyParser, keys_1.RestBindings.REQUEST_BODY_PARSER_RAW),
+                rest_server_1.createBodyParserBinding(body_parsers_1.StreamBodyParser, keys_1.RestBindings.REQUEST_BODY_PARSER_STREAM),
+                context_1.createBindingFromClass(info_spec_enhancer_1.InfoSpecEnhancer),
+                context_1.createBindingFromClass(consolidate_spec_enhancer_1.ConsolidationEnhancer),
+            ];
+            this.servers = {
+                RestServer: rest_server_1.RestServer,
+            };
+            app.bind(keys_1.RestBindings.SEQUENCE).toClass(sequence_1.DefaultSequence);
+            const apiSpec = openapi_v3_1.createEmptyApiSpec();
+            // Merge the OpenAPI `servers` spec from the config into the empty one
+            if ((_a = config === null || config === void 0 ? void 0 : config.openApiSpec) === null || _a === void 0 ? void 0 : _a.servers) {
+                Object.assign(apiSpec, { servers: config.openApiSpec.servers });
+            }
+            app.bind(keys_1.RestBindings.API_SPEC).to(apiSpec);
+        }
+    };
+    RestComponent = tslib_1.__decorate([
+        tslib_1.__param(0, context_1.inject(core_1.CoreBindings.APPLICATION_INSTANCE)),
+        tslib_1.__param(1, context_1.inject(keys_1.RestBindings.CONFIG)),
+        tslib_1.__metadata("design:paramtypes", [core_1.Application, Object])
+    ], RestComponent);
+    return RestComponent;
+})();
+exports.RestComponent = RestComponent;
+//# sourceMappingURL=rest.component.js.map

package/dist/rest.component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest.component.js","sourceRoot":"","sources":["../src/rest.component.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+CAK2B;AAC3B,yCAMwB;AACxB,+CAA2D;AAC3D,qDAAwD;AACxD,iDAMwB;AACxB,oEAA6D;AAC7D,iCAAoC;AACpC,2CAOqB;AACrB,+CAIuB;AACvB,yCAA2C;AAC3C,0FAAiF;AACjF,4EAAqE;AACrE,4EAAqE;AAErE;IAAA,IAAa,aAAa,GAA1B,MAAa,aAAa;QAgDxB,YAC6C,GAAgB,EAC9B,MAA4B;;YAjD3D,cAAS,GAAgB;gBACvB,CAAC,mBAAY,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,4BAAgB;gBAC9D,CAAC,mBAAY,CAAC,eAAe,CAAC,iBAAiB;qBAC5C,GAAG,CAAC,EAAE,kCAAwB;gBACjC,CAAC,mBAAY,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,6BAAiB;gBAChE,CAAC,mBAAY,CAAC,eAAe,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,gCAAoB;gBACtE,CAAC,mBAAY,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,0BAAc;gBACzD,CAAC,mBAAY,CAAC,eAAe,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,+BAAmB;gBACpE,CAAC,mBAAY,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,wBAAY;gBACrD,CAAC,mBAAY,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,yCAAkB;aACnD,CAAC;YACF;;eAEG;YACH,aAAQ,GAAc;gBACpB,wEAAwE;gBACxE,2DAA2D;gBAC3D,iBAAO,CAAC,IAAI,CAAC,mBAAY,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,gCAAiB,CAAC;gBACzE,qCAAuB,CACrB,6BAAc,EACd,mBAAY,CAAC,wBAAwB,CACtC;gBACD,qCAAuB,CACrB,6BAAc,EACd,mBAAY,CAAC,wBAAwB,CACtC;gBACD,qCAAuB,CACrB,mCAAoB,EACpB,mBAAY,CAAC,8BAA8B,CAC5C;gBACD,qCAAuB,CACrB,+BAAa,EACb,mBAAY,CAAC,uBAAuB,CACrC;gBACD,qCAAuB,CACrB,+BAAgB,EAChB,mBAAY,CAAC,0BAA0B,CACxC;gBACD,gCAAsB,CAAC,qCAAgB,CAAC;gBACxC,gCAAsB,CAAC,iDAAqB,CAAC;aAC9C,CAAC;YACF,YAAO,GAEH;gBACF,UAAU,EAAV,wBAAU;aACX,CAAC;YAMA,GAAG,CAAC,IAAI,CAAC,mBAAY,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,0BAAe,CAAC,CAAC;YACzD,MAAM,OAAO,GAAG,+BAAkB,EAAE,CAAC;YACrC,sEAAsE;YACtE,UAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,0CAAE,OAAO,EAAE;gBAChC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,EAAC,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,OAAO,EAAC,CAAC,CAAC;aAC/D;YACD,GAAG,CAAC,IAAI,CAAC,mBAAY,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAC9C,CAAC;KACF,CAAA;IA5DY,aAAa;QAiDrB,mBAAA,gBAAM,CAAC,mBAAY,CAAC,oBAAoB,CAAC,CAAA;QACzC,mBAAA,gBAAM,CAAC,mBAAY,CAAC,MAAM,CAAC,CAAA;iDADoB,kBAAW;OAjDlD,aAAa,CA4DzB;IAAD,oBAAC;KAAA;AA5DY,sCAAa"}