vue-fate 1.5.0 → 1.5.2

package/README.md

@@ -1354,13 +1354,13 @@ Then pass `persistence` when creating the client:
 
 ```tsx
 import { createPersistence } from '@nkzw/fate/persistence';
-import { indexedDB } from '@nkzw/fate-indexeddb';
+import { createIndexedDBStorage } from '@nkzw/fate-indexeddb';
 import { createFateClient } from 'react-fate/client';
 
 const fate = createFateClient({
   persistence: createPersistence({
     key: `workspace:${workspaceId}:user:${userId}`,
-    storage: indexedDB(),
+    storage: createIndexedDBStorage(),
   }),
   url: '/api/fate',
 });
@@ -1373,7 +1373,7 @@ persistence: createPersistence({
   key: `workspace:${workspaceId}:user:${userId}`,
   maxAge: 24 * 60 * 60 * 1000,
   maxBytes: 25 * 1024 * 1024,
-  storage: indexedDB(),
+  storage: createIndexedDBStorage(),
 }),
 ```
 
@@ -1545,7 +1545,7 @@ const durableHTTP = createHTTPTransport<MyAPI>({
 
 const fate = createFateClient({
   // ...your generated tRPC or GraphQL client options...
-  persistence: createPersistence({ key: accountKey, storage: indexedDB() }),
+  persistence: createPersistence({ key: accountKey, storage: createIndexedDBStorage() }),
   mutateDurably: durableHTTP.mutateDurably,
 });
 ```
@@ -1635,7 +1635,6 @@ The core persistence layer has no IndexedDB dependency. You can use another back
 ```ts
 interface PersistenceStorage {
   read(key: string): Promise<unknown>;
-  write(key: string, value: unknown): Promise<void>;
   scan(
     prefix: string,
     after?: string,
@@ -1650,9 +1649,8 @@ interface PersistenceStorage {
 Values use fate's hydration codec and can be stored as JSON. The adapter handles storage and coordination:
 
 - `read` returns the saved value for a key.
-- `write` replaces one value atomically and resolves after it has committed.
 - `scan` returns keys under a prefix in ascending order, strictly after the optional cursor, up to the limit (64 by default). Use your backend's ordered index to keep each scan small.
-- `writeBatch` commits all entries atomically. An `undefined` value deletes the key.
+- `writeBatch` commits all entries atomically and resolves after they have committed. An `undefined` value deletes the key. Use a one-entry batch for a single write.
 - `exclusive` coordinates every tab or process sharing the backend. Different lock names are independent: fate holds a delivery lock during network work and acquires a separate write lock when updating storage. Your adapter must allow that nesting.
 - `subscribe` notifies other clients after a change commits, including keys changed by `writeBatch`. Without notifications, clients check saved mutations during delivery attempts and explicit `retry()` calls.
 

package/lib/client.d.mts

@@ -1,6 +1,6 @@
 import { createFateClient } from "@nkzw/fate/client";
 //#region src/client.d.ts
-interface ClientMutations {}
-interface ClientRoots {}
+export interface ClientMutations {}
+export interface ClientRoots {}
 //#endregion
-export { ClientMutations, ClientRoots, createFateClient };
+export { createFateClient };

package/lib/index.d.mts

@@ -14,17 +14,17 @@ type RequestResource<T> = {
 /**
  * Declares the data a component or screen needs and exposes it as a Vue resource.
  */
-declare function useRequest<R extends Request, O extends FateRoots = Roots>(request: MaybeRefOrGetter<R>, options?: RequestOptions): RequestResource<RequestResult<O, R>>;
+export declare function useRequest<R extends Request, O extends FateRoots = Roots>(request: MaybeRefOrGetter<R>, options?: RequestOptions): RequestResource<RequestResult<O, R>>;
 //#endregion
 //#region src/context.d.ts
 type GeneratedFateClient = ReturnType<typeof import('vue-fate/client').createFateClient>;
 type Mutations = [GeneratedFateClient] extends [never] ? FateMutations : GeneratedFateClient extends FateClient$1<any, infer M> ? M : FateMutations;
 type FateClientSource = ComputedRef<FateClient$1<any, any>> | Ref<FateClient$1<any, any>>;
-declare const FateClientKey: InjectionKey<FateClientSource>;
+export declare const FateClientKey: InjectionKey<FateClientSource>;
 /**
  * Provides a configured fate client to Vue composables.
  */
-declare const FateClient: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+export declare const FateClient: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
   client: {
     required: true;
     type: PropType<MaybeRefOrGetter<FateClient$1<any, any>>>;
@@ -37,12 +37,12 @@ declare const FateClient: import("vue").DefineComponent<import("vue").ExtractPro
     type: PropType<MaybeRefOrGetter<FateClient$1<any, any>>>;
   };
 }>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
-declare const provideFateClient: (client: MaybeRefOrGetter<FateClient$1<any, any>>) => void;
-declare const createFatePlugin: (client: MaybeRefOrGetter<FateClient$1<any, any>>) => Plugin;
+export declare const provideFateClient: (client: MaybeRefOrGetter<FateClient$1<any, any>>) => void;
+export declare const createFatePlugin: (client: MaybeRefOrGetter<FateClient$1<any, any>>) => Plugin;
 /**
  * Returns the nearest fate client from Vue dependency injection.
  */
-declare function useFateClient<T extends [Roots, Mutations] = [Roots, Mutations]>(): FateClient$1<T[0], T[1]>;
+export declare function useFateClient<T extends [Roots, Mutations] = [Roots, Mutations]>(): FateClient$1<T[0], T[1]>;
 //#endregion
 //#region src/listView.d.ts
 type ConnectionItems<C> = C extends {
@@ -71,7 +71,7 @@ type ListViewState<C> = [ShallowRef<ConnectionItems<ResolvedConnection<C>>>, Sha
 /**
  * Subscribes to a connection field, returning the current items and pagination helpers.
  */
-declare function useListView<C extends ConnectionValue$1 | Deferred$1<ConnectionValue$1> | null | undefined>(selection: ConnectionSelection, connection: MaybeRefOrGetter<C>): ListViewState<C>;
+export declare function useListView<C extends ConnectionValue$1 | Deferred$1<ConnectionValue$1> | null | undefined>(selection: ConnectionSelection, connection: MaybeRefOrGetter<C>): ListViewState<C>;
 //#endregion
 //#region src/useLiveListView.d.ts
 type ConnectionValue = {
@@ -81,7 +81,7 @@ type ConnectionValue = {
 /**
  * Subscribes to a connection field, returning live-updating items and pagination helpers.
  */
-declare function useLiveListView<C extends ConnectionValue | Deferred$1<ConnectionValue> | null | undefined>(selection: ConnectionSelection, connection: MaybeRefOrGetter<C>): ListViewState<C>;
+export declare function useLiveListView<C extends ConnectionValue | Deferred$1<ConnectionValue> | null | undefined>(selection: ConnectionSelection, connection: MaybeRefOrGetter<C>): ListViewState<C>;
 //#endregion
 //#region src/useView.d.ts
 type ViewEntityWithTypename$1<V extends View<any, any>> = ViewEntity<V> & {
@@ -97,9 +97,9 @@ type ViewResource<T> = ShallowRef<T> & {
 /**
  * Resolves a reference against a view and subscribes to updates for that selection.
  */
-declare function useView<V extends View<any, any>, R extends ViewRef$1<ViewEntityName<V>> | null>(view: V, ref: MaybeRefOrGetter<R>): ViewResource<R extends null ? null : ViewData<ViewEntityWithTypename$1<V>, ViewSelection<V>>>;
-declare function useView<V extends View<any, any>, R extends Deferred$1<ViewRef$1<ViewEntityName<V>>> | null>(view: V, ref: MaybeRefOrGetter<R>): ViewResource<R extends null ? null : ViewData<ViewEntityWithTypename$1<V>, ViewSelection<V>>>;
-declare function useView<V extends View<any, any>>(view: V, ref: MaybeRefOrGetter<Deferred$1<ViewRef$1<ViewEntityName<V>>> | ViewRef$1<ViewEntityName<V>> | null>): ViewResource<ViewData<ViewEntityWithTypename$1<V>, ViewSelection<V>> | null>;
+export declare function useView<V extends View<any, any>, R extends ViewRef$1<ViewEntityName<V>> | null>(view: V, ref: MaybeRefOrGetter<R>): ViewResource<R extends null ? null : ViewData<ViewEntityWithTypename$1<V>, ViewSelection<V>>>;
+export declare function useView<V extends View<any, any>, R extends Deferred$1<ViewRef$1<ViewEntityName<V>>> | null>(view: V, ref: MaybeRefOrGetter<R>): ViewResource<R extends null ? null : ViewData<ViewEntityWithTypename$1<V>, ViewSelection<V>>>;
+export declare function useView<V extends View<any, any>>(view: V, ref: MaybeRefOrGetter<Deferred$1<ViewRef$1<ViewEntityName<V>>> | ViewRef$1<ViewEntityName<V>> | null>): ViewResource<ViewData<ViewEntityWithTypename$1<V>, ViewSelection<V>> | null>;
 //#endregion
 //#region src/useLiveView.d.ts
 type ViewEntityWithTypename<V extends View<any, any>> = ViewEntity<V> & {
@@ -108,8 +108,8 @@ type ViewEntityWithTypename<V extends View<any, any>> = ViewEntity<V> & {
 /**
  * Resolves a reference against a view and subscribes to live server updates for that selection.
  */
-declare function useLiveView<V extends View<any, any>, R extends ViewRef$1<ViewEntityName<V>> | null>(view: V, ref: MaybeRefOrGetter<R>): ViewResource<R extends null ? null : ViewData<ViewEntityWithTypename<V>, ViewSelection<V>>>;
-declare function useLiveView<V extends View<any, any>, R extends Deferred$1<ViewRef$1<ViewEntityName<V>>> | null>(view: V, ref: MaybeRefOrGetter<R>): ViewResource<R extends null ? null : ViewData<ViewEntityWithTypename<V>, ViewSelection<V>>>;
-declare function useLiveView<V extends View<any, any>>(view: V, ref: MaybeRefOrGetter<Deferred$1<ViewRef$1<ViewEntityName<V>>> | ViewRef$1<ViewEntityName<V>> | null>): ViewResource<ViewData<ViewEntityWithTypename<V>, ViewSelection<V>> | null>;
+export declare function useLiveView<V extends View<any, any>, R extends ViewRef$1<ViewEntityName<V>> | null>(view: V, ref: MaybeRefOrGetter<R>): ViewResource<R extends null ? null : ViewData<ViewEntityWithTypename<V>, ViewSelection<V>>>;
+export declare function useLiveView<V extends View<any, any>, R extends Deferred$1<ViewRef$1<ViewEntityName<V>>> | null>(view: V, ref: MaybeRefOrGetter<R>): ViewResource<R extends null ? null : ViewData<ViewEntityWithTypename<V>, ViewSelection<V>>>;
+export declare function useLiveView<V extends View<any, any>>(view: V, ref: MaybeRefOrGetter<Deferred$1<ViewRef$1<ViewEntityName<V>>> | ViewRef$1<ViewEntityName<V>> | null>): ViewResource<ViewData<ViewEntityWithTypename<V>, ViewSelection<V>> | null>;
 //#endregion
-export { type ConnectionRef, type Deferred, FateClient, FateClientKey, type FateDehydratedState, type GraphQLMutationDefinition, type GraphQLMutationInput, type GraphQLMutationMap, type GraphQLMutationOutput, type GraphQLTransportOptions, type HydrateOptions, type HydrationLimits, type InferFateAPI, type ListViewState, type Pagination, type Persistence, type PersistenceSession, type PersistenceSnapshot, type RequestResource, type ViewRef, type ViewResource, clientRoot, createClient, createFatePlugin, createGraphQLTransport, createHTTPTransport, createTRPCTransport, defer, graphqlMutation, mutation, provideFateClient, toEntityId, useFateClient, useListView, useLiveListView, useLiveView, useRequest, useView, view };
+export { type ConnectionRef, type Deferred, type FateDehydratedState, type GraphQLMutationDefinition, type GraphQLMutationInput, type GraphQLMutationMap, type GraphQLMutationOutput, type GraphQLTransportOptions, type HydrateOptions, type HydrationLimits, type InferFateAPI, type ListViewState, type Pagination, type Persistence, type PersistenceSession, type PersistenceSnapshot, type RequestResource, type ViewRef, type ViewResource, clientRoot, createClient, createGraphQLTransport, createHTTPTransport, createTRPCTransport, defer, graphqlMutation, mutation, toEntityId, view };

package/lib/vite.d.mts

@@ -1,11 +1,10 @@
 import { FateViteTransport, fate as fate$1 } from "@nkzw/fate/vite";
 //#region src/vite.d.ts
-type FateVitePluginOptions = {
+export type FateVitePluginOptions = {
   generatedFile?: false | string;
   module: string;
   transport?: FateViteTransport;
   tsconfigFile?: false | string;
 };
-declare const fate: (options: FateVitePluginOptions) => ReturnType<typeof fate$1>;
-//#endregion
-export { FateVitePluginOptions, fate };
+export declare const fate: (options: FateVitePluginOptions) => ReturnType<typeof fate$1>;
+//#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-fate",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "fate is a modern data client for Vue.",
   "homepage": "https://github.com/nkzw-tech/fate",
   "license": "MIT",
@@ -40,7 +40,7 @@
     }
   },
   "dependencies": {
-    "@nkzw/fate": "^1.5.0"
+    "@nkzw/fate": "^1.5.2"
   },
   "devDependencies": {
     "vue": "^3.5.42"