@nkzw/fate-indexeddb 1.5.1 → 1.6.0

package/README.md

@@ -2995,7 +2995,7 @@ _And you are all set. Happy building!_
 
 ## Void Integration
 
-`void-fate` is the first-class [Void](https://void.cloud) adapter for fate to ease integration with the Void SDK and for deploying to the Void platform.
+`void-fate` is the [Void](https://void.cloud) adapter for fate. Deploy your app directly to your own Cloudflare account or to the Void platform with the same integration.
 
 Use this integration when your app runs on Void and you want the example app's
 setup without copying its adapter glue.
@@ -3122,14 +3122,29 @@ live.connection('Post.comments', { id: postId }).appendNode('Comment', commentId
 
 ### Routes
 
+Define a live stream once in a server-only module:
+
+```ts
+// src/fate/live.ts
+import { defineLiveStream } from 'void/live';
+
+export const fateStream = defineLiveStream({
+  allowAnonymousControl: true,
+  id: 'fate',
+});
+```
+
 Add one route for fate RPC requests:
 
 ```tsx
 // routes/fate.ts
 import { defineVoidFateRoute } from 'void-fate/server';
+import { fateStream } from '../src/fate/live.ts';
 import { fateLive, fateServer } from '../src/fate/server.ts';
 
-export const { GET, POST } = defineVoidFateRoute(fateServer, fateLive);
+export const { GET, POST } = defineVoidFateRoute(fateServer, fateLive, {
+  stream: fateStream,
+});
 ```
 
 Add a second route for the live SSE transport:
@@ -3137,9 +3152,9 @@ Add a second route for the live SSE transport:
 ```tsx
 // routes/fate-live.ts
 import { defineVoidFateLiveRoute } from 'void-fate/server';
-import { fateLive, fateServer } from '../src/fate/server.ts';
+import { fateStream } from '../src/fate/live.ts';
 
-export const { GET, POST } = defineVoidFateLiveRoute(fateServer, fateLive);
+export const { GET, POST } = defineVoidFateLiveRoute(fateStream);
 ```
 
 The live route handles `GET /fate-live` SSE connections and `POST /fate-live`
@@ -3205,13 +3220,7 @@ present.
 ### Custom Paths
 
 The default route pair is `/fate` and `/fate-live`. If your Void app uses
-different paths, configure the same values on the live adapter and client.
-
-```tsx
-export const fateLive = createVoidFateLive({
-  livePath: '/custom-fate-live',
-});
-```
+different paths, update your route filenames and configure the matching client paths.
 
 ::: code-group
 
@@ -3247,179 +3256,66 @@ or router configuration matches the paths you pass to the client.
 
 ### Live Transport
 
-Void can run separate request handlers for mutations and long-lived SSE
-connections. `createVoidFateLive` bridges those handlers by publishing live
-events from the request that changed data to the live route.
-
-In local development, `void-fate` uses a development token for that internal
-publish request. Outside local development, Void must provide `__VOID_PROXY_TOKEN`
-in the route environment. If no internal publish token is available, the adapter
-falls back to the in-memory live bus for the current request context.
+`createVoidFateLive` publishes entity and connection events through the `void/live`
+stream associated with the current request. Void manages the Durable Object
+transport that distributes events to connected clients across requests.
 
 The live transport is best-effort and does not replay missed events after a
 client reconnects. This matches fate's default in-memory live event bus.
 
-## Cloudflare Integration
-
-`cf-fate` is the first-class Cloudflare Workers adapter for Fate native HTTP transport and live views.
-
-Use it when your backend runs directly on Cloudflare Workers and you want fate live views without adopting the Void platform.
-
-### New Project
+### Cloudflare Deployment
 
-For a new Cloudflare Workers app, start from the Cloudflare template. It includes the client, Worker server, D1 migrations, Wrangler config, Durable Object live transport, auth wiring, and generated fate client setup.
+From your project root, run:
 
 ```sh
-vp create fate my-app --template cloudflare
+vp exec void deploy --platform cloudflare
 ```
 
-Use Vue instead of React with:
+Void provisions resources and deploys directly to your Cloudflare account. See the [Cloudflare integration](/docs/integrations/cloudflare.md) for setup and migration instructions.
 
-```sh
-vp create fate my-app --template cloudflare --framework vue
-```
+## Cloudflare Integration
 
-### Existing Project
+Deploy fate directly to your own Cloudflare account with [Void](/docs/integrations/void.md). The Void template includes the app, D1 database, Drizzle migrations, Better Auth, and live updates through `void-fate` and `void/live`.
 
-For an existing Cloudflare Workers project, add the packages directly:
+### New Project
 
 ```sh
-pnpm add @nkzw/fate react-fate cf-fate drizzle-orm
-pnpm add -D wrangler
-```
-
-For Vue clients, replace `react-fate` with `vue-fate`.
-
-### Server Setup
-
-Create a Cloudflare live stream and pass its Fate live facade to `createFateServer`.
-
-```ts
-// src/fate/live.ts
-import { defineCloudflareFateLiveStream } from 'cf-fate/server';
-
-export const fateStream = defineCloudflareFateLiveStream({
-  allowAnonymousControl: true,
-  binding: 'FATE_LIVE',
-  id: 'fate',
-});
-```
-
-```ts
-// src/fate/server.ts
-import { createFateServer } from '@nkzw/fate/server';
-import { createCloudflareFateLive } from 'cf-fate/server';
-
-export const fateLive = createCloudflareFateLive();
-export const { live } = fateLive;
-
-export const fateServer = createFateServer({
-  live,
-  // context,
-  // roots,
-  // sources,
-});
-```
-
-Publish from mutations through the normal Fate live bus:
-
-```ts
-live.update('Post', postId, { changed: ['likes'] });
-live.connection('Post.comments', { id: postId }).appendNode('Comment', commentId);
+vp create fate my-app --template void
+cd my-app
+vp run dev:setup
+vp run dev
 ```
 
-### Worker Routes
-
-Expose one route for Fate RPC and one route for the SSE live stream.
-
-```ts
-import {
-  createCloudflareFateLiveDurableObject,
-  defineCloudflareFateLiveRoute,
-  defineCloudflareFateRoute,
-} from 'cf-fate/server';
-import { fateStream } from './fate/live';
-import { fateLive, fateServer } from './fate/server';
-
-const fateRoute = defineCloudflareFateRoute(fateServer, fateLive, { stream: fateStream });
-const fateLiveRoute = defineCloudflareFateLiveRoute(fateStream);
-
-export const FateLiveDurableObject = createCloudflareFateLiveDurableObject({
-  binding: 'FATE_LIVE',
-});
-
-export default {
-  fetch(request, env, ctx) {
-    const url = new URL(request.url);
-    if (url.pathname === '/fate') {
-      return fateRoute.fetch(request, env, ctx);
-    }
-    if (url.pathname === '/fate-live') {
-      return fateLiveRoute.fetch(request, env, ctx);
-    }
-    return new Response('Not Found', { status: 404 });
-  },
-};
-```
+Add `--framework vue` to the create command to use Vue instead of React.
 
-### Wrangler
+### Deploy
 
-Add a Durable Object binding and migration. `cf-fate` uses `node:async_hooks`, so the Worker must enable Node compatibility.
+From the project root:
 
-```jsonc
-{
-  "compatibility_flags": ["nodejs_compat"],
-  "durable_objects": {
-    "bindings": [
-      {
-        "name": "FATE_LIVE",
-        "class_name": "FateLiveDurableObject",
-      },
-    ],
-  },
-  "migrations": [
-    {
-      "tag": "fate-live-v1",
-      "new_sqlite_classes": ["FateLiveDurableObject"],
-    },
-  ],
-}
+```sh
+vp exec void deploy --platform cloudflare
 ```
 
-### Client
+Void signs you into Cloudflare when needed, lets you select your account, provisions resources, applies checked-in database migrations, and deploys the app. It saves resource IDs in the root `wrangler.jsonc`; commit that updated config for subsequent deployments. A Void platform account is not required.
 
-Use the Cloudflare transport in the Fate Vite plugin:
+The template includes the `VOID_LIVE` Durable Object binding and its class migration. Keep them in `wrangler.jsonc` so live subscriptions can receive updates across requests. RPC requests use `/fate`, and live updates use `/fate-live`.
 
-```ts
-import { fate } from 'react-fate/vite';
+After changing your database schema or auth configuration, run `vp run db:generate`, review and commit the generated migrations, then deploy. The migrations must include the Better Auth schema used in production.
 
-fate({
-  module: './src/fate/server.ts',
-  transport: 'cloudflare',
-});
-```
-
-Then point the generated client at the Worker endpoints:
-
-```tsx
-import { FateClient } from 'react-fate';
-import { createFateClient } from 'react-fate/client';
+See [Void's Cloudflare deployment guide](https://void.cloud/integrations/cloudflare) for custom domains, secrets, and CI configuration.
 
-const fate = createFateClient({
-  liveUrl: 'http://localhost:8787/fate-live',
-  url: 'http://localhost:8787/fate',
-});
+### Migrating from cf-fate
 
-export function App({ children }) {
-  return <FateClient client={fate}>{children}</FateClient>;
-}
-```
+Fate 1.6 replaces the standalone Cloudflare adapter and template with the Void integration. Use `--template void` for new projects and `transport: 'void'` in the fate Vite plugin.
 
-### Semantics
+For an existing app, move the Worker routes into Void's `routes/` directory and follow the [Void integration](/docs/integrations/void.md) for the complete setup:
 
-`cf-fate` uses one browser `EventSource` per Fate client and multiplexes entity and connection topics over that stream. Durable Objects keep connection and topic subscription state so later requests, mutations, scheduled handlers, and queue consumers can publish to already-connected clients.
+- Define the live stream with `defineLiveStream` from `void/live`.
+- Use `createVoidFateLive`, `defineVoidFateRoute`, and `defineVoidFateLiveRoute` from `void-fate/server`.
+- Let the generated client use `void/live/client` for live connections.
+- Remove the `cf-fate` dependency and the custom Worker entry point.
 
-Delivery is at-most-once. Events are ordered within one topic, but events are not durably replayed after a disconnect. Use authoritative refetching or application-owned replay storage if missed events must be recovered.
+Deploy the Void app as a new Worker with its `VOID_LIVE` binding and class migration. The old `FATE_LIVE` Durable Object class and its active connections are not migrated. Preserve existing database IDs and migration history when reusing your database, and reconnect clients to the new app after deployment.
 
 ## Frequently Asked Questions
 

package/lib/index.d.mts

@@ -1,8 +1,7 @@
 import { PersistenceStorage } from "@nkzw/fate/persistence";
 //#region src/index.d.ts
-type IndexedDBStorageOptions = Readonly<{
+export type IndexedDBStorageOptions = Readonly<{
   name?: string;
 }>;
-declare function createIndexedDBStorage({ name }?: IndexedDBStorageOptions): PersistenceStorage;
-//#endregion
-export { IndexedDBStorageOptions, createIndexedDBStorage };
+export declare function createIndexedDBStorage({ name }?: IndexedDBStorageOptions): PersistenceStorage;
+//#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nkzw/fate-indexeddb",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "Optional IndexedDB persistence adapter for fate.",
   "license": "MIT",
   "files": [
@@ -19,10 +19,10 @@
     "idb": "^8.0.3"
   },
   "devDependencies": {
-    "fake-indexeddb": "^6.2.4",
-    "vite": "npm:@voidzero-dev/vite-plus-core@0.3.0",
-    "vite-plus": "0.3.0",
-    "@nkzw/fate": "1.5.1"
+    "@nkzw/fate": "1.6.0",
+    "fake-indexeddb": "^6.2.5",
+    "vite": "npm:@voidzero-dev/vite-plus-core@0.3.3",
+    "vite-plus": "0.3.3"
   },
   "peerDependencies": {
     "@nkzw/fate": "^1.5.1"