htmx-router 1.0.0-alpha.3 → 1.0.0-alpha.4

package/bin/cli/index.js

@@ -11,6 +11,7 @@ await writeFile(config.router.output, `/*---------------------------------------
  * Generated by htmx-router                *
  * Warn: Any changes will be overwritten   *
 -------------------------------------------*/
+/* eslint-disable @typescript-eslint/no-explicit-any */
 
 import { GenericContext, RouteTree } from "htmx-router/bin/router";
 import { RegisterDynamic } from "htmx-router/bin/util/dynamic";

package/bin/client/index.js

@@ -83,6 +83,7 @@ function BuildClientManifest(type, imports) {
         + " * Generated by htmx-router                *\n"
         + " * Warn: Any changes will be overwritten   *\n"
         + "-------------------------------------------*/\n\n"
+        + "/* eslint-disable @typescript-eslint/no-explicit-any */\n"
         + "const client = {\n";
     const render = renderer[type];
     if (!render) {

package/bin/index.d.ts

@@ -5,4 +5,5 @@ import { Cookies, CookieOptions } from "./util/cookies.js";
 import { EventSourceConnection } from "./util/event-source.js";
 import { StyleClass } from './util/css.js';
 import { Endpoint } from './util/endpoint.js';
-export { CatchFunction, CookieOptions, Cookies, createRequestHandler, Endpoint, EventSourceConnection, GenericContext, RenderFunction, RouteContext, RouteModule, StyleClass, };
+import { redirect, text, json, refresh } from './response.js';
+export { CatchFunction, CookieOptions, Cookies, createRequestHandler, Endpoint, EventSourceConnection, GenericContext, RenderFunction, RouteContext, RouteModule, StyleClass, redirect, text, json, refresh };

package/bin/index.js

@@ -4,4 +4,5 @@ import { Cookies } from "./util/cookies.js";
 import { EventSourceConnection } from "./util/event-source.js";
 import { StyleClass } from './util/css.js';
 import { Endpoint } from './util/endpoint.js';
-export { Cookies, createRequestHandler, Endpoint, EventSourceConnection, GenericContext, RouteContext, StyleClass, };
+import { redirect, text, json, refresh } from './response.js';
+export { Cookies, createRequestHandler, Endpoint, EventSourceConnection, GenericContext, RouteContext, StyleClass, redirect, text, json, refresh };

package/bin/request/native.js

@@ -26,15 +26,7 @@ export async function Resolve(request, tree, config) {
     const fragments = x.split("/").slice(1);
     let response = await tree.resolve(fragments, ctx);
     if (response === null)
-        response = new Response("Not Found", { status: 404, statusText: "Not Found", headers: ctx.headers });
-    // Merge context headers
-    if (response.headers !== ctx.headers) {
-        for (const [key, value] of ctx.headers) {
-            if (response.headers.has(key))
-                continue;
-            response.headers.set(key, value);
-        }
-    }
+        response = new Response("No Route Found", { status: 404, statusText: "Not Found", headers: ctx.headers });
     // Merge cookie changes
     const headers = Object.fromEntries(ctx.headers);
     const cookies = ctx.cookie.export();
@@ -42,5 +34,17 @@ export async function Resolve(request, tree, config) {
         headers['set-cookie'] = cookies;
         response.headers.set("Set-Cookie", cookies[0]); // Response object doesn't support multi-header..[]
     }
+    // Merge context headers
+    if (response.headers !== ctx.headers) {
+        for (const [key, value] of response.headers) {
+            if (!headers[key]) {
+                headers[key] = value;
+                continue;
+            }
+            if (!Array.isArray(headers[key]))
+                headers[key] = [headers[key]];
+            headers[key].push(value);
+        }
+    }
     return { response, headers };
 }

package/bin/response.d.ts

@@ -0,0 +1,4 @@
+export declare function redirect(url: string, init?: ResponseInit): Response;
+export declare function text(text: string, init?: ResponseInit): Response;
+export declare function json(data: unknown, init?: ResponseInit): Response;
+export declare function refresh(init?: ResponseInit): Response;

package/bin/response.js

@@ -0,0 +1,33 @@
+export function redirect(url, init) {
+    init ||= {};
+    init.statusText ||= "Temporary Redirect";
+    init.status = 307;
+    const res = new Response("", init);
+    res.headers.set("X-Caught", "true");
+    res.headers.set("Location", url);
+    return res;
+}
+export function text(text, init) {
+    init ||= {};
+    init.statusText ||= "ok";
+    init.status = 200;
+    const res = new Response(text, init);
+    res.headers.set("Content-Type", "text/plain");
+    return res;
+}
+export function json(data, init) {
+    init ||= {};
+    init.statusText ||= "ok";
+    init.status = 200;
+    const res = new Response(JSON.stringify(data), init);
+    res.headers.set("Content-Type", "application/json");
+    return res;
+}
+export function refresh(init) {
+    init ||= {};
+    init.statusText ||= "ok";
+    init.status = 200;
+    const res = new Response("", init);
+    res.headers.set("HX-Refresh", "true");
+    return res;
+}

package/bin/router.d.ts

@@ -26,7 +26,7 @@ export declare class RouteLeaf {
     module: RouteModule<any>;
     constructor(module: RouteModule<any>);
     resolve(ctx: GenericContext): Promise<Response | null>;
-    error(ctx: GenericContext, e: unknown): Promise<Response | null>;
+    error(ctx: GenericContext, e: unknown): Promise<Response>;
     private renderWrapper;
 }
 export declare class RouteTree {
@@ -39,6 +39,7 @@ export declare class RouteTree {
     constructor(root?: boolean);
     ingest(path: string | string[], module: RouteModule<any>): void;
     resolve(fragments: string[], ctx: GenericContext): Promise<Response | null>;
+    private _resolve;
     private resolveIndex;
     private resolveNext;
     private resolveWild;

package/bin/router.js

@@ -55,10 +55,8 @@ export class RouteLeaf {
     }
     async error(ctx, e) {
         if (!this.module.error)
-            return null;
+            throw e;
         const res = await this.module.error(ctx, e);
-        if (res === null)
-            return null;
         if (res instanceof Response)
             return res;
         return ctx.render(res);
@@ -79,10 +77,7 @@ export class RouteLeaf {
             throw new Response("Method not Allowed", { status: 405, statusText: "Method not Allowed", headers: ctx.headers });
         }
         catch (e) {
-            if (this.module.error)
-                return await this.module.error(ctx, e);
-            else
-                throw e;
+            return await this.error(ctx, e);
         }
         return null;
     }
@@ -138,12 +133,29 @@ export class RouteTree {
         next.ingest(path, module);
     }
     async resolve(fragments, ctx) {
+        if (!this.slug)
+            return await this._resolve(fragments, ctx);
+        try {
+            return await this._resolve(fragments, ctx);
+        }
+        catch (e) {
+            return this.unwrap(ctx, e);
+        }
+    }
+    async _resolve(fragments, ctx) {
         let res = await this.resolveNative(fragments, ctx)
             || await this.resolveIndex(fragments, ctx)
             || await this.resolveNext(fragments, ctx)
             || await this.resolveWild(fragments, ctx)
             || await this.resolveSlug(fragments, ctx);
-        return this.unwrap(ctx, res);
+        if (res instanceof Response) {
+            if (100 <= res.status && res.status <= 399)
+                return res;
+            if (res.headers.has("X-Caught"))
+                return res;
+            this.unwrap(ctx, res);
+        }
+        return res;
     }
     async resolveIndex(fragments, ctx) {
         if (fragments.length > 0)
@@ -187,29 +199,13 @@ export class RouteTree {
         return await ResolveNatively(fragments, ctx);
     }
     async unwrap(ctx, res) {
-        if (!BadResponse(res))
-            return res;
         if (!this.slug)
-            return res;
-        if (res === null)
-            res = new Response("Not Found", { status: 404, statusText: "Not Found", headers: ctx.headers });
-        if (res.headers.has("X-Caught"))
-            return res;
+            throw res;
         const caught = await this.slug.error(ctx, res);
-        if (!caught)
-            return res;
         caught.headers.set("X-Caught", "true");
         return caught;
     }
 }
-function BadResponse(res) {
-    if (res === null)
-        return true;
-    if (res.status < 200)
-        return true;
-    if (res.status > 299)
-        return true;
-}
 async function ResolveNatively(fragments, ctx) {
     switch (fragments[1]) {
         case "dynamic": return dynamic._resolve(fragments, ctx);

package/bin/types.d.ts

@@ -1,6 +1,6 @@
 import { ParameterShaper } from "./util/parameters.js";
 import { RouteContext } from "./router.js";
-export type CatchFunction<T> = (args: T, err: unknown) => Promise<Response | JSX.Element | null>;
+export type CatchFunction<T> = (args: T, err: unknown) => Promise<Response | JSX.Element>;
 export type RenderFunction<T> = (args: T) => Promise<Response | JSX.Element | null>;
 export type RouteModule<T extends ParameterShaper> = {
     parameters?: T;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "htmx-router",
-	"version": "1.0.0-alpha.3",
+	"version": "1.0.0-alpha.4",
 	"description": "A simple SSR framework with dynamic+client islands",
 	"keywords": ["htmx", "router", ""],
 	"main": "./bin/index.js",