@canonical/react-ssr 0.21.0 → 0.23.0

package/dist/esm/lib/renderer/SitemapRenderer.js

@@ -0,0 +1,241 @@
+import { Readable } from "node:stream";
+/**
+ * Renders an XML sitemap from a set of async data sources.
+ *
+ * Unlike `JSXRenderer`, this renderer produces XML (not HTML) and does not use
+ * React. The render pipeline is functional: each stage returns data rather than
+ * mutating instance state, so calling render methods multiple times produces
+ * identical results for the same underlying data.
+ *
+ * Implements the same three render methods as `JSXRenderer` — `renderToReadableStream`,
+ * `renderToPipeableStream`, and `renderToString` — with the same `statusCode` /
+ * `statusReady` metadata contract. This allows consumers to use either renderer
+ * interchangeably.
+ *
+ * @example
+ * ```ts
+ * const renderer = new SitemapRenderer(
+ *   [() => fetchPages(), () => fetchPosts()],
+ *   { baseUrl: "https://example.com", defaultChangefreq: "weekly" },
+ * );
+ *
+ * const stream = await renderer.renderToReadableStream();
+ * return new Response(stream, {
+ *   status: renderer.statusCode,
+ *   headers: { "Content-Type": "application/xml; charset=utf-8" },
+ * });
+ * ```
+ */
+export default class SitemapRenderer {
+    getters;
+    config;
+    /**
+     * HTTP status code determined during rendering.
+     *
+     * Set to 200 on successful render. Errors from getters propagate as
+     * thrown exceptions rather than setting this to 500 — the consumer's
+     * error handler decides the status code for unexpected failures.
+     */
+    statusCode = 200;
+    /**
+     * Resolves when `statusCode` is determined.
+     *
+     * For all three render methods on `SitemapRenderer`, this resolves by
+     * the time the method's returned Promise settles (or synchronously for
+     * the portions that are sync).
+     */
+    statusReady = Promise.resolve();
+    /**
+     * Create a sitemap renderer.
+     *
+     * @param getters - Async functions that each return a batch of sitemap items.
+     *   Called concurrently via `Promise.all` during rendering.
+     * @param config - Base URL and optional defaults for changefreq / priority.
+     */
+    constructor(getters, config) {
+        this.getters = getters;
+        this.config = config;
+    }
+    /**
+     * Load sitemap items from all configured getters.
+     *
+     * Calls every getter concurrently and flattens the results into a single
+     * array. This is the only async step in the pipeline.
+     *
+     * @note This method is impure — it calls external async data sources.
+     * @returns A flat array of raw sitemap items from all getters.
+     */
+    async loadItems() {
+        const results = await Promise.all(this.getters.map((getter) => getter()));
+        return results.flat();
+    }
+    /**
+     * Resolve URLs and apply defaults to raw sitemap items.
+     *
+     * For each item:
+     * - Relative `loc` values are resolved against `config.baseUrl`. An empty
+     *   `loc` resolves to the base URL itself.
+     * - `lastmod` dates are formatted to `YYYY-MM-DD` (ISO 8601 date-only).
+     * - Missing `changefreq` and `priority` are filled from `config` defaults.
+     *
+     * @param items - Raw items as returned by `loadItems`.
+     * @returns A new array of items with resolved URLs and applied defaults.
+     */
+    formatItems(items) {
+        return items.map((item) => ({
+            loc: item.loc.length
+                ? new URL(item.loc, this.config.baseUrl).href
+                : this.config.baseUrl,
+            lastmod: item.lastmod != null
+                ? SitemapRenderer.formatDate(item.lastmod)
+                : undefined,
+            changefreq: item.changefreq ?? this.config.defaultChangefreq,
+            priority: item.priority ?? this.config.defaultPriority,
+        }));
+    }
+    /**
+     * Format a `Date` object or ISO string to a `YYYY-MM-DD` date string.
+     *
+     * The Sitemaps protocol specifies W3C Datetime format; the date-only
+     * variant (`YYYY-MM-DD`) is the most common form used in practice.
+     *
+     * @param date - A `Date` instance or an ISO 8601 date/datetime string.
+     * @returns The date formatted as `YYYY-MM-DD`.
+     */
+    static formatDate(date) {
+        const d = typeof date === "string" ? new Date(date) : date;
+        return d.toISOString().slice(0, 10);
+    }
+    /**
+     * Escape the five XML special characters in a string.
+     *
+     * Prevents malformed XML when interpolating user-supplied URLs that may
+     * contain `&` (common in query strings), `<`, `>`, `"`, or `'`.
+     *
+     * @param value - The raw string to escape.
+     * @returns The string with `&`, `<`, `>`, `"`, and `'` replaced by their XML entities.
+     */
+    static escapeXml(value) {
+        return value
+            .replace(/&/g, "&amp;")
+            .replace(/</g, "&lt;")
+            .replace(/>/g, "&gt;")
+            .replace(/"/g, "&quot;")
+            .replace(/'/g, "&apos;");
+    }
+    /**
+     * Serialise a list of formatted sitemap items into an XML sitemap string.
+     *
+     * Produces a complete `<?xml>` document with a `<urlset>` root element
+     * conforming to the Sitemaps 0.9 schema. Only non-null optional fields
+     * (`lastmod`, `changefreq`, `priority`) are included in the output.
+     *
+     * @param items - Formatted items (URLs resolved, dates formatted).
+     * @returns The complete XML sitemap as a string.
+     */
+    toXml(items) {
+        const urlEntries = items
+            .map((item) => {
+            const parts = [
+                `    <loc>${SitemapRenderer.escapeXml(String(item.loc))}</loc>`,
+            ];
+            if (item.lastmod != null) {
+                parts.push(`    <lastmod>${SitemapRenderer.escapeXml(String(item.lastmod))}</lastmod>`);
+            }
+            if (item.changefreq != null) {
+                parts.push(`    <changefreq>${item.changefreq}</changefreq>`);
+            }
+            if (item.priority != null) {
+                parts.push(`    <priority>${item.priority}</priority>`);
+            }
+            return `  <url>\n${parts.join("\n")}\n  </url>`;
+        })
+            .join("\n");
+        return [
+            '<?xml version="1.0" encoding="UTF-8"?>',
+            '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">',
+            urlEntries,
+            "</urlset>",
+        ].join("\n");
+    }
+    /**
+     * Build the full XML string by loading items, applying formatting, and
+     * serialising to XML.
+     */
+    async buildXml() {
+        const rawItems = await this.loadItems();
+        const items = this.formatItems(rawItems);
+        return this.toXml(items);
+    }
+    /**
+     * Render the sitemap to a web `ReadableStream`.
+     *
+     * Loads items from all getters, formats them, serialises to XML, and
+     * wraps the result in a `ReadableStream`. Sets `statusCode` to 200.
+     *
+     * @note This method is impure — it calls external data sources and mutates `statusCode`.
+     *
+     * @param _signal - Accepted for API compatibility with `JSXRenderer`. Not used.
+     * @returns A `ReadableStream` of the XML sitemap.
+     */
+    renderToReadableStream = async (_signal) => {
+        const xml = await this.buildXml();
+        this.statusCode = 200;
+        this.statusReady = Promise.resolve();
+        return new ReadableStream({
+            start(controller) {
+                controller.enqueue(new TextEncoder().encode(xml));
+                controller.close();
+            },
+        });
+    };
+    /**
+     * Render the sitemap to a Node.js pipeable stream.
+     *
+     * Returns `{ pipe, abort }` synchronously. The actual XML generation is
+     * async (getters are called), so data is pushed to the stream when ready.
+     * `statusReady` resolves when the XML is built and `statusCode` is set.
+     *
+     * @note This method is impure — it calls external data sources and mutates `statusCode`.
+     *
+     * @returns The pipe/abort handles for the XML stream.
+     */
+    renderToPipeableStream = () => {
+        /* v8 ignore next -- read() is a required no-op for push-based Readable streams */
+        const readable = new Readable({ read() { } });
+        let aborted = false;
+        this.statusReady = this.buildXml().then((xml) => {
+            this.statusCode = 200;
+            if (!aborted) {
+                readable.push(xml);
+                readable.push(null);
+            }
+        });
+        return {
+            pipe: (destination) => readable.pipe(destination),
+            abort: () => {
+                aborted = true;
+                readable.destroy();
+            },
+        };
+    };
+    /**
+     * Render the sitemap to a complete XML string.
+     *
+     * Loads items from all getters, formats them, and returns the serialised
+     * XML. Sets `statusCode` to 200.
+     *
+     * Async because the getters are async.
+     *
+     * @note This method is impure — it calls external data sources and mutates `statusCode`.
+     *
+     * @returns The complete XML sitemap string.
+     */
+    renderToString = async () => {
+        const xml = await this.buildXml();
+        this.statusCode = 200;
+        this.statusReady = Promise.resolve();
+        return xml;
+    };
+}
+//# sourceMappingURL=SitemapRenderer.js.map

package/dist/esm/lib/renderer/SitemapRenderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SitemapRenderer.js","sourceRoot":"","sources":["../../../../src/lib/renderer/SitemapRenderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAQvC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IA2Bb;IACA;IA3BrB;;;;;;OAMG;IACI,UAAU,GAAG,GAAG,CAAC;IAExB;;;;;;OAMG;IACI,WAAW,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;IAEtD;;;;;;OAMG;IACH,YACqB,OAAiC,EACjC,MAAqB;QADrB,YAAO,GAAP,OAAO,CAA0B;QACjC,WAAM,GAAN,MAAM,CAAe;IACvC,CAAC;IAEJ;;;;;;;;OAQG;IACO,KAAK,CAAC,SAAS;QACvB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC1E,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;OAWG;IACO,WAAW,CAAC,KAA6B;QACjD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC1B,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM;gBAClB,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI;gBAC7C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;YACvB,OAAO,EACL,IAAI,CAAC,OAAO,IAAI,IAAI;gBAClB,CAAC,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC;gBAC1C,CAAC,CAAC,SAAS;YACf,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,iBAAiB;YAC5D,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe;SACvD,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,UAAU,CAAC,IAAmB;QAC7C,MAAM,CAAC,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3D,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;OAQG;IACO,MAAM,CAAC,SAAS,CAAC,KAAa;QACtC,OAAO,KAAK;aACT,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC;aACvB,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;OASG;IACO,KAAK,CAAC,KAA6B;QAC3C,MAAM,UAAU,GAAG,KAAK;aACrB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACZ,MAAM,KAAK,GAAa;gBACtB,YAAY,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ;aAChE,CAAC;YACF,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC;gBACzB,KAAK,CAAC,IAAI,CACR,gBAAgB,eAAe,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,YAAY,CAC5E,CAAC;YACJ,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;gBAC5B,KAAK,CAAC,IAAI,CAAC,mBAAmB,IAAI,CAAC,UAAU,eAAe,CAAC,CAAC;YAChE,CAAC;YACD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;gBAC1B,KAAK,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,QAAQ,aAAa,CAAC,CAAC;YAC1D,CAAC;YACD,OAAO,YAAY,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;QAClD,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAEd,OAAO;YACL,wCAAwC;YACxC,8DAA8D;YAC9D,UAAU;YACV,WAAW;SACZ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,QAAQ;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;OAUG;IACH,sBAAsB,GAAG,KAAK,EAC5B,OAAqB,EACI,EAAE;QAC3B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAErC,OAAO,IAAI,cAAc,CAAC;YACxB,KAAK,CAAC,UAAU;gBACd,UAAU,CAAC,OAAO,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;gBAClD,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF;;;;;;;;;;OAUG;IACH,sBAAsB,GAAG,GAAyB,EAAE;QAClD,kFAAkF;QAClF,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,EAAE,IAAI,KAAI,CAAC,EAAE,CAAC,CAAC;QAC7C,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;YAC9C,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;YACtB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACnB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,IAAI,EAAE,CAAkC,WAAc,EAAE,EAAE,CACxD,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;YAC5B,KAAK,EAAE,GAAG,EAAE;gBACV,OAAO,GAAG,IAAI,CAAC;gBACf,QAAQ,CAAC,OAAO,EAAE,CAAC;YACrB,CAAC;SACF,CAAC;IACJ,CAAC,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,cAAc,GAAG,KAAK,IAAqB,EAAE;QAC3C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;CACH"}

package/dist/esm/lib/renderer/TextRenderer.js

@@ -0,0 +1,124 @@
+import { Readable } from "node:stream";
+/**
+ * Renders a plain-text document from async data sources.
+ *
+ * Produces output suitable for `llms.txt`, `humans.txt`, `security.txt`, or
+ * any text file that requires dynamic data (e.g. fetching page descriptions
+ * from a CMS for an LLM context file).
+ *
+ * The renderer is intentionally minimal — it accepts an array of async getters,
+ * each returning a string, and concatenates the results. No structure is imposed.
+ * The consumer controls formatting entirely.
+ *
+ * Implements the same three render methods and `statusCode` / `statusReady`
+ * contract as `JSXRenderer` and `SitemapRenderer`.
+ *
+ * @example
+ * ```ts
+ * const renderer = new TextRenderer([
+ *   async () => "# My App\n\nContext for LLMs about this application.\n",
+ *   async () => {
+ *     const pages = await fetchPages();
+ *     return pages.map(p => `- ${p.title}: ${p.url}`).join("\n");
+ *   },
+ * ]);
+ *
+ * const stream = await renderer.renderToReadableStream();
+ * return new Response(stream, {
+ *   status: renderer.statusCode,
+ *   headers: { "Content-Type": "text/plain; charset=utf-8" },
+ * });
+ * ```
+ */
+export default class TextRenderer {
+    getters;
+    /**
+     * HTTP status code determined during rendering.
+     *
+     * Set to 200 on successful render. Errors from getters propagate as
+     * thrown exceptions — the consumer's error handler decides the status code.
+     */
+    statusCode = 200;
+    /**
+     * Resolves when `statusCode` is determined.
+     */
+    statusReady = Promise.resolve();
+    /**
+     * Create a text renderer.
+     *
+     * @param getters - Async functions that each return a string. Called
+     *   sequentially (order matters) and concatenated into the final document.
+     */
+    constructor(getters) {
+        this.getters = getters;
+    }
+    /**
+     * Build the full text by calling all getters sequentially and concatenating.
+     */
+    async buildText() {
+        const parts = [];
+        for (const getter of this.getters) {
+            parts.push(await getter());
+        }
+        return parts.join("");
+    }
+    /**
+     * Render to a web `ReadableStream`.
+     *
+     * @note This method is impure — it calls external data sources and mutates `statusCode`.
+     *
+     * @param _signal - Accepted for API compatibility. Not used.
+     * @returns A `ReadableStream` of the plain-text document.
+     */
+    renderToReadableStream = async (_signal) => {
+        const text = await this.buildText();
+        this.statusCode = 200;
+        this.statusReady = Promise.resolve();
+        return new ReadableStream({
+            start(controller) {
+                controller.enqueue(new TextEncoder().encode(text));
+                controller.close();
+            },
+        });
+    };
+    /**
+     * Render to a Node.js pipeable stream.
+     *
+     * Returns `{ pipe, abort }` synchronously. Data is pushed when ready.
+     *
+     * @note This method is impure — it calls external data sources and mutates `statusCode`.
+     */
+    renderToPipeableStream = () => {
+        /* v8 ignore next -- read() is a required no-op for push-based Readable streams */
+        const readable = new Readable({ read() { } });
+        let aborted = false;
+        this.statusReady = this.buildText().then((text) => {
+            this.statusCode = 200;
+            if (!aborted) {
+                readable.push(text);
+                readable.push(null);
+            }
+        });
+        return {
+            pipe: (destination) => readable.pipe(destination),
+            abort: () => {
+                aborted = true;
+                readable.destroy();
+            },
+        };
+    };
+    /**
+     * Render to a complete string.
+     *
+     * Async because the getters are async.
+     *
+     * @note This method is impure — it calls external data sources and mutates `statusCode`.
+     */
+    renderToString = async () => {
+        const text = await this.buildText();
+        this.statusCode = 200;
+        this.statusReady = Promise.resolve();
+        return text;
+    };
+}
+//# sourceMappingURL=TextRenderer.js.map

package/dist/esm/lib/renderer/TextRenderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextRenderer.js","sourceRoot":"","sources":["../../../../src/lib/renderer/TextRenderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAoBA;IAnB/B;;;;;OAKG;IACI,UAAU,GAAG,GAAG,CAAC;IAExB;;OAEG;IACI,WAAW,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;IAEtD;;;;;OAKG;IACH,YAA+B,OAA8B;QAA9B,YAAO,GAAP,OAAO,CAAuB;IAAG,CAAC;IAEjE;;OAEG;IACO,KAAK,CAAC,SAAS;QACvB,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,KAAK,CAAC,IAAI,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,GAAG,KAAK,EAC5B,OAAqB,EACI,EAAE;QAC3B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACpC,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAErC,OAAO,IAAI,cAAc,CAAC;YACxB,KAAK,CAAC,UAAU;gBACd,UAAU,CAAC,OAAO,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBACnD,UAAU,CAAC,KAAK,EAAE,CAAC;YACrB,CAAC;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF;;;;;;OAMG;IACH,sBAAsB,GAAG,GAAyB,EAAE;QAClD,kFAAkF;QAClF,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,EAAE,IAAI,KAAI,CAAC,EAAE,CAAC,CAAC;QAC7C,IAAI,OAAO,GAAG,KAAK,CAAC;QAEpB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YAChD,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;YACtB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,IAAI,EAAE,CAAkC,WAAc,EAAE,EAAE,CACxD,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;YAC5B,KAAK,EAAE,GAAG,EAAE;gBACV,OAAO,GAAG,IAAI,CAAC;gBACf,QAAQ,CAAC,OAAO,EAAE,CAAC;YACrB,CAAC;SACF,CAAC;IACJ,CAAC,CAAC;IAEF;;;;;;OAMG;IACH,cAAc,GAAG,KAAK,IAAqB,EAAE;QAC3C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACpC,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;CACH"}

package/dist/esm/lib/renderer/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/lib/renderer/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,gBAAgB,GAAG,kBAAkB,CAAC"}

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

@@ -0,0 +1,6 @@
+export * from "./constants.js";
+export { default as Extractor } from "./Extractor.js";
+export { default as JSXRenderer } from "./JSXRenderer.js";
+export { default as SitemapRenderer } from "./SitemapRenderer.js";
+export { default as TextRenderer } from "./TextRenderer.js";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/renderer/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

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

@@ -0,0 +1,10 @@
+/**
+ * Shared type contracts for the SSR renderer domain.
+ *
+ * These types define the interface between renderers (which produce HTML or XML
+ * content and record metadata like status codes) and server adapters (which
+ * deliver that content over HTTP). Renderers are transport-agnostic — they
+ * never write to a response object.
+ */
+export {};
+//# sourceMappingURL=types.js.map

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

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

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

@@ -0,0 +1,3 @@
+export { serveStream } from "./serveStream.js";
+export { serveString } from "./serveString.js";
+//# sourceMappingURL=index.js.map

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

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

package/dist/esm/lib/server/serveStream.js

@@ -0,0 +1,53 @@
+/**
+ * Convenience wrapper that adapts a renderer factory into a Node.js `(req, res)` handler
+ * for pipeable stream rendering.
+ *
+ * Calls the factory with each incoming request. The factory is expected to construct
+ * a renderer (with per-request context like locale, auth, theme) and call
+ * `renderToPipeableStream()` on it. This wrapper then awaits `statusReady`, writes
+ * headers with the renderer's `statusCode`, and pipes the stream to the response.
+ *
+ * Does not set `Content-Type` — the consumer controls headers through the factory
+ * or by wrapping this handler. Defaults to `text/html; charset=utf-8`.
+ *
+ * @note This function is impure — it writes to the HTTP response.
+ *
+ * @param factory - A function that receives the request and returns a renderer.
+ *   The renderer must have `renderToPipeableStream()`, `statusCode`, and `statusReady`.
+ * @returns A Node.js request handler suitable for `app.use()` or `http.createServer()`.
+ *
+ * @example
+ * ```ts
+ * import { JSXRenderer } from "@canonical/react-ssr/renderer";
+ * import { serveStream } from "@canonical/react-ssr/server";
+ *
+ * app.use(serveStream((req) => {
+ *   return new JSXRenderer(
+ *     EntryServer,
+ *     { locale: getLocale(req), user: getUser(req) },
+ *     { htmlString },
+ *   );
+ * }));
+ * ```
+ */
+export function serveStream(factory) {
+    return async (req, res) => {
+        try {
+            const renderer = factory(req);
+            const result = renderer.renderToPipeableStream();
+            await renderer.statusReady;
+            res.writeHead(renderer.statusCode, {
+                "Content-Type": "text/html; charset=utf-8",
+            });
+            result.pipe(res);
+            /* v8 ignore next -- finish event fires after stream completes; not triggered in unit tests */
+            res.on("finish", () => res.end());
+        }
+        catch (error) {
+            console.error("Error during rendering:", error);
+            res.statusCode = 500;
+            res.end("Internal server error");
+        }
+    };
+}
+//# sourceMappingURL=serveStream.js.map

package/dist/esm/lib/server/serveStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serveStream.js","sourceRoot":"","sources":["../../../../src/lib/server/serveStream.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,WAAW,CACzB,OAMC;IAED,OAAO,KAAK,EAAE,GAAoB,EAAE,GAAmB,EAAE,EAAE;QACzD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,MAAM,GAAG,QAAQ,CAAC,sBAAsB,EAAE,CAAC;YACjD,MAAM,QAAQ,CAAC,WAAW,CAAC;YAC3B,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE;gBACjC,cAAc,EAAE,0BAA0B;aAC3C,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACjB,8FAA8F;YAC9F,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;YAChD,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;YACrB,GAAG,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACnC,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/esm/lib/server/serveString.js

@@ -0,0 +1,49 @@
+/**
+ * Convenience wrapper that adapts a renderer factory into a Node.js `(req, res)` handler
+ * for string rendering.
+ *
+ * Calls the factory with each incoming request. The factory is expected to construct
+ * a renderer (with per-request context like locale, auth, theme) and call
+ * `renderToString()` on it. This wrapper then writes headers with the renderer's
+ * `statusCode` and sends the HTML string as the response body.
+ *
+ * Does not set `Content-Type` — defaults to `text/html; charset=utf-8`.
+ *
+ * @note This function is impure — it writes to the HTTP response.
+ *
+ * @param factory - A function that receives the request and returns a renderer.
+ *   The renderer must have `renderToString()` and `statusCode`.
+ * @returns A Node.js request handler suitable for `app.use()` or `http.createServer()`.
+ *
+ * @example
+ * ```ts
+ * import { JSXRenderer } from "@canonical/react-ssr/renderer";
+ * import { serveString } from "@canonical/react-ssr/server";
+ *
+ * app.use(serveString((req) => {
+ *   return new JSXRenderer(
+ *     EntryServer,
+ *     { locale: getLocale(req), user: getUser(req) },
+ *     { htmlString },
+ *   );
+ * }));
+ * ```
+ */
+export function serveString(factory) {
+    return (req, res) => {
+        try {
+            const renderer = factory(req);
+            const body = renderer.renderToString();
+            res.writeHead(renderer.statusCode, {
+                "Content-Type": "text/html; charset=utf-8",
+            });
+            res.end(body);
+        }
+        catch (error) {
+            console.error("Error during rendering:", error);
+            res.statusCode = 500;
+            res.end("Internal server error");
+        }
+    };
+}
+//# sourceMappingURL=serveString.js.map

package/dist/esm/lib/server/serveString.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serveString.js","sourceRoot":"","sources":["../../../../src/lib/server/serveString.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,WAAW,CACzB,OAGC;IAED,OAAO,CAAC,GAAoB,EAAE,GAAmB,EAAE,EAAE;QACnD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,IAAI,GAAG,QAAQ,CAAC,cAAc,EAAE,CAAC;YACvC,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE;gBACjC,cAAc,EAAE,0BAA0B;aAC3C,CAAC,CAAC;YACH,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;YAChD,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;YACrB,GAAG,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACnC,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/types/bin/serve-express.d.ts

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+/**
+ * Standalone Express server for serving an SSR application.
+ *
+ * Dynamically imports a renderer module that exports a factory function.
+ * The factory receives a Node `IncomingMessage` and returns a renderer.
+ * Supports both streaming and string rendering modes.
+ *
+ * @example
+ * ```sh
+ * # String rendering (default), one static directory
+ * serve-express dist/server/renderer.js --static assets:dist/client/assets
+ *
+ * # Streaming, multiple static directories
+ * serve-express dist/server/renderer.js --streaming \
+ *   --static assets:dist/client/assets \
+ *   --static public:dist/client/public
+ *
+ * # Custom port
+ * serve-express dist/server/renderer.js -p 3000 --static assets:dist/client/assets
+ * ```
+ */
+export {};
+//# sourceMappingURL=serve-express.d.ts.map

package/dist/types/bin/serve-express.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serve-express.d.ts","sourceRoot":"","sources":["../../../src/bin/serve-express.ts"],"names":[],"mappings":";AAEA;;;;;;;;;;;;;;;;;;;;GAoBG"}

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
-export * as renderer from "./renderer/index.js";
-export * as server from "./server/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,qBAAqB,CAAC;AAChD,OAAO,KAAK,MAAM,MAAM,mBAAmB,CAAC"}
+{"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"}

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

@@ -0,0 +1,3 @@
+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

@@ -0,0 +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"}