@foldkit/vite-plugin 0.26.0 → 0.26.1

package/README.md

@@ -65,6 +65,25 @@ With this set, the dev server converts HTML page requests to Web `Request` value
 
 Vite retains ownership of configured proxy routes before Foldkit handles application requests. Vite's `server.cors` option applies to Vite-owned source modules, assets, and HMR. It does not add headers to application responses or answer their preflights. Preflight ownership follows `Access-Control-Request-Method`, so a preflight for an application `POST` reaches `renderPage` even when its path looks like an asset. An `OPTIONS` request without both `Origin` and `Access-Control-Request-Method` is not a preflight and also reaches `renderPage`. Define application CORS in `renderPage`, where development and the deployed host share one policy. Vite's `allowedHosts` check runs before proxy and application handling, including `OPTIONS` and methods the Web `Request` API cannot represent.
 
+## Foldkit package resolution
+
+Each module graph must load one Foldkit copy. The plugin configures Vite for that:
+
+- `resolve.dedupe` lists `foldkit`, `@foldkit/ui`, and `@foldkit/devtools`, each only when it resolves from the application root.
+- Server builds and the dev server's server render bundle those three packages, plus every installed package whose `dependencies` or `peerDependencies` include `foldkit` or an `@foldkit/*` package, such as `@foldkit/markdown`. In the dev server, these `ssr.noExternal` packages run through Vite's module runner instead of Node's own import. An explicit `ssr.external` entry still keeps a package external.
+- The plugin finds these packages by crawling from the application's `package.json`. It follows the application's `dependencies` and `devDependencies`, then the `dependencies` of each package it bundles, plus the `devDependencies` of a bundled package that is a private workspace package.
+
+A package the crawl does not reach stays external. For example: a peer the application does not declare, or a package reached only through a package that does not depend on Foldkit. Such a package loads a second Foldkit copy from `node_modules` at runtime. Declare it in the application's `package.json`, or add it to `ssr.noExternal`:
+
+```typescript
+export default defineConfig({
+  plugins: [foldkit()],
+  ssr: { noExternal: ['foldkit-component-library'] },
+})
+```
+
+Vitest copies SSR `noExternal` into `server.deps.inline`. A Vitest config that includes `foldkit()` therefore also inlines the crawled packages in tests.
+
 ## Completed build metadata
 
 Deployment tools that run Vite in process can read `foldkit:build` through Vite's standard plugin `api` field. Await the full application build before reading:

package/dist/foldkitPackages.d.ts

@@ -1,12 +1,17 @@
+import { type UserConfig } from 'vite';
 /** Tests whether an import refers to a package that must share Foldkit's
  * runtime instance.
  *
  * @internal
  */
 export declare const isFoldkitSingletonPackageSpecifier: (specifier: string) => boolean;
-/** Resolves the installed packages that must share Foldkit's runtime instance.
+/** Finds the installed packages an application's server render must bundle
+ * and the Foldkit packages Vite must deduplicate.
  *
  * @internal
  */
-export declare const resolveInstalledFoldkitPackages: (root: string) => Array<string>;
+export declare const crawlFoldkitPackages: (root: string, isBuild: boolean, viteUserConfig: UserConfig) => Promise<Readonly<{
+    dedupe: Array<string>;
+    ssrNoExternal: Array<string>;
+}>>;
 //# sourceMappingURL=foldkitPackages.d.ts.map

package/dist/foldkitPackages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"foldkitPackages.d.ts","sourceRoot":"","sources":["../src/foldkitPackages.ts"],"names":[],"mappings":"AAUA;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,cAClC,MAAM,KAChB,OAKA,CAAA;AAEH;;;GAGG;AACH,eAAO,MAAM,+BAA+B,SACpC,MAAM,KACX,KAAK,CAAC,MAAM,CAmBd,CAAA"}
+{"version":3,"file":"foldkitPackages.d.ts","sourceRoot":"","sources":["../src/foldkitPackages.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,UAAU,EAA0B,MAAM,MAAM,CAAA;AAS9D;;;;GAIG;AACH,eAAO,MAAM,kCAAkC,cAClC,MAAM,KAChB,OAKA,CAAA;AA8CH;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,SACzB,MAAM,WACH,OAAO,kBACA,UAAU,KACzB,OAAO,CACR,QAAQ,CAAC;IAAE,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAAC,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;CAAE,CAAC,CAqClE,CAAA"}

package/dist/foldkitPackages.js

@@ -1,6 +1,8 @@
-import { Array, Predicate } from 'effect';
-import { createRequire } from 'node:module';
+import { Array, Option, Record, Schema, pipe } from 'effect';
+import { realpathSync } from 'node:fs';
 import { resolve } from 'node:path';
+import { searchForWorkspaceRoot } from 'vite';
+import { crawlFrameworkPkgs, findDepPkgJsonPath } from 'vitefu';
 const FOLDKIT_SINGLETON_PACKAGES = [
     'foldkit',
     '@foldkit/ui',
@@ -12,26 +14,55 @@ const FOLDKIT_SINGLETON_PACKAGES = [
  * @internal
  */
 export const isFoldkitSingletonPackageSpecifier = (specifier) => Array.some(FOLDKIT_SINGLETON_PACKAGES, packageName => specifier === packageName || specifier.startsWith(`${packageName}/`));
-/** Resolves the installed packages that must share Foldkit's runtime instance.
+const isFoldkitPackageName = (name) => name === 'foldkit' || name.startsWith('@foldkit/');
+const decodeDependencyRecord = Schema.decodeUnknownOption(Schema.Record(Schema.String, Schema.Unknown));
+const dependencyNames = (field) => Option.match(decodeDependencyRecord(field), {
+    onNone: () => [],
+    onSome: Record.keys,
+});
+const dependsOnFoldkit = (packageJson) => pipe([packageJson['dependencies'], packageJson['peerDependencies']], Array.flatMap(dependencyNames), Array.some(isFoldkitPackageName));
+const toRealPath = (path) => {
+    try {
+        return realpathSync(path);
+    }
+    catch {
+        return path;
+    }
+};
+const toCrawlRoot = (root, isPreservingSymlinks) => {
+    const absoluteRoot = resolve(root);
+    // NOTE: The crawl and the dedupe lookup must start from the root Vite
+    // resolves from: the path as given under resolve.preserveSymlinks, and its
+    // realpath otherwise. Any other root makes them walk a different directory
+    // chain than Vite's resolver.
+    if (isPreservingSymlinks) {
+        return absoluteRoot;
+    }
+    return toRealPath(absoluteRoot);
+};
+/** Finds the installed packages an application's server render must bundle
+ * and the Foldkit packages Vite must deduplicate.
  *
  * @internal
  */
-export const resolveInstalledFoldkitPackages = (root) => {
-    // NOTE: Vite can supply a relative root before it resolves the config, while
-    // createRequire requires an absolute path.
-    const requireFromRoot = createRequire(resolve(root, 'noop.js'));
-    return Array.filter(FOLDKIT_SINGLETON_PACKAGES, packageName => {
-        try {
-            requireFromRoot.resolve(packageName);
-            return true;
-        }
-        catch (error) {
-            // NOTE: optional ESM-only packages can throw
-            // ERR_PACKAGE_PATH_NOT_EXPORTED even when installed. Only
-            // MODULE_NOT_FOUND proves this consumer does not have the package.
-            return !(error instanceof Error &&
-                Predicate.hasProperty(error, 'code') &&
-                error.code === 'MODULE_NOT_FOUND');
-        }
+export const crawlFoldkitPackages = async (root, isBuild, viteUserConfig) => {
+    const crawlRoot = toCrawlRoot(root, viteUserConfig.resolve?.preserveSymlinks ?? false);
+    // NOTE: vitefu realpaths each dependency's package.json before comparing it
+    // with workspaceRoot, including when Vite preserves symlinks. The workspace
+    // boundary must use the same form so private workspace packages are found.
+    const workspaceRoot = toRealPath(searchForWorkspaceRoot(crawlRoot));
+    const crawl = await crawlFrameworkPkgs({
+        root: crawlRoot,
+        workspaceRoot,
+        isBuild,
+        viteUserConfig,
+        isSemiFrameworkPkgByJson: dependsOnFoldkit,
     });
+    const ssrNoExternal = Array.dedupe([
+        ...FOLDKIT_SINGLETON_PACKAGES,
+        ...crawl.ssr.noExternal,
+    ]);
+    const maybeResolvableSingletons = await Promise.all(Array.map(FOLDKIT_SINGLETON_PACKAGES, async (packageName) => pipe(await findDepPkgJsonPath(packageName, crawlRoot), Option.fromUndefinedOr, Option.as(packageName))));
+    const dedupe = Array.getSomes(maybeResolvableSingletons);
+    return { dedupe, ssrNoExternal };
 };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA6CA,OAAO,KAAK,EAEV,MAAM,EAIP,MAAM,MAAM,CAAA;AAOb,OAAO,EAAE,KAAK,mBAAmB,EAAgB,MAAM,YAAY,CAAA;AAKnE,OAAO,EAAE,KAAK,iBAAiB,EAAc,MAAM,UAAU,CAAA;AAG7D,OAAO,EAAE,KAAK,eAAe,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACzE,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,oBAAoB,EACpB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,YAAY,GACb,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,KAAK,iBAAiB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAC7D,OAAO,EACL,KAAK,2BAA2B,EAChC,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,mBAAmB,CAAA;AAE1B,6CAA6C;AAC7C,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC;IAC1C;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,KAAK,CAAA;IAChC;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,SAAS,GAAG,gBAAgB,CAAC,GACzD,QAAQ,CAAC;QACP;;;;;;;;WAQG;QACH,KAAK,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAA;KACtC,CAAC,CAAA;IACJ;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAC,CAAA;AAs6BF,eAAO,MAAM,OAAO,aAAa,oBAAoB,KAAQ,KAAK,CAAC,MAAM,CAuHxE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA6CA,OAAO,KAAK,EAEV,MAAM,EAIP,MAAM,MAAM,CAAA;AAOb,OAAO,EAAE,KAAK,mBAAmB,EAAgB,MAAM,YAAY,CAAA;AAKnE,OAAO,EAAE,KAAK,iBAAiB,EAAc,MAAM,UAAU,CAAA;AAG7D,OAAO,EAAE,KAAK,eAAe,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACzE,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,oBAAoB,EACpB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,YAAY,GACb,MAAM,YAAY,CAAA;AACnB,OAAO,EAAE,KAAK,iBAAiB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAC7D,OAAO,EACL,KAAK,2BAA2B,EAChC,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,mBAAmB,CAAA;AAE1B,6CAA6C;AAC7C,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC;IAC1C;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,KAAK,CAAA;IAChC;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,SAAS,GAAG,gBAAgB,CAAC,GACzD,QAAQ,CAAC;QACP;;;;;;;;WAQG;QACH,KAAK,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAA;KACtC,CAAC,CAAA;IACJ;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAC,CAAA;AAs6BF,eAAO,MAAM,OAAO,aAAa,oBAAoB,KAAQ,KAAK,CAAC,MAAM,CAyHxE,CAAA"}

package/dist/index.js

@@ -10,7 +10,7 @@ import * as NodePath from '@effect/platform-node/NodePath';
 import { foldkitBuild } from './build.js';
 import { foldkitBuildToken } from './buildToken.js';
 import { devToolsOverlayPlugin } from './devToolsOverlay.js';
-import { resolveInstalledFoldkitPackages } from './foldkitPackages.js';
+import { crawlFoldkitPackages } from './foldkitPackages.js';
 import { publishRelayRecord, retireRelayRecord } from './relayRegistry.js';
 import { foldkitSsr } from './ssr.js';
 import { foldkitViewIdentity } from './viewIdentity.js';
@@ -18,16 +18,15 @@ export { brandDistDirectory } from './brandDist.js';
 export { FOLDKIT_FETCH_MODULE_ID, FoldkitBuildManifest, FoldkitBuildMetadata, foldkitBuild, } from './build.js';
 export { foldkitSsr } from './ssr.js';
 export { foldkitViewIdentity, transformViewIdentity, } from './viewIdentity.js';
-// NOTE: Vite's dep optimizer scans the consumer's source for `effect`
-// imports and pre-bundles only those exports into a single `effect.js`
-// blob. It does not follow imports through workspace/node_modules
-// packages, so any `effect` namespace foldkit's compiled dist references
-// that the consumer does not mention by name is missing from the blob
-// and crashes at runtime in dev. The list below covers every top-level
-// namespace foldkit imports from bare `'effect'`. Over-inclusion is
-// harmless; under-inclusion is the bug. Kept in sync with foldkit's
-// source by `scripts/check-effect-prebundle.ts` (runs in `pnpm check`).
-const FORCE_INCLUDED_EFFECT_NAMESPACES = [
+// NOTE: Vite does not scan imports through `foldkit` because the plugin
+// excludes the package from optimization. A consumer can import only Effect
+// subpaths while Foldkit's compiled distribution imports the bare barrel, so
+// include both the barrel and every top-level namespace Foldkit imports. This
+// keeps them in one optimized dependency graph. Over-inclusion is harmless;
+// under-inclusion is the bug. `scripts/check-effect-prebundle.ts` keeps the
+// entries in sync with Foldkit's source and runs in `pnpm check`.
+const FORCE_INCLUDED_EFFECT_ENTRIES = [
+    'effect',
     'effect/Array',
     'effect/Boolean',
     'effect/Cause',
@@ -55,6 +54,7 @@ const FORCE_INCLUDED_EFFECT_NAMESPACES = [
     'effect/PubSub',
     'effect/Queue',
     'effect/Record',
+    'effect/Redacted',
     'effect/Ref',
     'effect/Result',
     'effect/Runtime',
@@ -515,7 +515,7 @@ export const foldkit = (options = {}) => {
         apply: 'serve',
         config: () => ({
             optimizeDeps: {
-                include: [...FORCE_INCLUDED_EFFECT_NAMESPACES],
+                include: [...FORCE_INCLUDED_EFFECT_ENTRIES],
             },
         }),
         configureServer: server => {
@@ -544,22 +544,22 @@ export const foldkit = (options = {}) => {
     };
     const resolutionPlugin = {
         name: 'foldkit:resolution',
-        config: userConfig => {
-            const singletonPackages = resolveInstalledFoldkitPackages(userConfig.root ?? process.cwd());
+        config: async (userConfig, { command }) => {
+            const foldkitPackages = await crawlFoldkitPackages(userConfig.root ?? process.cwd(), command === 'build', userConfig);
             return {
                 optimizeDeps: {
                     exclude: ['foldkit'],
                 },
                 resolve: {
-                    dedupe: singletonPackages,
+                    dedupe: foldkitPackages.dedupe,
                 },
                 ssr: {
-                    noExternal: singletonPackages,
+                    noExternal: foldkitPackages.ssrNoExternal,
                 },
                 environments: {
                     ssr: {
                         resolve: {
-                            noExternal: singletonPackages,
+                            noExternal: foldkitPackages.ssrNoExternal,
                         },
                     },
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foldkit/vite-plugin",
-  "version": "0.26.0",
+  "version": "0.26.1",
   "description": "Vite plugin for Foldkit with state-preserving live reload",
   "type": "module",
   "main": "./dist/index.js",
@@ -24,6 +24,7 @@
     "@effect/platform-node": "4.0.0",
     "@effect/platform-node-shared": "4.0.0",
     "magic-string": "^1.4.2",
+    "vitefu": "^1.1.3",
     "ws": "^8.21.3"
   },
   "devDependencies": {
@@ -37,7 +38,7 @@
     "vite": "^8.3.1",
     "vite-host": "npm:vite@8.2.1",
     "vitest": "^4.1.11",
-    "foldkit": "0.165.0"
+    "foldkit": "0.166.0"
   },
   "keywords": [
     "vite",