@farm.js/plugin 0.1.0-beta.0

package/dist/rsc/entries/ssr.d.ts

@@ -0,0 +1,13 @@
+import type { EntryContext } from "../types.js";
+/**
+ * Generates the SSR environment entry file.
+ *
+ * This entry file:
+ * - Receives the RSC stream from the RSC environment
+ * - Tees (duplicates) the stream - one copy for SSR, one for client hydration
+ * - Deserializes the RSC stream back to React elements
+ * - Renders those elements to HTML using React DOM's SSR
+ * - Injects the RSC payload into the HTML so the client can hydrate
+ */
+export declare function generateSsrEntry(ctx: EntryContext): string;
+//# sourceMappingURL=ssr.d.ts.map

package/dist/rsc/entries/ssr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssr.d.ts","sourceRoot":"","sources":["../../../src/rsc/entries/ssr.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,YAAY,GAAG,MAAM,CA6O1D"}

package/dist/rsc/entries/ssr.js

@@ -0,0 +1,245 @@
+/**
+ * Generates the SSR environment entry file.
+ *
+ * This entry file:
+ * - Receives the RSC stream from the RSC environment
+ * - Tees (duplicates) the stream - one copy for SSR, one for client hydration
+ * - Deserializes the RSC stream back to React elements
+ * - Renders those elements to HTML using React DOM's SSR
+ * - Injects the RSC payload into the HTML so the client can hydrate
+ */
+export function generateSsrEntry(ctx) {
+    const debugLog = `// Debug disabled`;
+    const routesDir = ctx.routesDir === undefined ? "app" : ctx.routesDir.trim();
+    const routesPath = routesDir ? `/${routesDir}` : "";
+    const globalsCssPath = ctx.globalCssPath ?? `/${ctx.srcDir}${routesPath}/globals.css`;
+    return `
+import React from 'react';
+import { createFromReadableStream } from '@vitejs/plugin-rsc/ssr';
+import { injectRSCPayload } from 'rsc-html-stream/server';
+import { renderToPipeableStream } from 'react-dom/server';
+
+function debug(...args) {
+  ${debugLog}
+}
+
+const DEV_GLOBAL_CSS_HREF = ${JSON.stringify(globalsCssPath)};
+const CLIENT_CSS_HREF = "__FARM_CLIENT_CSS_HREF__";
+const PLACEHOLDER_CSS_HREF = "__FARM_CLIENT_CSS_HREF__";
+const resolvedCssHref =
+  typeof CLIENT_CSS_HREF === "string" &&
+  CLIENT_CSS_HREF.indexOf(PLACEHOLDER_CSS_HREF) < 0
+    ? CLIENT_CSS_HREF
+    : DEV_GLOBAL_CSS_HREF;
+
+function escapeHtmlAttribute(value) {
+  return String(value).replace(/[&"]/g, (char) => (char === '&' ? '&amp;' : '&quot;'));
+}
+
+const cssLinkTag = resolvedCssHref
+  ? '<link rel="stylesheet" href="' + escapeHtmlAttribute(resolvedCssHref) + '" as="style" data-precedence="default">'
+  : '';
+
+function injectIntoHeadStream(tag) {
+  const encoder = new TextEncoder();
+  const decoder = new TextDecoder();
+  const marker = '</head>';
+  let buffer = '';
+  let injected = false;
+
+  return new TransformStream({
+    transform(chunk, controller) {
+      const str = typeof chunk === "string" ? chunk : decoder.decode(chunk);
+      if (injected || !tag) {
+        controller.enqueue(typeof chunk === "string" ? encoder.encode(str) : chunk);
+        return;
+      }
+
+      buffer += str;
+      const index = buffer.indexOf(marker);
+      if (index >= 0) {
+        const before = buffer.slice(0, index);
+        const after = buffer.slice(index + marker.length);
+        controller.enqueue(encoder.encode(before + tag + marker + after));
+        buffer = '';
+        injected = true;
+        return;
+      }
+
+      if (buffer.length > marker.length) {
+        controller.enqueue(encoder.encode(buffer.slice(0, buffer.length - marker.length)));
+        buffer = buffer.slice(-marker.length);
+      }
+    },
+    flush(controller) {
+      if (buffer) controller.enqueue(encoder.encode(buffer));
+    },
+  });
+}
+
+/** Collect Node stream (from renderToPipeableStream) into a single string. Supports Suspense. */
+function pipeableStreamToString(stream) {
+  return new Promise((resolve, reject) => {
+    const chunks = [];
+    stream.on('data', (c) => chunks.push(c));
+    stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf-8')));
+    stream.on('error', reject);
+  });
+}
+
+/**
+ * Renders an RSC stream to HTML
+ * Called by the RSC environment's handler
+ * @param { { payload, rscStream } | ReadableStream } firstArg - Either { payload, rscStream } for initial load (stream tree so loading.tsx shows first) or legacy rscStream only
+ */
+export async function renderHTML(firstArg, options = {}) {
+  debug('Starting SSR render');
+  
+  const hasPayload = firstArg && typeof firstArg === 'object' && firstArg.payload != null && firstArg.rscStream != null;
+  const rscStream = hasPayload ? firstArg.rscStream : firstArg;
+  const [s1, s2] = rscStream.tee();
+  
+  // Always deserialize the RSC stream before SSR. Rendering the raw payload directly
+  // calls client references on the server (for example, a "use client" Counter).
+  const payload = await createFromReadableStream(s1);
+  const rootElement = payload.root;
+  
+  function Root() {
+    return rootElement;
+  }
+  
+  // Get the bootstrap script that loads the client bundle (for hydration).
+  // In dev: Farm sets globalThis.__FARM_VITE_RSC_LOAD_BOOTSTRAP__ or import.meta.viteRsc.
+  // In production: __FARM_BOOTSTRAP_SCRIPT__ is replaced at build time by nitro-build from the manifest.
+  const PROD_BOOTSTRAP = "__FARM_BOOTSTRAP_SCRIPT__";
+  let bootstrap = '';
+  try {
+    if (typeof globalThis.__FARM_VITE_RSC_LOAD_BOOTSTRAP__ === 'function') {
+      bootstrap = await globalThis.__FARM_VITE_RSC_LOAD_BOOTSTRAP__();
+    } else if (typeof import.meta.viteRsc?.loadBootstrapScriptContent === 'function') {
+      bootstrap = await import.meta.viteRsc.loadBootstrapScriptContent('index');
+    }
+  } catch (e) {
+    debug('Could not load bootstrap script:', e);
+  }
+  if (!bootstrap && PROD_BOOTSTRAP !== "__FARM_BOOTSTRAP_SCRIPT__") bootstrap = PROD_BOOTSTRAP;
+  
+  // Use renderToPipeableStream so Suspense streams: fallback (loading.tsx) first, then resolved content.
+  const { pipe } = renderToPipeableStream(React.createElement(Root), {
+    ...(bootstrap && { bootstrapScriptContent: bootstrap }),
+    formState: options.formState,
+  });
+  const { PassThrough, Readable } = await import('stream');
+  const passThrough = new PassThrough();
+  pipe(passThrough);
+
+  const CLIENT_ENTRY_HREF = "__FARM_CLIENT_ENTRY_HREF__";
+  const PLACEHOLDER_STR = "__FARM_CLIENT_ENTRY_HREF__";
+  const injectClientScriptInStream = typeof CLIENT_ENTRY_HREF === "string" && CLIENT_ENTRY_HREF.length > 0 && CLIENT_ENTRY_HREF.indexOf(PLACEHOLDER_STR) < 0;
+  const clientScriptTag = injectClientScriptInStream ? '<script type="module" src="' + CLIENT_ENTRY_HREF + '"></script>' : '';
+
+  if (hasPayload) {
+    // Stream HTML to the client while preserving the RSC payload for hydration.
+    debug('Streaming HTML (loading fallback then content)');
+    const BODY_HTML_END = '</body></html>';
+    const TAG_LEN = BODY_HTML_END.length;
+    const encoder = new TextEncoder();
+    let streamBuf = '';
+    const streamingClientScriptInjector = new TransformStream({
+      transform(chunk, controller) {
+        const str = typeof chunk === "string" ? chunk : new TextDecoder().decode(chunk);
+        if (!injectClientScriptInStream || !clientScriptTag) {
+          controller.enqueue(typeof chunk === "string" ? encoder.encode(str) : chunk);
+          return;
+        }
+        streamBuf += str;
+        while (streamBuf.length > TAG_LEN) {
+          const tail = streamBuf.slice(-TAG_LEN);
+          if (tail === BODY_HTML_END) {
+            const before = streamBuf.slice(0, streamBuf.length - TAG_LEN);
+            controller.enqueue(encoder.encode(before + clientScriptTag + BODY_HTML_END));
+            streamBuf = '';
+            return;
+          }
+          controller.enqueue(encoder.encode(streamBuf.slice(0, streamBuf.length - TAG_LEN)));
+          streamBuf = streamBuf.slice(-TAG_LEN);
+        }
+      },
+      flush(controller) {
+        if (streamBuf) controller.enqueue(encoder.encode(streamBuf));
+      }
+    });
+    const webStream = typeof Readable.toWeb === 'function'
+      ? Readable.toWeb(passThrough)
+      : new ReadableStream({
+          start(controller) {
+            passThrough.on('data', (c) => controller.enqueue(c instanceof Buffer ? c : new TextEncoder().encode(String(c))));
+            passThrough.on('end', () => controller.close());
+            passThrough.on('error', (e) => controller.error(e));
+          }
+        });
+    let out = webStream.pipeThrough(injectIntoHeadStream(cssLinkTag));
+    out = out.pipeThrough(injectRSCPayload(s2));
+    out = out.pipeThrough(streamingClientScriptInjector);
+    return out;
+  }
+
+  // Legacy path: buffer full HTML then send (no loading streaming)
+  debug('Rendering to HTML stream (then buffering)');
+  const fullHtmlRaw = await pipeableStreamToString(passThrough);
+  let fullHtml = fullHtmlRaw;
+  if (cssLinkTag && fullHtml.includes("</head>")) {
+    fullHtml = fullHtml.replace("</head>", cssLinkTag + "</head>");
+  }
+  ${ctx.actionsEnabled
+        ? `// Ensure __viteRscCallServer is set before any module runs (fixes "is not a function" when form submits)
+  if (fullHtml.includes("<body")) {
+    fullHtml = fullHtml.replace(/<body[^>]*>/, function(m) {
+      return m + "<script>(function(){if(typeof globalThis.__viteRscCallServer!=='function'){globalThis.__viteRscCallServer=function(){return Promise.reject(new Error('Farm.js: server actions not ready'));}}})();</script>";
+    });
+  }
+  `
+        : ""}
+  debug('Injecting RSC payload into HTML');
+  const streamFromHtml = new ReadableStream({
+    start(controller) {
+      controller.enqueue(new TextEncoder().encode(fullHtml));
+      controller.close();
+    }
+  });
+  let clientBuffer = "";
+  let clientScriptInjected = false;
+  const injectClientScriptStream = new TransformStream({
+    transform(chunk, controller) {
+      const str = typeof chunk === "string" ? chunk : new TextDecoder().decode(chunk);
+      if (!injectClientScriptInStream || clientScriptInjected) {
+        controller.enqueue(chunk);
+        return;
+      }
+      clientBuffer += str;
+      if (clientBuffer.includes("</body></html>")) {
+        const href = (typeof CLIENT_ENTRY_HREF === "string" && CLIENT_ENTRY_HREF.length > 0 && CLIENT_ENTRY_HREF.indexOf(PLACEHOLDER_STR) < 0) ? CLIENT_ENTRY_HREF : "";
+        const out = href ? clientBuffer.replace("</body></html>", '<script type="module" src="' + href + '"></script></body></html>') : clientBuffer;
+        controller.enqueue(new TextEncoder().encode(out));
+        clientBuffer = "";
+        clientScriptInjected = true;
+      }
+    },
+    flush(controller) {
+      if (clientBuffer) {
+        controller.enqueue(new TextEncoder().encode(clientBuffer));
+      }
+    }
+  });
+
+  let out = streamFromHtml.pipeThrough(injectRSCPayload(s2));
+  out = out.pipeThrough(injectClientScriptStream);
+  return out;
+}
+
+// Enable HMR
+if (import.meta.hot) {
+  import.meta.hot.accept();
+}
+`;
+}

package/dist/rsc/index.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Farm.js RSC Plugin
+ *
+ * Provides React Server Components support for Farm.js.
+ * When enabled, this plugin:
+ * - Configures three build environments (rsc, ssr, client)
+ * - Generates virtual entry files for routing, rendering, and hydration
+ * - Supports server actions when experimental.serverActions is true
+ * - Integrates with @vitejs/plugin-rsc for core RSC transforms
+ *
+ * @example
+ * ```ts
+ * import { defineConfig } from '@farm.js/plugin/rsc'
+ *
+ * export default defineConfig({
+ *   srcDir: 'src',
+ *   experimental: {
+ *     serverComponents: true,
+ *     serverActions: true,
+ *   },
+ * })
+ * ```
+ */
+import { type Plugin, type UserConfig } from "vite";
+import type { FarmRscPluginOptions, EntryContext } from "./types.js";
+import type { FarmServerActionsConfig } from "@farm.js/core/server-action-security";
+import type { FarmLayerEntry, ResolvedFarmLayer } from "@farm.js/core/server";
+export type { FarmRscPluginOptions, EntryContext };
+export { buildRscNitro, waitForRscManifest, waitForRscOutputs } from "./nitro-build.js";
+export type { BuildRscNitroOptions } from "./nitro-build.js";
+export { default as nitro } from "./vite-plugin-nitro.js";
+export type { NitroPluginOptions } from "./vite-plugin-nitro.js";
+export interface FarmRscConfig {
+    srcDir?: string;
+    extends?: readonly FarmLayerEntry[];
+    layers?: readonly ResolvedFarmLayer[];
+    outDir?: string;
+    basePath?: string;
+    port?: number;
+    experimental?: {
+        serverComponents?: boolean;
+        serverActions?: boolean;
+        /**
+         * Enable server-only optimized boundaries through
+         * `@farm.js/plugin/rsc/optimized-boundary`.
+         *
+         * @experimental
+         * @default false
+         */
+        optimizedBoundary?: boolean;
+    };
+    debug?: boolean;
+    encryptActions?: boolean;
+    serverActions?: FarmServerActionsConfig;
+    deploymentId?: string;
+    generateBuildId?: () => string | Promise<string>;
+    routesDir?: string;
+    entries?: {
+        rsc?: string;
+        ssr?: string;
+        client?: string;
+    };
+    /** Extra Vite plugins (e.g. rsc() with entries so client build resolves virtual:vite-rsc/client-references). */
+    plugins?: any[];
+}
+/**
+ * Define a Farm.js RSC configuration
+ * This is the recommended way to configure your RSC app
+ */
+export declare function defineConfig(config?: FarmRscConfig): UserConfig;
+/**
+ * Farm.js RSC Plugin
+ *
+ * @param options - Plugin configuration options
+ * @returns Array of Vite plugins
+ */
+export default function farmRsc(options?: FarmRscPluginOptions): Plugin[];
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rsc/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAA4B,KAAK,MAAM,EAAE,KAAK,UAAU,EAAE,MAAM,MAAM,CAAC;AAE9E,OAAO,KAAK,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AA0B9E,YAAY,EAAE,oBAAoB,EAAE,YAAY,EAAE,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAExF,YAAY,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC1D,YAAY,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAGjE,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;IACpC,MAAM,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE;QACb,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B,CAAC;IACF,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE;QACR,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,gHAAgH;IAChH,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;CACjB;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,GAAE,aAAkB,GAAG,UAAU,CAiDnE;AA8TD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,OAAO,GAAE,oBAAyB,GAAG,MAAM,EAAE,CAqnC5E"}