@canonical/react-ssr 0.23.0 → 0.24.0

package/dist/esm/index.js

@@ -1,3 +1,4 @@
+export * as adapter from "./lib/adapter/index.js";
 export * as renderer from "./lib/renderer/index.js";
 export * as server from "./lib/server/index.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,wBAAwB,CAAC;AAClD,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC"}

package/dist/esm/lib/adapter/index.js

@@ -0,0 +1,2 @@
+export { buildCacheControl, getMimeType, matchPattern } from "./mime.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/lib/adapter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/adapter/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC"}

package/dist/esm/lib/adapter/mime.js

@@ -0,0 +1,85 @@
+/**
+ * Minimal MIME type lookup for static asset serving.
+ *
+ * Covers the file types commonly produced by Vite builds (scripts, styles,
+ * images, fonts, source maps). Adapters use this when the platform doesn't
+ * provide native MIME detection (Cloudflare R2, Deno filesystem).
+ *
+ * No external dependencies — the lookup is a plain record.
+ */
+const MIME_TYPES = {
+    ".html": "text/html; charset=utf-8",
+    ".js": "application/javascript; charset=utf-8",
+    ".mjs": "application/javascript; charset=utf-8",
+    ".css": "text/css; charset=utf-8",
+    ".json": "application/json; charset=utf-8",
+    ".svg": "image/svg+xml",
+    ".png": "image/png",
+    ".jpg": "image/jpeg",
+    ".jpeg": "image/jpeg",
+    ".gif": "image/gif",
+    ".webp": "image/webp",
+    ".avif": "image/avif",
+    ".ico": "image/x-icon",
+    ".woff": "font/woff",
+    ".woff2": "font/woff2",
+    ".ttf": "font/ttf",
+    ".otf": "font/otf",
+    ".txt": "text/plain; charset=utf-8",
+    ".xml": "application/xml; charset=utf-8",
+    ".wasm": "application/wasm",
+    ".map": "application/json; charset=utf-8",
+};
+/**
+ * Look up the MIME type for a file path based on its extension.
+ *
+ * Returns `"application/octet-stream"` for unknown extensions.
+ *
+ * @param path - File path or name (e.g. `"main.abc123.js"`, `"/assets/logo.png"`).
+ * @returns The MIME type string.
+ */
+export function getMimeType(path) {
+    const dotIndex = path.lastIndexOf(".");
+    if (dotIndex === -1)
+        return "application/octet-stream";
+    const ext = path.slice(dotIndex).toLowerCase();
+    return MIME_TYPES[ext] ?? "application/octet-stream";
+}
+/**
+ * Build a `Cache-Control` header value from a cache configuration.
+ *
+ * @param cache - Cache configuration with optional directives.
+ * @returns A `Cache-Control` header string.
+ */
+export function buildCacheControl(cache) {
+    const parts = [];
+    if (cache.maxAge != null)
+        parts.push(`max-age=${cache.maxAge}`);
+    if (cache.sMaxAge != null)
+        parts.push(`s-maxage=${cache.sMaxAge}`);
+    if (cache.staleWhileRevalidate != null)
+        parts.push(`stale-while-revalidate=${cache.staleWhileRevalidate}`);
+    return parts.length > 0 ? `public, ${parts.join(", ")}` : "public";
+}
+/**
+ * Match a URL pathname against a simple pattern.
+ *
+ * Supports three forms:
+ * - Exact match: `"/sitemap.xml"` matches only `"/sitemap.xml"`
+ * - Wildcard suffix: `"/api/*"` matches `"/api/"` and anything below
+ * - Catch-all: `"/*"` matches everything
+ *
+ * @param pattern - The route pattern.
+ * @param pathname - The URL pathname to test.
+ * @returns `true` if the pathname matches the pattern.
+ */
+export function matchPattern(pattern, pathname) {
+    if (pattern === "/*")
+        return true;
+    if (pattern.endsWith("/*")) {
+        const prefix = pattern.slice(0, -2);
+        return pathname === prefix || pathname.startsWith(`${prefix}/`);
+    }
+    return pathname === pattern;
+}
+//# sourceMappingURL=mime.js.map

package/dist/esm/lib/adapter/mime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mime.js","sourceRoot":"","sources":["../../../../src/lib/adapter/mime.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,MAAM,UAAU,GAA2B;IACzC,OAAO,EAAE,0BAA0B;IACnC,KAAK,EAAE,uCAAuC;IAC9C,MAAM,EAAE,uCAAuC;IAC/C,MAAM,EAAE,yBAAyB;IACjC,OAAO,EAAE,iCAAiC;IAC1C,MAAM,EAAE,eAAe;IACvB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,YAAY;IACpB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,WAAW;IACnB,OAAO,EAAE,YAAY;IACrB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,cAAc;IACtB,OAAO,EAAE,WAAW;IACpB,QAAQ,EAAE,YAAY;IACtB,MAAM,EAAE,UAAU;IAClB,MAAM,EAAE,UAAU;IAClB,MAAM,EAAE,2BAA2B;IACnC,MAAM,EAAE,gCAAgC;IACxC,OAAO,EAAE,kBAAkB;IAC3B,MAAM,EAAE,iCAAiC;CAC1C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACvC,IAAI,QAAQ,KAAK,CAAC,CAAC;QAAE,OAAO,0BAA0B,CAAC;IACvD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/C,OAAO,UAAU,CAAC,GAAG,CAAC,IAAI,0BAA0B,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAIjC;IACC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI;QAAE,KAAK,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI;QAAE,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACnE,IAAI,KAAK,CAAC,oBAAoB,IAAI,IAAI;QACpC,KAAK,CAAC,IAAI,CAAC,0BAA0B,KAAK,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACrE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;AACrE,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAAC,OAAe,EAAE,QAAgB;IAC5D,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAClC,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACpC,OAAO,QAAQ,KAAK,MAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,QAAQ,KAAK,OAAO,CAAC;AAC9B,CAAC"}

package/dist/esm/lib/adapter/types.js

@@ -0,0 +1,10 @@
+/**
+ * Shared type contracts for SSR deployment adapters.
+ *
+ * These types define the interface between platform-specific adapters
+ * (Cloudflare Workers, Vercel, Deno Deploy) and the transport-agnostic
+ * renderers in `@canonical/react-ssr`. Adapters consume these types;
+ * renderers satisfy them.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/lib/adapter/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/lib/adapter/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG"}

package/dist/esm/lib/index.js

@@ -1,3 +1,4 @@
+export * as adapter from "./adapter/index.js";
 export * as renderer from "./renderer/index.js";
 export * as server from "./server/index.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC"}

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+export * as adapter from "./lib/adapter/index.js";
 export * as renderer from "./lib/renderer/index.js";
 export * as server from "./lib/server/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,wBAAwB,CAAC;AAClD,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC"}

package/dist/types/lib/adapter/index.d.ts

@@ -0,0 +1,3 @@
+export { buildCacheControl, getMimeType, matchPattern } from "./mime.js";
+export type { CacheConfig, RendererFactory, RendererResult, RouteDefinition, StaticAssetConfig, } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/lib/adapter/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/adapter/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzE,YAAY,EACV,WAAW,EACX,eAAe,EACf,cAAc,EACd,eAAe,EACf,iBAAiB,GAClB,MAAM,YAAY,CAAC"}

package/dist/types/lib/adapter/mime.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Minimal MIME type lookup for static asset serving.
+ *
+ * Covers the file types commonly produced by Vite builds (scripts, styles,
+ * images, fonts, source maps). Adapters use this when the platform doesn't
+ * provide native MIME detection (Cloudflare R2, Deno filesystem).
+ *
+ * No external dependencies — the lookup is a plain record.
+ */
+/**
+ * Look up the MIME type for a file path based on its extension.
+ *
+ * Returns `"application/octet-stream"` for unknown extensions.
+ *
+ * @param path - File path or name (e.g. `"main.abc123.js"`, `"/assets/logo.png"`).
+ * @returns The MIME type string.
+ */
+export declare function getMimeType(path: string): string;
+/**
+ * Build a `Cache-Control` header value from a cache configuration.
+ *
+ * @param cache - Cache configuration with optional directives.
+ * @returns A `Cache-Control` header string.
+ */
+export declare function buildCacheControl(cache: {
+    maxAge?: number;
+    sMaxAge?: number;
+    staleWhileRevalidate?: number;
+}): string;
+/**
+ * Match a URL pathname against a simple pattern.
+ *
+ * Supports three forms:
+ * - Exact match: `"/sitemap.xml"` matches only `"/sitemap.xml"`
+ * - Wildcard suffix: `"/api/*"` matches `"/api/"` and anything below
+ * - Catch-all: `"/*"` matches everything
+ *
+ * @param pattern - The route pattern.
+ * @param pathname - The URL pathname to test.
+ * @returns `true` if the pathname matches the pattern.
+ */
+export declare function matchPattern(pattern: string, pathname: string): boolean;
+//# sourceMappingURL=mime.d.ts.map

package/dist/types/lib/adapter/mime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mime.d.ts","sourceRoot":"","sources":["../../../../src/lib/adapter/mime.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AA0BH;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKhD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,GAAG,MAAM,CAOT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAOvE"}

package/dist/types/lib/adapter/types.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Shared type contracts for SSR deployment adapters.
+ *
+ * These types define the interface between platform-specific adapters
+ * (Cloudflare Workers, Vercel, Deno Deploy) and the transport-agnostic
+ * renderers in `@canonical/react-ssr`. Adapters consume these types;
+ * renderers satisfy them.
+ */
+/**
+ * The subset of a renderer that adapters need to produce a response.
+ *
+ * Any renderer (`JSXRenderer`, `SitemapRenderer`, `TextRenderer`) satisfies
+ * this interface after calling the appropriate render method.
+ */
+export interface RendererResult {
+    /** Render to a web `ReadableStream` (Bun, Deno, Cloudflare Workers, Vercel Edge). */
+    renderToReadableStream: (signal?: AbortSignal) => Promise<ReadableStream>;
+    /** HTTP status code determined during rendering. */
+    statusCode: number;
+    /** Resolves when `statusCode` is determined. */
+    statusReady: Promise<void>;
+}
+/**
+ * A function that creates a renderer for a given request.
+ *
+ * All adapters use the Web Standard `Request` type. Adapters running on
+ * Node.js (e.g. Vercel serverless) convert `IncomingMessage` to `Request`
+ * internally before calling the factory.
+ */
+export type RendererFactory = (request: Request) => RendererResult;
+/**
+ * A route definition that maps a URL pattern to a renderer factory.
+ *
+ * Adapters iterate routes in order and use the first match. The pattern
+ * uses simple glob matching: `"/*"` matches everything, `"/sitemap.xml"`
+ * matches exactly, `"/api/*"` matches any path under `/api/`.
+ */
+export interface RouteDefinition {
+    /** URL pattern (e.g. `"/sitemap.xml"`, `"/api/*"`, `"/*"`). */
+    pattern: string;
+    /** Factory that creates a renderer for matched requests. */
+    factory: RendererFactory;
+    /**
+     * Content-Type header for responses from this route.
+     * Defaults to `"text/html; charset=utf-8"` when omitted.
+     */
+    contentType?: string;
+    /** Cache configuration for responses from this route. */
+    cache?: CacheConfig;
+}
+/**
+ * Cache-Control header configuration.
+ *
+ * Adapters translate these values into platform-appropriate caching:
+ * - Cloudflare: Cache API (`caches.default.put`) + `Cache-Control` header
+ * - Vercel: `Cache-Control` header (CDN respects `s-maxage`)
+ * - Deno: `Cache-Control` header only
+ */
+export interface CacheConfig {
+    /** Browser cache duration in seconds (`max-age`). */
+    maxAge?: number;
+    /** CDN/edge cache duration in seconds (`s-maxage`). */
+    sMaxAge?: number;
+    /** Duration in seconds to serve stale while revalidating (`stale-while-revalidate`). */
+    staleWhileRevalidate?: number;
+}
+/**
+ * Configuration for serving static assets (CSS, JS, images, fonts).
+ *
+ * Each entry maps a URL prefix to a source directory. The adapter serves
+ * matching requests from the source using the platform's optimal mechanism
+ * (R2 on Cloudflare, CDN on Vercel, filesystem on Deno/Bun).
+ */
+export interface StaticAssetConfig {
+    /** URL path prefix (e.g. `"/assets"`). */
+    urlPrefix: string;
+    /**
+     * Source directory or key prefix.
+     * - Cloudflare: R2 key prefix (e.g. `"assets"`)
+     * - Vercel: not used (static assets served by CDN from `.vercel/output/static/`)
+     * - Deno/Bun: filesystem path (e.g. `"dist/client/assets"`)
+     */
+    directory: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types/lib/adapter/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/lib/adapter/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,qFAAqF;IACrF,sBAAsB,EAAE,CAAC,MAAM,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAE1E,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAC;IAEnB,gDAAgD;IAChD,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,cAAc,CAAC;AAEnE;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAEhB,4DAA4D;IAC5D,OAAO,EAAE,eAAe,CAAC;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,yDAAyD;IACzD,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B,qDAAqD;IACrD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,wFAAwF;IACxF,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC,0CAA0C;IAC1C,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/types/lib/index.d.ts

@@ -1,3 +1,4 @@
+export * as adapter from "./adapter/index.js";
 export * as renderer from "./renderer/index.js";
 export * as server from "./server/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@canonical/react-ssr",
   "description": "TBD",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "type": "module",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -26,6 +26,7 @@
   },
   "homepage": "https://github.com/canonical/pragma#readme",
   "imports": {
+    "#adapter": "./src/lib/adapter/index.ts",
     "#renderer": "./src/lib/renderer/index.ts",
     "#server": "./src/lib/server/index.ts"
   },
@@ -58,13 +59,17 @@
     "./server": {
       "import": "./dist/esm/lib/server/index.js",
       "types": "./dist/types/lib/server/index.d.ts"
+    },
+    "./adapter": {
+      "import": "./dist/esm/lib/adapter/index.js",
+      "types": "./dist/types/lib/adapter/index.d.ts"
     }
   },
   "devDependencies": {
     "@biomejs/biome": "2.4.9",
-    "@canonical/biome-config": "^0.23.0",
-    "@canonical/typescript-config-react": "^0.23.0",
-    "@canonical/webarchitect": "^0.23.0",
+    "@canonical/biome-config": "^0.24.0",
+    "@canonical/typescript-config-react": "^0.24.0",
+    "@canonical/webarchitect": "^0.24.0",
     "@types/express": "^5.0.6",
     "@types/node": "^24.12.0",
     "@types/react": "^19.2.14",
@@ -74,7 +79,7 @@
     "vitest": "^4.0.18"
   },
   "dependencies": {
-    "@canonical/utils": "^0.23.0",
+    "@canonical/utils": "^0.24.0",
     "htmlparser2": "^10.1.0",
     "react": "^19.2.4",
     "react-dom": "^19.2.4"
@@ -87,5 +92,5 @@
       "optional": true
     }
   },
-  "gitHead": "742f5396bc3f9ca01a49646ed5b67acfc9d001d2"
+  "gitHead": "28565e3591ad80525b62bd7be6343d1f12ebf4d0"
 }