react-fate 1.0.3 → 1.2.0

package/docs/integrations/graphql.md

@@ -0,0 +1,345 @@
+# GraphQL Integration
+
+_fate_ can use an existing GraphQL API as its transport. This keeps the adapter APIs, view composition, normalized cache, masking, requests, list views, live views, and mutations the same while replacing the native or tRPC backend with GraphQL operations.
+
+Use the GraphQL transport when your backend already exposes GraphQL and you want fate's client model without adding fate's native server protocol.
+
+## Template
+
+Create a client for an existing GraphQL server with:
+
+```bash
+vp create fate my-app --template graphql-client
+```
+
+Create a full GraphQL + Prisma example app with:
+
+```bash
+vp create fate my-app --template graphql
+```
+
+The client-only template is the smallest reference for the integration. It contains a `src/fate/graphql.ts` file that maps your GraphQL schema to fate views and roots.
+
+## GraphQL Schema Shape
+
+The GraphQL transport expects a schema with Relay-style object identity and pagination:
+
+- Entity objects include `id` and `__typename`.
+- Object fetches go through a `nodes(ids:)` field.
+- List fields return Relay connections with `edges`, `cursor`, `node`, and `pageInfo`.
+- Root queries and mutations return the entity type selected by the fate view.
+
+For example, a `Post` list can be exposed as a normal GraphQL connection:
+
+```graphql
+type Query {
+  posts(first: Int, after: String): PostConnection!
+  viewer: User
+  nodes(ids: [ID!]!): [Node]!
+}
+
+type PostConnection {
+  edges: [PostEdge!]!
+  pageInfo: PageInfo!
+}
+```
+
+If your schema uses different root field names, keep the fate names you want on the client and map them with `fateGraphQL.roots`.
+
+## Mapping Your Schema
+
+Create a module that exports data views, `Root`, and an optional `fateGraphQL` config. The Vite plugin reads this module during development and build time, generates the client wiring, and leaves your runtime GraphQL server unchanged.
+
+```tsx
+import { graphqlMutation } from '@nkzw/fate';
+import { dataView, list, type Entity } from '@nkzw/fate/server';
+
+type GraphQLUser = {
+  id: string;
+  name?: string | null;
+  username?: string | null;
+};
+
+type GraphQLPost = {
+  author?: GraphQLUser | null;
+  id: string;
+  title: string;
+};
+
+export const userDataView = dataView<GraphQLUser>('User')({
+  id: true,
+  name: true,
+  username: true,
+});
+
+export const postDataView = dataView<GraphQLPost>('Post')({
+  author: userDataView,
+  id: true,
+  title: true,
+});
+
+export type User = Entity<typeof userDataView, 'User'>;
+export type Post = Entity<
+  typeof postDataView,
+  'Post',
+  {
+    author: User | null;
+  }
+>;
+
+export const Root = {
+  posts: list(postDataView),
+  viewer: userDataView,
+};
+
+export const fateGraphQL = {
+  roots: {
+    posts: { field: 'posts' },
+    viewer: { field: 'viewer' },
+  },
+} as const;
+```
+
+The data views describe the fields client components are allowed to select. `Root` describes the root operations available to `useRequest`. `fateGraphQL.roots` maps those root names to actual GraphQL fields. If the GraphQL field has the same name as the fate root, the `field` entry can be omitted.
+
+## Vite Plugin
+
+Configure the fate Vite plugin with the GraphQL transport and point it at the mapping module:
+
+::: code-group
+
+```tsx [React]
+import { fate } from 'react-fate/vite';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  plugins: [
+    fate({
+      module: './src/fate/graphql.ts',
+      transport: 'graphql',
+    }),
+  ],
+});
+```
+
+```ts [Vue]
+import vue from '@vitejs/plugin-vue';
+import { fate } from 'vue-fate/vite';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  plugins: [
+    vue(),
+    fate({
+      module: './src/fate/graphql.ts',
+      transport: 'graphql',
+    }),
+  ],
+});
+```
+
+:::
+
+The plugin generates a typed `createFateClient` helper from your views, roots, and GraphQL mapping. It also watches the mapping module and the files it imports during development.
+
+## Creating a Client
+
+Create the client with your GraphQL endpoint and provide it through the `FateClient` provider:
+
+::: code-group
+
+```tsx [React]
+import { FateClient } from 'react-fate';
+import { createFateClient } from 'react-fate/client';
+
+const fate = createFateClient({
+  headers: () => ({
+    authorization: `Bearer ${token}`,
+  }),
+  url: 'https://api.example.com/graphql',
+});
+
+export function App() {
+  return <FateClient client={fate}>{/* Components go here */}</FateClient>;
+}
+```
+
+```vue [Vue]
+<script setup lang="ts">
+import { FateClient } from 'vue-fate';
+import { createFateClient } from 'vue-fate/client';
+import AppRoutes from './AppRoutes.vue';
+
+const fate = createFateClient({
+  headers: () => ({
+    authorization: `Bearer ${token}`,
+  }),
+  url: 'https://api.example.com/graphql',
+});
+</script>
+
+<template>
+  <FateClient :client="fate">
+    <AppRoutes />
+  </FateClient>
+</template>
+```
+
+:::
+
+Use `fetch` when you need to customize credentials or reuse an application fetch wrapper:
+
+```tsx
+const fate = createFateClient({
+  fetch: (input, init) =>
+    fetch(input, {
+      ...init,
+      credentials: 'include',
+    }),
+  url: `${env('SERVER_URL')}/graphql`,
+});
+```
+
+GraphQL operations issued in the same microtask are batched into a single GraphQL query or mutation document with aliased fields.
+
+Deferred view fields work with the GraphQL transport through the same normalized cache flow as native HTTP: the eager query omits `defer(...)` fields, and `useView`, `useListView`, or `useLiveListView` fetches the missing selection through `nodes(ids:)` when the deferred handle is read. GraphQL `@defer` is the natural wire format for this feature, but fate's GraphQL transport currently expects one JSON result per operation and does not consume incremental multipart patches yet.
+
+## Object IDs
+
+The transport converts between fate entity IDs and GraphQL node IDs. By default, it sends IDs as `${type}-${id}` and strips that prefix from returned IDs. Override this if your schema uses Relay global IDs, raw database IDs, or another encoding:
+
+```tsx
+const fate = createFateClient({
+  decodeNodeId: (type, id) => {
+    const [nodeType, nodeId] = atob(String(id)).split(':');
+    if (nodeType !== type) {
+      throw new Error(`Expected a ${type} node id.`);
+    }
+    return nodeId;
+  },
+  encodeNodeId: (type, id) => btoa(`${type}:${id}`),
+  url: '/graphql',
+});
+```
+
+If your GraphQL API already accepts and returns the same IDs you use in the app, return `id` from both functions.
+
+## Requests and Arguments
+
+Client code keeps using `useRequest` with the same shape as the other transports:
+
+```tsx
+const { posts, viewer } = useRequest({
+  posts: {
+    args: { first: 10 },
+    list: PostView,
+  },
+  viewer: { view: UserView },
+});
+```
+
+Root arguments are sent to the root GraphQL field. Nested relation arguments are scoped by relation name:
+
+```tsx
+const { posts } = useRequest({
+  posts: {
+    args: {
+      comments: { first: 3 },
+      first: 10,
+    },
+    list: PostWithCommentsView,
+  },
+});
+```
+
+This produces a root `posts(first: 10)` field and a nested `comments(first: 3)` field in the generated GraphQL selection.
+
+## Mutations
+
+Map fate mutation names to GraphQL mutation fields with `graphqlMutation`:
+
+```tsx
+export const fateGraphQL = {
+  mutations: {
+    'post.like': graphqlMutation<Post, { id: string }, Post>('Post', {
+      field: 'postLike',
+    }),
+  },
+  roots: {
+    posts: { field: 'posts' },
+  },
+} as const;
+```
+
+By default, the input is sent as an `input` argument:
+
+```graphql
+mutation {
+  postLike(input: { id: "12" }) {
+    id
+    likes
+  }
+}
+```
+
+Use `inputArg` when your schema uses a different argument name, or `inputArg: false` when the input object should be spread into field arguments:
+
+```tsx
+export const fateGraphQL = {
+  mutations: {
+    'post.like': graphqlMutation<Post, { id: string }, Post>('Post', {
+      field: 'likePost',
+      inputArg: 'payload',
+    }),
+    'user.follow': graphqlMutation<User, { id: string }, User>('User', {
+      field: 'followUser',
+      inputArg: false,
+    }),
+  },
+} as const;
+```
+
+Mutations use the same `mutation(...)` API described in the [Actions Guide](../guide/actions.md). React clients can also expose those mutations as Actions for `useActionState`.
+
+## Live Views
+
+GraphQL live views use [GraphQL SSE](https://github.com/enisdenjo/graphql-sse). Install `graphql-sse` in the client package and leave `live` enabled, or pass `live: false` when your schema does not support subscriptions.
+
+```tsx
+const fate = createFateClient({
+  live: {
+    url: 'https://api.example.com/graphql/stream',
+  },
+  url: 'https://api.example.com/graphql',
+});
+```
+
+The default subscription fields are `fateLiveNode` for `useLiveView` and `fateLiveConnection` for `useLiveListView`. Rename them with `entityField` and `connectionField`:
+
+```tsx
+const fate = createFateClient({
+  live: {
+    connectionField: 'liveConnection',
+    entityField: 'liveNode',
+    url: '/graphql/stream',
+  },
+  url: '/graphql',
+});
+```
+
+The live node subscription returns `{ data, delete, id, select }`. The live connection subscription returns events such as `appendNode`, `prependNode`, `deleteEdge`, and `invalidate`. These payloads match fate's live transport events, so the cache update behavior is the same as the native transport.
+
+If you do not need live views, disable them explicitly:
+
+```tsx
+const fate = createFateClient({
+  live: false,
+  url: '/graphql',
+});
+```
+
+## Existing Servers
+
+The GraphQL transport is intentionally a mapping layer. It does not require `createFateServer`, the Prisma adapter, or the Drizzle adapter. Your GraphQL server remains responsible for authorization, validation, resolver behavior, cursor pagination, and mutation side effects.
+
+Use data views to expose only the fields the client should be able to select, keep GraphQL schema authorization in your server, and treat `src/fate/graphql.ts` as the contract between your GraphQL API and fate's client.

package/docs/{guide/server-integration.md → integrations/server.md}

@@ -1,9 +1,10 @@
 # Server Integration
 
-Until now, we have focused on the client-side API of fate. You'll need a backend that follows fate's data protocol so the Vite plugin can wire the typed fate APIs into your app. _fate_ currently ships two server paths:
+Until now, we have focused on the client-side API of fate. You'll need a backend that can be wired into fate's typed request model so the Vite plugin can connect the typed fate APIs to your app. _fate_ currently ships three integration paths:
 
 - The native fate protocol, which is transport-agnostic and can be hosted by any Fetch-compatible server.
 - The tRPC adapter, which keeps compatibility with existing tRPC backends.
+- The [GraphQL transport](graphql.md), which maps fate views and roots to an existing GraphQL schema.
 
 _fate_ currently provides database adapters for Prisma and Drizzle, but the framework itself is not coupled to a particular ORM. The adapters plug into the same source execution runtime and can be exposed through the native protocol or through tRPC.
 
@@ -184,7 +185,9 @@ app.post('/fate/live', handler);
 
 Configure the Vite plugin with the native transport:
 
-```tsx
+::: code-group
+
+```tsx [React]
 import { fate } from 'react-fate/vite';
 import { defineConfig } from 'vite';
 
@@ -198,9 +201,29 @@ export default defineConfig({
 });
 ```
 
+```ts [Vue]
+import vue from '@vitejs/plugin-vue';
+import { fate } from 'vue-fate/vite';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  plugins: [
+    vue(),
+    fate({
+      module: '@your-org/server/fate.ts',
+      transport: 'native',
+    }),
+  ],
+});
+```
+
+:::
+
 With the native transport, the Vite plugin handles the HTTP transport setup. If you need to create a client manually, use `createFateClient` with the same route:
 
-```tsx
+::: code-group
+
+```tsx [React]
 import { createFateClient } from 'react-fate/client';
 
 const client = createFateClient({
@@ -208,6 +231,16 @@ const client = createFateClient({
 });
 ```
 
+```ts [Vue]
+import { createFateClient } from 'vue-fate/client';
+
+const client = createFateClient({
+  url: '/fate',
+});
+```
+
+:::
+
 The HTTP transport batches operations issued in the same microtask into one `POST /fate` request. Live views use one `GET /fate/live` SSE stream per fate client and `POST /fate/live` control messages when views subscribe or unsubscribe.
 
 ### Custom Queries
@@ -584,7 +617,9 @@ export * from './views.ts';
 
 Configure the fate Vite plugin with your server module:
 
-```tsx
+::: code-group
+
+```tsx [React]
 import { fate } from 'react-fate/vite';
 import { defineConfig } from 'vite';
 
@@ -597,11 +632,28 @@ export default defineConfig({
 });
 ```
 
+```ts [Vue]
+import vue from '@vitejs/plugin-vue';
+import { fate } from 'vue-fate/vite';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  plugins: [
+    vue(),
+    fate({
+      module: '@your-org/server/trpc/router.ts',
+    }),
+  ],
+});
+```
+
+:::
+
 _Note: fate uses the specified server module name to find the server types it needs. Make sure that the module is available to the client package's Vite config._
 
 During development, the plugin watches the server module and the files it imports. When one of those files changes, fate updates the internal client wiring and invalidates `@nkzw/fate/client` in Vite's module graph.
 
-For a barebones client without React, import the plugin from `@nkzw/fate/vite` and the client APIs from `@nkzw/fate/client`. The plugin wires the same server types for the selected import path.
+For a barebones client without a framework adapter, import the plugin from `@nkzw/fate/vite` and the client APIs from `@nkzw/fate/client`. The plugin wires the same server types for the selected import path.
 
 The plugin writes project-local types under `.fate/`. If your TypeScript config does not already include dot-directories, extend the generated config:
 
@@ -613,9 +665,11 @@ The plugin writes project-local types under `.fate/`. If your TypeScript config
 
 ## Creating a _fate_ Client
 
-Now that the Vite plugin has connected the types, create a fate client instance and provide it to your React app with the `FateClient` context provider:
+Now that the Vite plugin has connected the types, create a fate client instance and provide it to your app with the `FateClient` provider:
 
-```tsx
+::: code-group
+
+```tsx [React]
 import { httpBatchLink } from '@trpc/client';
 import { FateClient } from 'react-fate';
 import { createFateClient } from 'react-fate/client';
@@ -641,4 +695,37 @@ export function App() {
 }
 ```
 
+```vue [Vue]
+<script setup lang="ts">
+import { httpBatchLink } from '@trpc/client';
+import { computed } from 'vue';
+import { FateClient } from 'vue-fate';
+import { createFateClient } from 'vue-fate/client';
+import AppRoutes from './AppRoutes.vue';
+
+const fate = computed(() =>
+  createFateClient({
+    links: [
+      httpBatchLink({
+        fetch: (input, init) =>
+          fetch(input, {
+            ...init,
+            credentials: 'include',
+          }),
+        url: `${env('SERVER_URL')}/trpc`,
+      }),
+    ],
+  }),
+);
+</script>
+
+<template>
+  <FateClient :client="fate">
+    <AppRoutes />
+  </FateClient>
+</template>
+```
+
+:::
+
 _And you are all set. Happy building!_

package/docs/{guide/void-integration.md → integrations/void.md}

@@ -7,15 +7,25 @@ setup without copying its adapter glue.
 
 ## Install
 
-```sh
-pnpm add @nkzw/fate react-fate void-fate void
+::: code-group
+
+```sh [React]
+pnpm add @nkzw/fate react-fate void-fate void @void/react
+```
+
+```sh [Vue]
+pnpm add @nkzw/fate vue-fate void-fate void @void/vue
 ```
 
+:::
+
 ## Vite
 
-Use the regular `react-fate` Vite plugin with the Void transport:
+Use the framework adapter's Vite plugin with the Void transport:
 
-```tsx
+::: code-group
+
+```tsx [React]
 import { voidReact } from '@void/react/plugin';
 import { fate } from 'react-fate/vite';
 import { defineConfig } from 'vite-plus';
@@ -33,6 +43,26 @@ export default defineConfig({
 });
 ```
 
+```ts [Vue]
+import { voidVue } from '@void/vue/plugin';
+import { fate } from 'vue-fate/vite';
+import { defineConfig } from 'vite-plus';
+import { voidPlugin } from 'void';
+
+export default defineConfig({
+  plugins: [
+    voidPlugin(),
+    voidVue(),
+    fate({
+      module: './src/fate/server.ts',
+      transport: 'void',
+    }),
+  ],
+});
+```
+
+:::
+
 The Void transport uses `/fate` for RPC requests and `/fate-live` for live
 updates by default. In SSR, it calls the exported fate server directly. In the
 browser, it uses fetch and the SSE live endpoint.
@@ -104,12 +134,14 @@ export const { GET, POST } = defineVoidFateLiveRoute(fateServer, fateLive);
 The live route handles `GET /fate-live` SSE connections and `POST /fate-live`
 control messages. `void-fate` does not use WebSockets.
 
-## React Layout
+## Layout
 
-Wrap your app with `VoidFateClient` from `void-fate/react`. It creates and
-provides the fate client through `react-fate`:
+Wrap your app with the Void fate client for your framework. It creates and
+provides the fate client through the matching adapter.
 
-```tsx
+::: code-group
+
+```tsx [React]
 import { useShared } from '@void/react';
 import type { ReactNode } from 'react';
 import { VoidFateClient } from 'void-fate/react';
@@ -128,9 +160,36 @@ export default function Layout({ children }: { children: ReactNode }) {
 }
 ```
 
-`userId` is optional, but passing it lets `VoidFateClient` recreate the client
-when the signed-in user changes. Browser requests include credentials when a
-`userId` is present.
+```vue [Vue]
+<script setup lang="ts">
+import { useShared } from '@void/vue';
+import { computed } from 'vue';
+import { FateClient } from 'vue-fate';
+import { createFateClient } from 'vue-fate/client';
+import type { SharedData } from '../src/lib/shared.ts';
+
+const shared = useShared<SharedData>();
+
+const fate = computed(() =>
+  createFateClient({
+    origin: typeof window === 'undefined' ? shared.origin : window.location.origin,
+    userId: shared.auth.user?.id,
+  }),
+);
+</script>
+
+<template>
+  <FateClient :client="fate">
+    <slot />
+  </FateClient>
+</template>
+```
+
+:::
+
+`userId` is optional, but passing it lets the client be recreated when the
+signed-in user changes. Browser requests include credentials when a `userId` is
+present.
 
 ## Custom Paths
 
@@ -143,12 +202,35 @@ export const fateLive = createVoidFateLive({
 });
 ```
 
-```tsx
+::: code-group
+
+```tsx [React]
 <VoidFateClient livePath="/custom-fate-live" origin={origin} rpcPath="/custom-fate" userId={userId}>
   {children}
 </VoidFateClient>
 ```
 
+```vue [Vue]
+<script setup lang="ts">
+const fate = computed(() =>
+  createFateClient({
+    livePath: '/custom-fate-live',
+    origin,
+    rpcPath: '/custom-fate',
+    userId,
+  }),
+);
+</script>
+
+<template>
+  <FateClient :client="fate">
+    <slot />
+  </FateClient>
+</template>
+```
+
+:::
+
 The route helper does not own the route path. Make sure your Void route filename
 or router configuration matches the paths you pass to the client.