@arabesque/middleware-http-router 1.0.0-alpha.0 → 1.0.0-alpha.1

package/index.cjs

@@ -0,0 +1,89 @@
+'use strict';
+
+var logicMiddlewares = require('@arabesque/logic-middlewares');
+
+const createRouteFactory = (log) => {
+    const createRoute = (pattern, handler, callback) => {
+        const subRoutes = [];
+        if (callback) {
+            callback((subPattern, handler, next) => {
+                const subRoute = createRoute(`${pattern}${subPattern}`, handler, next);
+                subRoutes.push(subRoute);
+                return subRoute;
+            });
+        }
+        const regularExpressionParts = [];
+        const parameterNames = [];
+        const patternParts = pattern.split('/');
+        for (const part of patternParts) {
+            let partPattern;
+            let parameterPart = null;
+            if (part.startsWith(':')) {
+                partPattern = `(.[^\\?]*)`;
+                parameterPart = part;
+            }
+            else if (part.startsWith('#')) {
+                partPattern = `(\\d+)`;
+                parameterPart = part;
+            }
+            else {
+                partPattern = part;
+            }
+            if (parameterPart !== null) {
+                parameterNames.push(parameterPart.substring(1));
+            }
+            regularExpressionParts.push(partPattern);
+        }
+        const regularExpression = new RegExp(`^${regularExpressionParts.join('\\/')}`);
+        const queryStringPattern = /\?+(.*)$/;
+        const subRoutesMiddleware = subRoutes.length > 0 ? logicMiddlewares.createORMiddleware(...subRoutes) : null;
+        return ((context, next) => {
+            const { request } = context;
+            let uri;
+            let queryString;
+            const queryStringMatches = request.uri.match(queryStringPattern);
+            if (queryStringMatches !== null) {
+                uri = request.uri.substring(0, queryStringMatches.index);
+                queryString = queryStringMatches[1];
+            }
+            else {
+                uri = request.uri;
+                queryString = null;
+            }
+            const matches = regularExpression.exec(uri);
+            if ((matches !== null) && (subRoutesMiddleware || (matches[0] === matches.input))) {
+                log === null || log === void 0 ? void 0 : log("match", context.request, pattern, subRoutes.length > 0 ? "node" : "leaf");
+                /**
+                 * If there are sub-routes, the next middleware is the sub-routes one.
+                 * If there is no sub-route, the next middleware is the one received as argument.
+                 */
+                const actualNext = subRoutesMiddleware ? (context) => {
+                    return subRoutesMiddleware(context, next);
+                } : next;
+                const parameters = {};
+                const numberOfParameters = parameterNames.length;
+                for (let i = 0; i < numberOfParameters; i++) {
+                    const parameterValue = matches[i + 1];
+                    const parameterName = parameterNames[i];
+                    parameters[parameterName] = parameterValue;
+                }
+                const queryParameters = new URLSearchParams(queryString || '');
+                if (handler) {
+                    const handlerContext = {
+                        request: Object.assign(Object.assign({}, context.request), { parameters,
+                            queryParameters }),
+                        response: context.response
+                    };
+                    return Promise.resolve(handler(handlerContext)).then(actualNext);
+                }
+                return actualNext(context);
+            }
+            return Promise.resolve(context);
+        });
+    };
+    return createRoute;
+};
+const createRoute = createRouteFactory();
+
+exports.createRoute = createRoute;
+exports.createRouteFactory = createRouteFactory;

package/index.d.mts

@@ -0,0 +1 @@
+export * from "./route.mjs";

package/index.mjs

@@ -0,0 +1,86 @@
+import { createORMiddleware } from '@arabesque/logic-middlewares';
+
+const createRouteFactory = (log) => {
+    const createRoute = (pattern, handler, callback) => {
+        const subRoutes = [];
+        if (callback) {
+            callback((subPattern, handler, next) => {
+                const subRoute = createRoute(`${pattern}${subPattern}`, handler, next);
+                subRoutes.push(subRoute);
+                return subRoute;
+            });
+        }
+        const regularExpressionParts = [];
+        const parameterNames = [];
+        const patternParts = pattern.split('/');
+        for (const part of patternParts) {
+            let partPattern;
+            let parameterPart = null;
+            if (part.startsWith(':')) {
+                partPattern = `(.[^\\?]*)`;
+                parameterPart = part;
+            }
+            else if (part.startsWith('#')) {
+                partPattern = `(\\d+)`;
+                parameterPart = part;
+            }
+            else {
+                partPattern = part;
+            }
+            if (parameterPart !== null) {
+                parameterNames.push(parameterPart.substring(1));
+            }
+            regularExpressionParts.push(partPattern);
+        }
+        const regularExpression = new RegExp(`^${regularExpressionParts.join('\\/')}`);
+        const queryStringPattern = /\?+(.*)$/;
+        const subRoutesMiddleware = subRoutes.length > 0 ? createORMiddleware(...subRoutes) : null;
+        return ((context, next) => {
+            const { request } = context;
+            let uri;
+            let queryString;
+            const queryStringMatches = request.uri.match(queryStringPattern);
+            if (queryStringMatches !== null) {
+                uri = request.uri.substring(0, queryStringMatches.index);
+                queryString = queryStringMatches[1];
+            }
+            else {
+                uri = request.uri;
+                queryString = null;
+            }
+            const matches = regularExpression.exec(uri);
+            if ((matches !== null) && (subRoutesMiddleware || (matches[0] === matches.input))) {
+                log === null || log === void 0 ? void 0 : log("match", context.request, pattern, subRoutes.length > 0 ? "node" : "leaf");
+                /**
+                 * If there are sub-routes, the next middleware is the sub-routes one.
+                 * If there is no sub-route, the next middleware is the one received as argument.
+                 */
+                const actualNext = subRoutesMiddleware ? (context) => {
+                    return subRoutesMiddleware(context, next);
+                } : next;
+                const parameters = {};
+                const numberOfParameters = parameterNames.length;
+                for (let i = 0; i < numberOfParameters; i++) {
+                    const parameterValue = matches[i + 1];
+                    const parameterName = parameterNames[i];
+                    parameters[parameterName] = parameterValue;
+                }
+                const queryParameters = new URLSearchParams(queryString || '');
+                if (handler) {
+                    const handlerContext = {
+                        request: Object.assign(Object.assign({}, context.request), { parameters,
+                            queryParameters }),
+                        response: context.response
+                    };
+                    return Promise.resolve(handler(handlerContext)).then(actualNext);
+                }
+                return actualNext(context);
+            }
+            return Promise.resolve(context);
+        });
+    };
+    return createRoute;
+};
+const createRoute = createRouteFactory();
+
+export { createRoute, createRouteFactory };

package/package.json

@@ -1,44 +1 @@
-{
-  "name": "@arabesque/middleware-http-router",
-  "description": "",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "prebuild": "rimraf dist",
-    "prebuild:test": "rimraf dist",
-    "prepack": "npm run build",
-    "pretest": "npm run build:test",
-    "build": "tsc --project src --declaration true --outDir dist",
-    "build:test": "tsc --project test --outDir dist",
-    "cover": "nyc --include 'dist/src/**' --exclude-after-remap=false --all=true --branches=100 --functions=100 --lines=100 --statements=100 --reporter html --reporter text npm t",
-    "test": "exit 0"
-  },
-  "keywords": [
-    "arabesque",
-    "middleware",
-    "router",
-    "http"
-  ],
-  "author": "Eric MORAND <eric.morand@gmail.com>",
-  "license": "MIT License",
-  "devDependencies": {
-    "@arabesque/core": "^0.3.0",
-    "@arabesque/listener-http": "^0.1.1",
-    "@types/node": "^16.18.3",
-    "@types/route-parser": "^0.1.4",
-    "nyc": "^15.1.0",
-    "rimraf": "^3.0.2",
-    "tape": "^5.6.1",
-    "typescript": "^4.9.3"
-  },
-  "dependencies": {
-    "@arabesque/logic-middlewares": "^0.2.0",
-    "route-parser": "^0.0.5"
-  },
-  "version": "1.0.0-alpha.0"
-}
+{"name":"@arabesque/middleware-http-router","version":"1.0.0-alpha.1","description":"An Arabesque Middleware to route HTTP requests","types":"index.d.mts","keywords":["arabesque","middleware","router","http","https"],"author":"Eric MORAND <eric.morand@gmail.com>","license":"MIT License","repository":"https://gitlab.com/arabesque/middleware-http-router","readme":"https://gitlab.com/arabesque/middleware-http-router/README.md","exports":{"import":"./index.mjs","require":"./index.cjs","types":"./index.d.mts"},"dependencies":{"@arabesque/logic-middlewares":"^1.0.0-beta.1"}}

package/route.d.mts

@@ -0,0 +1,32 @@
+import type { Middleware } from "@arabesque/core";
+import type { Context, ContextRequest } from "@arabesque/listener-http";
+type StringParameter = `:${string}`;
+type NumberParameter = `#${string}`;
+type ParameterName<T extends string> = T extends `${':' | '#'}${infer Name}` ? `${Name}` : void;
+type ParameterType<T extends string> = (T extends StringParameter ? string : (T extends NumberParameter ? number : never));
+type CreateRecord<T extends string, V extends string | void> = V extends string ? {
+    [key in V]: ParameterType<T>;
+} : {};
+export type SplitAsRecord<T extends string> = (T extends `/${infer Part extends string}/${infer Rest extends string}` ? CreateRecord<Part, ParameterName<Part>> & SplitAsRecord<`/${Rest}`> : (T extends `/${infer LastPart extends string}` ? CreateRecord<LastPart, ParameterName<LastPart>> : never));
+export type Parameters = Record<string, string | number>;
+export interface QueryParameters {
+    get(key: string): string | null;
+    getAll(key: string): Array<string>;
+    has(key: string): boolean;
+    entries(): Iterable<[string, string]>;
+    readonly size: number;
+}
+export interface HandlerContext<P extends Parameters> extends Context<ContextRequest & {
+    readonly parameters: P;
+    readonly queryParameters: QueryParameters;
+}> {
+}
+export type RouteHandler<P extends Parameters = {}> = (context: HandlerContext<P>) => Context | Promise<Context>;
+export type Route = Middleware<Context>;
+export type RouteFactory<Prefix extends string> = <Pattern extends string>(pattern: Pattern, handler: RouteHandler<SplitAsRecord<`${Prefix}${Pattern}`>> | null, callback?: (createRoute: RouteFactory<`${Prefix}${Pattern}`>) => void) => Route;
+export interface Logger {
+    (eventName: "match", request: Context["request"], pattern: string, type: "leaf" | "node"): void;
+}
+export declare const createRouteFactory: (log?: Logger) => RouteFactory<"">;
+export declare const createRoute: RouteFactory<"">;
+export {};

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export { createRoute, RouteHandler } from "./lib/route";
-export { createRouter } from "./lib/router";
-export type { HTTPMethod } from "./lib/http-method";

package/dist/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-exports.__esModule = true;
-exports.createRouter = exports.createRoute = void 0;
-var route_1 = require("./lib/route");
-__createBinding(exports, route_1, "createRoute");
-var router_1 = require("./lib/router");
-__createBinding(exports, router_1, "createRouter");

package/dist/lib/http-method.d.ts

@@ -1 +0,0 @@
-export type HTTPMethod = 'CONNECT ' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS ' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';

package/dist/lib/http-method.js

@@ -1,2 +0,0 @@
-"use strict";
-exports.__esModule = true;

package/dist/lib/route.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="node" />
-import type { Context } from "@arabesque/listener-http";
-import type { Middleware } from "@arabesque/core";
-import type { HTTPMethod } from "./http-method";
-export type RouteHandler<Context, Parameters extends Record<string, any>> = (context: Context, parameters: Parameters) => Promise<void>;
-export declare const createRoute: <C extends Context<import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>>, P extends Record<string, string>>(method: HTTPMethod, specification: string, handler: RouteHandler<C, P>) => Middleware<C>;

package/dist/lib/route.js

@@ -1,29 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.createRoute = void 0;
-var url_1 = require("url");
-var RouteParser = require("route-parser");
-var http_1 = require("http");
-var isAnHTTPMethod = function (candidate) {
-    return http_1.METHODS.includes(candidate);
-};
-var createRoute = function (method, specification, handler) {
-    return function (context, next) {
-        var message = context.message;
-        if (message.url && context.message.method && isAnHTTPMethod(context.message.method) && (context.message.method === method)) {
-            var pathname = (0, url_1.parse)(message.url).pathname;
-            if (pathname !== null) {
-                var routeParser = new RouteParser(specification);
-                var parameters = routeParser.match(pathname);
-                if (parameters !== false) {
-                    return handler(context, parameters)
-                        .then(function () {
-                        return next(context);
-                    });
-                }
-            }
-        }
-        return Promise.resolve(context);
-    };
-};
-exports.createRoute = createRoute;

package/dist/lib/router.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="node" />
-import type { Middleware } from "@arabesque/core";
-import type { Context } from "@arabesque/listener-http";
-export declare const createRouter: <C extends Context<import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>>>(...routes: Middleware<C>[]) => Middleware<C>;

package/dist/lib/router.js

@@ -1,12 +0,0 @@
-"use strict";
-exports.__esModule = true;
-exports.createRouter = void 0;
-var logic_middlewares_1 = require("@arabesque/logic-middlewares");
-var createRouter = function () {
-    var routes = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        routes[_i] = arguments[_i];
-    }
-    return logic_middlewares_1.createORMiddleware.apply(void 0, routes);
-};
-exports.createRouter = createRouter;