npm - @canonical/react-ssr - Versions diffs - 0.22.0 → 0.23.0 - Mend

@canonical/react-ssr 0.22.0 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (83) hide show

package/dist/esm/bin/serve-express.js +86 -0
package/dist/esm/bin/serve-express.js.map +1 -0
package/dist/esm/index.js +2 -2
package/dist/esm/index.js.map +1 -1
package/dist/esm/lib/index.js +3 -0
package/dist/esm/lib/index.js.map +1 -0
package/dist/esm/lib/renderer/Extractor.js +172 -0
package/dist/esm/lib/renderer/Extractor.js.map +1 -0
package/dist/esm/lib/renderer/JSXRenderer.js +283 -0
package/dist/esm/lib/renderer/JSXRenderer.js.map +1 -0
package/dist/esm/lib/renderer/SitemapRenderer.js +241 -0
package/dist/esm/lib/renderer/SitemapRenderer.js.map +1 -0
package/dist/esm/lib/renderer/TextRenderer.js +124 -0
package/dist/esm/lib/renderer/TextRenderer.js.map +1 -0
package/dist/esm/lib/renderer/constants.js.map +1 -0
package/dist/esm/lib/renderer/index.js +6 -0
package/dist/esm/lib/renderer/index.js.map +1 -0
package/dist/esm/lib/renderer/types.js +10 -0
package/dist/esm/lib/renderer/types.js.map +1 -0
package/dist/esm/lib/server/index.js +3 -0
package/dist/esm/lib/server/index.js.map +1 -0
package/dist/esm/lib/server/serveStream.js +53 -0
package/dist/esm/lib/server/serveStream.js.map +1 -0
package/dist/esm/lib/server/serveString.js +49 -0
package/dist/esm/lib/server/serveString.js.map +1 -0
package/dist/types/bin/serve-express.d.ts +24 -0
package/dist/types/bin/serve-express.d.ts.map +1 -0
package/dist/types/index.d.ts +2 -2
package/dist/types/index.d.ts.map +1 -1
package/dist/types/lib/index.d.ts +3 -0
package/dist/types/lib/index.d.ts.map +1 -0
package/dist/types/lib/renderer/Extractor.d.ts +93 -0
package/dist/types/lib/renderer/Extractor.d.ts.map +1 -0
package/dist/types/lib/renderer/JSXRenderer.d.ts +163 -0
package/dist/types/lib/renderer/JSXRenderer.d.ts.map +1 -0
package/dist/types/lib/renderer/SitemapRenderer.d.ts +153 -0
package/dist/types/lib/renderer/SitemapRenderer.d.ts.map +1 -0
package/dist/types/lib/renderer/TextRenderer.d.ts +83 -0
package/dist/types/lib/renderer/TextRenderer.d.ts.map +1 -0
package/dist/types/lib/renderer/constants.d.ts.map +1 -0
package/dist/types/lib/renderer/index.d.ts +7 -0
package/dist/types/lib/renderer/index.d.ts.map +1 -0
package/dist/types/lib/renderer/types.d.ts +161 -0
package/dist/types/lib/renderer/types.d.ts.map +1 -0
package/dist/types/lib/server/index.d.ts +3 -0
package/dist/types/lib/server/index.d.ts.map +1 -0
package/dist/types/lib/server/serveStream.d.ts +41 -0
package/dist/types/lib/server/serveStream.d.ts.map +1 -0
package/dist/types/lib/server/serveString.d.ts +37 -0
package/dist/types/lib/server/serveString.d.ts.map +1 -0
package/package.json +32 -17
package/dist/esm/renderer/Extractor.js +0 -127
package/dist/esm/renderer/Extractor.js.map +0 -1
package/dist/esm/renderer/JSXRenderer.js +0 -168
package/dist/esm/renderer/JSXRenderer.js.map +0 -1
package/dist/esm/renderer/constants.js.map +0 -1
package/dist/esm/renderer/index.js +0 -4
package/dist/esm/renderer/index.js.map +0 -1
package/dist/esm/renderer/types.js +0 -2
package/dist/esm/renderer/types.js.map +0 -1
package/dist/esm/server/index.js +0 -2
package/dist/esm/server/index.js.map +0 -1
package/dist/esm/server/serve-express.js +0 -58
package/dist/esm/server/serve-express.js.map +0 -1
package/dist/esm/server/serve.js +0 -41
package/dist/esm/server/serve.js.map +0 -1
package/dist/types/renderer/Extractor.d.ts +0 -68
package/dist/types/renderer/Extractor.d.ts.map +0 -1
package/dist/types/renderer/JSXRenderer.d.ts +0 -71
package/dist/types/renderer/JSXRenderer.d.ts.map +0 -1
package/dist/types/renderer/constants.d.ts.map +0 -1
package/dist/types/renderer/index.d.ts +0 -5
package/dist/types/renderer/index.d.ts.map +0 -1
package/dist/types/renderer/types.d.ts +0 -35
package/dist/types/renderer/types.d.ts.map +0 -1
package/dist/types/server/index.d.ts +0 -2
package/dist/types/server/index.d.ts.map +0 -1
package/dist/types/server/serve-express.d.ts +0 -3
package/dist/types/server/serve-express.d.ts.map +0 -1
package/dist/types/server/serve.d.ts +0 -30
package/dist/types/server/serve.d.ts.map +0 -1
/package/dist/esm/{renderer → lib/renderer}/constants.js +0 -0
/package/dist/types/{renderer → lib/renderer}/constants.d.ts +0 -0

package/dist/types/lib/renderer/types.d.ts ADDED Viewed

@@ -0,0 +1,161 @@
+/**
+ * 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.
+ */
+import type * as React from "react";
+import type { RenderToPipeableStreamOptions, RenderToReadableStreamOptions } from "react-dom/server";
+/**
+ * The pipe/abort handles returned by `renderToPipeableStream`.
+ *
+ * Mirrors the shape of React's `PipeableStream` but decoupled from the
+ * `react-dom/server` import so consumers don't need to depend on it directly.
+ */
+export interface PipeableStreamResult {
+    /** Pipe the rendered HTML to a Node.js writable stream (e.g. `ServerResponse`). */
+    pipe: <W extends NodeJS.WritableStream>(destination: W) => W;
+    /** Abort the in-progress render. */
+    abort: (reason?: unknown) => void;
+}
+/**
+ * Configuration for a `JSXRenderer` instance.
+ *
+ * Controls locale, HTML shell extraction, and options forwarded to
+ * React's streaming APIs.
+ */
+export interface RendererOptions {
+    /**
+     * Locale for the rendered page, passed as the `lang` prop to the server
+     * entrypoint component. Defaults to `"en"` when omitted.
+     */
+    defaultLocale?: string;
+    /**
+     * A full HTML string (typically from a Vite build) whose `<head>` tags
+     * are extracted and injected into the rendered output. When omitted,
+     * the renderer produces output without extracted head elements.
+     */
+    htmlString?: string;
+    /**
+     * Options forwarded to `react-dom/server.renderToPipeableStream`.
+     *
+     * The renderer merges its own `bootstrapScriptContent`, `bootstrapScripts`,
+     * and `bootstrapModules` into these options, but user-provided values take
+     * priority and are never overwritten.
+     */
+    renderToPipeableStreamOptions?: RenderToPipeableStreamOptions;
+    /**
+     * Options forwarded to `react-dom/server.renderToReadableStream`.
+     *
+     * Same merge semantics as `renderToPipeableStreamOptions`. When omitted,
+     * the shared bootstrap options from `renderToPipeableStreamOptions` are
+     * used as a fallback (the bootstrap fields are structurally identical
+     * between the two option types).
+     */
+    renderToReadableStreamOptions?: RenderToReadableStreamOptions;
+}
+/**
+ * Props received by the server entrypoint component during SSR.
+ *
+ * The renderer assembles these from the locale, the extracted HTML head elements
+ * (when an HTML shell is provided), and the initial data for hydration.
+ *
+ * @typeParam InitialData - Shape of the hydration data embedded in the page.
+ */
+export interface ServerEntrypointProps<InitialData extends Record<string, unknown>> {
+    /** BCP 47 language tag for the page (e.g. `"en"`, `"fr-CA"`). */
+    lang?: string;
+    /**
+     * `<script>` elements extracted from the HTML shell, as React elements.
+     * Undefined when no HTML shell was provided.
+     */
+    scriptElements?: React.ReactElement[];
+    /**
+     * `<link>` elements extracted from the HTML shell, as React elements.
+     * Undefined when no HTML shell was provided.
+     */
+    linkElements?: React.ReactElement[];
+    /**
+     * `<title>`, `<meta>`, `<style>`, and `<base>` elements from the HTML shell,
+     * as React elements. Undefined when no HTML shell was provided.
+     */
+    otherHeadElements?: React.ReactElement[];
+    /**
+     * Data to embed in `window.__INITIAL_DATA__` for client hydration.
+     *
+     * The renderer serialises this object as JSON in a `<script>` tag so that the
+     * client can read it during hydration without a second network request. The
+     * JSON is escaped to prevent `</script>` injection.
+     */
+    initialData?: InitialData;
+}
+/**
+ * A React component used as the server-side rendering entry point.
+ *
+ * Receives `ServerEntrypointProps` and is expected to render the full `<html>`
+ * document, including the extracted head elements and initial data.
+ *
+ * @typeParam InitialData - Shape of the hydration data embedded in the page.
+ */
+export type ServerEntrypoint<InitialData extends Record<string, unknown>> = React.ComponentType<ServerEntrypointProps<InitialData>>;
+/**
+ * A single URL entry in an XML sitemap.
+ *
+ * Follows the Sitemaps XML protocol: https://www.sitemaps.org/protocol.html.
+ * All fields except `loc` are optional — the renderer applies defaults from
+ * `SitemapConfig` for `changefreq` and `priority`.
+ */
+export interface SitemapItem {
+    /**
+     * URL of the page. Can be absolute (`https://example.com/about`) or relative
+     * (`/about`). Relative URLs are resolved against `SitemapConfig.baseUrl`.
+     * An empty string resolves to the base URL itself.
+     */
+    loc: string;
+    /**
+     * Date of last modification. Accepts a `Date` object or an ISO 8601 string.
+     * Formatted to `YYYY-MM-DD` in the output XML.
+     */
+    lastmod?: Date | string;
+    /** How frequently the page is likely to change. */
+    changefreq?: "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never";
+    /**
+     * Priority of this URL relative to other URLs on the site.
+     * Valid range is `0.0` to `1.0`. Default is `0.5` per the protocol.
+     */
+    priority?: number;
+}
+/**
+ * An async function that produces a batch of sitemap items.
+ *
+ * The `SitemapRenderer` accepts an array of getters, calls them concurrently
+ * via `Promise.all`, and flattens the results into a single item list.
+ */
+export type SitemapGetter = () => Promise<SitemapItem[]>;
+/**
+ * Configuration for the `SitemapRenderer`.
+ *
+ * Defines the canonical base URL used to resolve relative `loc` values,
+ * and optional defaults applied to items that omit `changefreq` or `priority`.
+ */
+export interface SitemapConfig {
+    /**
+     * The canonical base URL for the site (e.g. `"https://example.com"`).
+     * Used to resolve relative `loc` values in sitemap items.
+     */
+    baseUrl: string;
+    /** Default `changefreq` applied to items that do not specify one. */
+    defaultChangefreq?: SitemapItem["changefreq"];
+    /** Default `priority` applied to items that do not specify one (0.0 to 1.0). */
+    defaultPriority?: number;
+}
+/**
+ * An async function that produces a string of text content.
+ *
+ * The `TextRenderer` accepts an array of getters, calls them sequentially
+ * (order matters for document structure), and concatenates the results.
+ */
+export type TextGetter = () => Promise<string>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types/lib/renderer/types.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/lib/renderer/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,KAAK,KAAK,MAAM,OAAO,CAAC;AACpC,OAAO,KAAK,EACV,6BAA6B,EAC7B,6BAA6B,EAC9B,MAAM,kBAAkB,CAAC;AAI1B;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,mFAAmF;IACnF,IAAI,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,cAAc,EAAE,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;IAC7D,oCAAoC;IACpC,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CACnC;AAID;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;OAMG;IACH,6BAA6B,CAAC,EAAE,6BAA6B,CAAC;IAE9D;;;;;;;OAOG;IACH,6BAA6B,CAAC,EAAE,6BAA6B,CAAC;CAC/D;AAID;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB,CACpC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAE3C,iEAAiE;IACjE,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC;IAEtC;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC;IAEpC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC;IAEzC;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,CAAC,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACtE,KAAK,CAAC,aAAa,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAC;AAI1D;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IAExB,mDAAmD;IACnD,UAAU,CAAC,EACP,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,OAAO,CAAC;IAEZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,qEAAqE;IACrE,iBAAiB,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC;IAE9C,gFAAgF;IAChF,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAID;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC"}

package/dist/types/lib/server/index.d.ts ADDED Viewed

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

package/dist/types/lib/server/index.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"index.d.ts","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/types/lib/server/serveStream.d.ts ADDED Viewed

@@ -0,0 +1,41 @@
+import type { IncomingMessage, ServerResponse } from "node:http";
+/**
+ * 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 declare function serveStream(factory: (req: IncomingMessage) => {
+    renderToPipeableStream: () => {
+        pipe: <W extends NodeJS.WritableStream>(destination: W) => W;
+    };
+    statusCode: number;
+    statusReady: Promise<void>;
+}): (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+//# sourceMappingURL=serveStream.d.ts.map

package/dist/types/lib/server/serveStream.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"serveStream.d.ts","sourceRoot":"","sources":["../../../../src/lib/server/serveStream.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK;IACjC,sBAAsB,EAAE,MAAM;QAC5B,IAAI,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,cAAc,EAAE,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;KAC9D,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B,IAEa,KAAK,eAAe,EAAE,KAAK,cAAc,mBAiBxD"}

package/dist/types/lib/server/serveString.d.ts ADDED Viewed

@@ -0,0 +1,37 @@
+import type { IncomingMessage, ServerResponse } from "node:http";
+/**
+ * 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 declare function serveString(factory: (req: IncomingMessage) => {
+    renderToString: () => string;
+    statusCode: number;
+}): (req: IncomingMessage, res: ServerResponse) => void;
+//# sourceMappingURL=serveString.d.ts.map

package/dist/types/lib/server/serveString.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"serveString.d.ts","sourceRoot":"","sources":["../../../../src/lib/server/serveString.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK;IACjC,cAAc,EAAE,MAAM,MAAM,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;CACpB,IAEO,KAAK,eAAe,EAAE,KAAK,cAAc,UAclD"}

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@canonical/react-ssr",
   "description": "TBD",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "type": "module",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -13,7 +13,8 @@
     "name": "Canonical Webteam"
   },
   "bin": {
-    "serve-express": "./dist/esm/server/serve-express.js"
+    "serve-express": "./dist/esm/bin/serve-express.js",
+    "serve-bun": "./dist/esm/bin/serve-bun.js"
   },
   "repository": {
     "type": "git",
@@ -24,6 +25,10 @@
     "url": "https://github.com/canonical/pragma/issues"
   },
   "homepage": "https://github.com/canonical/pragma#readme",
+  "imports": {
+    "#renderer": "./src/lib/renderer/index.ts",
+    "#server": "./src/lib/server/index.ts"
+  },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "build:all": "tsc -p tsconfig.build.json",
@@ -33,7 +38,9 @@
     "check:biome": "biome check",
     "check:biome:fix": "biome check --write",
     "check:ts": "tsc --noEmit",
-    "test": "echo 'No tests defined yet'"
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
   },
   "exports": {
     ".": {
@@ -41,36 +48,44 @@
       "types": "./dist/types/index.d.ts"
     },
     "./renderer": {
-      "import": "./dist/esm/renderer/index.js",
-      "types": "./dist/types/renderer/index.d.ts"
+      "import": "./dist/esm/lib/renderer/index.js",
+      "types": "./dist/types/lib/renderer/index.d.ts"
     },
     "./renderer/constants": {
-      "import": "./dist/esm/renderer/constants.js",
-      "types": "./dist/types/renderer/constants.d.ts"
+      "import": "./dist/esm/lib/renderer/constants.js",
+      "types": "./dist/types/lib/renderer/constants.d.ts"
     },
     "./server": {
-      "import": "./dist/esm/server/index.js",
-      "types": "./dist/types/server/index.d.ts"
+      "import": "./dist/esm/lib/server/index.js",
+      "types": "./dist/types/lib/server/index.d.ts"
     }
   },
   "devDependencies": {
     "@biomejs/biome": "2.4.9",
-    "@canonical/biome-config": "^0.22.0",
-    "@canonical/typescript-config-react": "^0.22.0",
-    "@canonical/webarchitect": "^0.22.0",
+    "@canonical/biome-config": "^0.23.0",
+    "@canonical/typescript-config-react": "^0.23.0",
+    "@canonical/webarchitect": "^0.23.0",
     "@types/express": "^5.0.6",
     "@types/node": "^24.12.0",
     "@types/react": "^19.2.14",
     "@types/react-dom": "^19.2.3",
-    "typescript": "^5.9.3"
+    "@vitest/coverage-v8": "^4.0.18",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   },
   "dependencies": {
-    "@canonical/utils": "^0.22.0",
-    "domhandler": "^6.0.0",
-    "express": "^5.2.1",
+    "@canonical/utils": "^0.23.0",
     "htmlparser2": "^10.1.0",
     "react": "^19.2.4",
     "react-dom": "^19.2.4"
   },
-  "gitHead": "99e187cf46d8bd7f3933705322fa4ab2d4a711e7"
+  "peerDependencies": {
+    "express": "^5.2.1"
+  },
+  "peerDependenciesMeta": {
+    "express": {
+      "optional": true
+    }
+  },
+  "gitHead": "742f5396bc3f9ca01a49646ed5b67acfc9d001d2"
 }

package/dist/esm/renderer/Extractor.js DELETED Viewed

@@ -1,127 +0,0 @@
-import { toCamelCase } from "@canonical/utils";
-import { NodeWithChildren } from "domhandler";
-import { parseDocument } from "htmlparser2";
-import React from "react";
-const REACT_KEYS_DICTIONARY = {
-    class: "className",
-    for: "htmlFor",
-    crossorigin: "crossOrigin",
-    charset: "charSet",
-};
-/**
- * Parses an HTML string to extract and convert the <head> tags to React.createElement calls.
- * The tags extracted are:
- * - title
- * - style
- * - meta
- * - link
- * - script
- * - base
- */
-class Extractor {
-    /**
-     * A document object representing the DOM of a page.
-     */
-    document;
-    /**
-     * Creates an Extractor object for a given HTML string.
-     */
-    constructor(html) {
-        this.document = parseDocument(html);
-    }
-    /**
-     * Searches elements with the specified tag in the document.
-     *
-     * @remark The method uses the parsed {@link Extractor.document | document} to navigate the
-     * whole DOM (usinig a stack) and checks for the elements with the tag name that matches
-     * the given parameter.
-     */
-    getElementsByTagName(tagName) {
-        const elements = [];
-        const stack = [...this.document.children];
-        while (stack.length) {
-            const node = stack.pop();
-            if (!node)
-                continue;
-            if (node.type === "tag" && node.name === tagName) {
-                elements.push(node);
-            }
-            // Check for script tags specifically
-            if (node.type === "script" && tagName === "script") {
-                elements.push(node);
-            }
-            if (node instanceof NodeWithChildren) {
-                stack.push(...node.children);
-            }
-        }
-        return elements;
-    }
-    /**
-     * Converts HTML keys to React keys.
-     *
-     * @remark There are some HTML attributes that don't map exactly to React with the same name.
-     * For example, class -> className.
-     */
-    convertKeyToReactKey(key) {
-        const reactKey = REACT_KEYS_DICTIONARY[key.toLowerCase()];
-        return reactKey ? reactKey : toCamelCase(key);
-    }
-    /**
-     * Converts a parsed {@link domhandler#Element | DOM Element} into a {@link react#React.ReactElement | ReactElement}.
-     *
-     * @remark The method takes into account the attributes of the parsed {@link domhandler#Element | Element}
-     * and passes them as props when creating the {@link react#React.ReactElement | ReactElement}.
-     * It only handles children of type "text".
-     */
-    convertToReactElement(element, index) {
-        const props = {};
-        for (const [key, value] of Object.entries(element.attribs)) {
-            props[this.convertKeyToReactKey(key)] = value;
-        }
-        // some tags from <head> have one children of type text
-        let elementChildren;
-        if (element.children.length === 1 && element.firstChild?.type === "text") {
-            elementChildren = element.firstChild.data;
-        }
-        props.key = `${element.name}_${index}`;
-        return React.createElement(element.name, props, elementChildren);
-    }
-    /**
-     * Finds all <link> elements in the {@link Extractor.document | document} and converts them
-     * into {@link react#React.ReactElement | ReactElements}.
-     *
-     * @remark The list of elements returned will be in order of appearance in the DOM.
-     */
-    getLinkElements() {
-        const linkElements = this.getElementsByTagName("link");
-        // reverse keeps the original order in the HTML (they are extracted with a stack in reverse)
-        // the order might be important for some scripts (i.e. in Vite Dev mode)
-        return linkElements.reverse().map(this.convertToReactElement, this);
-    }
-    /**
-     * Finds all <script> elements in the {@link Extractor.document | document} and converts them
-     * into {@link react#React.ReactElement | ReactElements}.
-     *
-     * @remark The list of elements returned will be in order of appearance in the DOM.
-     */
-    getScriptElements() {
-        const scriptElements = this.getElementsByTagName("script");
-        // reverse keeps the original order in the HTML (they are extracted with a stack in reverse)
-        // the order might be important for some scripts (i.e. in Vite Dev mode)
-        return scriptElements.reverse().map(this.convertToReactElement, this);
-    }
-    /**
-     * Finds all the <head> elements which are not "script" or "link" in the {@link Extractor.document | document}
-     * and converts them into {@link react#React.ReactElement | ReactElements}.
-     *
-     * @remark The list of elements returned will be in order of appearance in the DOM.
-     */
-    getOtherHeadElements() {
-        const otherHeadElements = ["title", "style", "meta", "base"].flatMap((elementName) => this.getElementsByTagName(elementName));
-        // reverse keeps the original order in the HTML (they are extracted with a stack in reverse)
-        // the order might be important for some scripts (i.e. in Vite Dev mode)
-        return otherHeadElements.reverse().map(this.convertToReactElement, this);
-    }
-}
-export default Extractor;
-//# sourceMappingURL=Extractor.js.map

package/dist/esm/renderer/Extractor.js.map DELETED Viewed

@@ -1 +0,0 @@

- {"version":3,"file":"Extractor.js","sourceRoot":"","sources":["../../../src/renderer/Extractor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAA+B,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,qBAAqB,GAA0C;IACnE,KAAK,EAAE,WAAW;IAClB,GAAG,EAAE,SAAS;IACd,WAAW,EAAE,aAAa;IAC1B,OAAO,EAAE,SAAS;CACnB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,SAAS;IACb;;OAEG;IACgB,QAAQ,CAAW;IAEtC;;OAEG;IACH,YAAY,IAAY;QACtB,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACO,oBAAoB,CAAC,OAAe;QAC5C,MAAM,QAAQ,GAAc,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAE1C,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI;gBAAE,SAAS;YAEpB,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBACjD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;YACD,qCAAqC;YACrC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACnD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;YAED,IAAI,IAAI,YAAY,gBAAgB,EAAE,CAAC;gBACrC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACO,oBAAoB,CAAC,GAAW;QACxC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1D,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACO,qBAAqB,CAC7B,OAAgB,EAChB,KAAa;QAEb,MAAM,KAAK,GAA8B,EAAE,CAAC;QAE5C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3D,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;QAChD,CAAC;QAED,uDAAuD;QACvD,IAAI,eAAmC,CAAC;QACxC,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,UAAU,EAAE,IAAI,KAAK,MAAM,EAAE,CAAC;YACzE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;QAC5C,CAAC;QAED,KAAK,CAAC,GAAG,GAAG,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACI,eAAe;QACpB,MAAM,YAAY,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;QACvD,4FAA4F;QAC5F,wEAAwE;QACxE,OAAO,YAAY,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IACI,iBAAiB;QACtB,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAC3D,4FAA4F;QAC5F,wEAAwE;QACxE,OAAO,cAAc,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACI,oBAAoB;QACzB,MAAM,iBAAiB,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,OAAO,CAClE,CAAC,WAAmB,EAAE,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAChE,CAAC;QACF,4FAA4F;QAC5F,wEAAwE;QACxE,OAAO,iBAAiB,CAAC,OAAO,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC;IAC3E,CAAC;CACF;AAED,eAAe,SAAS,CAAC"}

package/dist/esm/renderer/JSXRenderer.js DELETED Viewed

@@ -1,168 +0,0 @@
-import { createElement } from "react";
-import { renderToPipeableStream, renderToString, } from "react-dom/server";
-import { INITIAL_DATA_KEY } from "./constants.js";
-import Extractor from "./Extractor.js";
-/**
- * This class is responsible for rendering a React JSX component and sending it as response to a client.
- * It offers 2 ways of doing it:
- * - As string
- * - As stream
- * Each way has its advantages and inconveniences. You can read more about them in the package README.
- */
-export default class JSXRenderer {
-    Component;
-    initialData;
-    options;
-    extractor;
-    /**
-     * Creates a renderer instance which can be used to write Server Side Rendered HTML
-     * into a {@link node:http#ServerResponse | ServerResponse}.
-     */
-    constructor(Component, initialData = {}, options = {}) {
-        this.Component = Component;
-        this.initialData = initialData;
-        this.options = options;
-        this.extractor = this.options.htmlString
-            ? new Extractor(this.options.htmlString)
-            : undefined;
-    }
-    /**
-     * Gets the locale to be used for the rendered page.
-     * Default if there was no locale passed as option is "en".
-     */
-    getLocale() {
-        return this.options.defaultLocale || "en";
-    }
-    /**
-     * Gets the props needed to render the component.
-     */
-    getComponentProps() {
-        return {
-            lang: this.getLocale(),
-            scriptElements: this.extractor?.getScriptElements(),
-            linkElements: this.extractor?.getLinkElements(),
-            otherHeadElements: this.extractor?.getOtherHeadElements(),
-            initialData: this.initialData,
-        };
-    }
-    /**
-     * Gets a list of all the "src" attributes of the given scripts that match the passed type.
-     */
-    getScriptSourcesByType(scripts, type) {
-        return (scripts
-            .map((script) => script)
-            .filter((script) => {
-            if (type === "module") {
-                return script.props.type === "module";
-            }
-            else {
-                return script.props.type !== "module";
-            }
-        })
-            .map((script) => script.props.src)
-            .filter((src) => typeof src === "string") || []);
-    }
-    /**
-     * Adds some properties to the options that are passed to {@link react-dom#renderToPipeableStream | renderToPipeableStream}.
-     *
-     * @remark The options that are added are:
-     * - bootstrapScriptContent: includes the initial data passed as prop to the component in a <script> so that it
-     *  is available when rendering the page in the browser (to avoid hydration mismatches).
-     * - bootstrapScripts: classic scripts which react strips out of the page. The only way to add them is to include them
-     *  in this property.
-     * - bootstrapModules: module scripts which react also strips out of the page and need to be added like this.
-     */
-    enrichRendererOptions(props) {
-        const enrichedOptions = { ...this.options.renderToPipeableStreamOptions };
-        // options passed by the user always take priority
-        if (!enrichedOptions.bootstrapScriptContent) {
-            if (props.initialData) {
-                enrichedOptions.bootstrapScriptContent = `window.${INITIAL_DATA_KEY} = ${JSON.stringify(props.initialData)}`;
-            }
-        }
-        if (!enrichedOptions.bootstrapScripts) {
-            if (props.scriptElements) {
-                enrichedOptions.bootstrapScripts = this.getScriptSourcesByType(props.scriptElements, "classic");
-            }
-        }
-        if (!enrichedOptions.bootstrapModules) {
-            if (props.scriptElements) {
-                enrichedOptions.bootstrapModules = this.getScriptSourcesByType(props.scriptElements, "module");
-            }
-        }
-        return enrichedOptions;
-    }
-    /**
-     * This function is responsible for rendering a React component and sending it to the client through
-     * a pipeable stream.
-     *
-     * @remark See the README to understand the difference between rendering options.
-     *
-     * The streaming might improve the time taken for the page to be rendered and interactive
-     * (at least in part), using React's Suspense/lazy API and pipeable streams.
-     *
-     * CAUTION: The resulting HTML rendered this way is not cacheable.
-     */
-    renderToStream = (_req, res) => {
-        const errorRef = { current: undefined };
-        const props = this.getComponentProps();
-        const jsx = createElement(this.Component, props);
-        const { onShellError: onShellErrorCallback, onShellReady: onShellReadyCallback, onAllReady: onAllReadyCallback, onError: onErrorCallback, ...options } = this.enrichRendererOptions(props);
-        const jsxStream = renderToPipeableStream(jsx, {
-            ...options,
-            // Error occurred during rendering, after the shell & headers were sent - store the error for usage after stream is sent
-            onError(error, errorInfo) {
-                onErrorCallback?.(error, errorInfo);
-                errorRef.current = error;
-                console.error(error);
-            },
-            // Early error, before the shell is prepared
-            onShellError(error) {
-                onShellErrorCallback?.(error);
-                if (!res.headersSent) {
-                    res
-                        .writeHead(500, { "Content-Type": "text/html; charset=utf-8" })
-                        .end("<h1>Something went wrong</h1>");
-                }
-                console.error(error);
-            },
-            onShellReady() {
-                onShellReadyCallback?.();
-                if (!res.headersSent) {
-                    res.writeHead(errorRef.current ? 500 : 200, {
-                        "Content-Type": "text/html; charset=utf-8",
-                    });
-                }
-                jsxStream.pipe(res);
-                res.on("finish", () => {
-                    res.end();
-                });
-            },
-            onAllReady() {
-                onAllReadyCallback?.();
-            },
-        });
-    };
-    /**
-     * Renders this renderer's JSX component as a string and writes it to the given
-     * {@link node:http#ServerResponse | ServerResponse}.
-     *
-     * @remark See the README to understand the difference between rendering options.
-     *
-     * Rendering to string means all <Suspense> components are loaded synchronously and the response
-     * won't be sent to the client until all components have finished loading data and processing.
-     *
-     * renderToString is useful in Vite Dev mode, as the HMR doesn't work well with Suspense
-     * and the Pipeable Stream rendering. Also if the resulting document needs to be cached.
-     */
-    renderToString = (_req, res) => {
-        const props = this.getComponentProps();
-        const jsx = createElement(this.Component, props);
-        const html = renderToString(jsx);
-        res
-            .writeHead(200, { "Content-Type": "text/html; charset=utf-8" })
-            .write(html);
-        res.end();
-    };
-}
-//# sourceMappingURL=JSXRenderer.js.map