@farm.js/core 0.1.0-beta.45 → 0.1.0-beta.47

package/dist/client.mjs

@@ -62,7 +62,7 @@ import {
   createClientPluginManager,
   installChunkErrorRecovery,
   isChunkLoadError
-} from "./chunk-QLCUQD3U.mjs";
+} from "./chunk-SHZF3DEB.mjs";
 import "./chunk-GQVQESLY.mjs";
 import {
   api,
@@ -80,7 +80,7 @@ import "./chunk-RBRLLZL5.mjs";
 import "./chunk-WZ5QFROO.mjs";
 import "./chunk-7ZMKVETU.mjs";
 import "./chunk-FXG2PS27.mjs";
-import "./chunk-FLGRRGVU.mjs";
+import "./chunk-KTV3UWGE.mjs";
 import "./chunk-CGILA3WO.mjs";
 export {
   APIClientError,

package/dist/index.cjs

@@ -256,6 +256,13 @@ function matchRoute(url, segments) {
 function resolveAppPath(root, ...paths) {
   return import_path.default.resolve(root, ...paths);
 }
+function toRootRelativeUrlPath(absolutePath, projectRoot) {
+  if (absolutePath === projectRoot) return "";
+  if (absolutePath.startsWith(`${projectRoot}/`) || absolutePath.startsWith(`${projectRoot}\\`)) {
+    return absolutePath.slice(projectRoot.length).replace(/\\/g, "/");
+  }
+  return void 0;
+}
 function toViteModuleId(filePath, root) {
   if (!import_path.default.isAbsolute(filePath)) return filePath;
   const relativePath2 = import_path.default.relative(root, filePath);
@@ -304,6 +311,7 @@ var init_utils = __esm({
     __name(segmentsToPattern, "segmentsToPattern");
     __name(matchRoute, "matchRoute");
     __name(resolveAppPath, "resolveAppPath");
+    __name(toRootRelativeUrlPath, "toRootRelativeUrlPath");
     __name(toViteModuleId, "toViteModuleId");
     __name(fileExists, "fileExists");
     __name(globFiles, "globFiles");
@@ -10544,9 +10552,8 @@ var init_route_manager = __esm({
           return this.clientManifestCache.manifest;
         }
         const toUrlPath = /* @__PURE__ */ __name((absolutePath) => {
-          if (absolutePath === normalizedProjectRoot || absolutePath.startsWith(`${normalizedProjectRoot}${import_path5.default.sep}`)) {
-            return absolutePath.slice(normalizedProjectRoot.length);
-          }
+          const rootRelative = toRootRelativeUrlPath(absolutePath, normalizedProjectRoot);
+          if (rootRelative !== void 0) return rootRelative;
           if (import_path5.default.isAbsolute(absolutePath)) {
             const normalized = absolutePath.replace(/\\/g, "/");
             return normalized.startsWith("/") ? `/@fs${normalized}` : `/@fs/${normalized}`;
@@ -11172,6 +11179,60 @@ var init_route_manager = __esm({
   }
 });
 
+// src/server/full-document.ts
+function stripContentsWrappers(markup) {
+  let out = markup.replace(/^\s+/, "");
+  const opener = /^<div\b[^>]*style="display\s*:\s*contents"[^>]*>/i;
+  let match;
+  while (match = opener.exec(out)) {
+    out = out.slice(match[0].length).replace(/^\s+/, "");
+  }
+  return out;
+}
+function extractFarmFullDocument(markup) {
+  const inner = stripContentsWrappers(markup);
+  if (!/^<!doctype/i.test(inner) && !/^<html[\s>]/i.test(inner)) return null;
+  const start = markup.search(/<!doctype|<html[\s>]/i);
+  const closeIndex = markup.toLowerCase().lastIndexOf("</html>");
+  if (start < 0 || closeIndex < 0) return null;
+  return markup.slice(start, closeIndex + "</html>".length);
+}
+function opensFarmFullDocument(markup) {
+  const inner = stripContentsWrappers(markup);
+  return /^<!doctype/i.test(inner) || /^<html[\s>]/i.test(inner);
+}
+function composeFarmFullDocument(documentHtml, assets) {
+  let html = documentHtml;
+  if (assets.htmlAttributes) {
+    html = html.replace(
+      /<html\b([^>]*)>/i,
+      (_match, attrs) => `<html${attrs}${assets.htmlAttributes}>`
+    );
+  }
+  if (!/\sid=["']root["']/i.test(html)) {
+    html = html.replace(/<body\b([^>]*)>/i, '<body$1><div id="root">').replace(/<\/body>/i, "</div></body>");
+  }
+  if (assets.headAssets) {
+    html = html.replace(/<\/head>/i, () => `  ${assets.headAssets}
+</head>`);
+  }
+  if (assets.bodyFooter) {
+    html = html.replace(/<\/body>/i, () => `  ${assets.bodyFooter}
+</body>`);
+  }
+  return /^\s*<!doctype/i.test(html) ? html : `<!DOCTYPE html>
+${html}`;
+}
+var init_full_document = __esm({
+  "src/server/full-document.ts"() {
+    "use strict";
+    __name(stripContentsWrappers, "stripContentsWrappers");
+    __name(extractFarmFullDocument, "extractFarmFullDocument");
+    __name(opensFarmFullDocument, "opensFarmFullDocument");
+    __name(composeFarmFullDocument, "composeFarmFullDocument");
+  }
+});
+
 // src/middleware/server.ts
 function getGlobalMiddlewareStore(key) {
   const state = globalThis;
@@ -15188,7 +15249,7 @@ var init_server3 = __esm({
 var version;
 var init_package = __esm({
   "package.json"() {
-    version = "0.1.0-beta.45";
+    version = "0.1.0-beta.47";
   }
 });
 
@@ -15360,6 +15421,13 @@ function warnSuppressedAsyncHydrationOnce(modulePath) {
     `${modulePath} is an async server component that imports client components. React cannot hydrate async components in the browser, so this route stays server-rendered and its client imports are not interactive. Move the interactive UI into a "use client" child rendered by a synchronous page, or enable experimental server components support.`
   );
 }
+function warnFarmFullDocumentLayout() {
+  if (warnedFullDocumentLayout) return;
+  warnedFullDocumentLayout = true;
+  logger.warn(
+    `A root layout returned a full <html> document. Farm.js owns the document shell, so a layout should return a fragment (its children) \u2014 like the docs example \u2014 and let the framework provide <html>/<head>/<body>. The document has been composed into the response, but returning a fragment avoids the ambiguity and keeps dev and production identical.`
+  );
+}
 function hasRequestHeader(req, name2) {
   const value = req.headers[name2.toLowerCase()];
   return Array.isArray(value) ? value.length > 0 : Boolean(value);
@@ -15498,13 +15566,14 @@ function createRouteStateProps(input) {
     context: input.pluginExposedContext.size > 0 ? { data: input.pluginExposedContext } : void 0
   };
 }
-var fs3, path11, import_stream, import_node_url5, cachedClerkProvider, importRuntimeModule, warnedSuppressedAsyncHydrationModules, _ServerRenderer, ServerRenderer;
+var fs3, path11, import_stream, import_node_url5, cachedClerkProvider, importRuntimeModule, warnedSuppressedAsyncHydrationModules, fullDocumentRoutes, warnedFullDocumentLayout, _ServerRenderer, ServerRenderer;
 var init_renderer2 = __esm({
   "src/server/renderer.ts"() {
     "use strict";
     fs3 = __toESM(require("fs"));
     path11 = __toESM(require("path"));
     init_utils();
+    init_full_document();
     init_client_component();
     import_stream = require("stream");
     init_server();
@@ -15539,6 +15608,9 @@ var init_renderer2 = __esm({
     importRuntimeModule = new Function("specifier", "return import(specifier);");
     warnedSuppressedAsyncHydrationModules = /* @__PURE__ */ new Set();
     __name(warnSuppressedAsyncHydrationOnce, "warnSuppressedAsyncHydrationOnce");
+    fullDocumentRoutes = /* @__PURE__ */ new Set();
+    warnedFullDocumentLayout = false;
+    __name(warnFarmFullDocumentLayout, "warnFarmFullDocumentLayout");
     __name(hasRequestHeader, "hasRequestHeader");
     __name(serializeInlineValue2, "serializeInlineValue");
     __name(escapeHtmlAttribute2, "escapeHtmlAttribute");
@@ -16236,7 +16308,7 @@ var init_renderer2 = __esm({
           );
           const clientLayouts = layouts.map((layout2, index) => ({
             pattern: layout2.pattern,
-            modulePath: layout2.modulePath.startsWith(this.config.root) ? layout2.modulePath.slice(this.config.root.length) : layout2.modulePath,
+            modulePath: toRootRelativeUrlPath(layout2.modulePath, this.config.root) ?? layout2.modulePath,
             shouldHydrate: layoutHydrationMetadata[index]?.shouldHydrate === true,
             islandStrategy: layoutHydrationMetadata[index]?.islandStrategy ?? null
           }));
@@ -16812,7 +16884,7 @@ var init_renderer2 = __esm({
           const routeSlots = (req.__FARM_ROUTE_SLOTS__ || []).map(
             (slot) => ({
               ...slot,
-              modulePath: typeof slot.modulePath === "string" && slot.modulePath.startsWith(this.config.root) ? slot.modulePath.slice(this.config.root.length) : slot.modulePath
+              modulePath: typeof slot.modulePath === "string" ? toRootRelativeUrlPath(slot.modulePath, this.config.root) ?? slot.modulePath : slot.modulePath
             })
           );
           const deferredProps = prepareDeferredData({
@@ -16820,7 +16892,7 @@ var init_renderer2 = __esm({
             slots: routeSlots
           });
           const pagePath = req.__FARM_PAGE_PATH__;
-          const relativePath2 = pagePath ? pagePath.startsWith(this.config.root) ? pagePath.slice(this.config.root.length) : pagePath : "/src/app/page.tsx";
+          const relativePath2 = pagePath ? toRootRelativeUrlPath(pagePath, this.config.root) ?? pagePath : "/src/app/page.tsx";
           const deploymentId = this.getDeploymentId();
           const bootstrapScript = `<script>
 window.__FARM_PROPS__ = ${serializeInlineValue2(deferredProps.data.page)};
@@ -16854,7 +16926,27 @@ ${getFarmI18nClientSnapshot() ? `window.__FARM_I18N__ = ${serializeInlineValue2(
             this.config.basePath,
             getTheme()
           );
-          const html = `<!DOCTYPE html>
+          const fullDocument = extractFarmFullDocument(content);
+          let html;
+          if (fullDocument) {
+            warnFarmFullDocumentLayout();
+            html = composeFarmFullDocument(fullDocument, {
+              htmlAttributes: `${i18nSnapshot ? ` dir="${i18nSnapshot.direction}"` : ""}${themeDocument.attributes}`,
+              headAssets: [
+                themeDocument.head,
+                `<meta name="farm-deployment-id" content="${escapeHtmlAttribute2(deploymentId)}">`,
+                metaTags,
+                alternateTags,
+                renderFarmFontDevHead(this.config.root || process.cwd()),
+                `<link rel="stylesheet" href="/src/app/globals.css">`,
+                `<script type="module" src="/@vite/client"></script>`,
+                rendererHydrationScript,
+                bootstrapScript
+              ].filter(Boolean).join("\n  "),
+              bodyFooter: [deferredScript, `<script type="module" src="/@farm/client.js"></script>`].filter(Boolean).join("\n  ")
+            });
+          } else {
+            html = `<!DOCTYPE html>
 <html lang="${escapeHtmlAttribute2(i18nSnapshot?.locale || "en")}"${i18nSnapshot ? ` dir="${i18nSnapshot.direction}"` : ""}${themeDocument.attributes}>
 <head>
   ${themeDocument.head}
@@ -16875,6 +16967,7 @@ ${getFarmI18nClientSnapshot() ? `window.__FARM_I18N__ = ${serializeInlineValue2(
   <script type="module" src="/@farm/client.js"></script>
 </body>
 </html>`;
+          }
           emitFarmEvent({
             type: "render.stream.shellReady",
             route: route2,
@@ -16897,7 +16990,8 @@ ${getFarmI18nClientSnapshot() ? `window.__FARM_I18N__ = ${serializeInlineValue2(
       }
       async renderWithSSR(element, req, res, clearMiddlewareData, options = {}) {
         const renderToPipeableStream2 = this.rendererRuntime.renderToPipeableStream;
-        if (!renderToPipeableStream2) {
+        const fullDocumentRouteKey = options.observabilityRoute || req.__FARM_ROUTE__ || req.url || "/";
+        if (!renderToPipeableStream2 || fullDocumentRoutes.has(fullDocumentRouteKey)) {
           return this.renderBufferedSSR(element, req, res, clearMiddlewareData, options);
         }
         return new Promise((resolve8, reject) => {
@@ -16916,7 +17010,7 @@ ${getFarmI18nClientSnapshot() ? `window.__FARM_I18N__ = ${serializeInlineValue2(
           let didError = false;
           const pagePath = req.__FARM_PAGE_PATH__;
           const isClientComponent = req.__FARM_IS_CLIENT_COMPONENT__ === true;
-          const relativePath2 = pagePath ? pagePath.startsWith(this.config.root) ? pagePath.slice(this.config.root.length) : pagePath : "/src/app/page.tsx";
+          const relativePath2 = pagePath ? toRootRelativeUrlPath(pagePath, this.config.root) ?? pagePath : "/src/app/page.tsx";
           const manifest = options.routeManifest ?? this.routeManager.generateClientManifest(this.config.root);
           const clientManifest = {
             clientEntry: "/@farm/client.js",
@@ -16964,7 +17058,7 @@ ${getFarmI18nClientSnapshot() ? `window.__FARM_I18N__ = ${serializeInlineValue2(
           const routeSlotPayload = (req.__FARM_ROUTE_SLOTS__ || []).map(
             (slot) => ({
               ...slot,
-              modulePath: typeof slot.modulePath === "string" && slot.modulePath.startsWith(this.config.root) ? slot.modulePath.slice(this.config.root.length) : slot.modulePath
+              modulePath: typeof slot.modulePath === "string" ? toRootRelativeUrlPath(slot.modulePath, this.config.root) ?? slot.modulePath : slot.modulePath
             })
           );
           const deferredProps = prepareDeferredData({
@@ -17044,6 +17138,7 @@ ${getFarmI18nClientSnapshot() ? `window.__FARM_I18N__ = ${serializeInlineValue2(
               htmlParts.push(shell);
               staticShellParts?.push(shell);
               let firstChunk = true;
+              let checkedFullDocument = false;
               const writableStream = new import_stream.Writable({
                 write(chunk, encoding, callback) {
                   if (firstChunk && process.env.FARM_VERBOSE) {
@@ -17051,6 +17146,13 @@ ${getFarmI18nClientSnapshot() ? `window.__FARM_I18N__ = ${serializeInlineValue2(
                     firstChunk = false;
                   }
                   const chunkText = Buffer.isBuffer(chunk) ? chunk.toString() : String(chunk);
+                  if (!checkedFullDocument) {
+                    checkedFullDocument = true;
+                    if (opensFarmFullDocument(chunkText)) {
+                      fullDocumentRoutes.add(fullDocumentRouteKey);
+                      warnFarmFullDocumentLayout();
+                    }
+                  }
                   htmlParts.push(chunkText);
                   if (staticShellParts && !staticShellClosed) {
                     const dynamicIndex = findPPRDynamicChunkIndex(chunkText);
@@ -17249,6 +17351,24 @@ ${i18nSnapshot ? `window.__FARM_I18N__ = ${serializeInlineValue2(i18nSnapshot)};
           getTheme()
         );
         const rendererHydrationScript = this.rendererRuntime.generateHydrationScript?.() || "";
+        const fullDocument = extractFarmFullDocument(content);
+        if (fullDocument) {
+          warnFarmFullDocumentLayout();
+          return composeFarmFullDocument(fullDocument, {
+            htmlAttributes: `${i18nSnapshot ? ` dir="${i18nSnapshot.direction}"` : ""}${themeDocument.attributes}`,
+            headAssets: [
+              themeDocument.head,
+              `<meta name="farm-deployment-id" content="${escapeHtmlAttribute2(this.getDeploymentId())}">`,
+              alternateLinks,
+              fontHead,
+              `<link rel="stylesheet" href="/src/app/globals.css" />`,
+              `<script type="module" src="/@vite/client"></script>`,
+              rendererHydrationScript,
+              integrationManifestScript
+            ].filter(Boolean).join("\n  "),
+            bodyFooter: clientScript.trim()
+          });
+        }
         return `<!DOCTYPE html>
 <html lang="${escapeHtmlAttribute2(i18nSnapshot?.locale || "en")}"${i18nSnapshot ? ` dir="${i18nSnapshot.direction}"` : ""}${themeDocument.attributes}>
 <head>
@@ -34212,6 +34332,7 @@ __export(src_exports, {
   storageCacheAdapter: () => storageCacheAdapter,
   titleFromMarkdown: () => titleFromMarkdown,
   toFormData: () => toFormData,
+  toRootRelativeUrlPath: () => toRootRelativeUrlPath,
   toViteModuleId: () => toViteModuleId,
   toggleTheme: () => toggleTheme,
   unstable_cache: () => unstable_cache,
@@ -50297,6 +50418,7 @@ __name(decodeCookiePart, "decodeCookiePart");
   storageCacheAdapter,
   titleFromMarkdown,
   toFormData,
+  toRootRelativeUrlPath,
   toViteModuleId,
   toggleTheme,
   unstable_cache,