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

package/bin/client/index.d.ts

@@ -1,7 +0,0 @@
-/**
- * Builds the SSR and client side mounter for client components
- */
-export declare function GenerateClient(config: {
-    adapter: string;
-    source: string;
-}, force?: boolean): Promise<void>;

package/bin/client/index.js

@@ -1,126 +0,0 @@
-/**
- * Builds the SSR and client side mounter for client components
- */
-import { readFile, writeFile } from "fs/promises";
-import { init, parse } from "es-module-lexer";
-import { QuickHash } from "../util/hash.js";
-import { CutString } from "../helper.js";
-const pivot = `\n// DO NOT EDIT BELOW THIS LINE\n`;
-export async function GenerateClient(config, force = false) {
-    const file = await readFile(config.source, "utf8");
-    const [source, history] = CutString(file, pivot);
-    const hash = QuickHash(source);
-    if (!force && ExtractHash(history) === hash)
-        return;
-    await init;
-    const imported = ParseImports(source);
-    await Promise.all([
-        writeFile(config.source, source
-            + pivot
-            + `// hash: ${hash}\n`
-            + BuildClientServer(imported)),
-        writeFile(CutString(config.source, ".", -1)[0] + ".manifest.tsx", BuildClientManifest(config.adapter, imported))
-    ]);
-}
-function ParseImports(source) {
-    const parsed = parse(source)[0];
-    const out = [];
-    for (const imported of parsed) {
-        if (imported.a !== -1)
-            continue;
-        if (imported.t !== 1)
-            continue;
-        const href = source.slice(imported.s, imported.e);
-        const front = source.slice(imported.ss, imported.s);
-        const start = front.indexOf("{");
-        if (start === -1) {
-            const middle = CutString(CutString(front, "import")[1], "from", -1)[0];
-            out.push({ mapping: ExtractName(middle), href });
-            continue;
-        }
-        const end = front.lastIndexOf("}");
-        const segments = front.slice(start + 1, end).split(",");
-        out.push({ mapping: segments.map(ExtractName), href });
-    }
-    return out;
-}
-function BuildClientServer(imported) {
-    const names = new Array();
-    for (const imp of imported) {
-        if (Array.isArray(imp.mapping))
-            names.push(...imp.mapping.map(x => x.name));
-        else
-            names.push(imp.mapping.name);
-    }
-    let out = `import { StyleClass } from "htmx-router";\n`
-        + `const island = new StyleClass("i", ".this{display:contents;}\\n").name;\n\n`
-        + "type FirstArg<T> = T extends (arg: infer U, ...args: any[]) => any ? U : never;\n"
-        + "function mount(name: string, data: string, ssr?: JSX.Element) {\n"
-        + "\treturn (<>\n"
-        + `\t\t<div className={island}>{ssr}</div>\n`
-        + "\t\t<script>{`Router.mountAboveWith('${name}', ${data})`}</script>\n"
-        + "\t</>);\n"
-        + "}\n"
-        + "\n"
-        + "const Client = {\n";
-    for (const name of names) {
-        out += `\t${name}: function(props: FirstArg<typeof ${name}> & { children?: JSX.Element }) {\n`
-            + `\t\tconst { children, ...rest } = props;\n`
-            + `\t\treturn mount("${name}", JSON.stringify(rest), children);\n`
-            + `\t},\n`;
-    }
-    out += "}\nexport default Client;\n\n"
-        + `import { __RebuildClient__ } from "htmx-router/bin/client/watch.js";\n`
-        + `__RebuildClient__();`;
-    return out;
-}
-const renderer = {
-    react: '\t\tconst r = await import("react-dom/client");\n'
-        + "\t\tr.createRoot(element).render(<C {...props} />);\n"
-};
-function BuildClientManifest(type, imports) {
-    let out = "/*------------------------------------------\n"
-        + " * 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) {
-        console.error(`Unsupported client adapter ${type}`);
-        process.exit(1);
-    }
-    for (const imported of imports) {
-        if (Array.isArray(imported.mapping)) {
-            for (const map of imported.mapping) {
-                out += `\t${map.name}: async (element: HTMLElement, props: any) => {\n`
-                    + `\t\tconst C = (await import("${imported.href}")).${map.original};\n`
-                    + render
-                    + `\t},\n`;
-            }
-        }
-        else {
-            out += `\t${imported.mapping.name}: async (element: HTMLElement, props: any) => {\n`
-                + `\t\tconst C = (await import("${imported.href}")).default;\n`
-                + render
-                + `\t},\n`;
-        }
-    }
-    out += "}\nexport default client;\n"
-        + "(window as any).CLIENT = client;";
-    return out;
-}
-function ExtractName(str) {
-    const parts = CutString(str, "as");
-    if (parts[1].length !== 0)
-        return { name: parts[1].trim(), original: parts[0].trim() };
-    const name = parts[0].trim();
-    return { name, original: name };
-}
-function ExtractHash(source) {
-    const regex = /\/\/\s+hash\s*:\s*(\w+)/;
-    const match = source.match(regex);
-    if (match)
-        return match[1] || "";
-    return "";
-}

package/bin/client/watch.d.ts

@@ -1 +0,0 @@
-export declare function __RebuildClient__(): Promise<void>;

package/bin/client/watch.js

@@ -1,11 +0,0 @@
-import { GenerateClient } from "../client/index.js";
-import { ReadConfig } from "../cli/config.js";
-export async function __RebuildClient__() {
-    if (process.env.NODE_ENV === "production")
-        return;
-    const config = await ReadConfig();
-    const client = config.client;
-    if (!client)
-        return;
-    GenerateClient(client, false).catch(console.error);
-}

package/bin/index.d.ts

@@ -1,9 +0,0 @@
-import { RouteModule, CatchFunction, RenderFunction } from './types.js';
-import { RouteContext, GenericContext } from "./router.js";
-import { createRequestHandler } from './request/index.js';
-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';
-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

@@ -1,8 +0,0 @@
-import { RouteContext, GenericContext } from "./router.js";
-import { createRequestHandler } from './request/index.js';
-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';
-import { redirect, text, json, refresh } from './response.js';
-export { Cookies, createRequestHandler, Endpoint, EventSourceConnection, GenericContext, RouteContext, StyleClass, redirect, text, json, refresh };

package/bin/request/index.js

@@ -1,6 +0,0 @@
-import * as native from "../request/native.js";
-import * as http from "../request/http.js";
-export const createRequestHandler = {
-    http: http.createRequestHandler,
-    native: native.createRequestHandler
-};

package/bin/response.d.ts

@@ -1,4 +0,0 @@
-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/types.d.ts

@@ -1,10 +0,0 @@
-import { ParameterShaper } from "./util/parameters.js";
-import { RouteContext } from "./router.js";
-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;
-    loader?: RenderFunction<RouteContext<T>>;
-    action?: RenderFunction<RouteContext<T>>;
-    error?: CatchFunction<RouteContext<T>>;
-};

package/bin/types.js

@@ -1 +0,0 @@
-export {};

package/bin/util/dynamic.d.ts

@@ -1,8 +0,0 @@
-/**
- * This whole file is only for internal use but the generated router for the <Dynamic> component
- */
-import { GenericContext } from "../router.js";
-export declare function RegisterDynamic<T>(load: Loader<T>): string;
-type Loader<T> = (params: T, ctx: GenericContext) => Promise<JSX.Element>;
-export declare function _resolve(fragments: string[], ctx: GenericContext): Promise<Response | null>;
-export {};

package/bin/util/event-source.d.ts

@@ -1,16 +0,0 @@
-/**
- * Helper for Server-Sent-Events, with auto close on SIGTERM and SIGHUP messages
- * Includes a keep alive empty packet sent every 30sec (because Chrome implodes at 120sec, and can be unreliable at 60sec)
- */
-export declare class EventSourceConnection {
-    private controller;
-    private stream;
-    private timer;
-    readonly createdAt: number;
-    constructor(request: Request, keepAlive?: number);
-    response(): Response;
-    private keepAlive;
-    send(type: string, data: string, timeStamp: number): boolean;
-    isClosed(): boolean;
-    close(unlink?: boolean): boolean;
-}

package/bin/util/event-source.js

@@ -1,85 +0,0 @@
-/**
- * Helper for Server-Sent-Events, with auto close on SIGTERM and SIGHUP messages
- * Includes a keep alive empty packet sent every 30sec (because Chrome implodes at 120sec, and can be unreliable at 60sec)
- */
-export class EventSourceConnection {
-    controller;
-    stream;
-    timer;
-    createdAt; // unix time
-    constructor(request, keepAlive = 30_000) {
-        this.createdAt = Date.now();
-        this.controller = null;
-        this.stream = new ReadableStream({
-            start: (c) => { this.controller = c; },
-            cancel: () => { this.close(); }
-        });
-        request.signal.addEventListener('abort', () => this.close());
-        this.timer = setInterval(() => this.keepAlive(), keepAlive);
-        register.push(this);
-    }
-    response() {
-        const headers = new Headers();
-        headers.set("Content-Type", "text/event-stream");
-        headers.set("Transfer-Encoding", "chunked");
-        headers.set("Connection", "keep-alive");
-        headers.set("Keep-Alive", `timeout=120`);
-        return new Response(this.stream, { headers });
-    }
-    keepAlive() {
-        if (!this.controller)
-            return;
-        try {
-            this.controller.enqueue("\n\n");
-        }
-        catch (e) {
-            console.error(e);
-            this.close(); // unbind on failure
-        }
-    }
-    send(type, data, timeStamp) {
-        if (!this.controller)
-            return false;
-        try {
-            this.controller.enqueue(`event: ${type}\ndata: [${data},${timeStamp}]\n\n`);
-            return true;
-        }
-        catch (e) {
-            console.error(e);
-            this.close(); // unbind on failure
-            return false;
-        }
-    }
-    isClosed() {
-        return this.controller === null;
-    }
-    close(unlink = true) {
-        clearInterval(this.timer);
-        if (!this.controller)
-            return false;
-        if (unlink) {
-            const i = register.indexOf(this);
-            if (i !== -1)
-                register.splice(i, 1);
-        }
-        try {
-            this.controller?.close();
-        }
-        catch (e) {
-            console.error(e);
-            this.controller = null;
-            return false;
-        }
-        this.controller = null;
-        return true;
-    }
-}
-// Auto close all SSE streams when shutdown requested
-// Without this graceful shutdowns will hang indefinitely
-const register = new Array();
-function CloseAll() {
-    for (const connection of register)
-        connection.close(false); // don't waste time unregistering
-}
-process.on('SIGTERM', CloseAll);
-process.on('SIGHUP', CloseAll);

package/bin/util/index.d.ts

@@ -1 +0,0 @@
-export declare function MergeHeaders(base: Headers, extension: Headers, override: boolean): void;

package/bin/util/index.js

@@ -1,7 +0,0 @@
-export function MergeHeaders(base, extension, override) {
-    extension.forEach((val, key) => {
-        if (!override && base.has(key))
-            return;
-        base.set(key, val);
-    });
-}

package/bin/util/shell.d.ts

@@ -1,32 +0,0 @@
-/**
- * These types are just helpers which could be useful
- * But the goal is to add a feature in the future to help will shells merging meta data
- * Currently I want more experience using the slug-shell pattern before I build it out
- */
-export type MetaDescriptor = {
-    charSet: "utf-8";
-} | {
-    title: string;
-} | {
-    name: string;
-    content: string;
-} | {
-    property: string;
-    content: string;
-} | {
-    httpEquiv: string;
-    content: string;
-} | {
-    "script:ld+json": LdJsonObject;
-} | {
-    tagName: "meta" | "link";
-    [name: string]: string;
-} | {
-    [name: string]: unknown;
-};
-export type LdJsonObject = {
-    [Key in string]?: LdJsonValue | undefined;
-};
-export type LdJsonArray = LdJsonValue[] | readonly LdJsonValue[];
-export type LdJsonPrimitive = string | number | boolean | null;
-export type LdJsonValue = LdJsonPrimitive | LdJsonObject | LdJsonArray;

package/bin/util/shell.js

@@ -1,8 +0,0 @@
-/**
- * These types are just helpers which could be useful
- * But the goal is to add a feature in the future to help will shells merging meta data
- * Currently I want more experience using the slug-shell pattern before I build it out
- */
-export {};
-// export type ShellOptions = { meta?: Array<MetaDescriptor> } | undefined;
-// export type ShellProps<T> = T & ShellOptions;