@loopback/rest 4.0.0-alpha.8 → 5.0.1

package/dist/router/routing-table.js

@@ -0,0 +1,86 @@
+"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.RoutingTable = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const http_errors_1 = tslib_1.__importDefault(require("http-errors"));
+const controller_route_1 = require("./controller-route");
+const openapi_path_1 = require("./openapi-path");
+const trie_router_1 = require("./trie-router");
+const debug = debug_1.default('loopback:rest:routing-table');
+/**
+ * Routing table
+ */
+class RoutingTable {
+    constructor(_router = new trie_router_1.TrieRouter(), _externalRoutes) {
+        this._router = _router;
+        this._externalRoutes = _externalRoutes;
+    }
+    /**
+     * Register a controller as the route
+     * @param spec
+     * @param controllerCtor
+     * @param controllerFactory
+     */
+    registerController(spec, controllerCtor, controllerFactory) {
+        const routes = controller_route_1.createRoutesForController(spec, controllerCtor, controllerFactory);
+        for (const route of routes) {
+            this.registerRoute(route);
+        }
+    }
+    /**
+     * Register a route
+     * @param route - A route entry
+     */
+    registerRoute(route) {
+        // TODO(bajtos) handle the case where opSpec.parameters contains $ref
+        // See https://github.com/strongloop/loopback-next/issues/435
+        /* istanbul ignore if */
+        if (debug.enabled) {
+            debug('Registering route %s %s -> %s(%s)', route.verb.toUpperCase(), route.path, route.describe(), describeOperationParameters(route.spec));
+        }
+        openapi_path_1.validateApiPath(route.path);
+        this._router.add(route);
+    }
+    describeApiPaths() {
+        const paths = {};
+        for (const route of this._router.list()) {
+            if (route.spec['x-visibility'] === 'undocumented')
+                continue;
+            if (!paths[route.path]) {
+                paths[route.path] = {};
+            }
+            paths[route.path][route.verb] = route.spec;
+        }
+        return paths;
+    }
+    /**
+     * Map a request to a route
+     * @param request
+     */
+    find(request) {
+        debug('Finding route for %s %s', request.method, request.path);
+        const found = this._router.find(request);
+        if (found) {
+            debug('Route matched: %j', found);
+            return found;
+        }
+        if (this._externalRoutes) {
+            debug('No API route found for %s %s, trying to find an external Express route', request.method, request.path);
+            return this._externalRoutes.find(request);
+        }
+        debug('No route found for %s %s', request.method, request.path);
+        throw new http_errors_1.default.NotFound(`Endpoint "${request.method} ${request.path}" not found.`);
+    }
+}
+exports.RoutingTable = RoutingTable;
+function describeOperationParameters(opSpec) {
+    return (opSpec.parameters || [])
+        .map(p => (p === null || p === void 0 ? void 0 : p.name) || '')
+        .join(', ');
+}
+//# sourceMappingURL=routing-table.js.map

package/dist/router/routing-table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing-table.js","sourceRoot":"","sources":["../../src/router/routing-table.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAQhE,0DAAiC;AACjC,sEAAqC;AAErC,yDAI4B;AAE5B,iDAA+C;AAG/C,+CAAyC;AAEzC,MAAM,KAAK,GAAG,eAAY,CAAC,6BAA6B,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAa,YAAY;IACvB,YACmB,UAAsB,IAAI,wBAAU,EAAE,EAC/C,eAAuC;QAD9B,YAAO,GAAP,OAAO,CAA+B;QAC/C,oBAAe,GAAf,eAAe,CAAwB;IAC9C,CAAC;IAEJ;;;;;OAKG;IACH,kBAAkB,CAChB,IAAoB,EACpB,cAAkC,EAClC,iBAAwC;QAExC,MAAM,MAAM,GAAG,4CAAyB,CACtC,IAAI,EACJ,cAAc,EACd,iBAAiB,CAClB,CAAC;QACF,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YAC1B,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAC3B;IACH,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,KAAiB;QAC7B,qEAAqE;QACrE,6DAA6D;QAC7D,wBAAwB;QACxB,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,KAAK,CACH,mCAAmC,EACnC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,EACxB,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,QAAQ,EAAE,EAChB,2BAA2B,CAAC,KAAK,CAAC,IAAI,CAAC,CACxC,CAAC;SACH;QAED,8BAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE5B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,gBAAgB;QACd,MAAM,KAAK,GAAe,EAAE,CAAC;QAE7B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE;YACvC,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,cAAc;gBAAE,SAAS;YAC5D,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBACtB,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;aACxB;YAED,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC;SAC5C;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,OAAgB;QACnB,KAAK,CAAC,yBAAyB,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAE/D,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEzC,IAAI,KAAK,EAAE;YACT,KAAK,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;YAClC,OAAO,KAAK,CAAC;SACd;QAED,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,KAAK,CACH,wEAAwE,EACxE,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,IAAI,CACb,CAAC;YAEF,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC3C;QAED,KAAK,CAAC,0BAA0B,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAChE,MAAM,IAAI,qBAAU,CAAC,QAAQ,CAC3B,aAAa,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,cAAc,CAC1D,CAAC;IACJ,CAAC;CACF;AA9FD,oCA8FC;AAED,SAAS,2BAA2B,CAAC,MAAuB;IAC1D,OAAO,CAAE,MAAM,CAAC,UAAgC,IAAI,EAAE,CAAC;SACpD,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,IAAI,KAAI,EAAE,CAAC;SACvB,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC"}

package/dist/router/trie-router.d.ts

@@ -0,0 +1,13 @@
+import { RestRouterOptions } from './rest-router';
+import { ResolvedRoute, RouteEntry } from './route-entry';
+import { BaseRouter } from './router-base';
+/**
+ * Router implementation based on trie
+ */
+export declare class TrieRouter extends BaseRouter {
+    private trie;
+    constructor(options?: RestRouterOptions);
+    protected addRouteWithPathVars(route: RouteEntry): void;
+    protected findRouteWithPathVars(verb: string, path: string): ResolvedRoute | undefined;
+    protected listRoutesWithPathVars(): RouteEntry[];
+}

package/dist/router/trie-router.js

@@ -0,0 +1,55 @@
+"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.TrieRouter = void 0;
+const tslib_1 = require("tslib");
+const context_1 = require("@loopback/context");
+const util_1 = require("util");
+const keys_1 = require("../keys");
+const route_entry_1 = require("./route-entry");
+const router_base_1 = require("./router-base");
+const trie_1 = require("./trie");
+const debug = require('debug')('loopback:rest:router:trie');
+/**
+ * Router implementation based on trie
+ */
+let TrieRouter = /** @class */ (() => {
+    let TrieRouter = class TrieRouter extends router_base_1.BaseRouter {
+        constructor(options) {
+            super(options);
+            this.trie = new trie_1.Trie();
+        }
+        addRouteWithPathVars(route) {
+            // Add the route to the trie
+            const key = this.getKeyForRoute(route);
+            this.trie.create(key, route);
+        }
+        findRouteWithPathVars(verb, path) {
+            var _a;
+            const key = this.getKey(verb, path);
+            const found = this.trie.match(key);
+            debug('Route matched: %j', found);
+            if (found) {
+                const route = found.node.value;
+                if (route) {
+                    debug('Route found: %s', util_1.inspect(route, { depth: 5 }));
+                    return route_entry_1.createResolvedRoute(route, (_a = found.params) !== null && _a !== void 0 ? _a : {});
+                }
+            }
+            return undefined;
+        }
+        listRoutesWithPathVars() {
+            return this.trie.list().map(n => n.value);
+        }
+    };
+    TrieRouter = tslib_1.__decorate([
+        tslib_1.__param(0, context_1.inject(keys_1.RestBindings.ROUTER_OPTIONS, { optional: true })),
+        tslib_1.__metadata("design:paramtypes", [Object])
+    ], TrieRouter);
+    return TrieRouter;
+})();
+exports.TrieRouter = TrieRouter;
+//# sourceMappingURL=trie-router.js.map

package/dist/router/trie-router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trie-router.js","sourceRoot":"","sources":["../../src/router/trie-router.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+CAAyC;AACzC,+BAA6B;AAC7B,kCAAqC;AAErC,+CAA6E;AAC7E,+CAAyC;AACzC,iCAA4B;AAE5B,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,2BAA2B,CAAC,CAAC;AAE5D;;GAEG;AACH;IAAA,IAAa,UAAU,GAAvB,MAAa,UAAW,SAAQ,wBAAU;QAGxC,YAEE,OAA2B;YAE3B,KAAK,CAAC,OAAO,CAAC,CAAC;YANT,SAAI,GAAG,IAAI,WAAI,EAAc,CAAC;QAOtC,CAAC;QAES,oBAAoB,CAAC,KAAiB;YAC9C,4BAA4B;YAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACvC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC/B,CAAC;QAES,qBAAqB,CAC7B,IAAY,EACZ,IAAY;;YAEZ,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEpC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnC,KAAK,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;YAElC,IAAI,KAAK,EAAE;gBACT,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,KAAM,CAAC;gBAChC,IAAI,KAAK,EAAE;oBACT,KAAK,CAAC,iBAAiB,EAAE,cAAO,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC;oBACrD,OAAO,iCAAmB,CAAC,KAAK,QAAE,KAAK,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC;iBACvD;aACF;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QAES,sBAAsB;YAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC5C,CAAC;KACF,CAAA;IAtCY,UAAU;QAIlB,mBAAA,gBAAM,CAAC,mBAAY,CAAC,cAAc,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAA;;OAJ7C,UAAU,CAsCtB;IAAD,iBAAC;KAAA;AAtCY,gCAAU"}

package/dist/router/trie.d.ts

@@ -0,0 +1,59 @@
+import { PathParameterValues } from '../types';
+/**
+ * A Node in the trie
+ */
+export interface Node<T> {
+    /**
+     * Key of the node
+     */
+    key: string;
+    /**
+     * Value of the node
+     */
+    value?: T;
+    /**
+     * Children of the node
+     */
+    readonly children: {
+        [key: string]: Node<T>;
+    };
+    /**
+     * Regular expression for the template
+     */
+    regexp?: RegExp;
+    /**
+     * Names of the node if it contains named parameters
+     */
+    names?: string[];
+}
+export declare type NodeWithValue<T> = Node<T> & {
+    value: T;
+};
+export interface ResolvedNode<T> {
+    node: Node<T>;
+    params?: PathParameterValues;
+}
+/**
+ * An implementation of trie for routes. The key hierarchy is built with parts
+ * of the route path delimited by `/`
+ */
+export declare class Trie<T> {
+    readonly root: Node<T>;
+    /**
+     * Create a node for a given path template
+     * @param pathTemplate - The path template,
+     * @param value - Value of the route
+     */
+    create(routeTemplate: string, value: T): Node<T>;
+    /**
+     * Match a route path against the trie
+     * @param path - The route path, such as `/customers/c01`
+     */
+    match(path: string): (ResolvedNode<T> & {
+        node: NodeWithValue<T>;
+    }) | undefined;
+    /**
+     * List all nodes with value of the trie
+     */
+    list(): NodeWithValue<T>[];
+}

package/dist/router/trie.js

@@ -0,0 +1,180 @@
+"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.Trie = void 0;
+const path_to_regexp_1 = require("path-to-regexp");
+const openapi_path_1 = require("./openapi-path");
+/**
+ * An implementation of trie for routes. The key hierarchy is built with parts
+ * of the route path delimited by `/`
+ */
+class Trie {
+    constructor() {
+        this.root = { key: '', children: {} };
+    }
+    /**
+     * Create a node for a given path template
+     * @param pathTemplate - The path template,
+     * @param value - Value of the route
+     */
+    create(routeTemplate, value) {
+        const keys = routeTemplate.split('/').filter(Boolean);
+        return createNode(keys, 0, value, this.root);
+    }
+    /**
+     * Match a route path against the trie
+     * @param path - The route path, such as `/customers/c01`
+     */
+    match(path) {
+        const keys = path.split('/').filter(Boolean);
+        const params = {};
+        const resolved = search(keys, 0, params, this.root);
+        if (resolved == null || !isNodeWithValue(resolved.node))
+            return undefined;
+        return {
+            node: resolved.node,
+            params: resolved.params,
+        };
+    }
+    /**
+     * List all nodes with value of the trie
+     */
+    list() {
+        const nodes = [];
+        traverse(this.root, node => {
+            nodes.push(node);
+        });
+        return nodes;
+    }
+}
+exports.Trie = Trie;
+function isNodeWithValue(node) {
+    return node.value != null;
+}
+/**
+ * Use depth-first preorder traversal to list all nodes with values
+ * @param root - Root node
+ * @param visitor - A function to process nodes with values
+ */
+function traverse(root, visitor) {
+    if (isNodeWithValue(root))
+        visitor(root);
+    for (const k in root.children) {
+        traverse(root.children[k], visitor);
+    }
+}
+/**
+ * Match the given key to one or more children of the parent node
+ * @param key - Key
+ * @param parent - Parent node
+ */
+function matchChildren(key, parent) {
+    const resolvedNodes = [];
+    // Match key literal first
+    let child = parent.children[key];
+    if (child) {
+        resolvedNodes.push({
+            node: child,
+        });
+        return resolvedNodes;
+    }
+    // Match templates
+    for (const k in parent.children) {
+        child = parent.children[k];
+        if (!child.names || !child.regexp)
+            continue;
+        const match = child.regexp.exec(key);
+        if (match) {
+            const resolved = { params: {}, node: child };
+            let i = 0;
+            for (const n of child.names) {
+                const val = match[++i];
+                resolved.params[n] = decodeURIComponent(val);
+            }
+            resolvedNodes.push(resolved);
+        }
+    }
+    return resolvedNodes;
+}
+/**
+ * Search a sub list of keys against the parent node
+ * @param keys - An array of keys
+ * @param index - Starting index of the key list
+ * @param params - An object to receive resolved parameter values
+ * @param parent - Parent node
+ */
+function search(keys, index, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+params, parent) {
+    const key = keys[index];
+    const resolved = { node: parent, params };
+    if (key === undefined)
+        return resolved;
+    const children = matchChildren(key, parent);
+    if (children.length === 0)
+        return undefined;
+    // There might be multiple matches, such as `/users/{id}` and `/users/{userId}`
+    for (const child of children) {
+        const result = search(keys, index + 1, params, child.node);
+        if (result && isNodeWithValue(result.node)) {
+            Object.assign(params, child.params);
+            return result;
+        }
+    }
+    // no matches found
+    return undefined;
+}
+/**
+ * Create a node for a sub list of keys against the parent node
+ * @param keys - An array of keys
+ * @param index - Starting index of the key list
+ * @param value - Value of the node
+ * @param parent - Parent node
+ */
+function createNode(keys, index, value, parent) {
+    const key = keys[index];
+    if (key === undefined)
+        return parent;
+    const isLast = keys.length - 1 === index;
+    let child = parent.children[key];
+    if (child != null) {
+        // Found an existing node
+        if (isLast) {
+            if (child.value == null) {
+                child.value = value;
+            }
+            else {
+                if (child.value !== value) {
+                    throw new Error('Duplicate key found with different value: ' + keys.join('/'));
+                }
+            }
+        }
+        return createNode(keys, index + 1, value, child);
+    }
+    /**
+     * Build a new node
+     */
+    child = {
+        children: {},
+        key: key,
+    };
+    if (isLast) {
+        child.value = value;
+    }
+    // Check if the key has variables such as `{var}`
+    const path = openapi_path_1.toExpressPath(key);
+    const params = [];
+    const re = path_to_regexp_1.pathToRegexp(path, params);
+    if (params.length) {
+        child.names = params.map(p => `${p.name}`);
+        child.regexp = re;
+    }
+    // Add the node to the parent
+    parent.children[key] = child;
+    // Create nodes for rest of the keys
+    return createNode(keys, index + 1, value, child);
+}
+//# sourceMappingURL=trie.js.map

package/dist/router/trie.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trie.js","sourceRoot":"","sources":["../../src/router/trie.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAEhE,mDAAiD;AAEjD,iDAA6C;AAoC7C;;;GAGG;AACH,MAAa,IAAI;IAAjB;QACW,SAAI,GAAY,EAAC,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAC,CAAC;IAuCnD,CAAC;IArCC;;;;OAIG;IACH,MAAM,CAAC,aAAqB,EAAE,KAAQ;QACpC,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtD,OAAO,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACH,KAAK,CACH,IAAY;QAEZ,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,QAAQ,IAAI,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO,SAAS,CAAC;QAC1E,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,QAAQ,CAAC,MAAM;SACxB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAI;QACF,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;YACzB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAxCD,oBAwCC;AAED,SAAS,eAAe,CAAI,IAAa;IACvC,OAAO,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC;AAC5B,CAAC;AAED;;;;GAIG;AACH,SAAS,QAAQ,CAAI,IAAa,EAAE,OAAyC;IAC3E,IAAI,eAAe,CAAC,IAAI,CAAC;QAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;QAC7B,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;KACrC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAI,GAAW,EAAE,MAAe;IACpD,MAAM,aAAa,GAAsB,EAAE,CAAC;IAC5C,0BAA0B;IAC1B,IAAI,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,KAAK,EAAE;QACT,aAAa,CAAC,IAAI,CAAC;YACjB,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;QACH,OAAO,aAAa,CAAC;KACtB;IAED,kBAAkB;IAClB,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE;QAC/B,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,SAAS;QAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,KAAK,EAAE;YACT,MAAM,QAAQ,GAAoB,EAAC,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAC,CAAC;YAC5D,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,KAAK,EAAE;gBAC3B,MAAM,GAAG,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;gBACvB,QAAQ,CAAC,MAAO,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;aAC/C;YACD,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC9B;KACF;IACD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,MAAM,CACb,IAAc,EACd,KAAa;AACb,8DAA8D;AAC9D,MAA6B,EAC7B,MAAe;IAEf,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IACxB,MAAM,QAAQ,GAAoB,EAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC;IACzD,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IAEvC,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC5C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC5C,+EAA+E;IAC/E,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE;QAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAI,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YAC1C,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO,MAAM,CAAC;SACf;KACF;IACD,mBAAmB;IACnB,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CACjB,IAAc,EACd,KAAa,EACb,KAAQ,EACR,MAAe;IAEf,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IACxB,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IAErC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,KAAK,CAAC;IACzC,IAAI,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,KAAK,IAAI,IAAI,EAAE;QACjB,yBAAyB;QACzB,IAAI,MAAM,EAAE;YACV,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,EAAE;gBACvB,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;aACrB;iBAAM;gBACL,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK,EAAE;oBACzB,MAAM,IAAI,KAAK,CACb,4CAA4C,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAC9D,CAAC;iBACH;aACF;SACF;QACD,OAAO,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;KAClD;IAED;;OAEG;IACH,KAAK,GAAG;QACN,QAAQ,EAAE,EAAE;QACZ,GAAG,EAAE,GAAG;KACT,CAAC;IAEF,IAAI,MAAM,EAAE;QACV,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;KACrB;IAED,iDAAiD;IACjD,MAAM,IAAI,GAAG,4BAAa,CAAC,GAAG,CAAC,CAAC;IAChC,MAAM,MAAM,GAAU,EAAE,CAAC;IACzB,MAAM,EAAE,GAAG,6BAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAEtC,IAAI,MAAM,CAAC,MAAM,EAAE;QACjB,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3C,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC;KACnB;IAED,6BAA6B;IAC7B,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAE7B,oCAAoC;IACpC,OAAO,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AACnD,CAAC"}

package/{dist6/src → dist}/sequence.d.ts

@@ -1,12 +1,12 @@
-/// <reference types="node" />
-import { ServerResponse } from 'http';
-import { Context } from '@loopback/context';
-import { FindRoute, InvokeMethod, ParsedRequest, Send, Reject, ParseParams } from './internal-types';
+import { ValueOrPromise } from '@loopback/context';
+import { InvokeMiddleware } from '@loopback/express';
+import { RequestContext } from './request-context';
+import { FindRoute, InvokeMethod, ParseParams, Reject, Send } from './types';
 /**
  * A sequence function is a function implementing a custom
  * sequence of actions to handle an incoming request.
  */
-export declare type SequenceFunction = (sequence: DefaultSequence, request: ParsedRequest, response: ServerResponse) => Promise<void> | void;
+export declare type SequenceFunction = (context: RequestContext, sequence: DefaultSequence) => ValueOrPromise<void>;
 /**
  * A sequence handler is a class implementing sequence of actions
  * required to handle an incoming request.
@@ -15,14 +15,15 @@ export interface SequenceHandler {
     /**
      * Handle the request by running the configured sequence of actions.
      *
-     * @param request The incoming HTTP request
-     * @param response The HTTP server response where to write the result
+     * @param context - The request context: HTTP request and response objects,
+     * per-request IoC container and more.
      */
-    handle(request: ParsedRequest, response: ServerResponse): Promise<void>;
+    handle(context: RequestContext): Promise<void>;
 }
 /**
  * The default implementation of SequenceHandler.
  *
+ * @remarks
  * This class implements default Sequence for the LoopBack framework.
  * Default sequence is used if user hasn't defined their own Sequence
  * for their application.
@@ -31,41 +32,45 @@ export interface SequenceHandler {
  * when the API request comes in. User defines APIs in their Application
  * Controller class.
  *
+ * @example
  * User can bind their own Sequence to app as shown below
  * ```ts
  * app.bind(CoreBindings.SEQUENCE).toClass(MySequence);
  * ```
  */
 export declare class DefaultSequence implements SequenceHandler {
-    ctx: Context;
     protected findRoute: FindRoute;
     protected parseParams: ParseParams;
     protected invoke: InvokeMethod;
     send: Send;
     reject: Reject;
+    /**
+     * Optional invoker for registered middleware in a chain.
+     * To be injected via SequenceActions.INVOKE_MIDDLEWARE.
+     */
+    protected invokeMiddleware: InvokeMiddleware;
     /**
      * Constructor: Injects findRoute, invokeMethod & logError
      * methods as promises.
      *
-     * @param {Context} ctx The context for the sequence (injected via
-     * RestBindings.Http.CONTEXT).
-     * @param {FindRoute} findRoute Finds the appropriate controller method,
+     * @param findRoute - Finds the appropriate controller method,
      *  spec and args for invocation (injected via SequenceActions.FIND_ROUTE).
-     * @param {ParseParams} parseParams The parameter parsing function (injected
+     * @param parseParams - The parameter parsing function (injected
      * via SequenceActions.PARSE_PARAMS).
-     * @param {InvokeMethod} invoke Invokes the method specified by the route
+     * @param invoke - Invokes the method specified by the route
      * (injected via SequenceActions.INVOKE_METHOD).
-     * @param {Send} send The action to merge the invoke result with the response
+     * @param send - The action to merge the invoke result with the response
      * (injected via SequenceActions.SEND)
-     * @param {Reject} reject The action to take if the invoke returns a rejected
+     * @param reject - The action to take if the invoke returns a rejected
      * promise result (injected via SequenceActions.REJECT).
      */
-    constructor(ctx: Context, findRoute: FindRoute, parseParams: ParseParams, invoke: InvokeMethod, send: Send, reject: Reject);
+    constructor(findRoute: FindRoute, parseParams: ParseParams, invoke: InvokeMethod, send: Send, reject: Reject);
     /**
-     * Runs the default sequence. Given a request and response, running the
-     * sequence will produce a response or an error.
+     * Runs the default sequence. Given a handler context (request and response),
+     * running the sequence will produce a response or an error.
      *
      * Default sequence executes these steps
+     *  - Executes middleware for CORS, OpenAPI spec endpoints
      *  - Finds the appropriate controller method, swagger spec
      *    and args for invocation
      *  - Parses HTTP request to get API argument list
@@ -73,9 +78,9 @@ export declare class DefaultSequence implements SequenceHandler {
      *  - Writes the result from API into the HTTP response
      *  - Error is caught and logged using 'logError' if any of the above steps
      *    in the sequence fails with an error.
-     * @param req Parsed incoming HTTP request
-     * @param res HTTP server response with result from Application controller
-     *  method invocation
+     *
+     * @param context - The request context: HTTP request and response objects,
+     * per-request IoC container and more.
      */
-    handle(req: ParsedRequest, res: ServerResponse): Promise<void>;
+    handle(context: RequestContext): Promise<void>;
 }

package/dist/sequence.js

@@ -0,0 +1,112 @@
+"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.DefaultSequence = void 0;
+const tslib_1 = require("tslib");
+const debug = require('debug')('loopback:rest:sequence');
+const context_1 = require("@loopback/context");
+const keys_1 = require("./keys");
+const SequenceActions = keys_1.RestBindings.SequenceActions;
+/**
+ * The default implementation of SequenceHandler.
+ *
+ * @remarks
+ * This class implements default Sequence for the LoopBack framework.
+ * Default sequence is used if user hasn't defined their own Sequence
+ * for their application.
+ *
+ * Sequence constructor() and run() methods are invoked from [[http-handler]]
+ * when the API request comes in. User defines APIs in their Application
+ * Controller class.
+ *
+ * @example
+ * User can bind their own Sequence to app as shown below
+ * ```ts
+ * app.bind(CoreBindings.SEQUENCE).toClass(MySequence);
+ * ```
+ */
+let DefaultSequence = /** @class */ (() => {
+    let DefaultSequence = class DefaultSequence {
+        /**
+         * Constructor: Injects findRoute, invokeMethod & logError
+         * methods as promises.
+         *
+         * @param findRoute - Finds the appropriate controller method,
+         *  spec and args for invocation (injected via SequenceActions.FIND_ROUTE).
+         * @param parseParams - The parameter parsing function (injected
+         * via SequenceActions.PARSE_PARAMS).
+         * @param invoke - Invokes the method specified by the route
+         * (injected via SequenceActions.INVOKE_METHOD).
+         * @param send - The action to merge the invoke result with the response
+         * (injected via SequenceActions.SEND)
+         * @param reject - The action to take if the invoke returns a rejected
+         * promise result (injected via SequenceActions.REJECT).
+         */
+        constructor(findRoute, parseParams, invoke, send, reject) {
+            this.findRoute = findRoute;
+            this.parseParams = parseParams;
+            this.invoke = invoke;
+            this.send = send;
+            this.reject = reject;
+            /**
+             * Optional invoker for registered middleware in a chain.
+             * To be injected via SequenceActions.INVOKE_MIDDLEWARE.
+             */
+            this.invokeMiddleware = () => false;
+        }
+        /**
+         * Runs the default sequence. Given a handler context (request and response),
+         * running the sequence will produce a response or an error.
+         *
+         * Default sequence executes these steps
+         *  - Executes middleware for CORS, OpenAPI spec endpoints
+         *  - Finds the appropriate controller method, swagger spec
+         *    and args for invocation
+         *  - Parses HTTP request to get API argument list
+         *  - Invokes the API which is defined in the Application Controller
+         *  - Writes the result from API into the HTTP response
+         *  - Error is caught and logged using 'logError' if any of the above steps
+         *    in the sequence fails with an error.
+         *
+         * @param context - The request context: HTTP request and response objects,
+         * per-request IoC container and more.
+         */
+        async handle(context) {
+            try {
+                const { request, response } = context;
+                // Invoke registered Express middleware
+                const finished = await this.invokeMiddleware(context);
+                if (finished) {
+                    // The response been produced by the middleware chain
+                    return;
+                }
+                const route = this.findRoute(request);
+                const args = await this.parseParams(request, route);
+                const result = await this.invoke(route, args);
+                debug('%s result -', route.describe(), result);
+                this.send(response, result);
+            }
+            catch (error) {
+                this.reject(context, error);
+            }
+        }
+    };
+    tslib_1.__decorate([
+        context_1.inject(SequenceActions.INVOKE_MIDDLEWARE, { optional: true }),
+        tslib_1.__metadata("design:type", Function)
+    ], DefaultSequence.prototype, "invokeMiddleware", void 0);
+    DefaultSequence = tslib_1.__decorate([
+        tslib_1.__param(0, context_1.inject(SequenceActions.FIND_ROUTE)),
+        tslib_1.__param(1, context_1.inject(SequenceActions.PARSE_PARAMS)),
+        tslib_1.__param(2, context_1.inject(SequenceActions.INVOKE_METHOD)),
+        tslib_1.__param(3, context_1.inject(SequenceActions.SEND)),
+        tslib_1.__param(4, context_1.inject(SequenceActions.REJECT)),
+        tslib_1.__metadata("design:paramtypes", [Function, Function, Function, Function, Function])
+    ], DefaultSequence);
+    return DefaultSequence;
+})();
+exports.DefaultSequence = DefaultSequence;
+//# sourceMappingURL=sequence.js.map

package/dist/sequence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sequence.js","sourceRoot":"","sources":["../src/sequence.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,wBAAwB,CAAC,CAAC;AACzD,+CAAyD;AAEzD,iCAAoC;AAIpC,MAAM,eAAe,GAAG,mBAAY,CAAC,eAAe,CAAC;AAyBrD;;;;;;;;;;;;;;;;;GAiBG;AACH;IAAA,IAAa,eAAe,GAA5B,MAAa,eAAe;QAQ1B;;;;;;;;;;;;;;WAcG;QACH,YACgD,SAAoB,EAClB,WAAwB,EACvB,MAAoB,EAChC,IAAU,EACR,MAAc;YAJP,cAAS,GAAT,SAAS,CAAW;YAClB,gBAAW,GAAX,WAAW,CAAa;YACvB,WAAM,GAAN,MAAM,CAAc;YAChC,SAAI,GAAJ,IAAI,CAAM;YACR,WAAM,GAAN,MAAM,CAAQ;YA3BvD;;;eAGG;YAEO,qBAAgB,GAAqB,GAAG,EAAE,CAAC,KAAK,CAAC;QAuBxD,CAAC;QAEJ;;;;;;;;;;;;;;;;WAgBG;QACH,KAAK,CAAC,MAAM,CAAC,OAAuB;YAClC,IAAI;gBACF,MAAM,EAAC,OAAO,EAAE,QAAQ,EAAC,GAAG,OAAO,CAAC;gBACpC,uCAAuC;gBACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;gBACtD,IAAI,QAAQ,EAAE;oBACZ,qDAAqD;oBACrD,OAAO;iBACR;gBACD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;gBACtC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAE9C,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;gBAC/C,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;aAC7B;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;aAC7B;QACH,CAAC;KACF,CAAA;IA7DC;QADC,gBAAM,CAAC,eAAe,CAAC,iBAAiB,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC;;6DACD;IANhD,eAAe;QAwBvB,mBAAA,gBAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAA;QAClC,mBAAA,gBAAM,CAAC,eAAe,CAAC,YAAY,CAAC,CAAA;QACpC,mBAAA,gBAAM,CAAC,eAAe,CAAC,aAAa,CAAC,CAAA;QACrC,mBAAA,gBAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAA;QAC5B,mBAAA,gBAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAA;;OA5BtB,eAAe,CAmE3B;IAAD,sBAAC;KAAA;AAnEY,0CAAe"}