@loopback/rest 4.0.0-alpha.8 → 5.0.1

package/dist/router/openapi-path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-path.js","sourceRoot":"","sources":["../../src/router/openapi-path.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAEhE,mDAAqC;AAErC;;;;;;GAMG;AACH,MAAM,wBAAwB,GAAG,eAAe,CAAC;AACjD,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;AAEhD;;;GAGG;AACH,SAAgB,eAAe,CAAC,IAAI,GAAG,GAAG;IACxC,MAAM,MAAM,GAAG,sBAAK,CAAC,IAAI,CAAC,CAAC;IAC3B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,SAAS;QACxC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YACxB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,EAAE,EAAE;gBAC3C,MAAM,IAAI,KAAK,CACb,2BAA2B,IAAI,kBAAkB,IAAI,kBAAkB,IAAI,GAAG,CAC/E,CAAC;aACH;YACD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC5B,MAAM,IAAI,KAAK,CAAC,6CAA6C,IAAI,GAAG,CAAC,CAAC;aACvE;YACD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACxD,IAAI,CAAC,KAAK,EAAE;gBACV,MAAM,IAAI,KAAK,CACb,2BAA2B,KAAK,CAAC,MAAM,oBAAoB,IAAI,GAAG,CACnE,CAAC;aACH;YACD,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;gBAC5C,MAAM,IAAI,KAAK,CACb,wBAAwB,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,6BAA6B,IAAI,EAAE,CAC1F,CAAC;aACH;SACF;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AA5BD,0CA4BC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAAC,IAAY;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;AAC9C,CAAC;AAFD,4CAEC;AAED;;;GAGG;AACH,SAAgB,aAAa,CAAC,IAAY;IACxC,yEAAyE;IACzE,gBAAgB;IAChB,OAAO,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAC7E,CAAC;AAJD,sCAIC"}

package/dist/router/redirect-route.d.ts

@@ -0,0 +1,23 @@
+import { OperationObject, SchemasObject } from '@loopback/openapi-v3';
+import { ResolvedRoute, RouteEntry } from '.';
+import { RequestContext } from '../request-context';
+import { OperationArgs, OperationRetval, PathParameterValues } from '../types';
+export declare class RedirectRoute implements RouteEntry, ResolvedRoute {
+    readonly sourcePath: string;
+    readonly targetLocation: string;
+    readonly statusCode: number;
+    readonly pathParams: PathParameterValues;
+    readonly schemas: SchemasObject;
+    readonly verb: string;
+    readonly path: string;
+    readonly spec: OperationObject;
+    constructor(sourcePath: string, targetLocation: string, statusCode?: number);
+    invokeHandler({ response }: RequestContext, args: OperationArgs): Promise<OperationRetval>;
+    updateBindings(requestContext: RequestContext): void;
+    describe(): string;
+    /**
+     * type guard type checker for this class
+     * @param obj
+     */
+    static isRedirectRoute(obj: any): obj is RedirectRoute;
+}

package/dist/router/redirect-route.js

@@ -0,0 +1,50 @@
+"use strict";
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/rest
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedirectRoute = void 0;
+class RedirectRoute {
+    constructor(sourcePath, targetLocation, statusCode = 303) {
+        this.sourcePath = sourcePath;
+        this.targetLocation = targetLocation;
+        this.statusCode = statusCode;
+        // ResolvedRoute API
+        this.pathParams = [];
+        this.schemas = {};
+        // RouteEntry implementation
+        this.verb = 'get';
+        this.spec = {
+            description: 'LoopBack Redirect route',
+            'x-visibility': 'undocumented',
+            responses: {},
+        };
+        this.path = sourcePath;
+    }
+    async invokeHandler({ response }, args) {
+        response.redirect(this.statusCode, this.targetLocation);
+    }
+    updateBindings(requestContext) {
+        // no-op
+    }
+    describe() {
+        return `RedirectRoute from "${this.sourcePath}" to "${this.targetLocation}"`;
+    }
+    /**
+     * type guard type checker for this class
+     * @param obj
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static isRedirectRoute(obj) {
+        const redirectOptions = obj;
+        if ((redirectOptions === null || redirectOptions === void 0 ? void 0 : redirectOptions.targetLocation) &&
+            redirectOptions.spec &&
+            redirectOptions.spec.description === 'LoopBack Redirect route') {
+            return true;
+        }
+        return false;
+    }
+}
+exports.RedirectRoute = RedirectRoute;
+//# sourceMappingURL=redirect-route.js.map

package/dist/router/redirect-route.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redirect-route.js","sourceRoot":"","sources":["../../src/router/redirect-route.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAOhE,MAAa,aAAa;IAcxB,YACkB,UAAkB,EAClB,cAAsB,EACtB,aAAqB,GAAG;QAFxB,eAAU,GAAV,UAAU,CAAQ;QAClB,mBAAc,GAAd,cAAc,CAAQ;QACtB,eAAU,GAAV,UAAU,CAAc;QAhB1C,oBAAoB;QACX,eAAU,GAAwB,EAAE,CAAC;QACrC,YAAO,GAAkB,EAAE,CAAC;QAErC,4BAA4B;QACnB,SAAI,GAAW,KAAK,CAAC;QAErB,SAAI,GAAoB;YAC/B,WAAW,EAAE,yBAAyB;YACtC,cAAc,EAAE,cAAc;YAC9B,SAAS,EAAE,EAAE;SACd,CAAC;QAOA,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,EAAC,QAAQ,EAAiB,EAC1B,IAAmB;QAEnB,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1D,CAAC;IAED,cAAc,CAAC,cAA8B;QAC3C,QAAQ;IACV,CAAC;IAED,QAAQ;QACN,OAAO,uBAAuB,IAAI,CAAC,UAAU,SAAS,IAAI,CAAC,cAAc,GAAG,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACH,8DAA8D;IAC9D,MAAM,CAAC,eAAe,CAAC,GAAQ;QAC7B,MAAM,eAAe,GAAG,GAAoB,CAAC;QAC7C,IACE,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,cAAc;YAC/B,eAAe,CAAC,IAAI;YACpB,eAAe,CAAC,IAAI,CAAC,WAAW,KAAK,yBAAyB,EAC9D;YACA,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AArDD,sCAqDC"}

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

@@ -0,0 +1,25 @@
+import { RestRouterOptions } from './rest-router';
+import { ResolvedRoute, RouteEntry } from './route-entry';
+import { BaseRouter } from './router-base';
+import { Key } from 'path-to-regexp';
+/**
+ * Route entry with path-to-regexp
+ */
+interface RegExpRouteEntry extends RouteEntry {
+    regexp: RegExp;
+    keys: Key[];
+}
+/**
+ * Router implementation based on regexp matching
+ */
+export declare class RegExpRouter extends BaseRouter {
+    private routes;
+    private _sorted;
+    private _sort;
+    constructor(options?: RestRouterOptions);
+    protected addRouteWithPathVars(route: RouteEntry): void;
+    protected findRouteWithPathVars(verb: string, path: string): ResolvedRoute | undefined;
+    protected listRoutesWithPathVars(): RegExpRouteEntry[];
+    private _buildPathParams;
+}
+export {};

package/dist/router/regexp-router.js

@@ -0,0 +1,84 @@
+"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.RegExpRouter = void 0;
+const tslib_1 = require("tslib");
+const context_1 = require("@loopback/context");
+const util_1 = require("util");
+const keys_1 = require("../keys");
+const openapi_path_1 = require("./openapi-path");
+const route_entry_1 = require("./route-entry");
+const route_sort_1 = require("./route-sort");
+const router_base_1 = require("./router-base");
+const path_to_regexp_1 = require("path-to-regexp");
+const debug = require('debug')('loopback:rest:router:regexp');
+/**
+ * Router implementation based on regexp matching
+ */
+let RegExpRouter = /** @class */ (() => {
+    let RegExpRouter = class RegExpRouter extends router_base_1.BaseRouter {
+        constructor(options) {
+            super(options);
+            this.routes = [];
+        }
+        _sort() {
+            if (!this._sorted) {
+                this.routes.sort(route_sort_1.compareRoute);
+                this._sorted = true;
+            }
+        }
+        addRouteWithPathVars(route) {
+            const path = openapi_path_1.toExpressPath(route.path);
+            const keys = [];
+            const regexp = path_to_regexp_1.pathToRegexp(path, keys, {
+                strict: this.options.strict,
+                end: true,
+            });
+            const entry = Object.assign(route, { keys, regexp });
+            this.routes.push(entry);
+            this._sorted = false;
+        }
+        findRouteWithPathVars(verb, path) {
+            this._sort();
+            for (const r of this.routes) {
+                debug('trying endpoint %s', util_1.inspect(r, { depth: 5 }));
+                if (r.verb !== verb.toLowerCase()) {
+                    debug(' -> verb mismatch');
+                    continue;
+                }
+                const match = r.regexp.exec(path);
+                if (!match) {
+                    debug(' -> path mismatch');
+                    continue;
+                }
+                const pathParams = this._buildPathParams(r, match);
+                debug(' -> found with params: %j', pathParams);
+                return route_entry_1.createResolvedRoute(r, pathParams);
+            }
+            return undefined;
+        }
+        listRoutesWithPathVars() {
+            this._sort();
+            return this.routes;
+        }
+        _buildPathParams(route, pathMatch) {
+            const pathParams = {};
+            for (const ix in route.keys) {
+                const key = route.keys[ix];
+                const matchIndex = +ix + 1;
+                pathParams[key.name] = pathMatch[matchIndex];
+            }
+            return pathParams;
+        }
+    };
+    RegExpRouter = tslib_1.__decorate([
+        tslib_1.__param(0, context_1.inject(keys_1.RestBindings.ROUTER_OPTIONS, { optional: true })),
+        tslib_1.__metadata("design:paramtypes", [Object])
+    ], RegExpRouter);
+    return RegExpRouter;
+})();
+exports.RegExpRouter = RegExpRouter;
+//# sourceMappingURL=regexp-router.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"regexp-router.js","sourceRoot":"","sources":["../../src/router/regexp-router.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+CAAyC;AACzC,+BAA6B;AAC7B,kCAAqC;AAErC,iDAA6C;AAE7C,+CAA6E;AAC7E,6CAA0C;AAC1C,+CAAyC;AACzC,mDAAiD;AAEjD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,6BAA6B,CAAC,CAAC;AAU9D;;GAEG;AACH;IAAA,IAAa,YAAY,GAAzB,MAAa,YAAa,SAAQ,wBAAU;QAY1C,YAEE,OAA2B;YAE3B,KAAK,CAAC,OAAO,CAAC,CAAC;YAfT,WAAM,GAAuB,EAAE,CAAC;QAgBxC,CAAC;QAZO,KAAK;YACX,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;gBACjB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yBAAY,CAAC,CAAC;gBAC/B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;aACrB;QACH,CAAC;QASS,oBAAoB,CAAC,KAAiB;YAC9C,MAAM,IAAI,GAAG,4BAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACvC,MAAM,IAAI,GAAU,EAAE,CAAC;YACvB,MAAM,MAAM,GAAG,6BAAY,CAAC,IAAI,EAAE,IAAI,EAAE;gBACtC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;gBAC3B,GAAG,EAAE,IAAI;aACV,CAAC,CAAC;YACH,MAAM,KAAK,GAAqB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAC,IAAI,EAAE,MAAM,EAAC,CAAC,CAAC;YACrE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACxB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACvB,CAAC;QAES,qBAAqB,CAC7B,IAAY,EACZ,IAAY;YAEZ,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE;gBAC3B,KAAK,CAAC,oBAAoB,EAAE,cAAO,CAAC,CAAC,EAAE,EAAC,KAAK,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC;gBACpD,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,WAAW,EAAE,EAAE;oBACjC,KAAK,CAAC,mBAAmB,CAAC,CAAC;oBAC3B,SAAS;iBACV;gBAED,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAClC,IAAI,CAAC,KAAK,EAAE;oBACV,KAAK,CAAC,mBAAmB,CAAC,CAAC;oBAC3B,SAAS;iBACV;gBAED,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACnD,KAAK,CAAC,2BAA2B,EAAE,UAAU,CAAC,CAAC;gBAE/C,OAAO,iCAAmB,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;aAC3C;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QAES,sBAAsB;YAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QAEO,gBAAgB,CACtB,KAAuB,EACvB,SAA0B;YAE1B,MAAM,UAAU,GAAwB,EAAE,CAAC;YAC3C,KAAK,MAAM,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE;gBAC3B,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAC3B,MAAM,UAAU,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;gBAC3B,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;aAC9C;YACD,OAAO,UAAU,CAAC;QACpB,CAAC;KACF,CAAA;IA1EY,YAAY;QAapB,mBAAA,gBAAM,CAAC,mBAAY,CAAC,cAAc,EAAE,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC,CAAA;;OAb7C,YAAY,CA0ExB;IAAD,mBAAC;KAAA;AA1EY,oCAAY"}

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

@@ -0,0 +1,35 @@
+import { Request } from '../types';
+import { ResolvedRoute, RouteEntry } from './route-entry';
+export interface RestRouter {
+    /**
+     * Add a route to the router
+     * @param route - A route entry
+     */
+    add(route: RouteEntry): void;
+    /**
+     * Find a matching route for the given http request
+     * @param request - Http request
+     * @returns The resolved route, if not found, `undefined` is returned
+     */
+    find(request: Request): ResolvedRoute | undefined;
+    /**
+     * List all routes
+     */
+    list(): RouteEntry[];
+}
+export declare type RestRouterOptions = {
+    /**
+     * When `true` it uses trailing slash to match. (default: `false`)
+     *
+     * 1. `strict` is true:
+     * - request `/orders` matches route `/orders` but not `/orders/`
+     * - request `/orders/` matches route `/orders/` but not `/orders`
+     *
+     * 2. `strict` is false (default)
+     * - request `/orders` matches route `/orders` first and falls back to `/orders/`
+     * - request `/orders/` matches route `/orders/` first and falls back to `/orders`
+     *
+     * See `strict routing` at http://expressjs.com/en/4x/api.html#app
+     */
+    strict?: boolean;
+};

package/dist/{src/internal-types.js → router/rest-router.js}

@@ -1,7 +1,7 @@
 "use strict";
-// Copyright IBM Corp. 2017. All Rights Reserved.
+// 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 });
-//# sourceMappingURL=internal-types.js.map
+//# sourceMappingURL=rest-router.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"rest-router.js","sourceRoot":"","sources":["../../src/router/rest-router.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE"}

package/dist/router/route-entry.d.ts

@@ -0,0 +1,46 @@
+import { Context } from '@loopback/context';
+import { OperationObject, SchemasObject } from '@loopback/openapi-v3';
+import { OperationArgs, OperationRetval, PathParameterValues } from '../types';
+/**
+ * An entry in the routing table
+ */
+export interface RouteEntry {
+    /**
+     * http verb
+     */
+    readonly verb: string;
+    /**
+     * http path
+     */
+    readonly path: string;
+    /**
+     * OpenAPI operation spec
+     */
+    readonly spec: OperationObject;
+    /**
+     * Update bindings for the request context
+     * @param requestContext
+     */
+    updateBindings(requestContext: Context): void;
+    /**
+     * A handler to invoke the resolved controller method
+     * @param requestContext
+     * @param args
+     */
+    invokeHandler(requestContext: Context, args: OperationArgs): Promise<OperationRetval>;
+    describe(): string;
+}
+/**
+ * A route with path parameters resolved
+ */
+export interface ResolvedRoute extends RouteEntry {
+    readonly pathParams: PathParameterValues;
+    /**
+     * Server/application wide schemas shared by multiple routes,
+     * e.g. model schemas. This is a temporary workaround for
+     * missing support for $ref references, see
+     * https://github.com/strongloop/loopback-next/issues/435
+     */
+    readonly schemas: SchemasObject;
+}
+export declare function createResolvedRoute(route: RouteEntry, pathParams: PathParameterValues): ResolvedRoute;

package/dist/router/route-entry.js

@@ -0,0 +1,20 @@
+"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.createResolvedRoute = void 0;
+function createResolvedRoute(route, pathParams) {
+    return Object.create(route, {
+        pathParams: {
+            writable: false,
+            value: pathParams,
+        },
+        schemas: {
+            value: {},
+        },
+    });
+}
+exports.createResolvedRoute = createResolvedRoute;
+//# sourceMappingURL=route-entry.js.map

package/dist/router/route-entry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-entry.js","sourceRoot":"","sources":["../../src/router/route-entry.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAyDhE,SAAgB,mBAAmB,CACjC,KAAiB,EACjB,UAA+B;IAE/B,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;QAC1B,UAAU,EAAE;YACV,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,UAAU;SAClB;QACD,OAAO,EAAE;YACP,KAAK,EAAE,EAAE;SACV;KACF,CAAC,CAAC;AACL,CAAC;AAbD,kDAaC"}

package/dist/router/route-sort.d.ts

@@ -0,0 +1,7 @@
+import { RouteEntry } from './route-entry';
+/**
+ * Compare two routes by verb/path for sorting
+ * @param route1 - First route entry
+ * @param route2 - Second route entry
+ */
+export declare function compareRoute(route1: Pick<RouteEntry, 'verb' | 'path'>, route2: Pick<RouteEntry, 'verb' | 'path'>): number;

package/dist/router/route-sort.js

@@ -0,0 +1,75 @@
+"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.compareRoute = void 0;
+const path_to_regexp_1 = require("path-to-regexp");
+/**
+ * Sorting order for http verbs
+ */
+const HTTP_VERBS = {
+    post: 1,
+    put: 2,
+    patch: 3,
+    get: 4,
+    head: 5,
+    delete: 6,
+    options: 7,
+};
+/**
+ * Compare two routes by verb/path for sorting
+ * @param route1 - First route entry
+ * @param route2 - Second route entry
+ */
+function compareRoute(route1, route2) {
+    // First check the path tokens
+    const path1 = route1.path.replace(/{([^}]*)}(\/|$)/g, ':$1$2');
+    const path2 = route2.path.replace(/{([^}]*)}(\/|$)/g, ':$1$2');
+    const tokensForPath1 = toTokens(path1);
+    const tokensForPath2 = toTokens(path2);
+    const length = tokensForPath1.length > tokensForPath2.length
+        ? tokensForPath1.length
+        : tokensForPath2.length;
+    for (let i = 0; i < length; i++) {
+        const token1 = tokensForPath1[i];
+        const token2 = tokensForPath2[i];
+        if (token1 === token2)
+            continue;
+        if (token1 === undefined)
+            return 1;
+        if (token2 === undefined)
+            return -1;
+        if (token1 < token2)
+            return -1;
+        if (token1 > token2)
+            return 1;
+    }
+    // Then check verb
+    const verb1 = HTTP_VERBS[route1.verb.toLowerCase()] || HTTP_VERBS.get;
+    const verb2 = HTTP_VERBS[route2.verb.toLowerCase()] || HTTP_VERBS.get;
+    if (verb1 !== verb2)
+        return verb1 - verb2;
+    return 0;
+}
+exports.compareRoute = compareRoute;
+/**
+ *
+ * @param path - Parse a path template into tokens
+ */
+function toTokens(path) {
+    const tokens = [];
+    path_to_regexp_1.parse(path).forEach(p => {
+        if (typeof p === 'string') {
+            // The string can be /orders/count
+            tokens.push(...p.split('/').filter(Boolean));
+        }
+        else {
+            // Use `{}` for wildcard as they are larger than any other ascii chars
+            tokens.push(`{}`);
+        }
+    });
+    return tokens;
+}
+//# sourceMappingURL=route-sort.js.map

package/dist/router/route-sort.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-sort.js","sourceRoot":"","sources":["../../src/router/route-sort.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAEhE,mDAA4C;AAG5C;;GAEG;AACH,MAAM,UAAU,GAA6B;IAC3C,IAAI,EAAE,CAAC;IACP,GAAG,EAAE,CAAC;IACN,KAAK,EAAE,CAAC;IACR,GAAG,EAAE,CAAC;IACN,IAAI,EAAE,CAAC;IACP,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;CACX,CAAC;AAEF;;;;GAIG;AACH,SAAgB,YAAY,CAC1B,MAAyC,EACzC,MAAyC;IAEzC,8BAA8B;IAC9B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC/D,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAC/D,MAAM,cAAc,GAAY,QAAQ,CAAC,KAAK,CAAC,CAAC;IAChD,MAAM,cAAc,GAAY,QAAQ,CAAC,KAAK,CAAC,CAAC;IAEhD,MAAM,MAAM,GACV,cAAc,CAAC,MAAM,GAAG,cAAc,CAAC,MAAM;QAC3C,CAAC,CAAC,cAAc,CAAC,MAAM;QACvB,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC;IAE5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE;QAC/B,MAAM,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QACjC,IAAI,MAAM,KAAK,MAAM;YAAE,SAAS;QAChC,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,CAAC,CAAC;QACnC,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,CAAC,CAAC,CAAC;QACpC,IAAI,MAAM,GAAG,MAAM;YAAE,OAAO,CAAC,CAAC,CAAC;QAC/B,IAAI,MAAM,GAAG,MAAM;YAAE,OAAO,CAAC,CAAC;KAC/B;IACD,kBAAkB;IAClB,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC;IACtE,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC;IACtE,IAAI,KAAK,KAAK,KAAK;QAAE,OAAO,KAAK,GAAG,KAAK,CAAC;IAC1C,OAAO,CAAC,CAAC;AACX,CAAC;AA7BD,oCA6BC;AAED;;;GAGG;AACH,SAAS,QAAQ,CAAC,IAAY;IAC5B,MAAM,MAAM,GAAY,EAAE,CAAC;IAC3B,sBAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QACtB,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;YACzB,kCAAkC;YAClC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;SAC9C;aAAM;YACL,sEAAsE;YACtE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACnB;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -0,0 +1,42 @@
+import { Request } from '../types';
+import { ResolvedRoute, RouteEntry } from './route-entry';
+import { RestRouter, RestRouterOptions } from './rest-router';
+/**
+ * Base router implementation that only handles path without variables
+ */
+export declare abstract class BaseRouter implements RestRouter {
+    protected options: RestRouterOptions;
+    /**
+     * A map to optimize matching for routes without variables in the path
+     */
+    protected routesWithoutPathVars: {
+        [key: string]: RouteEntry;
+    };
+    constructor(options?: RestRouterOptions);
+    protected getKeyForRoute(route: RouteEntry): string;
+    add(route: RouteEntry): void;
+    protected getKeyForRequest(request: Request): string;
+    find(request: Request): ResolvedRoute | undefined;
+    private findRoute;
+    list(): RouteEntry[];
+    /**
+     * Build a key for verb+path as `/<verb>/<path>`
+     * @param verb - HTTP verb/method
+     * @param path - URL path
+     */
+    protected getKey(verb: string, path: string): string;
+    /**
+     * Add a route with path variables
+     * @param route - Route
+     */
+    protected abstract addRouteWithPathVars(route: RouteEntry): void;
+    /**
+     * Find a route with path variables for a given request
+     * @param request - Http request
+     */
+    protected abstract findRouteWithPathVars(verb: string, path: string): ResolvedRoute | undefined;
+    /**
+     * List routes with path variables
+     */
+    protected abstract listRoutesWithPathVars(): RouteEntry[];
+}

package/dist/router/router-base.js

@@ -0,0 +1,101 @@
+"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.BaseRouter = void 0;
+const openapi_path_1 = require("./openapi-path");
+const route_entry_1 = require("./route-entry");
+const route_sort_1 = require("./route-sort");
+/**
+ * Base router implementation that only handles path without variables
+ */
+class BaseRouter {
+    constructor(options = { strict: false }) {
+        this.options = options;
+        /**
+         * A map to optimize matching for routes without variables in the path
+         */
+        this.routesWithoutPathVars = {};
+    }
+    getKeyForRoute(route) {
+        return this.getKey(route.verb, route.path);
+    }
+    add(route) {
+        if (!openapi_path_1.getPathVariables(route.path)) {
+            const key = this.getKeyForRoute(route);
+            this.routesWithoutPathVars[key] = route;
+        }
+        else {
+            this.addRouteWithPathVars(route);
+        }
+    }
+    getKeyForRequest(request) {
+        return this.getKey(request.method, request.path);
+    }
+    find(request) {
+        if (this.options.strict) {
+            return this.findRoute(request.method, request.path);
+        }
+        // Non-strict mode
+        let path = request.path;
+        // First try the exact match
+        const route = this.findRoute(request.method, path);
+        if (route || path === '/')
+            return route;
+        if (path.endsWith('/')) {
+            // Fall back to the path without trailing slash
+            path = path.substring(0, path.length - 1);
+        }
+        else {
+            // Fall back to the path with trailing slash
+            path = path + '/';
+        }
+        return this.findRoute(request.method, path);
+    }
+    findRoute(verb, path) {
+        const key = this.getKey(verb, path);
+        const route = this.routesWithoutPathVars[key];
+        if (route)
+            return route_entry_1.createResolvedRoute(route, {});
+        else
+            return this.findRouteWithPathVars(verb, path);
+    }
+    list() {
+        let routes = Object.values(this.routesWithoutPathVars);
+        routes = routes.concat(this.listRoutesWithPathVars());
+        // Sort the routes so that they show up in OpenAPI spec in order
+        return routes.sort(route_sort_1.compareRoute);
+    }
+    /**
+     * Build a key for verb+path as `/<verb>/<path>`
+     * @param verb - HTTP verb/method
+     * @param path - URL path
+     */
+    getKey(verb, path) {
+        verb = normalizeVerb(verb);
+        path = normalizePath(path);
+        return `/${verb}${path}`;
+    }
+}
+exports.BaseRouter = BaseRouter;
+/**
+ * Normalize http verb to lowercase
+ * @param verb - Http verb
+ */
+function normalizeVerb(verb) {
+    // Use lower case, default to `get`
+    return (verb === null || verb === void 0 ? void 0 : verb.toLowerCase()) || 'get';
+}
+/**
+ * Normalize path to make sure it starts with `/`
+ * @param path - Path
+ */
+function normalizePath(path) {
+    // Prepend `/` if needed
+    path = path || '/';
+    path = path.startsWith('/') ? path : `/${path}`;
+    return path;
+}
+//# sourceMappingURL=router-base.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"router-base.js","sourceRoot":"","sources":["../../src/router/router-base.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAGhE,iDAAgD;AAChD,+CAA6E;AAC7E,6CAA0C;AAG1C;;GAEG;AACH,MAAsB,UAAU;IAM9B,YAAsB,UAA6B,EAAC,MAAM,EAAE,KAAK,EAAC;QAA5C,YAAO,GAAP,OAAO,CAAqC;QALlE;;WAEG;QACO,0BAAqB,GAAgC,EAAE,CAAC;IAEG,CAAC;IAE5D,cAAc,CAAC,KAAiB;QACxC,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,GAAG,CAAC,KAAiB;QACnB,IAAI,CAAC,+BAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YACjC,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACvC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;SACzC;aAAM;YACL,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;SAClC;IACH,CAAC;IAES,gBAAgB,CAAC,OAAgB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,CAAC,OAAgB;QACnB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACvB,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;SACrD;QACD,kBAAkB;QAClB,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACxB,4BAA4B;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACnD,IAAI,KAAK,IAAI,IAAI,KAAK,GAAG;YAAE,OAAO,KAAK,CAAC;QACxC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACtB,+CAA+C;YAC/C,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SAC3C;aAAM;YACL,4CAA4C;YAC5C,IAAI,GAAG,IAAI,GAAG,GAAG,CAAC;SACnB;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAEO,SAAS,CAAC,IAAY,EAAE,IAAY;QAC1C,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI,KAAK;YAAE,OAAO,iCAAmB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;;YAC5C,OAAO,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACrD,CAAC;IAED,IAAI;QACF,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACvD,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QACtD,gEAAgE;QAChE,OAAO,MAAM,CAAC,IAAI,CAAC,yBAAY,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAC,IAAY,EAAE,IAAY;QACzC,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;QAC3B,OAAO,IAAI,IAAI,GAAG,IAAI,EAAE,CAAC;IAC3B,CAAC;CAsBF;AAzFD,gCAyFC;AAED;;;GAGG;AACH,SAAS,aAAa,CAAC,IAAY;IACjC,mCAAmC;IACnC,OAAO,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,OAAM,KAAK,CAAC;AACtC,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CAAC,IAAY;IACjC,wBAAwB;IACxB,IAAI,GAAG,IAAI,IAAI,GAAG,CAAC;IACnB,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;IAChD,OAAO,IAAI,CAAC;AACd,CAAC"}

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

@@ -0,0 +1,3 @@
+import { OpenApiSpec } from '@loopback/openapi-v3';
+export declare type RouterSpec = Pick<OpenApiSpec, 'paths' | 'components' | 'tags'>;
+export declare function assignRouterSpec(target: RouterSpec, additions: RouterSpec): void;

package/dist/router/router-spec.js

@@ -0,0 +1,40 @@
+"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.assignRouterSpec = void 0;
+function assignRouterSpec(target, additions) {
+    if (additions.components) {
+        if (!target.components)
+            target.components = {};
+        for (const key in additions.components) {
+            if (!target.components[key])
+                target.components[key] = {};
+            Object.assign(target.components[key], additions.components[key]);
+        }
+    }
+    for (const url in additions.paths) {
+        if (!(url in target.paths))
+            target.paths[url] = {};
+        for (const verbOrKey in additions.paths[url]) {
+            // routes registered earlier takes precedence
+            if (verbOrKey in target.paths[url])
+                continue;
+            target.paths[url][verbOrKey] = additions.paths[url][verbOrKey];
+        }
+    }
+    if (additions.tags && additions.tags.length > 0) {
+        if (!target.tags)
+            target.tags = [];
+        for (const tag of additions.tags) {
+            // tags defined earlier take precedence
+            if (target.tags.some(t => t.name === tag.name))
+                continue;
+            target.tags.push(tag);
+        }
+    }
+}
+exports.assignRouterSpec = assignRouterSpec;
+//# sourceMappingURL=router-spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"router-spec.js","sourceRoot":"","sources":["../../src/router/router-spec.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAMhE,SAAgB,gBAAgB,CAAC,MAAkB,EAAE,SAAqB;IACxE,IAAI,SAAS,CAAC,UAAU,EAAE;QACxB,IAAI,CAAC,MAAM,CAAC,UAAU;YAAE,MAAM,CAAC,UAAU,GAAG,EAAE,CAAC;QAC/C,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,UAAU,EAAE;YACtC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;YACzD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;SAClE;KACF;IAED,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,KAAK,EAAE;QACjC,IAAI,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC;YAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;QACnD,KAAK,MAAM,SAAS,IAAI,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YAC5C,6CAA6C;YAC7C,IAAI,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;gBAAE,SAAS;YAC7C,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC;SAChE;KACF;IAED,IAAI,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QAC/C,IAAI,CAAC,MAAM,CAAC,IAAI;YAAE,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;QACnC,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE;YAChC,uCAAuC;YACvC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC;gBAAE,SAAS;YACzD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACvB;KACF;AACH,CAAC;AA1BD,4CA0BC"}

package/dist/router/routing-table.d.ts

@@ -0,0 +1,32 @@
+import { ControllerSpec, PathObject } from '@loopback/openapi-v3';
+import { Request } from '../types';
+import { ControllerClass, ControllerFactory } from './controller-route';
+import { ExternalExpressRoutes } from './external-express-routes';
+import { RestRouter } from './rest-router';
+import { ResolvedRoute, RouteEntry } from './route-entry';
+/**
+ * Routing table
+ */
+export declare class RoutingTable {
+    private readonly _router;
+    private _externalRoutes?;
+    constructor(_router?: RestRouter, _externalRoutes?: ExternalExpressRoutes | undefined);
+    /**
+     * Register a controller as the route
+     * @param spec
+     * @param controllerCtor
+     * @param controllerFactory
+     */
+    registerController<T>(spec: ControllerSpec, controllerCtor: ControllerClass<T>, controllerFactory?: ControllerFactory<T>): void;
+    /**
+     * Register a route
+     * @param route - A route entry
+     */
+    registerRoute(route: RouteEntry): void;
+    describeApiPaths(): PathObject;
+    /**
+     * Map a request to a route
+     * @param request
+     */
+    find(request: Request): ResolvedRoute;
+}