@declarion/react 0.51.0 → 0.53.0

package/dist-lib/hooks/useMutations.d.ts

@@ -1,4 +1,4 @@
-import type { PkValues } from "../types/schema";
+import { type PkValues } from "../types/schema";
 import type { ActionExecuteRequest } from "../api/data";
 export declare function useCreateObject(entityCode: string): import("@tanstack/react-query").UseMutationResult<import("..").DataResponse<Record<string, unknown>>, Error, Record<string, unknown>, unknown>;
 export declare function useUpdateObject(entityCode: string): import("@tanstack/react-query").UseMutationResult<import("..").DataResponse<Record<string, unknown>>, Error, {

package/dist-lib/hooks/useSSE.d.ts

@@ -1,12 +1,32 @@
 import { type QueryClient } from "@tanstack/react-query";
-type EntityAction = "created" | "updated" | "deleted" | "restored";
-interface EntityChangedEvent {
+import { type ChangedObject, type EntityAction } from "../api/events";
+export interface EntityChangedEvent {
     entity: string;
     action: EntityAction;
     eventID?: string;
+    ids: string[];
+    objects?: ChangedObject[];
+    reason?: string;
 }
-export declare function invalidateForEntityChanges(queryClient: QueryClient, events: EntityChangedEvent[]): void;
+/**
+ * Applies one coalescing window of change frames, resolving once every query it
+ * touched claims no freshness it lacks - which is what lets the caller advance
+ * its resume position. docs/realtime.md "Frontend Invalidation".
+ */
+export declare function applyEntityChanges(queryClient: QueryClient, events: EntityChangedEvent[], signal?: AbortSignal): Promise<void>;
+/**
+ * What a write of one's OWN settles: the rows it NAMED are re-read through the
+ * path a change frame takes, and `fallback` covers everything it does not
+ * identify. docs/realtime.md "Frontend Invalidation".
+ */
+export declare function settleOwnWrite(queryClient: QueryClient, isAuthenticated: boolean, entity: string, rows: Array<Record<string, string>>, fallback: () => void): void;
+export declare function evictEntityBackedQueries(queryClient: QueryClient): void;
 export declare function liveEntityChanges(queryClient: QueryClient, isAuthenticated: boolean, events: EntityChangedEvent[]): EntityChangedEvent[];
 export declare function refetchActiveSSEQueries(queryClient: QueryClient): void;
+/**
+ * What a returning tab still has to ask for, once the replay covers the rest:
+ * the entities that are not `realtime: true` and the ones the relay degraded,
+ * which between them are the majority of screens. docs/realtime.md.
+ */
+export declare function refetchQueriesReplayDoesNotCover(queryClient: QueryClient, isAuthenticated: boolean): void;
 export declare function useSSE(): void;
-export {};