@loopback/rest 4.0.0-alpha.8 → 5.0.1

package/dist/src/providers/invoke-method.js

@@ -1,36 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2017. All Rights Reserved.
-// Node module: @loopback/rest
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __param = (this && this.__param) || function (paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const context_1 = require("@loopback/context");
-const keys_1 = require("../keys");
-let InvokeMethodProvider = class InvokeMethodProvider {
-    constructor(context) {
-        this.context = context;
-    }
-    value() {
-        return async (route, args) => {
-            return await route.invokeHandler(this.context, args);
-        };
-    }
-};
-InvokeMethodProvider = __decorate([
-    __param(0, context_1.inject(keys_1.RestBindings.Http.CONTEXT)),
-    __metadata("design:paramtypes", [context_1.Context])
-], InvokeMethodProvider);
-exports.InvokeMethodProvider = InvokeMethodProvider;
-//# sourceMappingURL=invoke-method.js.map

package/dist/src/providers/invoke-method.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"invoke-method.js","sourceRoot":"","sources":["../../../src/providers/invoke-method.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;;;;;;;;;;;AAEhE,+CAA4D;AAE5D,kCAAqC;AAErC,IAAa,oBAAoB,GAAjC;IACE,YAAyD,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAE7E,KAAK;QACH,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC3B,MAAM,CAAC,MAAM,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC;IACJ,CAAC;CACF,CAAA;AARY,oBAAoB;IAClB,WAAA,gBAAM,CAAC,mBAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;qCAAoB,iBAAO;GAD9D,oBAAoB,CAQhC;AARY,oDAAoB"}

package/dist/src/providers/log-error-provider.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="node" />
-import { BoundValue, Provider } from '@loopback/context';
-import { ServerRequest } from '../';
-export declare class LogErrorProvider implements Provider<BoundValue> {
-    value(): (err: Error, statusCode: number, req: ServerRequest) => void;
-}

package/dist/src/providers/log-error-provider.js

@@ -1,17 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2017. 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 });
-class LogErrorProvider {
-    value() {
-        return (err, statusCode, req) => {
-            if (statusCode >= 500) {
-                console.error('Unhandled error in %s %s: %s %s', req.method, req.url, statusCode, err.stack || err);
-            }
-        };
-    }
-}
-exports.LogErrorProvider = LogErrorProvider;
-//# sourceMappingURL=log-error-provider.js.map

package/dist/src/providers/log-error-provider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"log-error-provider.js","sourceRoot":"","sources":["../../../src/providers/log-error-provider.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;AAKhE;IACE,KAAK;QACH,MAAM,CAAC,CAAC,GAAU,EAAE,UAAkB,EAAE,GAAkB,EAAE,EAAE;YAC5D,EAAE,CAAC,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC,CAAC;gBACtB,OAAO,CAAC,KAAK,CACX,iCAAiC,EACjC,GAAG,CAAC,MAAM,EACV,GAAG,CAAC,GAAG,EACP,UAAU,EACV,GAAG,CAAC,KAAK,IAAI,GAAG,CACjB,CAAC;YACJ,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;CACF;AAdD,4CAcC"}

package/dist/src/providers/parse-params.d.ts

@@ -1,13 +0,0 @@
-import { Provider, BoundValue } from '@loopback/context';
-import { parseOperationArgs } from '../parser';
-/**
- * Provides the function for parsing args in requests at runtime.
- *
- * @export
- * @class ParseParamsProvider
- * @implements {Provider<BoundValue>}
- * @returns {BoundValue} The handler function that will parse request args.
- */
-export declare class ParseParamsProvider implements Provider<BoundValue> {
-    value(): typeof parseOperationArgs;
-}

package/dist/src/providers/parse-params.js

@@ -1,22 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2017. 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 });
-const parser_1 = require("../parser");
-/**
- * Provides the function for parsing args in requests at runtime.
- *
- * @export
- * @class ParseParamsProvider
- * @implements {Provider<BoundValue>}
- * @returns {BoundValue} The handler function that will parse request args.
- */
-class ParseParamsProvider {
-    value() {
-        return parser_1.parseOperationArgs;
-    }
-}
-exports.ParseParamsProvider = ParseParamsProvider;
-//# sourceMappingURL=parse-params.js.map

package/dist/src/providers/parse-params.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"parse-params.js","sourceRoot":"","sources":["../../../src/providers/parse-params.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;AAGhE,sCAA6C;AAC7C;;;;;;;GAOG;AACH;IACE,KAAK;QACH,MAAM,CAAC,2BAAkB,CAAC;IAC5B,CAAC;CACF;AAJD,kDAIC"}

package/dist/src/providers/reject.d.ts

@@ -1,6 +0,0 @@
-import { LogError, Reject } from '../internal-types';
-export declare class RejectProvider {
-    protected logError: LogError;
-    constructor(logError: LogError);
-    value(): Reject;
-}

package/dist/src/providers/reject.js

@@ -1,40 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2017. All Rights Reserved.
-// Node module: loopback
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __param = (this && this.__param) || function (paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const context_1 = require("@loopback/context");
-const writer_1 = require("../writer");
-const keys_1 = require("../keys");
-let RejectProvider = class RejectProvider {
-    constructor(logError) {
-        this.logError = logError;
-    }
-    value() {
-        return (response, request, error) => {
-            const err = error;
-            const statusCode = err.statusCode || err.status || 500;
-            writer_1.writeErrorToResponse(response, err);
-            this.logError(error, statusCode, request);
-        };
-    }
-};
-RejectProvider = __decorate([
-    __param(0, context_1.inject(keys_1.RestBindings.SequenceActions.LOG_ERROR)),
-    __metadata("design:paramtypes", [Function])
-], RejectProvider);
-exports.RejectProvider = RejectProvider;
-//# sourceMappingURL=reject.js.map

package/dist/src/providers/reject.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"reject.js","sourceRoot":"","sources":["../../../src/providers/reject.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,wBAAwB;AACxB,+CAA+C;AAC/C,gEAAgE;;;;;;;;;;;;;;AAGhE,+CAAyC;AAGzC,sCAA+C;AAC/C,kCAAqC;AAErC,IAAa,cAAc,GAA3B;IACE,YAEY,QAAkB;QAAlB,aAAQ,GAAR,QAAQ,CAAU;IAC3B,CAAC;IAEJ,KAAK;QACH,MAAM,CAAC,CAAC,QAAwB,EAAE,OAAsB,EAAE,KAAY,EAAE,EAAE;YACxE,MAAM,GAAG,GAAc,KAAK,CAAC;YAC7B,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC;YACvD,6BAAoB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAC5C,CAAC,CAAC;IACJ,CAAC;CACF,CAAA;AAdY,cAAc;IAEtB,WAAA,gBAAM,CAAC,mBAAY,CAAC,eAAe,CAAC,SAAS,CAAC,CAAA;;GAFtC,cAAc,CAc1B;AAdY,wCAAc"}

package/dist/src/providers/send.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"send.js","sourceRoot":"","sources":["../../../src/providers/send.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;AAGhE,sCAAgD;AAChD;;;;;;;;;GASG;AACH;IACE,KAAK;QACH,MAAM,CAAC,8BAAqB,CAAC;IAC/B,CAAC;CACF;AAJD,oCAIC"}

package/dist/src/rest-component.d.ts

@@ -1,12 +0,0 @@
-import { Component, ProviderMap, Server, Application } from '@loopback/core';
-import { Constructor } from '@loopback/context';
-import { RestServerConfig } from './rest-server';
-export declare class RestComponent implements Component {
-    providers: ProviderMap;
-    servers: {
-        [name: string]: Constructor<Server>;
-    };
-    constructor(app: Application, config?: RestComponentConfig);
-}
-export interface RestComponentConfig extends RestServerConfig {
-}

package/dist/src/rest-component.js

@@ -1,50 +0,0 @@
-"use strict";
-// Copyright IBM Corp. 2017. All Rights Reserved.
-// Node module: @loopback/rest
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __param = (this && this.__param) || function (paramIndex, decorator) {
-    return function (target, key) { decorator(target, key, paramIndex); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const core_1 = require("@loopback/core");
-const context_1 = require("@loopback/context");
-const keys_1 = require("./keys");
-const providers_1 = require("./providers");
-const providers_2 = require("./providers");
-const rest_server_1 = require("./rest-server");
-let RestComponent = class RestComponent {
-    constructor(app, config) {
-        this.providers = {
-            [keys_1.RestBindings.SequenceActions.LOG_ERROR]: providers_1.LogErrorProvider,
-            [keys_1.RestBindings.SequenceActions.FIND_ROUTE]: providers_2.FindRouteProvider,
-            [keys_1.RestBindings.SequenceActions.INVOKE_METHOD]: providers_2.InvokeMethodProvider,
-            [keys_1.RestBindings.SequenceActions.REJECT]: providers_2.RejectProvider,
-            [keys_1.RestBindings.BIND_ELEMENT]: providers_2.BindElementProvider,
-            [keys_1.RestBindings.GET_FROM_CONTEXT]: providers_2.GetFromContextProvider,
-            [keys_1.RestBindings.SequenceActions.PARSE_PARAMS]: providers_2.ParseParamsProvider,
-            [keys_1.RestBindings.SequenceActions.SEND]: providers_2.SendProvider,
-        };
-        this.servers = {
-            RestServer: rest_server_1.RestServer,
-        };
-        if (!config)
-            config = {};
-    }
-};
-RestComponent = __decorate([
-    __param(0, context_1.inject(core_1.CoreBindings.APPLICATION_INSTANCE)),
-    __param(1, context_1.inject(keys_1.RestBindings.CONFIG)),
-    __metadata("design:paramtypes", [core_1.Application, Object])
-], RestComponent);
-exports.RestComponent = RestComponent;
-//# sourceMappingURL=rest-component.js.map

package/dist/src/rest-component.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"rest-component.js","sourceRoot":"","sources":["../../src/rest-component.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;;;;;;;;;;;AAEhE,yCAMwB;AACxB,+CAAsD;AACtD,iCAAoC;AACpC,2CAA6C;AAC7C,2CAQqB;AACrB,+CAA2D;AAE3D,IAAa,aAAa,GAA1B;IAiBE,YAC6C,GAAgB,EAC9B,MAA4B;QAlB3D,cAAS,GAAgB;YACvB,CAAC,mBAAY,CAAC,eAAe,CAAC,SAAS,CAAC,EAAE,4BAAgB;YAC1D,CAAC,mBAAY,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,6BAAiB;YAC5D,CAAC,mBAAY,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE,gCAAoB;YAClE,CAAC,mBAAY,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,0BAAc;YACrD,CAAC,mBAAY,CAAC,YAAY,CAAC,EAAE,+BAAmB;YAChD,CAAC,mBAAY,CAAC,gBAAgB,CAAC,EAAE,kCAAsB;YACvD,CAAC,mBAAY,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,+BAAmB;YAChE,CAAC,mBAAY,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,wBAAY;SAClD,CAAC;QACF,YAAO,GAEH;YACF,UAAU,EAAV,wBAAU;SACX,CAAC;QAMA,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;YAAC,MAAM,GAAG,EAAE,CAAC;IAC3B,CAAC;CACF,CAAA;AAvBY,aAAa;IAkBrB,WAAA,gBAAM,CAAC,mBAAY,CAAC,oBAAoB,CAAC,CAAA;IACzC,WAAA,gBAAM,CAAC,mBAAY,CAAC,MAAM,CAAC,CAAA;qCADoB,kBAAW;GAlBlD,aAAa,CAuBzB;AAvBY,sCAAa"}

package/dist/src/rest-server.d.ts

@@ -1,211 +0,0 @@
-/// <reference types="node" />
-import { Binding, Context, Constructor } from '@loopback/context';
-import { RouteEntry } from '.';
-import { OpenApiSpec, OperationObject } from '@loopback/openapi-spec';
-import { ServerRequest, ServerResponse } from 'http';
-import * as Http from 'http';
-import { Application, Server } from '@loopback/core';
-import { HttpHandler } from './http-handler';
-import { SequenceHandler, SequenceFunction } from './sequence';
-import { ControllerClass } from './router/routing-table';
-/**
- * A REST API server for use with Loopback.
- * Add this server to your application by importing the RestComponent.
- * ```ts
- * const app = new MyApplication({
- *   components: [RestComponent]
- * });
- * // OR
- * app.component(RestComponent);
- * ```
- *
- * To add additional instances of RestServer to your application, use the
- * `.server` function:
- * ```ts
- * app.server(RestServer, 'nameOfYourServer');
- * ```
- *
- * By default, one instance of RestServer will be created when the RestComponent
- * is bootstrapped. This instance can be retrieved with
- * `app.getServer(RestServer)`, or by calling `app.get('servers.RestServer')`
- * Note that retrieving other instances of RestServer must be done using the
- * server's name:
- * ```ts
- * const server = await app.getServer('foo')
- * // OR
- * const server = await app.get('servers.foo');
- * ```
- *
- * @export
- * @class RestServer
- * @extends {Context}
- * @implements {Server}
- */
-export declare class RestServer extends Context implements Server {
-    /**
-     * Handle incoming HTTP(S) request by invoking the corresponding
-     * Controller method via the configured Sequence.
-     *
-     * @example
-     *
-     * ```ts
-     * const app = new Application();
-     * // setup controllers, etc.
-     *
-     * const server = http.createServer(app.handleHttp);
-     * server.listen(3000);
-     * ```
-     *
-     * @param req The request.
-     * @param res The response.
-     */
-    handleHttp: (req: ServerRequest, res: ServerResponse) => void;
-    protected _httpHandler: HttpHandler;
-    protected readonly httpHandler: HttpHandler;
-    protected _httpServer: Http.Server;
-    /**
-     * @memberof RestServer
-     * Creates an instance of RestServer.
-     *
-     * @param {Application} app The application instance (injected via
-     * CoreBindings.APPLICATION_INSTANCE).
-     * @param {RestServerConfig=} options The configuration options (injected via
-     * RestBindings.CONFIG).
-     *
-     */
-    constructor(app: Application, options?: RestServerConfig);
-    protected _handleHttpRequest(request: ServerRequest, response: ServerResponse): Promise<void>;
-    protected _setupHandlerIfNeeded(): void;
-    private _setupOperation(verb, path, spec);
-    private _serveOpenApiSpec(request, response, options?);
-    private _redirectToSwaggerUI(request, response);
-    /**
-     * Register a controller class with this server.
-     *
-     * @param {Constructor} controllerCtor The controller class
-     * (constructor function).
-     * @returns {Binding} The newly created binding, you can use the reference to
-     * further modify the binding, e.g. lock the value to prevent further
-     * modifications.
-     *
-     * ```ts
-     * class MyController {
-     * }
-     * app.controller(MyController).lock();
-     * ```
-     *
-     */
-    controller(controllerCtor: ControllerClass): Binding;
-    /**
-     * Register a new Controller-based route.
-     *
-     * ```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 controller Controller constructor
-     * @param methodName The name of the controller method
-     */
-    route(verb: string, path: string, spec: OperationObject, controller: ControllerClass, methodName: string): Binding;
-    /**
-     * Register a new route.
-     *
-     * ```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;
-    /**
-     * Set the OpenAPI specification that defines the REST API schema for this
-     * server. 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 {OpenApiSpec} spec The OpenAPI specification, as an object.
-     * @returns {Binding}
-     * @memberof RestServer
-     */
-    api(spec: OpenApiSpec): Binding;
-    /**
-     * Get the OpenAPI specification describing the REST API provided by
-     * this application.
-     *
-     * This method merges operations (HTTP endpoints) from the following sources:
-     *  - `app.api(spec)`
-     *  - `app.controller(MyController)`
-     *  - `app.route(route)`
-     *  - `app.route('get', '/greet', operationSpec, MyController, 'greet')`
-     */
-    getApiSpec(): OpenApiSpec;
-    /**
-     * Configure a custom sequence class for handling incoming requests.
-     *
-     * ```ts
-     * class MySequence implements SequenceHandler {
-     *   constructor(
-     *     @inject('send) public send: Send)) {
-     *   }
-     *
-     *   public async handle(request: ParsedRequest, response: ServerResponse) {
-     *     send(response, 'hello world');
-     *   }
-     * }
-     * ```
-     *
-     * @param value The sequence to invoke for each incoming request.
-     */
-    sequence(value: Constructor<SequenceHandler>): void;
-    /**
-     * Configure a custom sequence function for handling incoming requests.
-     *
-     * ```ts
-     * app.handler((sequence, request, response) => {
-     *   sequence.send(response, 'hello world');
-     * });
-     * ```
-     *
-     * @param handlerFn The handler to invoke for each incoming request.
-     */
-    handler(handlerFn: SequenceFunction): void;
-    /**
-     * Start this REST API's HTTP/HTTPS server.
-     *
-     * @returns {Promise<void>}
-     * @memberof RestServer
-     */
-    start(): Promise<void>;
-    /**
-     * Stop this REST API's HTTP/HTTPS server.
-     *
-     * @returns {Promise<void>}
-     * @memberof RestServer
-     */
-    stop(): Promise<void>;
-    protected _onUnhandledError(req: ServerRequest, res: ServerResponse, err: Error): void;
-}
-/**
- * Valid configuration for the RestServer constructor.
- *
- * @export
- * @interface RestServerConfig
- */
-export interface RestServerConfig {
-    port?: number;
-    sequence?: Constructor<SequenceHandler>;
-}