react-fate 0.1.3 → 1.0.0

package/docs/api/functions/FateClient.md

@@ -0,0 +1,23 @@
+# Function: FateClient()
+
+> **FateClient**(`__namedParameters`): `Element`
+
+Defined in: [packages/react-fate/src/context.tsx:17](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/react-fate/src/context.tsx#L17)
+
+Provider component that supplies a configured `FateClient` to React hooks.
+
+## Parameters
+
+### \_\_namedParameters
+
+#### children
+
+`ReactNode`
+
+#### client
+
+`FateClient`\<`any`, `any`\>
+
+## Returns
+
+`Element`

package/docs/api/functions/clientRoot.md

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

package/docs/api/functions/createClient.md

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

package/docs/api/functions/createHTTPTransport.md

@@ -0,0 +1,51 @@
+# Function: createHTTPTransport()
+
+> **createHTTPTransport**\<`API`, `Mutations`\>(`__namedParameters`): `Transport`\<`Mutations`\>
+
+Defined in: packages/fate/lib/index.d.mts:47
+
+## 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/functions/createTRPCTransport.md

@@ -0,0 +1,46 @@
+# Function: createTRPCTransport()
+
+> **createTRPCTransport**\<`AppRouter`, `Mutations`\>(`__namedParameters`): `Transport`\<`MutationMapFromResolvers`\<`Mutations`\>\>
+
+Defined in: packages/fate/lib/types-Dz46PXr3.d.mts:709
+
+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`\>
+
+#### mutations?
+
+`Mutations`
+
+#### queries?
+
+`TRPCQueryResolvers`\<`AppRouter`\>
+
+## Returns
+
+`Transport`\<`MutationMapFromResolvers`\<`Mutations`\>\>

package/docs/api/functions/mutation.md

@@ -0,0 +1,32 @@
+# Function: mutation()
+
+> **mutation**\<`T`, `I`, `R`\>(`entity`): `MutationDefinition`\<`T`, `I`, `R`\>
+
+Defined in: packages/fate/lib/types-Dz46PXr3.d.mts:980
+
+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/functions/useFateClient.md

@@ -0,0 +1,17 @@
+# Function: useFateClient()
+
+> **useFateClient**\<`T`\>(): `FateClient`\<`T`\[`0`\], `T`\[`1`\]\>
+
+Defined in: [packages/react-fate/src/context.tsx:30](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/react-fate/src/context.tsx#L30)
+
+Returns the nearest `FateClient` from context.
+
+## Type Parameters
+
+### T
+
+`T` *extends* \[\{ `categories`: `RootDefinition`\<`"Category"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\>\>; `category`: `RootDefinition`\<`"Category"`, `Category`[]\>; `comment`: `RootDefinition`\<`"Comment"`, `Comment`[]\>; `commentSearch`: `RootDefinition`\<`"Comment"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\> & `ConnectionResult`\<`AnyRecord`\>\>; `event`: `RootDefinition`\<`"Event"`, `Event`[]\>; `eventAttendee`: `RootDefinition`\<`"EventAttendee"`, `EventAttendee`[]\>; `events`: `RootDefinition`\<`"Event"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\>\>; `post`: `RootDefinition`\<`"Post"`, `Post`[]\>; `posts`: `RootDefinition`\<`"Post"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\>\>; `tag`: `RootDefinition`\<`"Tag"`, `Tag`[]\>; `user`: `RootDefinition`\<`"User"`, `User`[]\>; `viewer`: `RootDefinition`\<`"User"`, `object` & `AnyRecord` \| `null`\>; \}, \{ `comment.add`: `MutationDefinition`\<`Comment`, \{ `content`: `string`; `postId`: `string`; \}, `object` & `ItemRecord` & `object` & `object`\>; `comment.delete`: `MutationDefinition`\<`Comment`, \{ `id`: `string`; \}, `object` & `ItemRecord` & `object` & `object`\>; `post.add`: `MutationDefinition`\<`Post`, \{ `content`: `string`; `title`: `string`; \}, `Post`\>; `post.like`: `MutationDefinition`\<`Post`, \{ `error?`: `"boundary"` \| `"callSite"`; `id`: `string`; `slow?`: `boolean`; \}, `Post`\>; `post.unlike`: `MutationDefinition`\<`Post`, \{ `id`: `string`; \}, `Post`\>; `user.update`: `MutationDefinition`\<`User`, \{ `name`: `string`; \}, `AnyRecord`\>; \}\] = \[\{ `categories`: `RootDefinition`\<`"Category"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\>\>; `category`: `RootDefinition`\<`"Category"`, `Category`[]\>; `comment`: `RootDefinition`\<`"Comment"`, `Comment`[]\>; `commentSearch`: `RootDefinition`\<`"Comment"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\> & `ConnectionResult`\<`AnyRecord`\>\>; `event`: `RootDefinition`\<`"Event"`, `Event`[]\>; `eventAttendee`: `RootDefinition`\<`"EventAttendee"`, `EventAttendee`[]\>; `events`: `RootDefinition`\<`"Event"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\>\>; `post`: `RootDefinition`\<`"Post"`, `Post`[]\>; `posts`: `RootDefinition`\<`"Post"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\>\>; `tag`: `RootDefinition`\<`"Tag"`, `Tag`[]\>; `user`: `RootDefinition`\<`"User"`, `User`[]\>; `viewer`: `RootDefinition`\<`"User"`, `object` & `AnyRecord` \| `null`\>; \}, \{ `comment.add`: `MutationDefinition`\<`Comment`, \{ `content`: `string`; `postId`: `string`; \}, `object` & `ItemRecord` & `object` & `object`\>; `comment.delete`: `MutationDefinition`\<`Comment`, \{ `id`: `string`; \}, `object` & `ItemRecord` & `object` & `object`\>; `post.add`: `MutationDefinition`\<`Post`, \{ `content`: `string`; `title`: `string`; \}, `Post`\>; `post.like`: `MutationDefinition`\<`Post`, \{ `error?`: `"boundary"` \| `"callSite"`; `id`: `string`; `slow?`: `boolean`; \}, `Post`\>; `post.unlike`: `MutationDefinition`\<`Post`, \{ `id`: `string`; \}, `Post`\>; `user.update`: `MutationDefinition`\<`User`, \{ `name`: `string`; \}, `AnyRecord`\>; \}\]
+
+## Returns
+
+`FateClient`\<`T`\[`0`\], `T`\[`1`\]\>

package/docs/api/functions/useListView.md

@@ -0,0 +1,28 @@
+# Function: useListView()
+
+> **useListView**\<`C`\>(`selection`, `connection`): \[`ConnectionItems`\<`NonNullable`\<`C`\>\>, `LoadMoreFn` \| `null`, `LoadMoreFn` \| `null`\]
+
+Defined in: [packages/react-fate/src/useListView.tsx:16](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/react-fate/src/useListView.tsx#L16)
+
+Subscribes to a connection field, returning the current items and pagination
+helpers to load the next or previous page.
+
+## Type Parameters
+
+### C
+
+`C` *extends* \{ `items?`: readonly `any`[]; `pagination?`: `Pagination`; \} \| `null` \| `undefined`
+
+## Parameters
+
+### selection
+
+`ConnectionSelection`
+
+### connection
+
+`C`
+
+## Returns
+
+\[`ConnectionItems`\<`NonNullable`\<`C`\>\>, `LoadMoreFn` \| `null`, `LoadMoreFn` \| `null`\]

package/docs/api/functions/useLiveListView.md

@@ -0,0 +1,28 @@
+# Function: useLiveListView()
+
+> **useLiveListView**\<`C`\>(`selection`, `connection`): \[`ConnectionItems`\<`NonNullable`\<`C`\>\>, `LoadMoreFn` \| `null`, `LoadMoreFn` \| `null`\]
+
+Defined in: [packages/react-fate/src/useLiveListView.tsx:16](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/react-fate/src/useLiveListView.tsx#L16)
+
+Subscribes to a connection field, returning live-updating items and pagination
+helpers to load the next or previous page.
+
+## Type Parameters
+
+### C
+
+`C` *extends* \{ `items?`: readonly `any`[]; `pagination?`: `Pagination`; \} \| `null` \| `undefined`
+
+## Parameters
+
+### selection
+
+`ConnectionSelection`
+
+### connection
+
+`C`
+
+## Returns
+
+\[`ConnectionItems`\<`NonNullable`\<`C`\>\>, `LoadMoreFn` \| `null`, `LoadMoreFn` \| `null`\]

package/docs/api/functions/useLiveView.md

@@ -0,0 +1,38 @@
+# Function: useLiveView()
+
+> **useLiveView**\<`V`, `R`\>(`view`, `ref`): `R` *extends* `null` ? `null` : `Readonly`\<`ViewSelection`\<`V`\> *extends* `Selection`\<`ViewEntityWithTypename`\<`V`\>\> ? `Mask`\<`ViewEntityWithTypename`\<`V`\>, \{ \[K in string \| number \| symbol as K extends "\_\_typename" ? never : K\]?: SelectionFieldValue\<ViewEntityWithTypename\<V\>, K\> \} & `object` & `SelectionViewSpread`\<`ViewEntityWithTypename`\<`V`\>\> & `ViewSelection`\<`V`\>\> : `ViewEntityWithTypename`\<`V`\> & `object`\>
+
+Defined in: [packages/react-fate/src/useLiveView.tsx:17](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/react-fate/src/useLiveView.tsx#L17)
+
+Resolves a reference against a view and subscribes to live server updates for
+that selection.
+
+## Type Parameters
+
+### V
+
+`V` *extends* `View`\<`any`, `any`\>
+
+### R
+
+`R` *extends* `Readonly`\<\{ `__typename`: `ViewEntityName`; `[ViewsTag]`: `Set`\<`string`\>; `id`: `string` \| `number`; \}\> \| `null`
+
+## Parameters
+
+### view
+
+`V`
+
+### ref
+
+`R`
+
+## Returns
+
+`R` *extends* `null` ? `null` : `Readonly`\<`ViewSelection`\<`V`\> *extends* `Selection`\<`ViewEntityWithTypename`\<`V`\>\> ? `Mask`\<`ViewEntityWithTypename`\<`V`\>, \{ \[K in string \| number \| symbol as K extends "\_\_typename" ? never : K\]?: SelectionFieldValue\<ViewEntityWithTypename\<V\>, K\> \} & `object` & `SelectionViewSpread`\<`ViewEntityWithTypename`\<`V`\>\> & `ViewSelection`\<`V`\>\> : `ViewEntityWithTypename`\<`V`\> & `object`\>
+
+## Example
+
+```ts
+const post = useLiveView(PostView, postRef);
+```

package/docs/api/functions/useRequest.md

@@ -0,0 +1,38 @@
+# Function: useRequest()
+
+> **useRequest**\<`R`, `O`\>(`request`, `options?`): `RequestResult`\<`O`, `R`\>
+
+Defined in: [packages/react-fate/src/useRequest.tsx:25](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/react-fate/src/useRequest.tsx#L25)
+
+Declares the data a screen needs and kicks off fetching, suspending while the
+request resolves.
+
+## Type Parameters
+
+### R
+
+`R` *extends* `Request$1`
+
+### O
+
+`O` *extends* `FateRoots` = \{ `categories`: `RootDefinition`\<`"Category"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\>\>; `category`: `RootDefinition`\<`"Category"`, `Category`[]\>; `comment`: `RootDefinition`\<`"Comment"`, `Comment`[]\>; `commentSearch`: `RootDefinition`\<`"Comment"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\> & `ConnectionResult`\<`AnyRecord`\>\>; `event`: `RootDefinition`\<`"Event"`, `Event`[]\>; `eventAttendee`: `RootDefinition`\<`"EventAttendee"`, `EventAttendee`[]\>; `events`: `RootDefinition`\<`"Event"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\>\>; `post`: `RootDefinition`\<`"Post"`, `Post`[]\>; `posts`: `RootDefinition`\<`"Post"`, `ConnectionResult`\<\{\[`key`: `string`\]: `any`; \}\>\>; `tag`: `RootDefinition`\<`"Tag"`, `Tag`[]\>; `user`: `RootDefinition`\<`"User"`, `User`[]\>; `viewer`: `RootDefinition`\<`"User"`, `object` & `AnyRecord` \| `null`\>; \}
+
+## Parameters
+
+### request
+
+`R`
+
+### options?
+
+`Readonly`\<\{ `mode?`: `RequestMode`; \}\>
+
+## Returns
+
+`RequestResult`\<`O`, `R`\>
+
+## Example
+
+```ts
+const { posts } = useRequest({ posts: { list: PostView } });
+```

package/docs/api/functions/useView.md

@@ -0,0 +1,37 @@
+# Function: useView()
+
+> **useView**\<`V`, `R`\>(`view`, `ref`): `R` *extends* `null` ? `null` : `Readonly`\<`ViewSelection`\<`V`\> *extends* `Selection`\<`ViewEntityWithTypename`\<`V`\>\> ? `Mask`\<`ViewEntityWithTypename`\<`V`\>, \{ \[K in string \| number \| symbol as K extends "\_\_typename" ? never : K\]?: SelectionFieldValue\<ViewEntityWithTypename\<V\>, K\> \} & `object` & `SelectionViewSpread`\<`ViewEntityWithTypename`\<`V`\>\> & `ViewSelection`\<`V`\>\> : `ViewEntityWithTypename`\<`V`\> & `object`\>
+
+Defined in: [packages/react-fate/src/useView.tsx:37](https://github.com/nkzw-tech/fate/blob/17081c4f677e224e55b75d9a31bd6e0a7ee94af1/packages/react-fate/src/useView.tsx#L37)
+
+Resolves a reference against a view and subscribes to updates for that selection.
+
+## Type Parameters
+
+### V
+
+`V` *extends* `View`\<`any`, `any`\>
+
+### R
+
+`R` *extends* `Readonly`\<\{ `__typename`: `ViewEntityName`; `[ViewsTag]`: `Set`\<`string`\>; `id`: `string` \| `number`; \}\> \| `null`
+
+## Parameters
+
+### view
+
+`V`
+
+### ref
+
+`R`
+
+## Returns
+
+`R` *extends* `null` ? `null` : `Readonly`\<`ViewSelection`\<`V`\> *extends* `Selection`\<`ViewEntityWithTypename`\<`V`\>\> ? `Mask`\<`ViewEntityWithTypename`\<`V`\>, \{ \[K in string \| number \| symbol as K extends "\_\_typename" ? never : K\]?: SelectionFieldValue\<ViewEntityWithTypename\<V\>, K\> \} & `object` & `SelectionViewSpread`\<`ViewEntityWithTypename`\<`V`\>\> & `ViewSelection`\<`V`\>\> : `ViewEntityWithTypename`\<`V`\> & `object`\>
+
+## Example
+
+```ts
+const post = useView(PostView, postRef);
+```

package/docs/api/functions/view.md

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

package/docs/api/index.md

@@ -0,0 +1,35 @@
+# react-fate
+
+The react fate library.
+
+## Example
+
+```ts
+import { useView, view } from 'react-fate';
+```
+
+## Type Aliases
+
+- [ConnectionRef](type-aliases/ConnectionRef.md)
+- [InferFateAPI](type-aliases/InferFateAPI.md)
+- [ViewRef](type-aliases/ViewRef.md)
+
+## Variables
+
+- [toEntityId](variables/toEntityId.md)
+
+## Functions
+
+- [clientRoot](functions/clientRoot.md)
+- [createClient](functions/createClient.md)
+- [createHTTPTransport](functions/createHTTPTransport.md)
+- [createTRPCTransport](functions/createTRPCTransport.md)
+- [FateClient](functions/FateClient.md)
+- [mutation](functions/mutation.md)
+- [useFateClient](functions/useFateClient.md)
+- [useListView](functions/useListView.md)
+- [useLiveListView](functions/useLiveListView.md)
+- [useLiveView](functions/useLiveView.md)
+- [useRequest](functions/useRequest.md)
+- [useView](functions/useView.md)
+- [view](functions/view.md)

package/docs/api/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`; \}\>
+
+Defined in: packages/fate/lib/types-Dz46PXr3.d.mts:1132
+
+Ref for a connection, including pagination metadata.
+
+## Type Parameters
+
+### TName
+
+`TName` *extends* `string`

package/docs/api/type-aliases/InferFateAPI.md

@@ -0,0 +1,11 @@
+# Type Alias: InferFateAPI\<Server\>
+
+> **InferFateAPI**\<`Server`\> = `Server` *extends* `object` ? `API` : `never`
+
+Defined in: packages/fate/lib/record-ENh92gyb.d.mts:206
+
+## Type Parameters
+
+### Server
+
+`Server`

package/docs/api/type-aliases/ViewRef.md

@@ -0,0 +1,13 @@
+# Type Alias: ViewRef\<TName\>
+
+> **ViewRef**\<`TName`\> = `Readonly`\<\{ `__typename`: `TName`; `[ViewsTag]`: `Set`\<`string`\>; `id`: `string` \| `number`; \}\>
+
+Defined in: packages/fate/lib/types-Dz46PXr3.d.mts:1107
+
+Reference to a normalized entity instance that can be resolved against one or more view tags.
+
+## Type Parameters
+
+### TName
+
+`TName` *extends* `string`

package/docs/api/variables/toEntityId.md

@@ -0,0 +1,21 @@
+# Variable: toEntityId
+
+> `const` **toEntityId**: (`type`, `rawId`) => `EntityId`
+
+Defined in: packages/fate/lib/index.d.mts:75
+
+Builds the canonical cache ID for an entity.
+
+## Parameters
+
+### type
+
+`TypeName`
+
+### rawId
+
+`string` \| `number`
+
+## Returns
+
+`EntityId`