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

package/bin/cli/config.js

@@ -1,4 +1,4 @@
 import { readFile } from "fs/promises";
 export async function ReadConfig() {
-    return JSON.parse(await readFile(process.argv[2] || "./htmx-router.json", "utf-8"));
+    return JSON.parse(await readFile(process.argv[2] || "./htmx-config.json", "utf-8"));
 }

package/bin/cli/index.js

@@ -11,10 +11,11 @@ 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";
 import { GetClientEntryURL } from 'htmx-router/bin/client/entry';
+import { DynamicReference } from "htmx-router/bin/util/dynamic";
 import { GetMountUrl } from 'htmx-router/bin/client/mount';
 import { GetSheetUrl } from 'htmx-router/bin/util/css';
 import { RouteModule } from "htmx-router";
@@ -31,18 +32,12 @@ for (const path in modules) {
 }
 
 export function Dynamic<T extends Record<string, string>>(props: {
-	params: T,
-	loader: (params: T, ctx: GenericContext) => Promise<JSX.Element>
+	params?: T,
+	loader: (ctx: GenericContext, params?: T) => Promise<JSX.Element>
 	children?: JSX.Element
 }): JSX.Element {
-	const path = RegisterDynamic(props.loader);
-
-	const query = new URLSearchParams();
-	for (const key in props.params) query.set(key, props.params[key]);
-	const url = path + query.toString();
-
 	return <div
-		hx-get={url}
+		hx-get={DynamicReference(props.loader, props.params)}
 		hx-trigger="load"
 		hx-swap="outerHTML transition:true"
 		style={{ display: "contents" }}

package/bin/client/index.js

@@ -18,7 +18,7 @@ export async function GenerateClient(config, force = false) {
         writeFile(config.source, source
             + pivot
             + `// hash: ${hash}\n`
-            + BuildClientServer(imported)),
+            + BuildClientServer(config.adapter, imported)),
         writeFile(CutString(config.source, ".", -1)[0] + ".manifest.tsx", BuildClientManifest(config.adapter, imported))
     ]);
 }
@@ -44,7 +44,13 @@ function ParseImports(source) {
     }
     return out;
 }
-function BuildClientServer(imported) {
+function SafeScript(type, script) {
+    switch (type) {
+        case "react": return `<script dangerouslySetInnerHTML={{__html: ${script}}}></script>`;
+        default: return `<script>${script}</script>`;
+    }
+}
+function BuildClientServer(type, imported) {
     const names = new Array();
     for (const imp of imported) {
         if (Array.isArray(imp.mapping))
@@ -58,7 +64,7 @@ function BuildClientServer(imported) {
         + "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\t${SafeScript(type, "`Router.mountAboveWith('${name}', ${data})`")}\n`
         + "\t</>);\n"
         + "}\n"
         + "\n"
@@ -83,6 +89,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/client/mount.js

@@ -3,6 +3,9 @@ import { CutString } from "../helper.js";
 // this function simply exists so it can be stringified and written into the client js bundle
 function ClientMounter() {
     const theme = {
+        get: () => {
+            return (localStorage.getItem("theme") || theme.infer());
+        },
         infer: () => {
             const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
             const current = prefersDark ? 'dark' : 'light';
@@ -10,16 +13,15 @@ function ClientMounter() {
             return current;
         },
         apply: () => {
-            const current = localStorage.getItem("theme") || theme.infer();
-            document.documentElement.setAttribute('data-theme', current);
+            document.documentElement.setAttribute('data-theme', theme.get());
         },
         toggle: () => {
-            const current = localStorage.getItem("theme") || theme.infer();
-            if (current === "dark")
+            if (theme.get() === "dark")
                 localStorage.setItem("theme", "light");
             else
                 localStorage.setItem("theme", "dark");
             theme.apply();
+            return localStorage.getItem("theme");
         }
     };
     window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', () => {
@@ -49,6 +51,45 @@ function ClientMounter() {
     document.addEventListener("DOMContentLoaded", Mount);
     if (global.htmx)
         global.htmx.onLoad(Mount);
+    // Track the number of active requests
+    let activeRequests = 0;
+    const updateLoadingAttribute = () => {
+        if (activeRequests > 0)
+            document.body.setAttribute('data-loading', 'true');
+        else
+            document.body.removeAttribute('data-loading');
+    };
+    const originalXHROpen = XMLHttpRequest.prototype.open;
+    const originalXHRSend = XMLHttpRequest.prototype.send;
+    // @ts-ignore
+    XMLHttpRequest.prototype.open = function (...args) {
+        this.addEventListener('loadstart', () => {
+            activeRequests++;
+            updateLoadingAttribute();
+        });
+        this.addEventListener('loadend', () => {
+            activeRequests--;
+            updateLoadingAttribute();
+        });
+        originalXHROpen.apply(this, args);
+    };
+    XMLHttpRequest.prototype.send = function (...args) {
+        originalXHRSend.apply(this, args);
+    };
+    // Override fetch
+    const originalFetch = window.fetch;
+    window.fetch = async (...args) => {
+        activeRequests++;
+        updateLoadingAttribute();
+        try {
+            const response = await originalFetch(...args);
+            return response;
+        }
+        finally {
+            activeRequests--;
+            updateLoadingAttribute();
+        }
+    };
     return {
         mountAboveWith: RequestMount,
         theme

package/bin/index.d.ts

@@ -1,8 +1,11 @@
 import { RouteModule, CatchFunction, RenderFunction } from './types.js';
 import { RouteContext, GenericContext } from "./router.js";
 import { createRequestHandler } from './request/index.js';
+import { MetaDescriptor, RenderMetaDescriptor, ShellOptions, ApplyMetaDescriptorDefaults, LdJsonObject, OpenGraph, OpenGraphImage, OpenGraphVideo, OpenGraphAudio, InferShellOptions } from './util/shell.js';
+import { redirect, refresh, revalidate, text, json } from './util/response.js';
 import { Cookies, CookieOptions } from "./util/cookies.js";
 import { EventSourceConnection } from "./util/event-source.js";
+import { DynamicReference } from './util/dynamic.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, };
+export { createRequestHandler, CatchFunction, RenderFunction, RouteContext, RouteModule, GenericContext, Cookies, CookieOptions, Endpoint, DynamicReference, StyleClass, EventSourceConnection, redirect, refresh, revalidate, text, json, MetaDescriptor, RenderMetaDescriptor, ShellOptions, ApplyMetaDescriptorDefaults, LdJsonObject, OpenGraph, OpenGraphImage, OpenGraphVideo, OpenGraphAudio, InferShellOptions };

package/bin/index.js

@@ -1,7 +1,18 @@
 import { RouteContext, GenericContext } from "./router.js";
 import { createRequestHandler } from './request/index.js';
+import { RenderMetaDescriptor, ApplyMetaDescriptorDefaults } from './util/shell.js';
+import { redirect, refresh, revalidate, text, json } from './util/response.js';
 import { Cookies } from "./util/cookies.js";
 import { EventSourceConnection } from "./util/event-source.js";
+import { DynamicReference } from './util/dynamic.js';
 import { StyleClass } from './util/css.js';
 import { Endpoint } from './util/endpoint.js';
-export { Cookies, createRequestHandler, Endpoint, EventSourceConnection, GenericContext, RouteContext, StyleClass, };
+export { createRequestHandler, RouteContext, GenericContext, 
+// Request helpers
+Cookies, Endpoint, DynamicReference, 
+// CSS Helper
+StyleClass, 
+// SSE helper
+EventSourceConnection, 
+// Response helpers
+redirect, refresh, revalidate, text, json, RenderMetaDescriptor, ApplyMetaDescriptorDefaults };

package/bin/request/native.js

@@ -26,17 +26,17 @@ 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
+        response = new Response("No Route Found", { status: 404, statusText: "Not Found", headers: ctx.headers });
+    // Override with context headers
     if (response.headers !== ctx.headers) {
         for (const [key, value] of ctx.headers) {
-            if (response.headers.has(key))
+            if (ctx.headers.has(key))
                 continue;
             response.headers.set(key, value);
         }
     }
     // Merge cookie changes
-    const headers = Object.fromEntries(ctx.headers);
+    const headers = Object.fromEntries(response.headers);
     const cookies = ctx.cookie.export();
     if (cookies.length > 0) {
         headers['set-cookie'] = cookies;

package/bin/response.d.ts

@@ -0,0 +1,9 @@
+export declare function text(text: string, init?: ResponseInit): Response;
+export declare function json(data: unknown, init?: ResponseInit): Response;
+export declare function redirect(url: string, init?: ResponseInit & {
+    client?: boolean;
+}): Response;
+export declare function revalidate(init?: ResponseInit): Response;
+export declare function refresh(init?: ResponseInit & {
+    client?: boolean;
+}): Response;

package/bin/response.js

@@ -0,0 +1,46 @@
+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");
+    res.headers.set("X-Caught", "true");
+    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");
+    res.headers.set("X-Caught", "true");
+    return res;
+}
+export function redirect(url, init) {
+    init ||= {};
+    init.statusText ||= "Temporary Redirect";
+    init.status = 307;
+    const res = new Response("", init);
+    if (!init?.client)
+        res.headers.set("Location", url);
+    res.headers.set("HX-Location", url); // use hx-boost if applicable
+    return res;
+}
+export function revalidate(init) {
+    init ||= {};
+    init.statusText ||= "ok";
+    init.status = 200;
+    const res = new Response("", init);
+    res.headers.set("HX-Location", "");
+    return res;
+}
+export function refresh(init) {
+    init ||= {};
+    init.statusText ||= "ok";
+    init.status = 200;
+    const res = new Response("", init);
+    if (!init?.client)
+        res.headers.set("Refresh", "0"); // fallback
+    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;
+            return 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/bin/util/dynamic.d.ts

@@ -2,7 +2,7 @@
  * 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 DynamicReference<T extends Record<string, string>>(loader: Loader<T>, params?: T): string;
+type Loader<T> = (ctx: GenericContext, params: T) => Promise<JSX.Element>;
 export declare function _resolve(fragments: string[], ctx: GenericContext): Promise<Response | null>;
 export {};

package/bin/util/dynamic.js

@@ -4,17 +4,28 @@
 import { QuickHash } from "../util/hash.js";
 const registry = new Map();
 const index = new Map();
-export function RegisterDynamic(load) {
+function Register(load) {
     const existing = index.get(load);
     if (existing)
         return existing;
     const hash = QuickHash(String(load));
     const name = `${encodeURIComponent(load.name)}-${hash}`;
     registry.set(name, load);
-    const url = `/_/dynamic/${name}?`;
+    const url = `/_/dynamic/${name}`;
     index.set(load, url);
     return url;
 }
+export function DynamicReference(loader, params) {
+    let url = Register(loader);
+    if (params) {
+        const query = new URLSearchParams();
+        if (params)
+            for (const key in params)
+                query.set(key, params[key]);
+        url += "?" + query.toString();
+    }
+    return url;
+}
 export async function _resolve(fragments, ctx) {
     if (!fragments[2])
         return null;
@@ -25,5 +36,5 @@ export async function _resolve(fragments, ctx) {
     for (const [key, value] of ctx.url.searchParams)
         props[key] = value;
     ctx.headers.set("X-Partial", "true");
-    return ctx.render(await endpoint(props, ctx));
+    return ctx.render(await endpoint(ctx, props));
 }

package/bin/util/response.d.ts

@@ -0,0 +1,11 @@
+export declare function text(text: string, init?: ResponseInit): Response;
+export declare function json<T>(data: T, init?: ResponseInit): Omit<Response, "json"> & {
+    json(): Promise<T>;
+};
+export declare function redirect(url: string, init?: ResponseInit & {
+    clientOnly?: boolean;
+}): Response;
+export declare function revalidate(init?: ResponseInit): Response;
+export declare function refresh(init?: ResponseInit & {
+    clientOnly?: boolean;
+}): Response;

package/bin/util/response.js

@@ -0,0 +1,46 @@
+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");
+    res.headers.set("X-Caught", "true");
+    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");
+    res.headers.set("X-Caught", "true");
+    return res;
+}
+export function redirect(url, init) {
+    init ||= {};
+    init.statusText ||= "Temporary Redirect";
+    init.status = 307;
+    const res = new Response("", init);
+    if (!init?.clientOnly)
+        res.headers.set("Location", url);
+    res.headers.set("HX-Location", url); // use hx-boost if applicable
+    return res;
+}
+export function revalidate(init) {
+    init ||= {};
+    init.statusText ||= "ok";
+    init.status = 200;
+    const res = new Response("", init);
+    res.headers.set("HX-Location", "");
+    return res;
+}
+export function refresh(init) {
+    init ||= {};
+    init.statusText ||= "ok";
+    init.status = 200;
+    const res = new Response("", init);
+    if (!init?.clientOnly)
+        res.headers.set("Refresh", "0"); // fallback
+    res.headers.set("HX-Refresh", "true");
+    return res;
+}

package/bin/util/shell.d.ts

@@ -1,32 +1,120 @@
-/**
- * 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 ShellOptions<D = {}> = D & MetaDescriptor;
+export declare function ApplyMetaDescriptorDefaults(options: ShellOptions, defaults: Readonly<Partial<ShellOptions>>): void;
+export type InferShellOptions<F> = F extends (jsx: any, options: infer U) => any ? U : never;
 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;
+    title?: string;
+    description?: string;
+    meta?: Record<string, string>;
+    og?: OpenGraph<string>;
+    jsonLD?: LdJsonObject[];
 };
+export declare function RenderMetaDescriptor<T>(options: ShellOptions<T>): string;
 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;
+type LdJsonArray = LdJsonValue[] | readonly LdJsonValue[];
+type LdJsonPrimitive = string | number | boolean | null;
+type LdJsonValue = LdJsonPrimitive | LdJsonObject | LdJsonArray;
+export type OpenGraphType = "website" | "article" | "book" | "profile" | "music.song" | "music.album" | "music.playlist" | "music.radio_station" | "video.movie" | "video.episode" | "video.tv_show" | "video.other" | string;
+export type OpenGraph<T extends OpenGraphType = string> = {
+    type?: T;
+    title?: string;
+    description?: string;
+    determiner?: string;
+    url?: string;
+    secure_url?: string;
+    locale?: string | {
+        base: string;
+        alternative: string[];
+    };
+    image?: OpenGraphImage[];
+    video?: OpenGraphVideo[];
+    audio?: OpenGraphAudio[];
+} & (T extends "music.song" ? OpenGraphSong : T extends "music.album" ? OpenGraphAlbum : T extends "music.playlist" ? OpenGraphPlaylist : T extends "music.radio_station" ? OpenGraphRadioStation : T extends "video.movie" ? OpenGraphMovie : T extends "video.episode" ? OpenGraphEpisode : T extends "video.tv_show" ? OpenGraphTvShow : T extends "video.other" ? OpenGraphVideoOther : T extends "article" ? OpenGraphArticle : T extends "book" ? OpenGraphBook : T extends "profile" ? OpenGraphProfile : {});
+export type OpenGraphImage = {
+    url: string;
+    secure_url?: string;
+    type?: string;
+    width?: number;
+    height?: number;
+    alt?: string;
+};
+export type OpenGraphVideo = {
+    url: string;
+    type?: string;
+    secure_url?: string;
+    width?: number;
+    height?: number;
+    alt?: string;
+};
+export type OpenGraphAudio = {
+    url: string;
+    type?: string;
+    secure_url?: string;
+};
+type OpenGraphSong = {
+    duration?: number;
+    album?: Array<string | {
+        url: string;
+        disc?: number;
+        track?: number;
+    }>;
+    musician?: string[];
+};
+type OpenGraphAlbum = {
+    songs?: Array<string | {
+        url: string;
+        disc?: number;
+        track?: number;
+    }>;
+    musician?: string[];
+    release_date?: Date;
+};
+type OpenGraphPlaylist = {
+    songs?: Array<string | {
+        url: string;
+        disc?: number;
+        track?: number;
+    }>;
+    creator?: string[];
+};
+type OpenGraphRadioStation = {
+    creator?: string[];
+};
+type OpenGraphMovie = {
+    actors?: Array<string | {
+        url: string;
+        role: string;
+    }>;
+    directors?: string[];
+    writers?: string[];
+    duration?: number;
+    release_date?: Date;
+    tag: string[];
+};
+type OpenGraphEpisode = OpenGraphMovie & {
+    series?: string;
+};
+type OpenGraphTvShow = OpenGraphMovie;
+type OpenGraphVideoOther = OpenGraphMovie;
+type OpenGraphArticle = {
+    published_time?: Date;
+    modified_time?: Date;
+    expiration_time?: Date;
+    authors?: string[];
+    section?: string;
+    tag?: string;
+};
+type OpenGraphBook = {
+    authors?: string[];
+    isbn?: string;
+    release_date?: Date;
+    tag?: string;
+};
+type OpenGraphProfile = {
+    first_name?: string;
+    last_name?: string;
+    username?: string;
+    gender?: "male" | "female";
+};
+export {};

package/bin/util/shell.js

@@ -1,8 +1,251 @@
-/**
- * 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;
+export function ApplyMetaDescriptorDefaults(options, defaults) {
+    if (defaults.title && !options.title)
+        options.title = defaults.title;
+    if (defaults.description && !options.description)
+        options.description = defaults.description;
+    if (defaults.meta && !options.meta)
+        options.meta = defaults.meta;
+    if (defaults.og && !options.og)
+        options.og = defaults.og;
+    if (defaults.jsonLD && !options.jsonLD)
+        options.jsonLD = defaults.jsonLD;
+}
+export function RenderMetaDescriptor(options) {
+    let out = "";
+    if (options.title)
+        out += `<title>${EscapeHTML(options.title)}</title>`;
+    if (options.description)
+        out += `<meta name="description" content="${EscapeHTML(options.description)}">\n`;
+    if (options.meta)
+        for (const key in options.meta) {
+            out += `<meta name="${EscapeHTML(key)}" content="${EscapeHTML(options.meta[key])}">\n`;
+        }
+    if (options.jsonLD)
+        for (const json of options.jsonLD) {
+            out += `<script>${EscapeHTML(JSON.stringify(json))}</script>\n`;
+        }
+    // Auto apply og:title + og:description if not present
+    if (options.title && !options.og?.title)
+        out += `<meta property="og:title" content="${EscapeHTML(options.title)}">\n`;
+    if (options.description && !options.og?.description)
+        out += `<meta property="og:description" content="${EscapeHTML(options.description)}">\n`;
+    // Apply open graphs
+    if (options.og)
+        out += RenderOpenGraph(options.og);
+    return out;
+}
+function RenderOpenGraph(og) {
+    // Manually encoding everything rather than using a loop to ensure they are in the correct order
+    // And to ensure extra values can't leak in creating unsafe og tags
+    const type = og.type || "website";
+    let out = RenderProperty("og:type", type);
+    if (og.title)
+        out += RenderProperty("og:title", og.title);
+    if (og.description)
+        out += RenderProperty("og:description", og.description);
+    if (og.determiner)
+        out += RenderProperty("og:determiner", og.determiner);
+    if (og.url)
+        out += RenderProperty("og:url", og.url);
+    if (og.secure_url)
+        out += RenderProperty("og:secure_url", og.secure_url);
+    if (og.locale) {
+        if (typeof og.locale === "string")
+            out += RenderProperty("og:locale", og.locale);
+        else {
+            out += RenderProperty("og:locale", og.locale.base);
+            for (const l of og.locale.alternative)
+                out += RenderProperty("og:locale:alternative", l);
+        }
+    }
+    if (og.image)
+        for (const img of og.image) {
+            out += RenderProperty("og:image", img.url);
+            if (img.secure_url)
+                out += RenderProperty("og:image:secure_url", img.secure_url);
+            if (img.type)
+                out += RenderProperty("og:image:type", img.type);
+            if (img.width)
+                out += RenderProperty("og:image:width", img.width.toString());
+            if (img.height)
+                out += RenderProperty("og:image:height", img.height.toString());
+            if (img.alt)
+                out += RenderProperty("og:image:alt", img.alt);
+        }
+    if (og.video)
+        for (const vid of og.video) {
+            out += RenderProperty("og:video", vid.url);
+            if (vid.secure_url)
+                out += RenderProperty("og:video:secure_url", vid.secure_url);
+            if (vid.type)
+                out += RenderProperty("og:video:type", vid.type);
+            if (vid.width)
+                out += RenderProperty("og:video:width", vid.width.toString());
+            if (vid.height)
+                out += RenderProperty("og:video:height", vid.height.toString());
+            if (vid.alt)
+                out += RenderProperty("og:video:alt", vid.alt);
+        }
+    if (og.audio)
+        for (const audio of og.audio) {
+            out += RenderProperty("og:audio", audio.url);
+            if (audio.secure_url)
+                out += RenderProperty("og:audio:secure_url", audio.secure_url);
+            if (audio.type)
+                out += RenderProperty("og:audio:type", audio.type);
+        }
+    return out + RenderOpenGraphExtras(og);
+}
+function RenderProperty(name, value) {
+    return `<meta property="${name}" content="${EscapeHTML(value)}">\n`;
+}
+function RenderOpenGraphExtras(og) {
+    let out = "";
+    if (og.type === "music.song") {
+        const g = og;
+        if (g.duration)
+            out += RenderProperty("og:music:duration", g.duration.toString());
+        if (g.album)
+            for (const album of g.album) {
+                if (typeof album === "string")
+                    out += RenderProperty("og:music:album", album);
+                else {
+                    out += RenderProperty("og:music:album", album.url);
+                    if (album.disc)
+                        out += RenderProperty("og:music:album:disc", album.disc.toString());
+                    if (album.track)
+                        out += RenderProperty("og:music:album:track", album.track.toString());
+                }
+            }
+        if (g.musician)
+            for (const profile of g.musician)
+                out += RenderProperty("og:music:musician", profile);
+        return out;
+    }
+    if (og.type === "music.album") {
+        const g = og;
+        if (g.songs)
+            for (const song of g.songs) {
+                if (typeof song === "string")
+                    out += RenderProperty("og:music:song", song);
+                else {
+                    out += RenderProperty("og:music:song", song.url);
+                    if (song.disc)
+                        out += RenderProperty("og:music:song:disc", song.disc.toString());
+                    if (song.track)
+                        out += RenderProperty("og:music:song:track", song.track.toString());
+                }
+            }
+        if (g.musician)
+            for (const profile of g.musician)
+                out += RenderProperty("og:music:musician", profile);
+        if (g.release_date)
+            out += RenderProperty("og:music:release_date", g.release_date.toISOString());
+        return out;
+    }
+    if (og.type === "music.playlist") {
+        const g = og;
+        if (g.songs)
+            for (const song of g.songs) {
+                if (typeof song === "string")
+                    out += RenderProperty("og:music:song", song);
+                else {
+                    out += RenderProperty("og:music:song", song.url);
+                    if (song.disc)
+                        out += RenderProperty("og:music:song:disc", song.disc.toString());
+                    if (song.track)
+                        out += RenderProperty("og:music:song:track", song.track.toString());
+                }
+            }
+        if (g.creator)
+            for (const profile of g.creator)
+                out += RenderProperty("og:music:creator", profile);
+        return out;
+    }
+    if (og.type === "music.radio_station") {
+        const g = og;
+        if (g.creator)
+            for (const profile of g.creator)
+                out += RenderProperty("og:music:creator", profile);
+        return out;
+    }
+    if (og.type === "video.movie" || og.type === "video.episode" || og.type === "video.tv_show" || og.type === "video.other") {
+        const g = og;
+        if (g.actors)
+            for (const actor of g.actors) {
+                if (typeof actor === "string")
+                    out += RenderProperty("og:video:actor", actor);
+                else {
+                    out += RenderProperty("og:video:actor", actor.url);
+                    out += RenderProperty("og:video:actor:role", actor.role);
+                }
+            }
+        if (g.directors)
+            for (const profile of g.directors)
+                out += RenderProperty("og:video:director", profile);
+        if (g.writers)
+            for (const profile of g.writers)
+                out += RenderProperty("og:video:writer", profile);
+        if (g.duration)
+            out += RenderProperty("og:video:duration", g.duration.toString());
+        if (g.release_date)
+            out += RenderProperty("og:video:release_date", g.release_date.toISOString());
+        if (g.tag)
+            for (const tag of g.tag)
+                out += RenderProperty("og:video:tag", tag);
+        if (g.series)
+            out += RenderProperty("og:video:series", g.series);
+    }
+    if (og.type === "article") {
+        const g = og;
+        if (g.published_time)
+            out += RenderProperty("og:article:published_time", g.published_time.toISOString());
+        if (g.modified_time)
+            out += RenderProperty("og:article:modified_time", g.modified_time.toISOString());
+        if (g.expiration_time)
+            out += RenderProperty("og:article:expiration_time", g.expiration_time.toISOString());
+        if (g.authors)
+            for (const profile of g.authors)
+                out += RenderProperty("og:article:author", profile);
+        if (g.section)
+            out += RenderProperty("og:article:section", g.section);
+        if (g.tag)
+            for (const tag of g.tag)
+                out += RenderProperty("og:video:tag", tag);
+    }
+    if (og.type === "book") {
+        const g = og;
+        if (g.authors)
+            for (const profile of g.authors)
+                out += RenderProperty("og:article:author", profile);
+        if (g.isbn)
+            out += RenderProperty("og:book:isbn", g.isbn);
+        if (g.release_date)
+            out += RenderProperty("og:book:release_date", g.release_date.toISOString());
+        if (g.tag)
+            for (const tag of g.tag)
+                out += RenderProperty("og:video:tag", tag);
+    }
+    if (og.type === "profile") {
+        const g = og;
+        if (g.first_name)
+            out += RenderProperty("og:profile:first_name", g.first_name);
+        if (g.last_name)
+            out += RenderProperty("og:profile:last_name", g.last_name);
+        if (g.username)
+            out += RenderProperty("og:profile:username", g.username);
+        if (g.gender)
+            out += RenderProperty("og:profile:gender", g.gender);
+    }
+    return "";
+}
+const escapeTo = {
+    "&": "&amp;",
+    "<": "&lt;",
+    ">": "&gt;",
+    "\"": "&quot;",
+    "'": "&#39;",
+};
+function EscapeHTML(str) {
+    return str.replace(/[&<>"']/g, (match) => escapeTo[match] || match);
+}

package/package.json

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