htmx-router 2.1.2 → 2.1.4

package/dist/cookies.d.ts

@@ -26,5 +26,5 @@ export declare class Cookies {
     private string;
     unset(name: string, options?: CookieOptions): void;
     /** Creates the response headers required to make the changes done to these cookies */
-    export(): string[];
+    export(): Array<string>;
 }

package/dist/cookies.js

@@ -58,7 +58,7 @@ export class Cookies {
     unset(name, options = { maxAge: -1 }) {
         options.maxAge ||= -1;
         this.parse();
-        return this.set(name, "", options);
+        this.set(name, "", options);
     }
     /** Creates the response headers required to make the changes done to these cookies */
     export() {

package/dist/css.js

@@ -46,9 +46,7 @@ export function GetSheetUrl() {
  * RouteTree mounting point
  */
 export const path = "/_/style/$hash";
-export const parameters = {
-    hash: String
-};
+export const parameters = { hash: String };
 export async function loader(ctx) {
     const build = GetSheet();
     if (!ctx.params.hash.startsWith(build.hash))

package/dist/defer.js

@@ -53,9 +53,7 @@ export function Deferral(func, params) {
  * RouteTree mounting point
  */
 export const path = "/_/defer/$";
-export const parameters = {
-    "$": String
-};
+export const parameters = { "$": String };
 export async function loader(ctx) {
     const endpoint = registry.get(ctx.params["$"]);
     if (!endpoint)

package/dist/endpoint.js

@@ -23,9 +23,7 @@ export class Endpoint {
  * RouteTree mounting point
  */
 export const path = "/_/endpoint/$";
-export const parameters = {
-    "$": String
-};
+export const parameters = { "$": String };
 export async function loader(ctx) {
     const endpoint = registry.get(ctx.params["$"]);
     if (!endpoint)

package/dist/event-source.d.ts

@@ -22,15 +22,24 @@ export declare class EventSource<JsxEnabled extends boolean = false> {
      */
     _keepAlive(): boolean;
     dispatch(type: string, data: JsxEnabled extends true ? (JSX.Element | string) : string): boolean;
-    close(unlink?: boolean): boolean;
+    close(): boolean;
 }
 export declare class EventSourceSet<JsxEnabled extends boolean = false> extends Set<EventSource<JsxEnabled>> {
-    /** Send update to all EventSources, auto closing failed dispatches */
-    dispatch(type: string, data: string): void;
-    /** Cull all closed connections */
-    cull(): void;
-    /** Close all connections */
-    closeAll(): void;
+    /**
+     * Send update to all EventSources, auto closing failed dispatches
+     * @returns number of successful sends
+     */
+    dispatch(type: string, data: string): number;
+    /**
+     * Cull all closed connections
+     * @returns number of connections closed
+     */
+    cull(): number;
+    /**
+     * Close all connections
+     * @returns number of connections closed
+     */
+    closeAll(): number;
 }
 type SharedEventSourceCacheRule = {
     limit: number;

package/dist/event-source.js

@@ -97,7 +97,7 @@ export class EventSource {
         }
         return this.#sendText(`event: ${type}\ndata: ${html}\n\n`, true);
     }
-    close(unlink = true) {
+    close() {
         if (this.#controller) {
             try {
                 this.#controller.close();
@@ -119,29 +119,46 @@ export class EventSource {
 }
 _a = EventSource;
 export class EventSourceSet extends Set {
-    /** Send update to all EventSources, auto closing failed dispatches */
+    /**
+     * Send update to all EventSources, auto closing failed dispatches
+     * @returns number of successful sends
+     */
     dispatch(type, data) {
+        let count = 0;
         for (const stream of this) {
             if (stream.readyState === 0)
                 continue; // skip initializing
             const success = stream.dispatch(type, data);
-            if (!success)
+            if (success)
+                count++;
+            else
                 this.delete(stream);
         }
+        return count;
     }
-    /** Cull all closed connections */
+    /**
+     * Cull all closed connections
+     * @returns number of connections closed
+     */
     cull() {
+        const count = this.size;
         for (const stream of this) {
             if (stream.readyState !== 2)
                 continue;
             this.delete(stream);
         }
+        return count;
     }
-    /** Close all connections */
+    /**
+     * Close all connections
+     * @returns number of connections closed
+     */
     closeAll() {
+        const count = this.size;
         for (const stream of this)
             stream.close();
         this.clear();
+        return count;
     }
 }
 /**

package/dist/internal/client.js

@@ -2,7 +2,7 @@ import { ServerOnlyWarning } from "./util.js";
 ServerOnlyWarning("client-url");
 import { readFile } from "fs/promises";
 export async function GetClientEntryURL() {
-    if (process.env.NODE_ENV !== "production")
+    if (import.meta.env.DEV)
         return "/app/entry.client.ts";
     const config = JSON.parse(await readFile("./dist/client/.vite/manifest.json", "utf8"));
     for (const key in config) {

package/dist/internal/component/scripts.js

@@ -3,19 +3,18 @@ import { GetMountUrl } from 'htmx-router/internal/mount';
 import { GetSheetUrl } from 'htmx-router/css';
 
 let cache: JSX.Element | null = null;
-const isProduction = process.env.NODE_ENV === "production";
 const clientEntry = await GetClientEntryURL();
 export function Scripts() {
 	if (cache) return cache;
 
 	const res = <>
 		<link href={GetSheetUrl()} rel="stylesheet"></link>
-		{ isProduction ? "" : <script type="module" src="/@vite/client"></script> }
+		{ import.meta.env.DEV ? <script type="module" src="/@vite/client"></script> : "" }
 		<script type="module" src={clientEntry}></script>
 		<script src={GetMountUrl()}></script>
 	</>;
 
-	if (isProduction) cache = res;
+	if (import.meta.env.PROD) cache = res;
 	return res;
 }`;
 export default {

package/dist/response.d.ts

@@ -1,3 +1,4 @@
+import { ResponseInit } from "./util/types";
 export declare function text(text: BodyInit, init?: ResponseInit): Response;
 export declare function html(text: BodyInit, init?: ResponseInit): Response;
 export type TypedResponse<T> = Omit<Response, "json"> & {
@@ -18,7 +19,7 @@ export declare function refresh(init?: ResponseInit & {
  * Acts like an assertion that stops execution when the client's ETag matches the current ETag.
  *
  * @param {Request} request - The incoming HTTP request object
- * @param {Headers} headers - The response headers object to modify
+ * @param {Headers} headers - The output response headers object to modify
  * @param {string} etag - The current ETag value for the resource (do not quote)
  * @param {Object} [options] - Optional caching configuration
  * @param {number} [options.revalidate] - client must revalidate their etag at this interval in seconds

package/dist/response.js

@@ -58,7 +58,7 @@ export function refresh(init) {
  * Acts like an assertion that stops execution when the client's ETag matches the current ETag.
  *
  * @param {Request} request - The incoming HTTP request object
- * @param {Headers} headers - The response headers object to modify
+ * @param {Headers} headers - The output response headers object to modify
  * @param {string} etag - The current ETag value for the resource (do not quote)
  * @param {Object} [options] - Optional caching configuration
  * @param {number} [options.revalidate] - client must revalidate their etag at this interval in seconds
@@ -97,6 +97,7 @@ export function refresh(init) {
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/ETag | ETag - MDN Web Docs }
  */
 export function AssertETagStale(request, headers, etag, options) {
+    headers.delete("Cache-Control"); // clear any defaults
     if (options) {
         // default to private, because it's the slightly less worse of the two potential foot guns
         if (options.public)
@@ -107,7 +108,7 @@ export function AssertETagStale(request, headers, etag, options) {
             headers.append("Cache-Control", `max-age=${options.revalidate}`);
     }
     headers.append("Cache-Control", "must-revalidate");
-    headers.set("ETag", `"${etag}"`);
+    headers.set("ETag", `"${encodeURIComponent(etag.trim())}"`);
     const client = request.headers.get("if-none-match");
     if (client !== etag)
         return;

package/dist/status.d.ts

@@ -1,3 +1,9 @@
+import { ResponseInit } from "./util/types";
+type ResponseConfig = ResponseInit & {
+    status: number;
+    statusText: string;
+};
+export declare function MakeStatus(lookup: StatusCode | StatusText, init?: ResponseInit | Headers): ResponseConfig;
 declare const dictionary: {
     100: "Continue";
     101: "Switching Protocols";
@@ -66,5 +72,4 @@ declare const dictionary: {
 type Definitions = typeof dictionary;
 export type StatusCode = keyof Definitions;
 export type StatusText = Definitions[StatusCode];
-export declare function MakeStatus(lookup: StatusCode | StatusText, init?: ResponseInit | Headers): ResponseInit;
 export {};

package/dist/status.js

@@ -1,3 +1,28 @@
+export function MakeStatus(lookup, init) {
+    if (init instanceof Headers)
+        init = { headers: init };
+    if (typeof lookup === "number")
+        return lookupCode(lookup, init);
+    return lookupStatus(lookup, init);
+}
+function lookupCode(code, init) {
+    const text = index.text.get(code);
+    if (text === undefined)
+        throw new TypeError(`Status ${code} is not a known status code`);
+    return SetStatus(init, code, text);
+}
+function lookupStatus(text, init) {
+    const code = index.code.get(text.toLowerCase());
+    if (code === undefined)
+        throw new TypeError(`Status "${text}" is not a known status text`);
+    return SetStatus(init, code, text);
+}
+function SetStatus(into = {}, status, statusText) {
+    into.statusText = statusText;
+    into.status = status;
+    return into;
+}
+;
 const dictionary = {
     100: "Continue",
     101: "Switching Protocols",
@@ -73,28 +98,3 @@ for (const k in dictionary) {
     index.code.set(text.toLowerCase(), code);
     index.text.set(code, text);
 }
-export function MakeStatus(lookup, init) {
-    if (init instanceof Headers)
-        init = { headers: init };
-    if (typeof lookup === "number")
-        return lookupCode(lookup, init);
-    return lookupStatus(lookup, init);
-}
-function lookupCode(code, init) {
-    const text = index.text.get(code);
-    if (text === undefined)
-        throw new TypeError(`Status ${code} is not a known status code`);
-    return SetStatus(init, code, text);
-}
-function lookupStatus(text, init) {
-    const code = index.code.get(text.toLowerCase());
-    if (code === undefined)
-        throw new TypeError(`Status "${text}" is not a known status text`);
-    return SetStatus(init, code, text);
-}
-function SetStatus(into = {}, status, statusText) {
-    into.statusText = statusText;
-    into.status = status;
-    return into;
-}
-;

package/dist/timer.d.ts

@@ -50,4 +50,5 @@ export declare class RequestTimer {
      * It will clear all timers for the request, and ensure they aren't included in the response
      */
     disable(): void;
+    getElapsed(): number;
 }

package/dist/timer.js

@@ -12,7 +12,9 @@
  */
 export class RequestTimer {
     #checkpoints;
+    #start;
     constructor(enabled) {
+        this.#start = Date.now();
         if (!enabled) {
             this.#checkpoints = null;
             return;
@@ -77,6 +79,9 @@ export class RequestTimer {
      * It will clear all timers for the request, and ensure they aren't included in the response
      */
     disable() { this.#checkpoints = null; }
+    getElapsed() {
+        return Date.now() - this.#start;
+    }
 }
 class Checkpoint {
     time;

package/dist/util/types.d.ts

@@ -0,0 +1 @@
+export type ResponseInit = NonNullable<ConstructorParameters<typeof Response>[1]>;

package/dist/util/types.js

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

package/global.d.ts

@@ -4,4 +4,23 @@ declare namespace JSX {
 		[elementName: string]: any;
 	}
 	interface Fragment {}
+}
+
+interface ImportMeta {
+	glob: (
+		pattern: string,
+		options?: {
+			eager?: boolean;
+			import?: string;
+			as?: string;
+		}
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	) => Record<string, any>;
+	env: {
+		BASE_URL: string,
+		DEV: boolean,
+		MODE: string,
+		PROD: boolean,
+		SSR: true,
+	} & Record<`VITE_${string}`, string>
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "htmx-router",
-	"version": "2.1.2",
+	"version": "2.1.4",
 	"description": "A lightweight SSR framework with server+client islands",
 	"keywords": [ "htmx", "router", "client islands", "ssr", "vite" ],
 	"type": "module",