@loopback/rest 4.0.0-alpha.8 → 5.0.1

package/dist/coercion/validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../src/coercion/validator.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAGhE,2BAAmC;AAgBnC;;;GAGG;AACH,MAAa,SAAS;IACpB,YAAmB,GAAsB;QAAtB,QAAG,GAAH,GAAG,CAAmB;IAAG,CAAC;IAE7C;;;;;;;OAOG;IACH,2BAA2B,CACzB,KAAkC,EAClC,IAAwB;QAExB,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACjD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC;YACzC,MAAM,kBAAc,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;SAC5C;IACH,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,IAAwB;QACjC,IAAI,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAC;QACjD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ;YAAE,OAAO,IAAI,CAAC;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,8DAA8D;IAC9D,QAAQ,CAAC,KAAU;;QACjB,IAAI,KAAK,KAAK,EAAE,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QAErD,MAAM,IAAI,GAAoB,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;QACrD,MAAM,MAAM,SAAiB,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,mCAAI,EAAE,CAAC;QACjE,MAAM,WAAW,GAAG,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,IAAI,CAAC;QAEvD,IAAI,IAAI,CAAC,qBAAqB,EAAE,EAAE;YAChC,sDAAsD;YACtD,wBAAwB;YACxB,IAAI,WAAW;gBAAE,OAAO,IAAI,CAAC;SAC9B;aAAM,IAAI,IAAI,CAAC,MAAM,EAAE;YACtB,4EAA4E;YAC5E,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,WAAW;gBAAE,OAAO,IAAI,CAAC;SAC1D;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACH,qBAAqB;;QACnB,MAAM,IAAI,GAAoB,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;QAErD,IAAI,IAAI,CAAC,EAAE,KAAK,OAAO,iBAAI,IAAI,CAAC,OAAO,0CAAG,kBAAkB,2CAAG,MAAM,CAAA,EAAE;YACrE,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAvED,8BAuEC"}

package/dist/http-handler.d.ts

@@ -0,0 +1,38 @@
+import { Context } from '@loopback/context';
+import { ComponentsObject, ControllerSpec, PathObject, ReferenceObject, SchemaObject, SchemasObject } from '@loopback/openapi-v3';
+import { RestServerResolvedConfig } from './rest.server';
+import { ControllerClass, ControllerFactory, ResolvedRoute, RouteEntry, RoutingTable } from './router';
+import { Request, Response } from './types';
+export declare class HttpHandler {
+    protected readonly _rootContext: Context;
+    protected readonly _serverConfig: RestServerResolvedConfig;
+    protected readonly _routes: RoutingTable;
+    /**
+     * Shared OpenAPI spec objects as `components`
+     */
+    protected _openApiComponents: ComponentsObject;
+    handleRequest: (request: Request, response: Response) => Promise<void>;
+    constructor(_rootContext: Context, _serverConfig: RestServerResolvedConfig, _routes?: RoutingTable);
+    registerController<T>(spec: ControllerSpec, controllerCtor: ControllerClass<T>, controllerFactory?: ControllerFactory<T>): void;
+    registerRoute(route: RouteEntry): void;
+    /**
+     * @deprecated Use `registerApiComponents`
+     * @param defs Schemas
+     */
+    registerApiDefinitions(defs: SchemasObject): void;
+    /**
+     * Merge components into the OpenApi spec
+     * @param defs - Components
+     */
+    registerApiComponents(defs: ComponentsObject): void;
+    getApiComponents(): ComponentsObject;
+    /**
+     * @deprecated Use `getApiComponents`
+     */
+    getApiDefinitions(): {
+        [schema: string]: SchemaObject | ReferenceObject;
+    } | undefined;
+    describeApiPaths(): PathObject;
+    findRoute(request: Request): ResolvedRoute;
+    protected _handleRequest(request: Request, response: Response): Promise<void>;
+}

package/dist/http-handler.js

@@ -0,0 +1,68 @@
+"use strict";
+// Copyright IBM Corp. 2017,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.HttpHandler = void 0;
+const keys_1 = require("./keys");
+const request_context_1 = require("./request-context");
+const router_1 = require("./router");
+class HttpHandler {
+    constructor(_rootContext, _serverConfig, _routes = new router_1.RoutingTable()) {
+        this._rootContext = _rootContext;
+        this._serverConfig = _serverConfig;
+        this._routes = _routes;
+        this.handleRequest = (req, res) => this._handleRequest(req, res);
+    }
+    registerController(spec, controllerCtor, controllerFactory) {
+        this._routes.registerController(spec, controllerCtor, controllerFactory);
+    }
+    registerRoute(route) {
+        this._routes.registerRoute(route);
+    }
+    /**
+     * @deprecated Use `registerApiComponents`
+     * @param defs Schemas
+     */
+    registerApiDefinitions(defs) {
+        this.registerApiComponents({ schemas: defs });
+    }
+    /**
+     * Merge components into the OpenApi spec
+     * @param defs - Components
+     */
+    registerApiComponents(defs) {
+        var _a;
+        this._openApiComponents = (_a = this._openApiComponents) !== null && _a !== void 0 ? _a : {};
+        for (const p in defs) {
+            // Merge each child, such as `schemas`, `parameters`, and `headers`
+            this._openApiComponents[p] = { ...this._openApiComponents[p], ...defs[p] };
+        }
+    }
+    getApiComponents() {
+        return this._openApiComponents;
+    }
+    /**
+     * @deprecated Use `getApiComponents`
+     */
+    getApiDefinitions() {
+        var _a;
+        return (_a = this._openApiComponents) === null || _a === void 0 ? void 0 : _a.schemas;
+    }
+    describeApiPaths() {
+        return this._routes.describeApiPaths();
+    }
+    findRoute(request) {
+        const route = this._routes.find(request);
+        Object.assign(route.schemas, this.getApiDefinitions());
+        return route;
+    }
+    async _handleRequest(request, response) {
+        const requestContext = new request_context_1.RequestContext(request, response, this._rootContext, this._serverConfig);
+        const sequence = await requestContext.get(keys_1.RestBindings.SEQUENCE);
+        await sequence.handle(requestContext);
+    }
+}
+exports.HttpHandler = HttpHandler;
+//# sourceMappingURL=http-handler.js.map

package/dist/http-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-handler.js","sourceRoot":"","sources":["../src/http-handler.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAWhE,iCAAoC;AACpC,uDAAiD;AAEjD,qCAMkB;AAIlB,MAAa,WAAW;IAQtB,YACqB,YAAqB,EACrB,aAAuC,EACvC,UAAU,IAAI,qBAAY,EAAE;QAF5B,iBAAY,GAAZ,YAAY,CAAS;QACrB,kBAAa,GAAb,aAAa,CAA0B;QACvC,YAAO,GAAP,OAAO,CAAqB;QAE/C,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACnE,CAAC;IAED,kBAAkB,CAChB,IAAoB,EACpB,cAAkC,EAClC,iBAAwC;QAExC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,cAAc,EAAE,iBAAiB,CAAC,CAAC;IAC3E,CAAC;IAED,aAAa,CAAC,KAAiB;QAC7B,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,sBAAsB,CAAC,IAAmB;QACxC,IAAI,CAAC,qBAAqB,CAAC,EAAC,OAAO,EAAE,IAAI,EAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,qBAAqB,CAAC,IAAsB;;QAC1C,IAAI,CAAC,kBAAkB,SAAG,IAAI,CAAC,kBAAkB,mCAAI,EAAE,CAAC;QACxD,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE;YACpB,mEAAmE;YACnE,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,GAAG,EAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,EAAC,CAAC;SAC1E;IACH,CAAC;IAED,gBAAgB;QACd,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,iBAAiB;;QAKf,aAAO,IAAI,CAAC,kBAAkB,0CAAE,OAAO,CAAC;IAC1C,CAAC;IAED,gBAAgB;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IACzC,CAAC;IAED,SAAS,CAAC,OAAgB;QACxB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACvD,OAAO,KAAK,CAAC;IACf,CAAC;IAES,KAAK,CAAC,cAAc,CAC5B,OAAgB,EAChB,QAAkB;QAElB,MAAM,cAAc,GAAG,IAAI,gCAAc,CACvC,OAAO,EACP,QAAQ,EACR,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,aAAa,CACnB,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,GAAG,CACvC,mBAAY,CAAC,QAAQ,CACtB,CAAC;QACF,MAAM,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IACxC,CAAC;CACF;AAzFD,kCAyFC"}

package/dist/index.d.ts

@@ -1 +1,36 @@
-export * from './src';
+/**
+ * The REST API package for loopback-next.
+ *
+ * @remarks
+ * A REST server for LoopBack 4 application instances, complete with:
+ *
+ * - new custom routing engine (special thanks to @bajtos)!
+ * - tools for defining your application routes
+ * - OpenAPI 3.0 spec (openapi.json/openapi.yaml) generation using
+ *   @loopback/openapi-v3
+ * - a default sequence implementation to manage the request and response
+ *   lifecycle
+ *
+ *
+ * @packageDocumentation
+ */
+export * from '@loopback/openapi-v3';
+export * from './body-parsers';
+export * from './http-handler';
+export * from './keys';
+export * from './parse-json';
+export * from './parser';
+export * from './providers';
+export * from './request-context';
+export * from './rest-http-error';
+export * from './rest.application';
+export * from './rest.component';
+export * from './rest.server';
+export * from './router';
+export * from './sequence';
+export * from './spec-enhancers/info.spec-enhancer';
+export * from './types';
+export * from './validation/request-body.validator';
+export * from './writer';
+export { HttpErrors };
+import HttpErrors from 'http-errors';

package/dist/index.js

@@ -1,12 +1,46 @@
 "use strict";
-// Copyright IBM Corp. 2013,2017. All Rights Reserved.
+// Copyright IBM Corp. 2017,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
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
 Object.defineProperty(exports, "__esModule", { value: true });
-// NOTE(bajtos) This file is used by VSCode/TypeScriptServer at dev time only
-__export(require("./src"));
+exports.HttpErrors = void 0;
+const tslib_1 = require("tslib");
+/**
+ * The REST API package for loopback-next.
+ *
+ * @remarks
+ * A REST server for LoopBack 4 application instances, complete with:
+ *
+ * - new custom routing engine (special thanks to @bajtos)!
+ * - tools for defining your application routes
+ * - OpenAPI 3.0 spec (openapi.json/openapi.yaml) generation using
+ *   @loopback/openapi-v3
+ * - a default sequence implementation to manage the request and response
+ *   lifecycle
+ *
+ *
+ * @packageDocumentation
+ */
+tslib_1.__exportStar(require("@loopback/openapi-v3"), exports);
+tslib_1.__exportStar(require("./body-parsers"), exports);
+tslib_1.__exportStar(require("./http-handler"), exports);
+tslib_1.__exportStar(require("./keys"), exports);
+tslib_1.__exportStar(require("./parse-json"), exports);
+tslib_1.__exportStar(require("./parser"), exports);
+tslib_1.__exportStar(require("./providers"), exports);
+tslib_1.__exportStar(require("./request-context"), exports);
+tslib_1.__exportStar(require("./rest-http-error"), exports);
+tslib_1.__exportStar(require("./rest.application"), exports);
+tslib_1.__exportStar(require("./rest.component"), exports);
+tslib_1.__exportStar(require("./rest.server"), exports);
+tslib_1.__exportStar(require("./router"), exports);
+tslib_1.__exportStar(require("./sequence"), exports);
+tslib_1.__exportStar(require("./spec-enhancers/info.spec-enhancer"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+tslib_1.__exportStar(require("./validation/request-body.validator"), exports);
+tslib_1.__exportStar(require("./writer"), exports);
+// export all errors from external http-errors package
+const http_errors_1 = tslib_1.__importDefault(require("http-errors"));
+exports.HttpErrors = http_errors_1.default;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE;;;;;;;;;;;;;;;GAeG;AAEH,+DAAqC;AACrC,yDAA+B;AAC/B,yDAA+B;AAC/B,iDAAuB;AACvB,uDAA6B;AAC7B,mDAAyB;AACzB,sDAA4B;AAC5B,4DAAkC;AAClC,4DAAkC;AAClC,6DAAmC;AACnC,2DAAiC;AACjC,wDAA8B;AAC9B,mDAAyB;AACzB,qDAA2B;AAC3B,8EAAoD;AACpD,kDAAwB;AACxB,8EAAoD;AACpD,mDAAyB;AAGzB,sDAAsD;AACtD,sEAAqC;AAH7B,qBAGD,qBAAU,CAHC"}

package/dist/keys.d.ts

@@ -0,0 +1,198 @@
+/// <reference types="node" />
+import { BindingKey, Context } from '@loopback/context';
+import { InvokeMiddleware } from '@loopback/express';
+import { HttpProtocol } from '@loopback/http-server';
+import { OpenApiSpec, OperationObject } from '@loopback/openapi-v3';
+import https from 'https';
+import { ErrorWriterOptions } from 'strong-error-handler';
+import { BodyParser, RequestBodyParser } from './body-parsers';
+import { HttpHandler } from './http-handler';
+import { RestServer, RestServerConfig } from './rest.server';
+import { RestRouter, RestRouterOptions } from './router';
+import { SequenceHandler } from './sequence';
+import { AjvFactory, FindRoute, InvokeMethod, LogError, ParseParams, Reject, Request, RequestBodyParserOptions, Response, Send } from './types';
+/**
+ * RestServer-specific bindings
+ */
+export declare namespace RestBindings {
+    /**
+     * Binding key for setting and injecting RestComponentConfig
+     */
+    const CONFIG: BindingKey<RestServerConfig>;
+    /**
+     * Binding key for setting and injecting the host name of RestServer
+     */
+    const HOST: BindingKey<string | undefined>;
+    /**
+     * Binding key for setting and injecting the port number of RestServer
+     */
+    const PORT: BindingKey<number>;
+    /**
+     * Binding key for setting and injecting the socket path of the RestServer
+     */
+    const PATH: BindingKey<string | undefined>;
+    /**
+     * Binding key for setting and injecting the URL of RestServer
+     */
+    const URL: BindingKey<string>;
+    /**
+     * Binding key for setting and injecting the protocol of RestServer
+     */
+    const PROTOCOL: BindingKey<HttpProtocol>;
+    /**
+     * Binding key for HTTPS options
+     */
+    const HTTPS_OPTIONS: BindingKey<https.ServerOptions>;
+    /**
+     * Binding key for the server itself
+     */
+    const SERVER: BindingKey<RestServer>;
+    /**
+     * Internal binding key for basePath
+     */
+    const BASE_PATH: BindingKey<string>;
+    /**
+     * Internal binding key for http-handler
+     */
+    const HANDLER: BindingKey<HttpHandler>;
+    /**
+     * Internal binding key for rest router
+     */
+    const ROUTER: BindingKey<RestRouter>;
+    const ROUTER_OPTIONS: BindingKey<RestRouterOptions>;
+    /**
+     * Binding key for setting and injecting Reject action's error handling
+     * options.
+     *
+     * See https://github.com/strongloop/strong-error-handler#options for
+     * the list of available options. Please note that the flag `log` is not used
+     * by `@loopback/rest`.
+     */
+    const ERROR_WRITER_OPTIONS: BindingKey<ErrorWriterOptions>;
+    /**
+     * Binding key for request body parser options
+     */
+    const REQUEST_BODY_PARSER_OPTIONS: BindingKey<RequestBodyParserOptions>;
+    /**
+     * Binding key for request body parser
+     */
+    const REQUEST_BODY_PARSER: BindingKey<RequestBodyParser>;
+    /**
+     * Binding key for request json body parser
+     */
+    const REQUEST_BODY_PARSER_JSON: BindingKey<BodyParser>;
+    /**
+     * Binding key for request urlencoded body parser
+     */
+    const REQUEST_BODY_PARSER_URLENCODED: BindingKey<BodyParser>;
+    /**
+     * Binding key for request text body parser
+     */
+    const REQUEST_BODY_PARSER_TEXT: BindingKey<BodyParser>;
+    /**
+     * Binding key for request raw body parser
+     */
+    const REQUEST_BODY_PARSER_RAW: BindingKey<BodyParser>;
+    /**
+     * Binding key for request raw body parser
+     */
+    const REQUEST_BODY_PARSER_STREAM: BindingKey<BodyParser>;
+    /**
+     * Binding key for AJV
+     */
+    const AJV_FACTORY: BindingKey<AjvFactory>;
+    /**
+     * Binding key for setting and injecting an OpenAPI spec
+     */
+    const API_SPEC: BindingKey<OpenApiSpec>;
+    /**
+     * Binding key for setting and injecting an OpenAPI operation spec
+     */
+    const OPERATION_SPEC_CURRENT: BindingKey<OperationObject>;
+    /**
+     * Binding key for setting and injecting a Sequence
+     */
+    const SEQUENCE: BindingKey<SequenceHandler>;
+    /**
+     * Bindings for potential actions that could be used in a sequence
+     */
+    namespace SequenceActions {
+        /**
+         * Binding key for setting and injecting a route finding function
+         */
+        const INVOKE_MIDDLEWARE: BindingKey<InvokeMiddleware>;
+        /**
+         * Binding key for setting and injecting a route finding function
+         */
+        const FIND_ROUTE: BindingKey<FindRoute>;
+        /**
+         * Binding key for setting and injecting a parameter parsing function
+         */
+        const PARSE_PARAMS: BindingKey<ParseParams>;
+        /**
+         * Binding key for setting and injecting a controller route invoking function
+         */
+        const INVOKE_METHOD: BindingKey<InvokeMethod>;
+        /**
+         * Binding key for setting and injecting an error logging function
+         */
+        const LOG_ERROR: BindingKey<LogError>;
+        /**
+         * Binding key for setting and injecting a response writing function
+         */
+        const SEND: BindingKey<Send>;
+        /**
+         * Binding key for setting and injecting a bad response writing function
+         */
+        const REJECT: BindingKey<Reject>;
+    }
+    /**
+     * Request-specific bindings
+     */
+    namespace Http {
+        /**
+         * Binding key for setting and injecting the http request
+         */
+        const REQUEST: BindingKey<Request>;
+        /**
+         * Binding key for setting and injecting the http response
+         */
+        const RESPONSE: BindingKey<Response<any>>;
+        /**
+         * Binding key for setting and injecting the http request context
+         */
+        const CONTEXT: BindingKey<Context>;
+    }
+    /**
+     * Namespace for REST routes
+     */
+    const ROUTES = "routes";
+}
+/**
+ * Binding tags for RestServer
+ */
+export declare namespace RestTags {
+    /**
+     * Binding tag to identify REST routes
+     */
+    const REST_ROUTE = "restRoute";
+    /**
+     * Binding tag for the REST route verb
+     */
+    const ROUTE_VERB = "restRouteVerb";
+    /**
+     * Binding tag for the REST route path
+     */
+    const ROUTE_PATH = "restRoutePath";
+    /**
+     * Binding tag to identify controller based REST routes
+     */
+    const CONTROLLER_ROUTE = "controllerRoute";
+    /**
+     * Binding tag for controller route bindings to represent the controller
+     * binding key
+     */
+    const CONTROLLER_BINDING = "controllerBinding";
+    const AJV_KEYWORD = "ajvKeyword";
+    const AJV_FORMAT = "ajvFormat";
+}

package/dist/keys.js

@@ -0,0 +1,202 @@
+"use strict";
+// Copyright IBM Corp. 2017,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.RestTags = exports.RestBindings = void 0;
+const context_1 = require("@loopback/context");
+const core_1 = require("@loopback/core");
+/**
+ * RestServer-specific bindings
+ */
+var RestBindings;
+(function (RestBindings) {
+    /**
+     * Binding key for setting and injecting RestComponentConfig
+     */
+    RestBindings.CONFIG = core_1.CoreBindings.APPLICATION_CONFIG.deepProperty('rest');
+    /**
+     * Binding key for setting and injecting the host name of RestServer
+     */
+    RestBindings.HOST = context_1.BindingKey.create('rest.host');
+    /**
+     * Binding key for setting and injecting the port number of RestServer
+     */
+    RestBindings.PORT = context_1.BindingKey.create('rest.port');
+    /**
+     * Binding key for setting and injecting the socket path of the RestServer
+     */
+    RestBindings.PATH = context_1.BindingKey.create('rest.path');
+    /**
+     * Binding key for setting and injecting the URL of RestServer
+     */
+    RestBindings.URL = context_1.BindingKey.create('rest.url');
+    /**
+     * Binding key for setting and injecting the protocol of RestServer
+     */
+    RestBindings.PROTOCOL = context_1.BindingKey.create('rest.protocol');
+    /**
+     * Binding key for HTTPS options
+     */
+    RestBindings.HTTPS_OPTIONS = context_1.BindingKey.create('rest.httpsOptions');
+    /**
+     * Binding key for the server itself
+     */
+    RestBindings.SERVER = context_1.BindingKey.create('servers.RestServer');
+    /**
+     * Internal binding key for basePath
+     */
+    RestBindings.BASE_PATH = context_1.BindingKey.create('rest.basePath');
+    /**
+     * Internal binding key for http-handler
+     */
+    RestBindings.HANDLER = context_1.BindingKey.create('rest.handler');
+    /**
+     * Internal binding key for rest router
+     */
+    RestBindings.ROUTER = context_1.BindingKey.create('rest.router');
+    RestBindings.ROUTER_OPTIONS = context_1.BindingKey.create('rest.router.options');
+    /**
+     * Binding key for setting and injecting Reject action's error handling
+     * options.
+     *
+     * See https://github.com/strongloop/strong-error-handler#options for
+     * the list of available options. Please note that the flag `log` is not used
+     * by `@loopback/rest`.
+     */
+    RestBindings.ERROR_WRITER_OPTIONS = context_1.BindingKey.create('rest.errorWriterOptions');
+    /**
+     * Binding key for request body parser options
+     */
+    RestBindings.REQUEST_BODY_PARSER_OPTIONS = context_1.BindingKey.create('rest.requestBodyParserOptions');
+    /**
+     * Binding key for request body parser
+     */
+    RestBindings.REQUEST_BODY_PARSER = context_1.BindingKey.create('rest.requestBodyParser');
+    function bodyParserBindingKey(parser) {
+        return `${RestBindings.REQUEST_BODY_PARSER}.${parser}`;
+    }
+    /**
+     * Binding key for request json body parser
+     */
+    RestBindings.REQUEST_BODY_PARSER_JSON = context_1.BindingKey.create(bodyParserBindingKey('JsonBodyParser'));
+    /**
+     * Binding key for request urlencoded body parser
+     */
+    RestBindings.REQUEST_BODY_PARSER_URLENCODED = context_1.BindingKey.create(bodyParserBindingKey('UrlEncodedBodyParser'));
+    /**
+     * Binding key for request text body parser
+     */
+    RestBindings.REQUEST_BODY_PARSER_TEXT = context_1.BindingKey.create(bodyParserBindingKey('TextBodyParser'));
+    /**
+     * Binding key for request raw body parser
+     */
+    RestBindings.REQUEST_BODY_PARSER_RAW = context_1.BindingKey.create(bodyParserBindingKey('RawBodyParser'));
+    /**
+     * Binding key for request raw body parser
+     */
+    RestBindings.REQUEST_BODY_PARSER_STREAM = context_1.BindingKey.create(bodyParserBindingKey('StreamBodyParser'));
+    /**
+     * Binding key for AJV
+     */
+    RestBindings.AJV_FACTORY = context_1.BindingKey.create(bodyParserBindingKey('rest.ajvFactory'));
+    /**
+     * Binding key for setting and injecting an OpenAPI spec
+     */
+    RestBindings.API_SPEC = context_1.BindingKey.create('rest.apiSpec');
+    /**
+     * Binding key for setting and injecting an OpenAPI operation spec
+     */
+    RestBindings.OPERATION_SPEC_CURRENT = context_1.BindingKey.create('rest.operationSpec.current');
+    /**
+     * Binding key for setting and injecting a Sequence
+     */
+    RestBindings.SEQUENCE = context_1.BindingKey.create('rest.sequence');
+    /**
+     * Bindings for potential actions that could be used in a sequence
+     */
+    let SequenceActions;
+    (function (SequenceActions) {
+        /**
+         * Binding key for setting and injecting a route finding function
+         */
+        SequenceActions.INVOKE_MIDDLEWARE = context_1.BindingKey.create('rest.sequence.actions.invokeMiddleware');
+        /**
+         * Binding key for setting and injecting a route finding function
+         */
+        SequenceActions.FIND_ROUTE = context_1.BindingKey.create('rest.sequence.actions.findRoute');
+        /**
+         * Binding key for setting and injecting a parameter parsing function
+         */
+        SequenceActions.PARSE_PARAMS = context_1.BindingKey.create('rest.sequence.actions.parseParams');
+        /**
+         * Binding key for setting and injecting a controller route invoking function
+         */
+        SequenceActions.INVOKE_METHOD = context_1.BindingKey.create('rest.sequence.actions.invokeMethod');
+        /**
+         * Binding key for setting and injecting an error logging function
+         */
+        SequenceActions.LOG_ERROR = context_1.BindingKey.create('rest.sequence.actions.logError');
+        /**
+         * Binding key for setting and injecting a response writing function
+         */
+        SequenceActions.SEND = context_1.BindingKey.create('rest.sequence.actions.send');
+        /**
+         * Binding key for setting and injecting a bad response writing function
+         */
+        SequenceActions.REJECT = context_1.BindingKey.create('rest.sequence.actions.reject');
+    })(SequenceActions = RestBindings.SequenceActions || (RestBindings.SequenceActions = {}));
+    /**
+     * Request-specific bindings
+     */
+    let Http;
+    (function (Http) {
+        /**
+         * Binding key for setting and injecting the http request
+         */
+        Http.REQUEST = context_1.BindingKey.create('rest.http.request');
+        /**
+         * Binding key for setting and injecting the http response
+         */
+        Http.RESPONSE = context_1.BindingKey.create('rest.http.response');
+        /**
+         * Binding key for setting and injecting the http request context
+         */
+        Http.CONTEXT = context_1.BindingKey.create('rest.http.request.context');
+    })(Http = RestBindings.Http || (RestBindings.Http = {}));
+    /**
+     * Namespace for REST routes
+     */
+    RestBindings.ROUTES = 'routes';
+})(RestBindings = exports.RestBindings || (exports.RestBindings = {}));
+/**
+ * Binding tags for RestServer
+ */
+var RestTags;
+(function (RestTags) {
+    /**
+     * Binding tag to identify REST routes
+     */
+    RestTags.REST_ROUTE = 'restRoute';
+    /**
+     * Binding tag for the REST route verb
+     */
+    RestTags.ROUTE_VERB = 'restRouteVerb';
+    /**
+     * Binding tag for the REST route path
+     */
+    RestTags.ROUTE_PATH = 'restRoutePath';
+    /**
+     * Binding tag to identify controller based REST routes
+     */
+    RestTags.CONTROLLER_ROUTE = 'controllerRoute';
+    /**
+     * Binding tag for controller route bindings to represent the controller
+     * binding key
+     */
+    RestTags.CONTROLLER_BINDING = 'controllerBinding';
+    RestTags.AJV_KEYWORD = 'ajvKeyword';
+    RestTags.AJV_FORMAT = 'ajvFormat';
+})(RestTags = exports.RestTags || (exports.RestTags = {}));
+//# sourceMappingURL=keys.js.map

package/dist/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/keys.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAEhE,+CAAsD;AACtD,yCAA4C;AAwB5C;;GAEG;AACH,IAAiB,YAAY,CA6N5B;AA7ND,WAAiB,YAAY;IAC3B;;OAEG;IACU,mBAAM,GAAiC,mBAAY,CAAC,kBAAkB,CAAC,YAAY,CAC9F,MAAM,CACP,CAAC;IACF;;OAEG;IACU,iBAAI,GAAG,oBAAU,CAAC,MAAM,CAAqB,WAAW,CAAC,CAAC;IACvE;;OAEG;IACU,iBAAI,GAAG,oBAAU,CAAC,MAAM,CAAS,WAAW,CAAC,CAAC;IAC3D;;OAEG;IACU,iBAAI,GAAG,oBAAU,CAAC,MAAM,CAAqB,WAAW,CAAC,CAAC;IACvE;;OAEG;IACU,gBAAG,GAAG,oBAAU,CAAC,MAAM,CAAS,UAAU,CAAC,CAAC;IACzD;;OAEG;IACU,qBAAQ,GAAG,oBAAU,CAAC,MAAM,CAAe,eAAe,CAAC,CAAC;IACzE;;OAEG;IACU,0BAAa,GAAG,oBAAU,CAAC,MAAM,CAC5C,mBAAmB,CACpB,CAAC;IAEF;;OAEG;IACU,mBAAM,GAAG,oBAAU,CAAC,MAAM,CAAa,oBAAoB,CAAC,CAAC;IAE1E;;OAEG;IACU,sBAAS,GAAG,oBAAU,CAAC,MAAM,CAAS,eAAe,CAAC,CAAC;IAEpE;;OAEG;IACU,oBAAO,GAAG,oBAAU,CAAC,MAAM,CAAc,cAAc,CAAC,CAAC;IAEtE;;OAEG;IACU,mBAAM,GAAG,oBAAU,CAAC,MAAM,CAAa,aAAa,CAAC,CAAC;IAEtD,2BAAc,GAAG,oBAAU,CAAC,MAAM,CAC7C,qBAAqB,CACtB,CAAC;IAEF;;;;;;;OAOG;IACU,iCAAoB,GAAG,oBAAU,CAAC,MAAM,CACnD,yBAAyB,CAC1B,CAAC;IAEF;;OAEG;IACU,wCAA2B,GAAG,oBAAU,CAAC,MAAM,CAE1D,+BAA+B,CAAC,CAAC;IAEnC;;OAEG;IACU,gCAAmB,GAAG,oBAAU,CAAC,MAAM,CAClD,wBAAwB,CACzB,CAAC;IAEF,SAAS,oBAAoB,CAAC,MAAc;QAC1C,OAAO,GAAG,aAAA,mBAAmB,IAAI,MAAM,EAAE,CAAC;IAC5C,CAAC;IAED;;OAEG;IACU,qCAAwB,GAAG,oBAAU,CAAC,MAAM,CACvD,oBAAoB,CAAC,gBAAgB,CAAC,CACvC,CAAC;IAEF;;OAEG;IACU,2CAA8B,GAAG,oBAAU,CAAC,MAAM,CAC7D,oBAAoB,CAAC,sBAAsB,CAAC,CAC7C,CAAC;IAEF;;OAEG;IACU,qCAAwB,GAAG,oBAAU,CAAC,MAAM,CACvD,oBAAoB,CAAC,gBAAgB,CAAC,CACvC,CAAC;IAEF;;OAEG;IACU,oCAAuB,GAAG,oBAAU,CAAC,MAAM,CACtD,oBAAoB,CAAC,eAAe,CAAC,CACtC,CAAC;IAEF;;OAEG;IACU,uCAA0B,GAAG,oBAAU,CAAC,MAAM,CACzD,oBAAoB,CAAC,kBAAkB,CAAC,CACzC,CAAC;IAEF;;OAEG;IACU,wBAAW,GAAG,oBAAU,CAAC,MAAM,CAC1C,oBAAoB,CAAC,iBAAiB,CAAC,CACxC,CAAC;IAEF;;OAEG;IACU,qBAAQ,GAA4B,oBAAU,CAAC,MAAM,CAEhE,cAAc,CAAC,CAAC;IAElB;;OAEG;IACU,mCAAsB,GAAG,oBAAU,CAAC,MAAM,CACrD,4BAA4B,CAC7B,CAAC;IAEF;;OAEG;IACU,qBAAQ,GAAG,oBAAU,CAAC,MAAM,CAAkB,eAAe,CAAC,CAAC;IAE5E;;OAEG;IACH,IAAiB,eAAe,CAyC/B;IAzCD,WAAiB,eAAe;QAC9B;;WAEG;QACU,iCAAiB,GAAG,oBAAU,CAAC,MAAM,CAChD,wCAAwC,CACzC,CAAC;QACF;;WAEG;QACU,0BAAU,GAAG,oBAAU,CAAC,MAAM,CACzC,iCAAiC,CAClC,CAAC;QACF;;WAEG;QACU,4BAAY,GAAG,oBAAU,CAAC,MAAM,CAC3C,mCAAmC,CACpC,CAAC;QACF;;WAEG;QACU,6BAAa,GAAG,oBAAU,CAAC,MAAM,CAC5C,oCAAoC,CACrC,CAAC;QACF;;WAEG;QACU,yBAAS,GAAG,oBAAU,CAAC,MAAM,CACxC,gCAAgC,CACjC,CAAC;QACF;;WAEG;QACU,oBAAI,GAAG,oBAAU,CAAC,MAAM,CAAO,4BAA4B,CAAC,CAAC;QAC1E;;WAEG;QACU,sBAAM,GAAG,oBAAU,CAAC,MAAM,CACrC,8BAA8B,CAC/B,CAAC;IACJ,CAAC,EAzCgB,eAAe,GAAf,4BAAe,KAAf,4BAAe,QAyC/B;IAED;;OAEG;IACH,IAAiB,IAAI,CAiBpB;IAjBD,WAAiB,IAAI;QACnB;;WAEG;QACU,YAAO,GAAwB,oBAAU,CAAC,MAAM,CAC3D,mBAAmB,CACpB,CAAC;QACF;;WAEG;QACU,aAAQ,GAAG,oBAAU,CAAC,MAAM,CAAW,oBAAoB,CAAC,CAAC;QAC1E;;WAEG;QACU,YAAO,GAAG,oBAAU,CAAC,MAAM,CACtC,2BAA2B,CAC5B,CAAC;IACJ,CAAC,EAjBgB,IAAI,GAAJ,iBAAI,KAAJ,iBAAI,QAiBpB;IAED;;OAEG;IACU,mBAAM,GAAG,QAAQ,CAAC;AACjC,CAAC,EA7NgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QA6N5B;AAED;;GAEG;AACH,IAAiB,QAAQ,CA6BxB;AA7BD,WAAiB,QAAQ;IACvB;;OAEG;IACU,mBAAU,GAAG,WAAW,CAAC;IAEtC;;OAEG;IACU,mBAAU,GAAG,eAAe,CAAC;IAE1C;;OAEG;IACU,mBAAU,GAAG,eAAe,CAAC;IAE1C;;OAEG;IACU,yBAAgB,GAAG,iBAAiB,CAAC;IAElD;;;OAGG;IACU,2BAAkB,GAAG,mBAAmB,CAAC;IAEzC,oBAAW,GAAG,YAAY,CAAC;IAC3B,mBAAU,GAAG,WAAW,CAAC;AACxC,CAAC,EA7BgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QA6BxB"}

package/dist/parse-json.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Factory to create a reviver function for `JSON.parse` to sanitize keys
+ * @param reviver - Reviver function
+ */
+export declare function sanitizeJsonParse(reviver?: (key: any, value: any) => any): (key: string, value: any) => any;
+/**
+ *
+ * @param text - JSON string
+ * @param reviver - Optional reviver function for `JSON.parse`
+ */
+export declare function parseJson(text: string, reviver?: (key: any, value: any) => any): any;

package/dist/parse-json.js

@@ -0,0 +1,42 @@
+"use strict";
+// Copyright IBM Corp. 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.parseJson = exports.sanitizeJsonParse = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// These utilities are introduced to mitigate the prototype pollution issue
+// with `JSON.parse`.
+// See https://hueniverse.com/a-tale-of-prototype-poisoning-2610fa170061
+//
+// The [bourne](https://github.com/hapijs/bourne) module provides a drop-in
+// replacement for `JSON.parse` but we need to instruct `body-parser` to honor
+// a `reviver` function.
+/**
+ * Factory to create a reviver function for `JSON.parse` to sanitize keys
+ * @param reviver - Reviver function
+ */
+function sanitizeJsonParse(reviver) {
+    return (key, value) => {
+        if (key === '__proto__')
+            throw new Error('JSON string cannot contain "__proto__" key.');
+        if (reviver) {
+            return reviver(key, value);
+        }
+        else {
+            return value;
+        }
+    };
+}
+exports.sanitizeJsonParse = sanitizeJsonParse;
+/**
+ *
+ * @param text - JSON string
+ * @param reviver - Optional reviver function for `JSON.parse`
+ */
+function parseJson(text, reviver) {
+    return JSON.parse(text, sanitizeJsonParse(reviver));
+}
+exports.parseJson = parseJson;
+//# sourceMappingURL=parse-json.js.map