vue-fate 1.7.7 → 1.8.0

package/README.md

@@ -437,8 +437,8 @@ ViewRefs carry a set of view names they can resolve. `useView` throws if a ref d
 A view can take parameters. Define the selection with a function, then bind its parameters where you request or compose the view:
 
 ```tsx
-import { alias, useRequest, useView, view, when, type ViewRef } from 'react-fate';
 import type { User } from '@your-org/server/views';
+import { alias, useRequest, useView, view, when, type ViewRef } from 'react-fate';
 
 const AccountView = view<User>()({ email: true });
 
@@ -1391,8 +1391,8 @@ export const fate = createFateServer({
 The equivalent tRPC mutation lives in your router and returns the selected shape that the client asked for:
 
 ```tsx
-import { z } from 'zod';
 import { connectionArgs, createResolver } from '@nkzw/fate/server';
+import { z } from 'zod';
 import { procedure, router } from '../init.ts';
 import { postDataView, PostItem } from '../views.ts';
 
@@ -1525,8 +1525,8 @@ vp add @nkzw/fate-indexeddb
 Then pass `persistence` when creating the client:
 
 ```tsx
-import { createPersistence } from '@nkzw/fate/persistence';
 import { createIndexedDBStorage } from '@nkzw/fate-indexeddb';
+import { createPersistence } from '@nkzw/fate/persistence';
 import { createFateClient } from 'react-fate/client';
 
 const fate = createFateClient({
@@ -1863,9 +1863,9 @@ If your server lives in a separate package, install `@nkzw/fate` there as a runt
 Use the Vue adapter's Vite plugin in the client app:
 
 ```ts
-import { fate } from 'vue-fate/vite';
-import { defineConfig } from 'vite';
 import vue from '@vitejs/plugin-vue';
+import { defineConfig } from 'vite';
+import { fate } from 'vue-fate/vite';
 
 export default defineConfig({
   plugins: [
@@ -2213,8 +2213,8 @@ export default defineConfig({
 
 ```ts [Vue]
 import vue from '@vitejs/plugin-vue';
-import { fate } from 'vue-fate/vite';
 import { defineConfig } from 'vite';
+import { fate } from 'vue-fate/vite';
 
 export default defineConfig({
   plugins: [
@@ -2737,8 +2737,8 @@ export default defineConfig({
 
 ```ts [Vue]
 import vue from '@vitejs/plugin-vue';
-import { fate } from 'vue-fate/vite';
 import { defineConfig } from 'vite';
+import { fate } from 'vue-fate/vite';
 
 export default defineConfig({
   plugins: [
@@ -2877,8 +2877,8 @@ Pass the `Root` export from `views.ts` to fate in your tRPC `init.ts` file. fate
 Use `createPrismaFate` from `@nkzw/fate/server/prisma` next to your tRPC helpers. By default, fate reads Prisma delegates from `ctx.prisma` using each data view's type name:
 
 ```tsx
-import { initTRPC } from '@trpc/server';
 import { createPrismaFate } from '@nkzw/fate/server/prisma';
+import { initTRPC } from '@trpc/server';
 import type { AppContext } from './context.ts';
 import { Root } from './views.ts';
 
@@ -2926,8 +2926,8 @@ return plan.resolve(post);
 Use `createDrizzleFate` from `@nkzw/fate/server/drizzle`. fate matches data view type names to Drizzle tables from your schema. The `db` option can be a Drizzle database object or a function that receives your tRPC context and returns a request-scoped database object:
 
 ```tsx
-import { initTRPC } from '@trpc/server';
 import { createDrizzleFate } from '@nkzw/fate/server/drizzle';
+import { initTRPC } from '@trpc/server';
 import db from '../drizzle/db.ts';
 import schema from '../drizzle/schema.ts';
 import type { AppContext } from './context.ts';
@@ -3168,8 +3168,8 @@ export default defineConfig({
 
 ```ts [Vue]
 import vue from '@vitejs/plugin-vue';
-import { fate } from 'vue-fate/vite';
 import { defineConfig } from 'vite';
+import { fate } from 'vue-fate/vite';
 
 export default defineConfig({
   plugins: [
@@ -3327,9 +3327,9 @@ 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';
+import { fate } from 'vue-fate/vite';
 
 export default defineConfig({
   plugins: [

package/docs/api/index.md

@@ -0,0 +1,3 @@
+# vue-fate API
+
+- [Vue](vue-fate/index.md)

package/docs/api/react-fate/src/functions/alias.md

@@ -0,0 +1,57 @@
+# Function: alias()
+
+## Call Signature
+
+> **alias**\<`V`\>(`view`): [`AliasedView`](../type-aliases/AliasedView.md)\<`V`\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:15
+
+Select a same-entity view under a named ref.
+
+### Type Parameters
+
+#### V
+
+`V` *extends* `View`\<`any`, `any`\>
+
+### Parameters
+
+#### view
+
+`V`
+
+### Returns
+
+[`AliasedView`](../type-aliases/AliasedView.md)\<`V`\>
+
+## Call Signature
+
+> **alias**\<`Field`, `S`\>(`field`, `selection`): [`AliasedSelection`](../type-aliases/AliasedSelection.md)\<`Field`, `S`\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:17
+
+Select a schema field under a different result name, with its own arguments.
+
+### Type Parameters
+
+#### Field
+
+`Field` *extends* `string`
+
+#### S
+
+`S`
+
+### Parameters
+
+#### field
+
+`Field`
+
+#### selection
+
+`S`
+
+### Returns
+
+[`AliasedSelection`](../type-aliases/AliasedSelection.md)\<`Field`, `S`\>

package/docs/api/react-fate/src/functions/clientRoot.md

@@ -0,0 +1,31 @@
+# Function: clientRoot()
+
+> **clientRoot**\<`Result`, `Type`, `Args`\>(`type`): `RootDefinition`\<`Type`, `Result`, `Args`\>
+
+Defined in: fate/lib/index.d.mts:67
+
+Defines a root query for an entity type, capturing the response shape.
+
+## Type Parameters
+
+### Result
+
+`Result`
+
+### Type
+
+`Type` *extends* `string`
+
+### Args
+
+`Args` = `AnyRecord`
+
+## Parameters
+
+### type
+
+`Type`
+
+## Returns
+
+`RootDefinition`\<`Type`, `Result`, `Args`\>

package/docs/api/react-fate/src/functions/createClient.md

@@ -0,0 +1,25 @@
+# Function: createClient()
+
+> **createClient**\<`T`, `HydrationScope`\>(`options`): `FateClient`\<`T`\[`0`\], `T`\[`1`\], `HydrationScope`\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:1287
+
+## Type Parameters
+
+### T
+
+`T` *extends* \[`FateRoots`, `FateMutations`\] = \[`Record`\<`never`, `RootDefinition`\<`any`, `any`, `AnyRecord`\>\>, `Record`\<`never`, `MutationDefinition`\<`any`, `any`, `any`\>\>\]
+
+### HydrationScope
+
+`HydrationScope` *extends* `string` = `string`
+
+## Parameters
+
+### options
+
+`FateClientOptions`\<`T`\[`0`\], `T`\[`1`\], `HydrationScope`\>
+
+## Returns
+
+`FateClient`\<`T`\[`0`\], `T`\[`1`\], `HydrationScope`\>

package/docs/api/react-fate/src/functions/createGraphQLTransport.md

@@ -0,0 +1,21 @@
+# Function: createGraphQLTransport()
+
+> **createGraphQLTransport**\<`Mutations`\>(`__namedParameters`): `Transport`\<`Mutations`\>
+
+Defined in: fate/lib/graphqlTransport-D\_Nmg2Cy.d.mts:89
+
+## Type Parameters
+
+### Mutations
+
+`Mutations` *extends* `TransportMutations` = `EmptyTransportMutations`
+
+## Parameters
+
+### \_\_namedParameters
+
+[`GraphQLTransportOptions`](../type-aliases/GraphQLTransportOptions.md)\<`Mutations`\>
+
+## Returns
+
+`Transport`\<`Mutations`\>

package/docs/api/react-fate/src/functions/createHTTPTransport.md

@@ -0,0 +1,51 @@
+# Function: createHTTPTransport()
+
+> **createHTTPTransport**\<`API`, `Mutations`\>(`__namedParameters`): `Transport`\<`Mutations`\>
+
+Defined in: fate/lib/index.d.mts:53
+
+## Type Parameters
+
+### API
+
+`API` *extends* `FateAPIShape`
+
+### Mutations
+
+`Mutations` *extends* `TransportMutations` = `MutationMapFromAPI`\<`API`\>
+
+## Parameters
+
+### \_\_namedParameters
+
+#### eventSource?
+
+`EventSourceConstructor`
+
+#### fetch?
+
+`FetchLike`
+
+#### headers?
+
+`HeadersFactory`
+
+#### live?
+
+`boolean` \| `LiveConnector`
+
+#### liveRetryMs?
+
+`number`
+
+#### liveUrl?
+
+`string` \| `URL`
+
+#### url
+
+`string` \| `URL`
+
+## Returns
+
+`Transport`\<`Mutations`\>

package/docs/api/react-fate/src/functions/createTRPCTransport.md

@@ -0,0 +1,50 @@
+# Function: createTRPCTransport()
+
+> **createTRPCTransport**\<`AppRouter`, `Mutations`\>(`__namedParameters`): `Transport`\<`MutationMapFromResolvers`\<`Mutations`\>\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:932
+
+Builds a `Transport` backed by a tRPC client using the configured resolvers
+for by-id queries, lists, and mutations.
+
+## Type Parameters
+
+### AppRouter
+
+`AppRouter` *extends* `AnyRouter`
+
+### Mutations
+
+`Mutations` *extends* `TRPCMutationResolvers`\<`AppRouter`\> = `EmptyMutationResolvers`\<`AppRouter`\>
+
+## Parameters
+
+### \_\_namedParameters
+
+#### byId
+
+`TRPCByIdResolvers`\<`AppRouter`\>
+
+#### client
+
+`TRPCClient`\<`AppRouter`\>
+
+#### lists?
+
+`TRPCListResolvers`\<`AppRouter`\>
+
+#### mutateDurably?
+
+\<`K`\>(`proc`, `input`, `select`, `identity`, `selectionArgs?`) => `Promise`\<`MutationMapFromResolvers`\<`Mutations`\>\[`K`\]\[`"output"`\]\>
+
+#### mutations?
+
+`Mutations`
+
+#### queries?
+
+`TRPCQueryResolvers`\<`AppRouter`\>
+
+## Returns
+
+`Transport`\<`MutationMapFromResolvers`\<`Mutations`\>\>

package/docs/api/react-fate/src/functions/defer.md

@@ -0,0 +1,21 @@
+# Function: defer()
+
+> **defer**\<`S`\>(`selection`): `DeferredSelection`\<`S`\>
+
+Defined in: fate/lib/index.d.mts:7
+
+## Type Parameters
+
+### S
+
+`S`
+
+## Parameters
+
+### selection
+
+`S`
+
+## Returns
+
+`DeferredSelection`\<`S`\>

package/docs/api/react-fate/src/functions/graphqlMutation.md

@@ -0,0 +1,39 @@
+# Function: graphqlMutation()
+
+> **graphqlMutation**\<`T`, `Input`, `Output`\>(`entity`, `options`): [`GraphQLMutationDefinition`](../type-aliases/GraphQLMutationDefinition.md)\<`T`, `Input`, `Output`\>
+
+Defined in: fate/lib/graphqlTransport-D\_Nmg2Cy.d.mts:78
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Entity`
+
+### Input
+
+`Input`
+
+### Output
+
+`Output`
+
+## Parameters
+
+### entity
+
+`T`\[`"__typename"`\]
+
+### options
+
+#### field
+
+`string`
+
+#### inputArg?
+
+`string` \| `false`
+
+## Returns
+
+[`GraphQLMutationDefinition`](../type-aliases/GraphQLMutationDefinition.md)\<`T`, `Input`, `Output`\>

package/docs/api/react-fate/src/functions/mutation.md

@@ -0,0 +1,32 @@
+# Function: mutation()
+
+> **mutation**\<`T`, `I`, `R`\>(`entity`): `MutationDefinition`\<`T`, `I`, `R`\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:1294
+
+Defines a mutation for a given entity type, preserving the input and output
+types for transports.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Entity`
+
+### I
+
+`I`
+
+### R
+
+`R`
+
+## Parameters
+
+### entity
+
+`T`\[`"__typename"`\]
+
+## Returns
+
+`MutationDefinition`\<`T`, `I`, `R`\>

package/docs/api/react-fate/src/functions/view.md

@@ -0,0 +1,26 @@
+# Function: view()
+
+> **view**\<`T`\>(): \{\<`S`\>(`select`): `View`\<`T`, `MutableSelection`\<`T`, `S`\>\>; \<`P`, `S`\>(`select`): [`ParameterizedView`](../type-aliases/ParameterizedView.md)\<`T`, `P`, `MutableSelection`\<`T`, `S`\>\>; \}
+
+Defined in: fate/lib/index.d.mts:90
+
+Creates a reusable view for an object using the declared selection.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Entity`
+
+## Returns
+
+\{\<`S`\>(`select`): `View`\<`T`, `MutableSelection`\<`T`, `S`\>\>; \<`P`, `S`\>(`select`): [`ParameterizedView`](../type-aliases/ParameterizedView.md)\<`T`, `P`, `MutableSelection`\<`T`, `S`\>\>; \}
+
+## Example
+
+```ts
+const PostView = view<Post>()({
+  id: true,
+  title: true,
+});
+```

package/docs/api/react-fate/src/functions/when.md

@@ -0,0 +1,31 @@
+# Function: when()
+
+> **when**\<`C`, `S`\>(`condition`, `selection`): [`ConditionalSelection`](../type-aliases/ConditionalSelection.md)\<`C`, `S`\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:1379
+
+Include a field or named fragment only when the condition is true.
+
+## Type Parameters
+
+### C
+
+`C` *extends* `boolean`
+
+### S
+
+`S`
+
+## Parameters
+
+### condition
+
+`C`
+
+### selection
+
+`S`
+
+## Returns
+
+[`ConditionalSelection`](../type-aliases/ConditionalSelection.md)\<`C`, `S`\>

package/docs/api/react-fate/src/interfaces/Persistence.md

@@ -0,0 +1,5 @@
+# Interface: Persistence
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:790
+
+A persistence integration. Implementations are imported separately from Fate core.

package/docs/api/react-fate/src/interfaces/PersistenceSession.md

@@ -0,0 +1,109 @@
+# Interface: PersistenceSession
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:810
+
+User-facing observability and lifecycle of an attached persistence integration.
+
+## Properties
+
+### ready
+
+> `readonly` **ready**: `Promise`\<`void`\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:816
+
+## Methods
+
+### clearCache()
+
+> **clearCache**(): `Promise`\<`void`\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:811
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### discard()
+
+> **discard**(`id`): `Promise`\<`void`\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:812
+
+#### Parameters
+
+##### id
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### dispose()
+
+> **dispose**(): `void`
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:813
+
+#### Returns
+
+`void`
+
+***
+
+### flush()
+
+> **flush**(): `Promise`\<`void`\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:814
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### getSnapshot()
+
+> **getSnapshot**(): [`PersistenceSnapshot`](../type-aliases/PersistenceSnapshot.md)
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:815
+
+#### Returns
+
+[`PersistenceSnapshot`](../type-aliases/PersistenceSnapshot.md)
+
+***
+
+### retry()
+
+> **retry**(): `void`
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:817
+
+#### Returns
+
+`void`
+
+***
+
+### subscribe()
+
+> **subscribe**(`listener`): () => `void`
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:818
+
+#### Parameters
+
+##### listener
+
+() => `void`
+
+#### Returns
+
+() => `void`

package/docs/api/react-fate/src/type-aliases/AliasedSelection.md

@@ -0,0 +1,15 @@
+# Type Alias: AliasedSelection\<Field, S\>
+
+> **AliasedSelection**\<`Field`, `S`\> = `Readonly`\<\{ `[AliasTag]`: `true`; `field`: `Field`; `selection`: `S`; \}\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:9
+
+## Type Parameters
+
+### Field
+
+`Field` *extends* `string` = `string`
+
+### S
+
+`S` = `unknown`

package/docs/api/react-fate/src/type-aliases/AliasedView.md

@@ -0,0 +1,11 @@
+# Type Alias: AliasedView\<V\>
+
+> **AliasedView**\<`V`\> = `Readonly`\<\{ `[FragmentAliasTag]`: `true`; `view`: `V`; \}\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:5
+
+## Type Parameters
+
+### V
+
+`V` *extends* `View`\<`any`, `any`\> = `View`\<`any`, `any`\>

package/docs/api/react-fate/src/type-aliases/ConditionalSelection.md

@@ -0,0 +1,15 @@
+# Type Alias: ConditionalSelection\<C, S\>
+
+> **ConditionalSelection**\<`C`, `S`\> = `Readonly`\<\{ `[ConditionTag]`: `true`; `condition`: `C`; `selection`: `S`; \}\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:1373
+
+## Type Parameters
+
+### C
+
+`C` *extends* `boolean` = `boolean`
+
+### S
+
+`S` = `unknown`

package/docs/api/react-fate/src/type-aliases/ConnectionRef.md

@@ -0,0 +1,13 @@
+# Type Alias: ConnectionRef\<TName\>
+
+> **ConnectionRef**\<`TName`\> = `Readonly`\<\{ `items`: `ReadonlyArray`\<\{ `cursor?`: `string`; `node`: [`ViewRef`](ViewRef.md)\<`TName`\>; \}\>; `pagination?`: [`Pagination`](Pagination.md); \}\>
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:1498
+
+Ref for a connection, including pagination metadata.
+
+## Type Parameters
+
+### TName
+
+`TName` *extends* `string`

package/docs/api/react-fate/src/type-aliases/Deferred.md

@@ -0,0 +1,19 @@
+# Type Alias: Deferred\<T\>
+
+> **Deferred**\<`T`\> = `Readonly`\<\{ `[DeferredTag]`: `DeferredMetadata`; \}\> & `object`
+
+Defined in: fate/lib/types-CNeg0z20.d.mts:1518
+
+A deferred value returned from a masked view. Existing view hooks resolve it when read.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Type Declaration
+
+### \[\_\_\_FateDeferredBrand\]
+
+> `readonly` **\[\_\_\_FateDeferredBrand\]**: `T`