@foldkit/devtools 0.138.0 → 0.139.0

package/README.md

@@ -7,33 +7,44 @@ The overlay displays every Message flowing through your app and lets you inspect
 ## Installation
 
 ```bash
-pnpm add @foldkit/devtools
+pnpm add --save-dev @foldkit/devtools
 # or
-npm install @foldkit/devtools
+npm install --save-dev @foldkit/devtools
 # or
-yarn add @foldkit/devtools
+yarn add --dev @foldkit/devtools
 ```
 
 `@foldkit/devtools` lists `foldkit`, `@foldkit/ui`, `effect`, and `@effect/platform-browser` as peer dependencies, so install those alongside it.
 
 ## Usage
 
-The overlay is opt-in. Pass its `overlay` factory as `devTools.overlay` when you create the application:
+With `@foldkit/vite-plugin`, installing this package as a development dependency is enough to mount the overlay during development. The plugin leaves it out of production builds:
 
 ```typescript
 import { Runtime } from 'foldkit'
 
-import { overlay } from '@foldkit/devtools'
-
 const application = Runtime.makeApplication({
   // ...
-  devTools: { Message, overlay },
+  devTools: {
+    Message,
+  },
 })
 
 Runtime.run(application)
 ```
 
-Without the overlay, a `devTools` config on its own still records Message history and serves the WebSocket bridge that the [DevTools MCP server](https://foldkit.dev/ai/mcp) connects to. Installing `@foldkit/devtools` and passing `overlay` is what mounts the visual panel in the browser.
+The `devTools` configuration is optional unless you need settings such as `Message`, `position`, or `excludeFromHistory`. Recording and the WebSocket bridge that the [DevTools MCP server](https://foldkit.dev/ai/mcp) connects to live in Foldkit's core runtime.
+
+To include the overlay in production, move `@foldkit/devtools` to regular `dependencies` and set `show: 'Always'`. The dependency section is the build-time opt-in, and `show` controls whether the runtime mounts it:
+
+```typescript
+const application = Runtime.makeApplication({
+  // ...
+  devTools: {
+    show: 'Always',
+  },
+})
+```
 
 See the [DevTools documentation](https://foldkit.dev/core/devtools) for the full configuration surface.
 

package/dist/vite.d.ts

@@ -0,0 +1,4 @@
+import type { DevToolsOverlay } from 'foldkit/devtools-host';
+/** The in-browser DevTools overlay factory consumed by the Foldkit Vite plugin. */
+export declare const overlay: DevToolsOverlay;
+//# sourceMappingURL=vite.d.ts.map

package/dist/vite.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite.d.ts","sourceRoot":"","sources":["../src/vite.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAI5D,mFAAmF;AACnF,eAAO,MAAM,OAAO,EAAE,eAA+B,CAAA"}

package/dist/vite.js

@@ -0,0 +1,3 @@
+import { createOverlay } from './overlay.js';
+/** The in-browser DevTools overlay factory consumed by the Foldkit Vite plugin. */
+export const overlay = createOverlay;

package/package.json

@@ -1,15 +1,12 @@
 {
   "name": "@foldkit/devtools",
-  "version": "0.138.0",
+  "version": "0.139.0",
   "description": "In-browser DevTools overlay for Foldkit applications",
   "type": "module",
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+    "./vite": {
+      "types": "./dist/vite.d.ts",
+      "import": "./dist/vite.js"
     }
   },
   "sideEffects": false,
@@ -17,23 +14,23 @@
     "dist"
   ],
   "peerDependencies": {
-    "@effect/platform-browser": "4.0.0-beta.102",
+    "@effect/platform-browser": "4.0.0-beta.103",
     "@foldkit/ui": "^0",
-    "effect": "4.0.0-beta.102",
+    "effect": "4.0.0-beta.103",
     "foldkit": "^0"
   },
   "dependencies": {
     "clsx": "^2.1.1"
   },
   "devDependencies": {
-    "@effect/platform-browser": "4.0.0-beta.102",
-    "effect": "4.0.0-beta.102",
+    "@effect/platform-browser": "4.0.0-beta.103",
+    "effect": "4.0.0-beta.103",
     "rimraf": "^6.1.3",
     "typescript": "^6.0.3",
     "vitest": "^4.1.9",
-    "@foldkit/ui": "0.138.0",
-    "@foldkit/vite-plugin": "0.11.3",
-    "foldkit": "0.138.0"
+    "@foldkit/ui": "0.139.0",
+    "@foldkit/vite-plugin": "0.12.0",
+    "foldkit": "0.139.0"
   },
   "keywords": [
     "foldkit",

package/dist/index.d.ts

@@ -1,16 +0,0 @@
-import type { DevToolsOverlay } from 'foldkit/runtime';
-/**
- * The in-browser DevTools overlay factory. Pass it as `DevToolsConfig.overlay`
- * to mount the panel:
- *
- * ```ts
- * import { overlay } from '@foldkit/devtools'
- *
- * Runtime.makeApplication({
- *   // ...
- *   devTools: { Message, overlay },
- * })
- * ```
- */
-export declare const overlay: DevToolsOverlay;
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAItD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO,EAAE,eAA+B,CAAA"}

package/dist/index.js

@@ -1,15 +0,0 @@
-import { createOverlay } from './overlay.js';
-/**
- * The in-browser DevTools overlay factory. Pass it as `DevToolsConfig.overlay`
- * to mount the panel:
- *
- * ```ts
- * import { overlay } from '@foldkit/devtools'
- *
- * Runtime.makeApplication({
- *   // ...
- *   devTools: { Message, overlay },
- * })
- * ```
- */
-export const overlay = createOverlay;