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

package/shell.js

@@ -1,253 +0,0 @@
-import { ServerOnlyWarning } from "./internal/util.js";
-ServerOnlyWarning("shell");
-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 type="application/ld+json">${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/util/parameters.d.ts

@@ -1,7 +0,0 @@
-export type Parameterized<T extends ParameterShaper> = {
-    [K in keyof T]: ReturnType<T[K]>;
-};
-export type ParameterShaper = Record<string, (val: string) => any>;
-export declare function Parameterize<T extends ParameterShaper>(params: {
-    [key: string]: string;
-}, shape: T): Parameterized<T>;

package/util/parameters.js

@@ -1,14 +0,0 @@
-export function Parameterize(params, shape) {
-    const out = {};
-    for (const key in shape) {
-        if (!(key in params))
-            console.warn(`Parameter ${key} not present in route, but defined in parameters`);
-        const func = shape[key];
-        const val = func(params[key] || "");
-        // NaN moment
-        if (func === Number && typeof val === "number" && isNaN(val))
-            throw new Error("Invalid Number");
-        out[key] = val;
-    }
-    return out;
-}

package/util/path-builder.d.ts

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

package/util/path-builder.js

@@ -1,45 +0,0 @@
-import { ServerOnlyWarning } from "../internal/util.js";
-ServerOnlyWarning("path-builder");
-import { relative } from "path";
-/*
-// This feature is disabled because vite doesn't compile import.meta.url to the original url when making the SSR build
-// Even though it's used statically in the routes
-
-const parameters = {
-    userID: Number
-};
-
-const urlPath = RoutePathBuilder<typeof parameters>(import.meta.url);
-
-export function loader({ params }: RouteContext<typeof parameters>) {
-    return <div>You are currently at {urlPath({ userID: params.userID.toString() })}</div>
-}
-*/
-// This feature isn't particularly helpful for a router to refer to it's own URL
-// But instead is useful because you could export this function
-// Allowing other routes to use it, and thus if you move the file your imports will auto update by your LSP
-// And thus so would your SSR rendered urls
-function RoutePathBuilder(importUrl) {
-    // file runs all imports before actually executing the route.tsx
-    // so I have to do this BS instead of pre-compiling
-    let compiled = null;
-    return (params) => {
-        if (!compiled) {
-            const root = globalThis.HTMX_ROUTER_ROOT;
-            let path = importUrl.slice("file:///".length);
-            const raw = relative(root, path).replaceAll("\\", "/");
-            const i = raw.lastIndexOf(".");
-            compiled = raw.slice(0, i).split("/");
-        }
-        let path = "";
-        for (const frag of compiled) {
-            path += "/";
-            if (frag[0] != "$") {
-                path += frag;
-                continue;
-            }
-            path += params[frag.slice(1)] || "_";
-        }
-        return path;
-    };
-}

package/util/route.d.ts

@@ -1,2 +0,0 @@
-import { ParameterShaper } from "./parameters.js";
-export declare function RoutePath<T extends ParameterShaper>(): (params: { [K in keyof T]: string; }) => string;

package/util/route.js

@@ -1,58 +0,0 @@
-import { ServerOnlyWarning } from "../internal/util.js";
-ServerOnlyWarning("route-path");
-export function RoutePath() {
-    const frags = new Array();
-    return (params) => {
-        const t = params;
-        if (typeof t === "string") {
-            Compile("/" + t, frags);
-            return "";
-        }
-        return Parse(frags, params);
-    };
-}
-const indexRoute = "/_index";
-function Compile(url, into) {
-    let cursor = 0;
-    let i = 1;
-    for (; i < url.length; i++) {
-        if (url[i] !== "$")
-            continue;
-        if (url[i - 1] !== "/")
-            continue;
-        let e = url.indexOf("/", i + 1);
-        if (e === -1)
-            e = url.length;
-        into.push(url.slice(cursor, i));
-        into.push(url.slice(i, e));
-        cursor = e;
-        i = e - 1;
-    }
-    // remainder
-    if (cursor != i)
-        into.push(url.slice(cursor));
-    // remove _index from end if present
-    const lastI = into.length - 1;
-    const last = into[lastI];
-    if (last && last.endsWith(indexRoute)) {
-        if (last.length === indexRoute.length)
-            into.length--;
-        else
-            into[lastI] = last.slice(0, -indexRoute.length);
-    }
-}
-function Parse(fragments, params) {
-    let out = "";
-    for (const frag of fragments) {
-        if (!frag.startsWith("$")) {
-            out += frag;
-            continue;
-        }
-        const key = frag.slice(1);
-        const param = params[key];
-        if (!param)
-            throw new Error(`Missing ${key} parameter required for route`);
-        out += param;
-    }
-    return out;
-}

package/vite/bundle-splitter.d.ts

@@ -1,4 +0,0 @@
-import type { UserConfig } from "vite";
-type Plugin = NonNullable<UserConfig["plugins"]>[number];
-export declare function BundleSplitter(): Plugin;
-export {};

package/vite/bundle-splitter.js

@@ -1,26 +0,0 @@
-import { ServerOnlyWarning } from "../internal/util.js";
-ServerOnlyWarning("bundle-splitter");
-const serverPattern = /\.server\.[tj]s(x)?/;
-const clientPattern = /\.client\.[tj]s(x)?/;
-const BLANK_MODULE = "export {};";
-export function BundleSplitter() {
-    return {
-        name: "htmx-bundle-splitter",
-        enforce: "pre",
-        transform: (code, id, options) => {
-            const ssr = options?.ssr || false;
-            const pattern = ssr ? clientPattern : serverPattern;
-            if (pattern.test(id))
-                return BLANK_MODULE;
-            if (ssr) {
-                if (code.startsWith('"use client"'))
-                    return BLANK_MODULE;
-            }
-            else {
-                if (code.startsWith('"use server"'))
-                    return BLANK_MODULE;
-            }
-            return code;
-        }
-    };
-}

package/vite/client-island.d.ts

@@ -1,4 +0,0 @@
-import type { Plugin } from "vite";
-type SupportedFramework = "react";
-export declare function ClientIsland(framework: SupportedFramework): Plugin;
-export {};

package/vite/client-island.js

@@ -1,14 +0,0 @@
-import { resolve } from "path";
-import { CompileManifest } from "../internal/compile/manifest.js";
-export function ClientIsland(framework) {
-    const file = resolve("./app/manifest.tsx").replaceAll("\\", "/");
-    return {
-        name: "vite-plugin-htmx-client-island",
-        enforce: "pre",
-        transform: (code, id, options) => {
-            if (id !== file)
-                return code;
-            return CompileManifest(framework, code, options?.ssr || false);
-        }
-    };
-}

package/vite/code-splitting.d.ts

@@ -1,4 +0,0 @@
-import type { UserConfig } from "vite";
-type Plugin = NonNullable<UserConfig["plugins"]>[number];
-export declare function BundleSplitting(): Plugin;
-export {};

package/vite/code-splitting.js

@@ -1,14 +0,0 @@
-const serverPattern = /\.server\.[tj]s(x)?/;
-const clientPattern = /\.client\.[tj]s(x)?/;
-export function BundleSplitting() {
-    return {
-        name: "htmx-bundle-splitter",
-        enforce: "pre",
-        transform: (code, id, options) => {
-            const pattern = options?.ssr ? clientPattern : serverPattern;
-            if (pattern.test(id))
-                return "export {};";
-            return code;
-        }
-    };
-}

package/vite/index.d.ts

@@ -1,3 +0,0 @@
-import { BundleSplitter } from "./bundle-splitter.js";
-import { ClientIsland } from "./client-island.js";
-export { BundleSplitter, ClientIsland };

package/vite/index.js

@@ -1,3 +0,0 @@
-import { BundleSplitter } from "./bundle-splitter.js";
-import { ClientIsland } from "./client-island.js";
-export { BundleSplitter, ClientIsland };

package/vite/router.d.ts

@@ -1,2 +0,0 @@
-import type { Plugin } from "vite";
-export declare function Router(): Plugin;

package/vite/router.js

@@ -1,29 +0,0 @@
-export function Router() {
-    const virtualModuleId = "virtual:htmx-router/dynamic.tsx";
-    const resolvedVirtualModuleId = '\0' + virtualModuleId;
-    return {
-        name: "vite-plugin-htmx-router",
-        resolveId(id) {
-            if (id === virtualModuleId)
-                return resolvedVirtualModuleId;
-        },
-        load(id) {
-            if (id !== resolvedVirtualModuleId)
-                return;
-            return source;
-        }
-    };
-}
-const source = `export function Scripts() {
-	if (headCache) return headCache;
-
-	const res = <>
-		<link href={GetSheetUrl()} rel="stylesheet"></link>
-		{ isProduction ? "" : <script type="module" src="/@vite/client"></script> }
-		<script type="module" src={clientEntry}></script>
-		<script src={GetMountUrl()}></script>
-	</>;
-
-	if (isProduction) headCache = res;
-	return res;
-}`;