@declarion/react 0.51.0 → 0.53.0

package/dist-lib/api/events.d.ts

@@ -1,21 +1,43 @@
+/**
+ * What a change frame says happened. The relay emits exactly these three
+ * (`golang/internal/realtime/mapper_coerce.go`, `actionForOp`); a restore is an
+ * SQL update and arrives as `updated`, so a branch on a fourth value is dead.
+ * Declared once here because every layer below reads the same wire word.
+ */
+export type EntityAction = "created" | "updated" | "deleted";
+/** One row a change frame names: its object id and its primary key. */
+export interface ChangedObject {
+    object_id?: string;
+    pk?: Record<string, string>;
+}
 export type SSEEvent = {
     type: "entity_changed";
     eventID?: string;
     entity: string;
     ids: string[];
-    objects?: Array<{
-        object_id?: string;
-        pk?: Record<string, string>;
-    }>;
-    action: "created" | "updated" | "deleted" | "restored";
+    objects?: ChangedObject[];
+    action: EntityAction;
+    /**
+     * Why the frame names no rows, when it names none. Only
+     * `access_not_projectable` can mean a viewer LOST a row, so only it may
+     * empty a cache; the rest leave a screen stale rather than wrong.
+     */
+    reason?: string;
 } | {
     type: "checkpoint";
     eventID: string;
+} | {
+    type: "replay_complete";
+    seq?: number;
 } | {
     type: "realtime_degraded";
     eventID?: string;
     entity: string;
     degradedSeq?: number;
+} | {
+    type: "realtime_restored";
+    eventID?: string;
+    restoredSeq?: number;
 } | {
     type: "cache_reset";
     eventID?: string;