@foldkit/vite-plugin 0.23.0 → 0.24.0-canary.989f8db07e4f

package/dist/build.d.ts

@@ -9,9 +9,10 @@ export type FoldkitPrerenderOptions = Readonly<{
      */
     paths?: ReadonlyArray<string>;
     /**
-     * The origin the entry sees as `Request.url` while generating, such as
-     * `'https://app.example'`. It reaches canonical URLs and Open Graph URLs, so
-     * a deployment that publishes those should set the origin it publishes.
+     * The origin used for `Request.url` while generating, such as
+     * `'https://app.example'`. This option does not set canonical or Open Graph
+     * metadata. It affects those fields only when the server entry derives them
+     * from `Request.url`, in which case it should match the published origin.
      */
     origin?: string;
     /**
@@ -42,15 +43,11 @@ export type FoldkitBuildOptions = Readonly<{
 /** Vite module id of the fetch handler Foldkit emits as the server entry. */
 export declare const FOLDKIT_FETCH_MODULE_ID = "virtual:foldkit/fetch";
 /**
- * What the build produced, written beside the server bundle for whatever
- * deploys it.
+ * What an `ssr.build` build produced, written beside the server bundle.
  *
- * A host has to decide what the asset layer does with a request that matches no
- * file, and that answer follows from the build rather than from taste: an
- * application with generated pages and no others wants a miss to stay a miss,
- * one with a server wants a miss to reach it, and one with neither wants the
- * template. Reading it here is how a deployment target gets that right without
- * asking its user to configure it twice.
+ * An SSR host serves generated paths as files and sends requests without a
+ * matching file to the server entry. A static-only SSG host serves the files
+ * and leaves other paths as misses.
  */
 export declare const FoldkitBuildManifest: Schema.Struct<{
     /**
@@ -71,26 +68,12 @@ export declare const FoldkitBuildManifest: Schema.Struct<{
     readonly serverEntry: Schema.String;
     /** Every path this build generated a page for, in the order it generated. */
     readonly prerendered: Schema.$Array<Schema.String>;
-    /**
-     * How a request-time host should run the server entry. Always `'fetch'`:
-     * the entry is a Web `fetch` handler, not a Node process.
-     */
-    readonly host: Schema.optional<Schema.Literals<readonly ["fetch"]>>;
 }>;
 /**
- * What the build produced, written beside the server bundle for whatever
- * deploys it.
- *
- * A host has to decide what the asset layer does with a request that matches no
- * file, and that answer follows from the build rather than from taste: an
- * application with generated pages and no others wants a miss to stay a miss,
- * one with a server wants a miss to reach it, and one with neither wants the
- * template. Reading it here is how a deployment target gets that right without
- * asking its user to configure it twice.
+ * The decoded shape of `foldkit.build.json`.
  *
- * It is a file on disk that something else writes the next time it builds, so a
- * consumer decodes it with this Schema and fails closed rather than trusting
- * the shape it happens to find.
+ * A deployment host decodes the manifest before using it. The Schema rejects
+ * unknown versions rather than letting the host read missing fields.
  */
 export type FoldkitBuildManifest = typeof FoldkitBuildManifest.Type;
 export declare const manifestPath: (root: string, directory: string, pathApi?: typeof nodePath) => string;
@@ -102,11 +85,10 @@ export declare const renderTargetFor: (clientDirectory: string, path: string, or
  * Builds a Web `fetch` handler alongside the browser build, and generates
  * static HTML from the server entry, inside one `vite build`.
  *
- * Vite drives both environments and every host plugin composes with them, so a
- * deployment target that runs `vite build` gets the whole application rather
- * than the browser half. The generated pages take their template from the
- * browser build's own output, so generating twice over one build produces the
- * same pages. The server bundle's default export is `{ fetch }`.
+ * Vite builds both environments, so a deployment target that runs `vite build`
+ * gets the browser and server bundles. The `fetch` handler and generated pages
+ * use the HTML emitted by the browser build, but the unrendered template is not
+ * published with the assets. The server bundle's default export is `{ fetch }`.
  */
 export declare const foldkitBuild: (serverEntry: string, options?: FoldkitBuildOptions) => Plugin;
 //# sourceMappingURL=build.d.ts.map

package/dist/build.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../src/build.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,MAAM,EAAE,MAAM,QAAQ,CAAA;AAGtC,OAAO,QAA8B,MAAM,WAAW,CAAA;AAEtD,OAAO,KAAK,EAGV,MAAM,EAEP,MAAM,MAAM,CAAA;AAEb,mEAAmE;AACnE,MAAM,MAAM,uBAAuB,GAAG,QAAQ,CAAC;IAC7C;;;OAGG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC7B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAC,CAAA;AAEF,4EAA4E;AAC5E,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC;IACzC,0CAA0C;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,yCAAyC;IACzC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAA;CAC9C,CAAC,CAAA;AAEF,6EAA6E;AAC7E,eAAO,MAAM,uBAAuB,0BAA0B,CAAA;AAE9D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;OAIG;;IAEH;;;;OAIG;;IAEH,+EAA+E;;IAE/E,2DAA2D;;IAE3D,6EAA6E;;IAE7E;;;OAGG;;EAEH,CAAA;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,oBAAoB,CAAC,IAAI,CAAA;AAcnE,eAAO,MAAM,YAAY,SACjB,MAAM,aACD,MAAM,YACR,OAAO,QAAQ,KACvB,MAQF,CAAA;AAwFD,eAAO,MAAM,eAAe,oBACT,MAAM,QACjB,MAAM,UACJ,MAAM,YACL,OAAO,QAAQ,KACvB,QAAQ,CAAC;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CA0CrC,CAAA;AA4GD;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,gBACV,MAAM,YACV,mBAAmB,KAC3B,MAoOF,CAAA"}
+{"version":3,"file":"build.d.ts","sourceRoot":"","sources":["../src/build.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAG/B,OAAO,QAA8B,MAAM,WAAW,CAAA;AAEtD,OAAO,KAAK,EAGV,MAAM,EAEP,MAAM,MAAM,CAAA;AAEb,mEAAmE;AACnE,MAAM,MAAM,uBAAuB,GAAG,QAAQ,CAAC;IAC7C;;;OAGG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAC,CAAA;AAEF,4EAA4E;AAC5E,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC;IACzC,0CAA0C;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,yCAAyC;IACzC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAA;CAC9C,CAAC,CAAA;AAEF,6EAA6E;AAC7E,eAAO,MAAM,uBAAuB,0BAA0B,CAAA;AAE9D;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;IAC/B;;;;OAIG;;IAEH;;;;OAIG;;IAEH,+EAA+E;;IAE/E,2DAA2D;;IAE3D,6EAA6E;;EAE7E,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,oBAAoB,CAAC,IAAI,CAAA;AAcnE,eAAO,MAAM,YAAY,SACjB,MAAM,aACD,MAAM,YACR,OAAO,QAAQ,KACvB,MAQF,CAAA;AAyFD,eAAO,MAAM,eAAe,oBACT,MAAM,QACjB,MAAM,UACJ,MAAM,YACL,OAAO,QAAQ,KACvB,QAAQ,CAAC;IAAE,GAAG,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CA0CrC,CAAA;AA4GD;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,gBACV,MAAM,YACV,mBAAmB,KAC3B,MAqOF,CAAA"}

package/dist/build.js

@@ -1,19 +1,15 @@
-import { Array, Schema } from 'effect';
+import { Schema } from 'effect';
 import { mkdir, writeFile } from 'node:fs/promises';
 import nodePath, { dirname, resolve } from 'node:path';
 import { pathToFileURL } from 'node:url';
 /** Vite module id of the fetch handler Foldkit emits as the server entry. */
 export const FOLDKIT_FETCH_MODULE_ID = 'virtual:foldkit/fetch';
 /**
- * What the build produced, written beside the server bundle for whatever
- * deploys it.
+ * What an `ssr.build` build produced, written beside the server bundle.
  *
- * A host has to decide what the asset layer does with a request that matches no
- * file, and that answer follows from the build rather than from taste: an
- * application with generated pages and no others wants a miss to stay a miss,
- * one with a server wants a miss to reach it, and one with neither wants the
- * template. Reading it here is how a deployment target gets that right without
- * asking its user to configure it twice.
+ * An SSR host serves generated paths as files and sends requests without a
+ * matching file to the server entry. A static-only SSG host serves the files
+ * and leaves other paths as misses.
  */
 export const FoldkitBuildManifest = Schema.Struct({
     /**
@@ -34,11 +30,6 @@ export const FoldkitBuildManifest = Schema.Struct({
     serverEntry: Schema.String,
     /** Every path this build generated a page for, in the order it generated. */
     prerendered: Schema.Array(Schema.String),
-    /**
-     * How a request-time host should run the server entry. Always `'fetch'`:
-     * the entry is a Web `fetch` handler, not a Node process.
-     */
-    host: Schema.optional(Schema.Literals(['fetch'])),
 });
 const MANIFEST_SCHEMA_VERSION = 1;
 // Relative and POSIX so the manifest describes a layout rather than this
@@ -59,6 +50,7 @@ export const manifestPath = (root, directory, pathApi = nodePath) => {
     return related.split(pathApi.sep).join('/');
 };
 const MANIFEST_FILE_NAME = 'foldkit.build.json';
+const TEMPLATE_FILE_NAME = 'index.html';
 const DEFAULT_CLIENT_OUT_DIR = 'dist/client';
 const DEFAULT_SERVER_OUT_DIR = 'dist/server';
 const DEFAULT_PRERENDER_ORIGIN = 'http://localhost';
@@ -212,7 +204,7 @@ const fetchModuleSource = (serverEntry, template, containerId) => {
 // page which cannot hydrate, from a build that reported success.
 const templateForFetchModule = (capturedTemplate) => {
     if (capturedTemplate === undefined) {
-        throw new Error('[foldkit] the browser build has not emitted index.html, so the fetch handler has no template to render into. Build the "client" environment before "ssr", and give the client an HTML entry.');
+        throw new Error(`[foldkit] the browser build has not emitted ${TEMPLATE_FILE_NAME}, so the fetch handler has no template to render into. Build the "client" environment before "ssr", and give the client an HTML entry.`);
     }
     return capturedTemplate;
 };
@@ -220,11 +212,10 @@ const templateForFetchModule = (capturedTemplate) => {
  * Builds a Web `fetch` handler alongside the browser build, and generates
  * static HTML from the server entry, inside one `vite build`.
  *
- * Vite drives both environments and every host plugin composes with them, so a
- * deployment target that runs `vite build` gets the whole application rather
- * than the browser half. The generated pages take their template from the
- * browser build's own output, so generating twice over one build produces the
- * same pages. The server bundle's default export is `{ fetch }`.
+ * Vite builds both environments, so a deployment target that runs `vite build`
+ * gets the browser and server bundles. The `fetch` handler and generated pages
+ * use the HTML emitted by the browser build, but the unrendered template is not
+ * published with the assets. The server bundle's default export is `{ fetch }`.
  */
 export const foldkitBuild = (serverEntry, options = {}) => {
     const clientOutDir = options.clientOutDir ?? DEFAULT_CLIENT_OUT_DIR;
@@ -274,7 +265,6 @@ export const foldkitBuild = (serverEntry, options = {}) => {
             server: manifestPath(builder.config.root, serverOutDir),
             serverEntry: entryFileName,
             prerendered,
-            host: 'fetch',
         });
         await writeFile(resolve(serverDirectory, MANIFEST_FILE_NAME), `${JSON.stringify(manifest, undefined, 2)}\n`);
         builder.config.logger.info(`  wrote ${MANIFEST_FILE_NAME}`);
@@ -307,7 +297,7 @@ export const foldkitBuild = (serverEntry, options = {}) => {
         // nothing has no use for an HTML entry and must not require one.
         const template = () => {
             if (state.template === undefined) {
-                throw new Error('[foldkit] the browser build emitted no index.html to generate pages from. Prerendering needs an HTML entry.');
+                throw new Error(`[foldkit] the browser build emitted no ${TEMPLATE_FILE_NAME} to generate pages from. Prerendering needs an HTML entry.`);
             }
             return state.template;
         };
@@ -318,7 +308,6 @@ export const foldkitBuild = (serverEntry, options = {}) => {
         name: 'foldkit:build',
         apply: 'build',
         api: {
-            host: 'fetch',
             serverEntry,
             fetchModuleId: FOLDKIT_FETCH_MODULE_ID,
         },
@@ -336,23 +325,26 @@ export const foldkitBuild = (serverEntry, options = {}) => {
             const template = templateForFetchModule(state.template);
             return fetchModuleSource(serverEntry, template, containerId);
         },
-        // NOTE: `writeBundle` rather than `generateBundle`: Vite's own HTML plugin
-        // emits `index.html` from a `generateBundle` hook of its own, and hook
-        // order between plugins decides whether that asset exists yet. By
-        // `writeBundle` the bundle is whatever the environment actually produced.
-        writeBundle(_options, bundle) {
-            const state = captured(this.environment.config.root);
-            const outputs = Object.values(bundle);
-            if (this.environment.name === 'client') {
-                const html = Array.findFirst(outputs, file => file.type === 'asset' && file.fileName === 'index.html');
-                if (html._tag === 'Some' && html.value.type === 'asset') {
-                    state.template = String(html.value.source);
+        // NOTE: `order: 'post'` because Vite's own HTML plugin emits `index.html`
+        // from a `generateBundle` of its own; post is guaranteed to run after it.
+        generateBundle: {
+            order: 'post',
+            handler(_options, bundle) {
+                const state = captured(this.environment.config.root);
+                if (this.environment.name === 'ssr') {
+                    state.serverEntryFile = serverEntryFile(Object.values(bundle), FETCH_CHUNK_NAME);
+                    return;
                 }
-                return;
-            }
-            if (this.environment.name === 'ssr') {
-                state.serverEntryFile = serverEntryFile(outputs, FETCH_CHUNK_NAME);
-            }
+                if (this.environment.name !== 'client') {
+                    return;
+                }
+                const html = bundle[TEMPLATE_FILE_NAME];
+                if (html === undefined || html.type !== 'asset') {
+                    return;
+                }
+                state.template = String(html.source);
+                delete bundle[TEMPLATE_FILE_NAME];
+            },
         },
         config: userConfig => {
             const client = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foldkit/vite-plugin",
-  "version": "0.23.0",
+  "version": "0.24.0-canary.989f8db07e4f",
   "description": "Vite plugin for Foldkit with state-preserving live reload",
   "type": "module",
   "main": "./dist/index.js",
@@ -16,8 +16,8 @@
     "dist"
   ],
   "peerDependencies": {
-    "effect": "4.0.0-rc.115",
-    "foldkit": ">=0.159.0",
+    "effect": "4.0.0-rc.116",
+    "foldkit": "0.163.0-canary.989f8db07e4f",
     "vite": "^8.0.0"
   },
   "dependencies": {
@@ -27,14 +27,14 @@
   "devDependencies": {
     "@types/node": "^26.4.0",
     "@types/ws": "^8.18.1",
-    "effect": "4.0.0-rc.115",
+    "effect": "4.0.0-rc.116",
     "happy-dom": "^20.11.13",
     "rimraf": "^6.1.3",
     "typescript": "^7.0.2",
     "vite": "^8.2.2",
     "vite-host": "npm:vite@8.2.1",
     "vitest": "^4.1.11",
-    "foldkit": "0.161.0"
+    "foldkit": "0.163.0-canary.989f8db07e4f"
   },
   "keywords": [
     "vite",