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

package/index.cjs

@@ -2,7 +2,10 @@
 
 var logicMiddlewares = require('@arabesque/logic-middlewares');
 
-const createRouteFactory = (log) => {
+/**
+ * Returns a Router - i.e. a Route which matches everything and has no handler.
+ */
+const createRouter = (callback, log) => {
     const createRoute = (pattern, handler, callback) => {
         const subRoutes = [];
         if (callback) {
@@ -69,21 +72,21 @@ const createRouteFactory = (log) => {
                 }
                 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);
+                    const handlerContext = Object.assign(Object.assign({}, context), { route: {
+                            pattern,
+                            parameters,
+                            queryParameters
+                        } });
+                    return Promise.resolve(handler(handlerContext)).then((context) => {
+                        return actualNext(Object.assign(Object.assign({}, context), { request: handlerContext.request }));
+                    });
                 }
                 return actualNext(context);
             }
             return Promise.resolve(context);
         });
     };
-    return createRoute;
+    return createRoute('', null, callback);
 };
-const createRoute = createRouteFactory();
 
-exports.createRoute = createRoute;
-exports.createRouteFactory = createRouteFactory;
+exports.createRouter = createRouter;

package/index.d.mts

@@ -1 +1,44 @@
-export * from "./route.mjs";
+import type { Middleware } from "@arabesque/core";
+import type { Context } 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>;
+} : {};
+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 RouterContext<Data extends Record<string, any>> extends Context {
+    readonly data: Data;
+}
+export interface RouteHandlerContext<P extends Parameters, Data extends Record<string, any>> extends RouterContext<Data> {
+    /**
+     * The route that was matched by the request uri.
+     */
+    readonly route: {
+        readonly parameters: P;
+        readonly pattern: string;
+        readonly queryParameters: QueryParameters;
+    };
+}
+export type RouteHandler<P extends Parameters = {}, Data extends Record<string, any> = {}> = (context: RouteHandlerContext<P, Data>) => Pick<typeof context, "response" | "data"> | Promise<Pick<typeof context, "response" | "data">>;
+export type Route<Data extends Record<string, any>> = Middleware<RouterContext<Data>>;
+export type RoutePattern<Prefix extends string, Pattern extends string> = `${Prefix}${Pattern}`;
+export type RouteParameters<P extends RoutePattern<string, string>> = SplitAsRecord<P>;
+export type RouteFactory<Prefix extends string, Data extends Record<string, any>> = <Pattern extends string>(pattern: Pattern, handler: RouteHandler<RouteParameters<RoutePattern<Prefix, Pattern>>, Data> | null, callback?: (createRoute: RouteFactory<RoutePattern<Prefix, Pattern>, Data>) => void) => Route<Data>;
+export interface Logger {
+    (eventName: "match", request: Context["request"], pattern: string, type: "leaf" | "node"): void;
+}
+/**
+ * Returns a Router - i.e. a Route which matches everything and has no handler.
+ */
+export declare const createRouter: <Data extends Record<string, any>>(callback: (createRoute: RouteFactory<"", Data>) => void, log?: Logger) => Route<Data>;
+export {};

package/index.mjs

@@ -1,6 +1,9 @@
 import { createORMiddleware } from '@arabesque/logic-middlewares';
 
-const createRouteFactory = (log) => {
+/**
+ * Returns a Router - i.e. a Route which matches everything and has no handler.
+ */
+const createRouter = (callback, log) => {
     const createRoute = (pattern, handler, callback) => {
         const subRoutes = [];
         if (callback) {
@@ -67,20 +70,21 @@ const createRouteFactory = (log) => {
                 }
                 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);
+                    const handlerContext = Object.assign(Object.assign({}, context), { route: {
+                            pattern,
+                            parameters,
+                            queryParameters
+                        } });
+                    return Promise.resolve(handler(handlerContext)).then((context) => {
+                        return actualNext(Object.assign(Object.assign({}, context), { request: handlerContext.request }));
+                    });
                 }
                 return actualNext(context);
             }
             return Promise.resolve(context);
         });
     };
-    return createRoute;
+    return createRoute('', null, callback);
 };
-const createRoute = createRouteFactory();
 
-export { createRoute, createRouteFactory };
+export { createRouter };

package/package.json

@@ -1 +1 @@
-{"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"}}
+{"name":"@arabesque/middleware-http-router","version":"1.0.0-alpha.2","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

@@ -1,32 +0,0 @@
-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 {};