@seedprotocol/vite 0.7.5-next.871.g8788c94 → 0.7.6-next.920.gdd0b533

package/README.md

@@ -4,22 +4,16 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Docs](https://img.shields.io/badge/docs-seedprotocol.io-0B6E4F)](https://seedprotocol.io)
 
-Vite plugin for browser and Electron-renderer apps that use [`@seedprotocol/sdk`](https://www.npmjs.com/package/@seedprotocol/sdk). It sets up Node polyfills, ZenFS `fs` aliases, CommonJS/ESM interop fixes, dependency pre-bundling, and the cross-origin isolation headers that SQLite WASM and OPFS need. Your app can then import the SDK without its own workarounds.
+Vite plugin for browser apps that use [`@seedprotocol/sdk`](https://www.npmjs.com/package/@seedprotocol/sdk). It sends the cross-origin isolation headers SQLite WASM and OPFS need on the dev and preview servers, builds workers as ES modules, and makes Seed packages linked from outside the app (`file:`, `link:`, a workspace) work under `vite dev`.
 
 ## Installation
 
-`vite` (8 or later) is a peer dependency. `vite-plugin-node-polyfills` is a dependency of this package, so you do not need to install it.
+`vite` (8 or later) is a peer dependency.
 
 ```bash
 npm install -D @seedprotocol/vite
-# or
-bun add -d @seedprotocol/vite
-# or
-pnpm add -D @seedprotocol/vite
 ```
 
-Your app also needs `@seedprotocol/sdk` and the ZenFS packages it uses in the browser. Pin the versions the SDK declares (currently `@zenfs/core@2.5.6` and `@zenfs/dom@1.2.9`) so only one copy is installed.
-
 ## Usage
 
 `seedVitePlugin()` returns an **array** of plugins, so spread it into `plugins`:
@@ -35,56 +29,63 @@ export default defineConfig({
 })
 ```
 
-Initialize ZenFS in your app entry before you use the SDK (`autoInit` is off by default):
+Don't list `@seedprotocol/*` packages, `sqlocal`, `drizzle-orm` or `@sqlite.org/sqlite-wasm` in `optimizeDeps.exclude`. Vite pre-bundles them, and under pnpm an excluded `sqlocal` can't be resolved from the pre-bundled SDK.
 
-```ts
-import { configure } from '@zenfs/core'
-import { IndexedDB } from '@zenfs/dom'
+## What it configures
 
-await configure({ mounts: { '/': IndexedDB } })
-```
+- **Cross-origin isolation headers** on the dev and preview servers: `Cross-Origin-Opener-Policy: same-origin`, `Cross-Origin-Embedder-Policy: credentialless`, `Cross-Origin-Resource-Policy: same-origin`. They are also set in `writeHead`, so React Router Framework Mode HTML responses get them. Without them the page isn't cross-origin isolated and the SDK can't keep its database in OPFS.
+- **`worker.format: 'es'`**, unless you set a format. SQLite's worker code-splits, which Vite's default `'iife'` worker format can't do, so the database never opens in a production build.
+- **`optimizeDeps.rolldownOptions.output.strictExecutionOrder: true`**, unless you set it. drizzle-orm's modules import each other in a cycle; when your app imports both `@seedprotocol/sdk` and `@seedprotocol/sdk/drizzle`, the dev pre-bundle can otherwise run them out of order and fail with `Cannot read properties of undefined (reading 'Symbol')`.
+- **`resolve.dedupe`** for React, thirdweb, xstate, ZenFS and the Seed packages, each only when your app root resolves it. A linked Seed package otherwise loads its own React (hooks fail) or its own copy of a Seed package.
+- **`server.fs.allow`** for the SDK, sqlocal and SQLite WASM directories when they are outside your app, so `vite dev` can serve the database worker and WASM file of a linked SDK.
 
-After you add or upgrade the plugin, delete `node_modules/.vite` and restart the dev server.
+With an SDK installed from npm in the app itself, only the first three matter, and you can set them without the plugin:
 
-## What it configures
+```ts
+const isolation = {
+  'Cross-Origin-Opener-Policy': 'same-origin',
+  'Cross-Origin-Embedder-Policy': 'credentialless',
+}
+
+export default defineConfig({
+  plugins: [react()],
+  server: { headers: isolation },
+  preview: { headers: isolation },
+  worker: { format: 'es' },
+  optimizeDeps: { rolldownOptions: { output: { strictExecutionOrder: true } } },
+})
+```
 
-- **Node polyfills** for `path`, `buffer`, `events`, `string_decoder` and `util`. Full `stream` and `crypto` polyfills are left out because they break Vite SSR and React Router prerender. A minimal `stream` stub is aliased instead.
-- **Cross-origin isolation headers** on the dev and preview servers: `Cross-Origin-Opener-Policy: same-origin`, `Cross-Origin-Embedder-Policy: credentialless`, `Cross-Origin-Resource-Policy: same-origin`. They are applied on `writeHead` too, so React Router Framework Mode HTML responses get them.
-- **`fs` aliases** to ZenFS (`fs`, `fs/promises`, `node:fs`, `node:fs/promises`), plus stable ESM entry points for `@zenfs/core` and `@zenfs/dom`.
-- **Interop shims** for `debug` default imports and the `nanoid-dictionary` ESM build.
-- **`optimizeDeps.include`** for fragile CommonJS dependencies, including the SDK's nested EAS SDK.
-- **Inline `global` / `process` shims** in `index.html`. `process.env.NODE_ENV` follows the Vite `mode`, so React Refresh works under `vite serve`.
+[VITE_RENDERER.md](https://github.com/JournoLabs/seed-protocol-sdk/blob/main/packages/vite/VITE_RENDERER.md) lists what each setting is needed for, how that was tested, and what the plugin no longer does.
 
 ## Options
 
 ```ts
 seedVitePlugin({
-  includeNodePolyfills: true,
   isolationHeaders: true,
-  autoInit: false,
+  includeNodePolyfills: false,
+  fsModules: [],
   debug: false,
 })
 ```
 
 | Option | Default | Description |
 |--------|---------|-------------|
-| `includeNodePolyfills` | `true` | Add `vite-plugin-node-polyfills` with the defaults above. Set `false` for React Router Framework Mode or SPA prerender. |
-| `isolationHeaders` | `true` | COOP/COEP/CORP on dev and preview servers. `false` disables them; `{ coop, coep, corp }` overrides individual values. |
-| `fsModules` | `['fs', 'fs/promises', 'node:fs', 'node:fs/promises']` | Modules aliased to ZenFS. |
-| `autoInit` | `false` | Inject a ZenFS init script into `index.html`. Browsers cannot resolve its bare `@zenfs/*` imports without an import map, so prefer initializing ZenFS in your entry. |
-| `debug` | `false` | Log plugin diagnostics. |
+| `isolationHeaders` | `true` | COOP/COEP/CORP on the dev and preview servers. `false` disables them; `{ coop, coep, corp }` overrides individual values. A value you set in `server.headers` or `preview.headers` wins for that server. |
+| `includeNodePolyfills` | `false` | Add `vite-plugin-node-polyfills` for `path`, `buffer`, `events`, `string_decoder` and `util` and the `Buffer` / `process` / `global` globals, a minimal `stream` stub, and inline `global` / `process` shims in `index.html`. The SDK doesn't need them; turn this on when another dependency uses Node built-ins in the browser. Full `stream` and `crypto` polyfills are left out because they break Vite SSR and React Router prerender. |
+| `fsModules` | `[]` | Modules aliased to ZenFS (`@zenfs/core`, or `@zenfs/core/promises` for ids containing "promises"), for app code or other dependencies that import `fs` in the browser. The SDK doesn't. For example `['fs', 'fs/promises', 'node:fs', 'node:fs/promises']`. |
+| `debug` | `false` | Log what the plugin adds, and warn about Node-only globals (`process`, `Buffer`, `global`, `__dirname`, `__filename`) left in production chunks. |
 
 The options type is exported as `SeedVitePluginOptions`.
 
 ## Production hosting
 
-The headers only apply to `vite serve` and `vite preview`. In production, your host must send `Cross-Origin-Opener-Policy: same-origin` and `Cross-Origin-Embedder-Policy: credentialless` (or `require-corp`) on the HTML document, for example through nginx or a Netlify `_headers` file. Without them, SQLite WASM and OPFS storage do not work.
+The headers only apply to `vite dev` and `vite preview`. In production, your host must send `Cross-Origin-Opener-Policy: same-origin` and `Cross-Origin-Embedder-Policy: credentialless` (or `require-corp`) on the HTML document, for example through nginx or a Netlify `_headers` file.
 
 ## Documentation
 
 - Full documentation: **https://seedprotocol.io**
-- [Vite renderer guide and troubleshooting](https://github.com/JournoLabs/seed-protocol-sdk/blob/main/packages/vite/VITE_RENDERER.md)
-- [Getting started](https://github.com/JournoLabs/seed-protocol-sdk/blob/main/docs/GETTING_STARTED.md)
+- [What each setting is for, and upgrading from 0.7](https://github.com/JournoLabs/seed-protocol-sdk/blob/main/packages/vite/VITE_RENDERER.md)
 - Core SDK: [`@seedprotocol/sdk`](https://www.npmjs.com/package/@seedprotocol/sdk)
 - React bindings: [`@seedprotocol/react`](https://www.npmjs.com/package/@seedprotocol/react)
 

package/dist/aliases.d.ts

@@ -0,0 +1,15 @@
+import type { UserConfig } from 'vite';
+export type AliasEntry = {
+    find: string | RegExp;
+    replacement: string;
+};
+export declare function normalizeAliasEntries(alias: NonNullable<UserConfig['resolve']>['alias'] | undefined): AliasEntry[];
+/** `existing` plus the `additions` whose find it doesn't already have, after it. */
+export declare function mergeAliasEntries(existing: AliasEntry[], additions: AliasEntry[]): AliasEntry[];
+/**
+ * Append aliases to the user's config in place. Vite merges a returned alias list *before*
+ * the existing one, so returning ours would let it shadow the user's; appending (Vite's
+ * documented escape hatch when merging can't express the order) keeps user aliases first.
+ */
+export declare function appendAliases(userConfig: UserConfig, additions: AliasEntry[]): void;
+//# sourceMappingURL=aliases.d.ts.map

package/dist/aliases.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aliases.d.ts","sourceRoot":"","sources":["../src/aliases.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AAEtC,MAAM,MAAM,UAAU,GAAG;IAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAA;AAEvE,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,SAAS,GAC7D,UAAU,EAAE,CAWd;AAED,oFAAoF;AACpF,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,CAY/F;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAMnF"}

package/dist/index.d.ts

@@ -1,67 +1,45 @@
 import type { Plugin } from 'vite';
 export interface SeedVitePluginOptions {
     /**
-     * Modules to alias to ZenFS (`@zenfs/core`, or `@zenfs/core/promises` for ids
-     * containing "promises"). The list replaces the default; to add a module, pass
-     * the defaults plus yours.
-     * @default ['fs', 'fs/promises', 'node:fs', 'node:fs/promises']
-     */
-    fsModules?: string[];
-    /**
-     * Whether to inject a ZenFS initialization script into index.html that mounts
-     * IndexedDB at `/`. Leave this false with the SDK: `client.init()` mounts OPFS
-     * at `/` itself, so apps do not configure ZenFS, and this mount would only be
-     * replaced. The script also imports the bare specifiers '@zenfs/core' and
-     * '@zenfs/dom', which browsers cannot resolve without an import map.
-     * @default false
+     * Cross-origin isolation headers for SQLite WASM, SharedArrayBuffer and OPFS on the dev and
+     * preview servers, also applied in `writeHead` because Vite's `server.headers` is not copied
+     * onto React Router Framework Mode HTML responses. Without them the SDK can't keep its
+     * database in OPFS. Set `false` to disable, or pass `{ coop, coep, corp }` to override values.
+     * A COOP/COEP/CORP value you set in `server.headers` or `preview.headers` (any letter case)
+     * wins for that server.
+     * @default true (`COOP: same-origin`, `COEP: credentialless`, `CORP: same-origin`)
      */
-    autoInit?: boolean;
+    isolationHeaders?: boolean | {
+        coop?: string;
+        coep?: string;
+        corp?: string;
+    };
     /**
-     * Enable debug logging.
+     * Add vite-plugin-node-polyfills (`path`, `buffer`, `events`, `string_decoder`, `util`, and
+     * the `Buffer` / `process` / `global` globals), a `stream` stub and inline `global` /
+     * `process` shims in index.html. The SDK doesn't need them; turn this on when another
+     * dependency of your app uses Node built-ins in the browser.
      * @default false
      */
-    debug?: boolean;
+    includeNodePolyfills?: boolean;
     /**
-     * Whether to automatically include vite-plugin-node-polyfills with sensible defaults.
-     * The SDK depends on that package and aliases its injected shim imports to absolute
-     * paths, so consuming apps do not need to install vite-plugin-node-polyfills themselves.
-     * Default include list omits full `stream`/`crypto` polyfills (those pull
-     * stream-browserify and break Vite SSR / React Router prerender). A minimal
-     * `stream` stub is still aliased so sax/rss-parser do not warn. Use `false`
-     * for Framework Mode / prerender.
-     * @default true
+     * Modules to alias to ZenFS (`@zenfs/core`, or `@zenfs/core/promises` for ids containing
+     * "promises"), for app code or dependencies that import Node's `fs` in the browser. The SDK's
+     * browser build doesn't.
+     * @default []
      */
-    includeNodePolyfills?: boolean;
+    fsModules?: string[];
     /**
-     * Cross-origin isolation headers for sqlocal / SharedArrayBuffer / OPFS.
-     * Applied in configureServer and configurePreviewServer, including writeHead,
-     * because Vite `server.headers` is not copied onto Framework-Mode HTML responses.
-     * Set `false` to disable. Pass `{ coop, coep, corp }` to override values.
-     * A COOP/COEP/CORP value you set yourself in `server.headers` or `preview.headers`
-     * (any letter case) wins over both this option and the defaults, for that server.
-     * @default true (`COOP: same-origin`, `COEP: credentialless`, `CORP: same-origin`)
+     * Log what the plugin adds, and warn about Node-only globals left in production chunks.
+     * @default false
      */
-    isolationHeaders?: boolean | {
-        coop?: string;
-        coep?: string;
-        corp?: string;
-    };
+    debug?: boolean;
 }
 /**
- * Minimal Vite plugin to make the SDK work in browser/Electron renderer:
- * - Aliases fs → @zenfs/core (and promises variant)
- * - Aliases path → path-browserify
- * - Ensures CommonJS in SDK dist is transformed by Vite's CommonJS plugin
- * - Allowlists linked SDK / sqlocal worker paths on server.fs.allow for Vite dev
- * - Optionally wires up vite-plugin-node-polyfills with safe defaults
- *
- * This plugin assumes the SDK does not bundle Node-only code in the browser entry.
- * For Electron, Node-only work (e.g. better-sqlite3) should run in the
- * main process; the renderer should only use browser-safe SDK usage.
- *
- * For the renderer build:
- * - Use the SDK's ESM entry: import from '@seedprotocol/sdk' (resolves to dist/main.js).
- * - Do not configure ZenFS yourself: `client.init()` mounts OPFS at `/`.
+ * The Vite settings a browser app using @seedprotocol/sdk needs: cross-origin isolation headers
+ * on the dev and preview servers, ES module workers, in-order dev pre-bundles, and, for SDK
+ * packages installed outside the app root, deduplication and dev-server file access. Node polyfills and `fs` aliases are
+ * opt-in.
  */
 export declare function seedVitePlugin(options?: SeedVitePluginOptions): Plugin[];
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAa,MAAM,EAA4C,MAAM,MAAM,CAAA;AAWvF,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpB;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG;QAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;CACF;AAixBD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,cAAc,CAAC,OAAO,GAAE,qBAA0B,GAAG,MAAM,EAAE,CA2c5E"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAgC,MAAM,MAAM,CAAA;AAahE,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;OAQG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG;QAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IAED;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAyFD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,GAAE,qBAA0B,GAAG,MAAM,EAAE,CA8F5E"}