@danxbot/ui 3.7.0 → 3.9.0

package/dist/types/lib/reads/types.d.ts

@@ -0,0 +1,139 @@
+import type { RecordPayload, RecordState } from "../records";
+/**
+ * A refusal.
+ *
+ * IT LIVES HERE AND NOT IN THE STORE, deliberately. A 404 is not one of the
+ * store's record states, because a refusal carries a message and a remedy the
+ * store has no way to build — so a `404` member there would be permanently
+ * unreachable. It belongs to the layer that performed the request, which is
+ * this one.
+ */
+export interface ReadError {
+    readonly message: string;
+    /** Whatever was thrown. The app's own error wrapper reads it. */
+    readonly cause: unknown;
+}
+/** What a fetch of one record must resolve to: the payload itself. */
+export type RecordFetch = (signal?: AbortSignal) => Promise<RecordPayload>;
+/** What a fetch of a page must resolve to. */
+export interface ListFetchResult<TMeta = unknown> {
+    readonly items: readonly RecordPayload[];
+    /**
+     * Pagination, totals, anything the page carries that is NOT a record.
+     *
+     * IT LIVES IN THE SLOT BECAUSE IT CANNOT LIVE ANYWHERE ELSE. `meta.total` has
+     * no `__type` and no `id`, so it can never be a record — and a normalized
+     * store without a place for it is the half of this design that gets omitted
+     * and then discovered from a screen that cannot render its own page count.
+     */
+    readonly meta?: TMeta;
+}
+export type ListFetch<TMeta = unknown> = (signal?: AbortSignal) => Promise<ListFetchResult<TMeta>>;
+/** Options common to both reads. */
+interface CommonReadOptions {
+    /**
+     * The opaque field-set name this request asks for — `"card"`, `"detail"`,
+     * whatever the app's own api layer already calls its selector.
+     *
+     * The library never interprets it. It is compared for equality and nothing
+     * else, which is what lets `needs` gate a read on a completion the library
+     * cannot compute.
+     */
+    readonly tag: string;
+    /**
+     * The tenant to stamp writes with. Defaults to the store's current tenant,
+     * READ AT REQUEST TIME.
+     *
+     * Request time is the whole point: stamping on ARRIVAL reads the tenant as it
+     * is now, which defeats the check entirely — a team-A response that resolves
+     * after a switch to team B would be stamped B and merged into B's store.
+     */
+    readonly tenant?: string | number;
+    /** Skip the fetch entirely. The read reports `loading: false`. */
+    readonly enabled?: boolean;
+    /**
+     * The floor between two refetches of THIS read. Default 1000ms.
+     *
+     * A TIME FLOOR IS NOT OPTIONAL, and breadth-coalescing alone is not enough:
+     * at least one real broadcast source has no change guard at all and fires on
+     * every related save, so during a long job it is a continuous STREAM rather
+     * than a burst. Without a floor that is one refetch per frame, of whatever
+     * the heaviest read on the screen happens to be.
+     */
+    readonly minRefetchIntervalMs?: number;
+}
+export interface RecordReadOptions extends CommonReadOptions {
+    readonly fetch: RecordFetch;
+}
+export interface ListReadOptions<TMeta = unknown> extends CommonReadOptions {
+    /**
+     * The serialized query — the slot's identity.
+     *
+     * Two components asking the same question share one slot; two different
+     * questions never collide. It is the caller's serialization because only the
+     * caller knows which of its parameters are part of the question.
+     */
+    readonly key: string;
+    readonly fetch: ListFetch<TMeta>;
+    /**
+     * Whether a `created` broadcast for this type may append to this slot.
+     * Default `true`.
+     *
+     * SET IT FALSE FOR A SLOT WHOSE MEMBERSHIP THIS CLIENT CANNOT VERIFY. The
+     * backend evaluates a filter subscription server-side per save, so a
+     * `created` event arriving on such a subscription IS authoritative that the
+     * record matches — but the library cannot tell WHICH of several slots of the
+     * same type it matches when a screen holds more than one differently-filtered
+     * list. Appending to all of them would be a guess; this flag is where the app
+     * says which one owns the event.
+     */
+    readonly acceptsCreated?: boolean;
+}
+/** The loading / refreshing / error triple, shared by both reads. */
+interface ReadStatus {
+    /** No answer yet AND a fetch is in flight. This is the skeleton. */
+    readonly loading: boolean;
+    /**
+     * An answer is on screen AND a fetch is in flight.
+     *
+     * SEPARATE FROM `loading` ON PURPOSE. Collapsing the two blanks a populated
+     * screen every time anything invalidates — which is exactly what recovering
+     * from staleness by blanking the screen would do, and it is a worse
+     * experience than the staleness.
+     */
+    readonly refreshing: boolean;
+    readonly error: ReadError | undefined;
+    /** Re-issue the request now, subject to the refetch floor. */
+    readonly refetch: () => void;
+}
+export interface RecordReadResult<T> extends ReadStatus {
+    /** The store's answer: `unknown`, `present` or `deleted`. Never a maybe. */
+    readonly state: RecordState<T>;
+    /** `state.record` when present, for the common case. */
+    readonly data: T | undefined;
+}
+export interface ListReadResult<T, TMeta = unknown> extends ReadStatus {
+    /** The fetched page, in the server's order, tombstoned rows removed. */
+    readonly items: readonly T[];
+    /**
+     * Rows that entered the set through a `created` broadcast, in arrival order.
+     *
+     * THEY ARE NOT SPLICED INTO `items`, and that is the honest form of the rule
+     * rather than a limitation: sort position and page boundary are decided by
+     * the server, so guessing where a new row goes is precisely the lie the rule
+     * exists to prevent. A screen renders "N new" and the next fetch places them.
+     */
+    readonly pending: readonly T[];
+    /**
+     * How many rows are waiting, INCLUDING ones not yet renderable.
+     *
+     * THIS IS NOT `pending.length`, and the difference is the whole reason it
+     * exists. A `created` broadcast is partial by whitelist, so it can never
+     * satisfy the field-set tag — meaning the appended record is countable but
+     * not renderable until a fetch fills it in. Reading "N new" off `pending`
+     * would print zero for exactly the case the marker was added to cover.
+     */
+    readonly pendingCount: number;
+    readonly meta: TMeta | undefined;
+}
+export {};

package/dist/types/lib/realtime/hooks.d.ts

@@ -0,0 +1,38 @@
+import type { RecordTypeToken } from "../records";
+import type { RealtimeHealth, RealtimeScopeInput } from "./types";
+/**
+ * Declare that this component is looking at these records and wants these
+ * events.
+ *
+ * COALESCED. Twenty-five components asking for the same scope produce ONE
+ * server-side registration, and the union of everyone's event names is bound —
+ * never the first caller's only, which is the live defect this module was
+ * written against.
+ *
+ * NO-OP WITHOUT A PROVIDER. An application with realtime switched off keeps
+ * fetching and keeps rendering; nothing here throws.
+ *
+ * @param token   the record type, from `defineRecordType`
+ * @param scope   `"all"`, an id list, or `{filter}` the server evaluates
+ * @param events  event names to bind, e.g. `["created", "updated", "deleted"]`
+ */
+export declare function useRealtime<T>(token: RecordTypeToken<T>, scope: RealtimeScopeInput, events: readonly string[]): void;
+/**
+ * The renderable liveness state.
+ *
+ * IT IS RENDERABLE ON PURPOSE. A dead subscription is indistinguishable from a
+ * quiet one, and the prior art's answer — a console panel behind a keyboard
+ * shortcut — is why two real bugs in it went unnoticed for years. This is the
+ * equivalent of `refreshing`: a word the reader can see, not a log line.
+ */
+export declare function useRealtimeHealth(): RealtimeHealth;
+/**
+ * The "you may have missed events" counter, for a consumer that wants to fold
+ * it into its own invalidation rather than use the read binding.
+ *
+ * IT IS A REVISION, NEVER A READ KEY. A key change blanks the screen to a
+ * skeleton; a revision keeps the answer on screen and marks it refreshing. This
+ * signal exists because a subscription went dead and came back — recovering
+ * from that by blanking the screen is a worse experience than the staleness.
+ */
+export declare function useRealtimeEpoch(): number;

package/dist/types/lib/realtime/index.d.ts

@@ -0,0 +1,4 @@
+export { RealtimeProvider, useRealtimeRegistry, type RealtimeProviderProps } from "./provider";
+export { useRealtime, useRealtimeEpoch, useRealtimeHealth } from "./hooks";
+export { SubscriptionRegistry, normalizeScope, scopeKey, readRealtimeEpoch, subscribeToRealtimeEpoch, subscribeToRealtimeEvents, resetRealtimeSignals, type RegistryOptions, } from "./registry";
+export type { RealtimeChannel, RealtimeConnectionState, RealtimeDiagnostic, RealtimeEvent, RealtimeHealth, RealtimeScope, RealtimeScopeInput, RealtimeStatus, RealtimeTransport, SubscriptionHealth, SubscriptionLease, SubscriptionRequest, } from "./types";

package/dist/types/lib/realtime/provider.d.ts

@@ -0,0 +1,38 @@
+import { type ReactNode } from "react";
+import { SubscriptionRegistry, type RegistryOptions } from "./registry";
+export interface RealtimeProviderProps extends Omit<RegistryOptions, "transport" | "tenant" | "now"> {
+    /**
+     * Everything environment-specific in one object: socket, endpoints,
+     * connection observer. INJECTED, never imported — see `types.ts` for why, and
+     * for the one constraint on its implementation that a type cannot express.
+     */
+    readonly transport: RegistryOptions["transport"];
+    /**
+     * The team, org or account these records belong to.
+     *
+     * CHANGING IT IS A REAL EVENT, not a re-render: every server-side
+     * registration is dropped, every channel is left, the record store is
+     * cleared, and everything still mounted re-subscribes under the new tenant.
+     */
+    readonly tenant?: string | number;
+    /**
+     * Whether this provider owns the record store's tenant. Default `true`.
+     *
+     * Set it false only when something else already calls
+     * `setRecordStoreTenant` — two writers of one value is how they disagree.
+     */
+    readonly ownsStoreTenant?: boolean;
+    readonly children: ReactNode;
+}
+export declare function RealtimeProvider({ transport, tenant, ownsStoreTenant, children, ...options }: RealtimeProviderProps): import("react").JSX.Element;
+/**
+ * The registry, or `null` when no provider is mounted.
+ *
+ * THIS PACKAGE'S USUAL CONVENTION IS INVERTED HERE, DELIBERATELY. Every other
+ * provider in this library throws when its hook is used outside it, and that is
+ * right for a capability a component cannot work without. Realtime is not one:
+ * an application with no transport configured must degrade to plain fetching,
+ * never crash. A design system that hard-fails because an OPTIONAL capability
+ * is absent is not offering an optional capability.
+ */
+export declare function useRealtimeRegistry(): SubscriptionRegistry | null;

package/dist/types/lib/realtime/registry.d.ts

@@ -0,0 +1,172 @@
+import type { RealtimeDiagnostic, RealtimeEvent, RealtimeHealth, RealtimeScope, RealtimeScopeInput, RealtimeTransport } from "./types";
+import type { RecordPayload } from "../records";
+export interface RegistryOptions {
+    readonly transport: RealtimeTransport;
+    readonly tenant?: string | number;
+    readonly keepaliveIntervalMs?: number;
+    readonly expiryMarginMs?: number;
+    readonly baseBackoffMs?: number;
+    readonly maxBackoffMs?: number;
+    readonly maxAttempts?: number;
+    /**
+     * The event name that means "this record just entered the set".
+     *
+     * Configurable because the name is the backend's, not this library's, and
+     * hard-coding one would be the only domain fact in this module.
+     */
+    readonly createdEventName?: string;
+    /**
+     * Drop a broadcast this client caused.
+     *
+     * A PREDICATE RATHER THAN A FIELD NAME, because the field that says who
+     * caused a change belongs to a wire format, not to a design system. Supplied
+     * by the app or absent; absent means every broadcast is written.
+     *
+     * IT APPLIES TO BROADCASTS ONLY, structurally — a fetch and a mutation's
+     * returned item never pass through here at all. That matters: a mutation
+     * response is self-caused BY DEFINITION, and dropping it would discard the
+     * server-computed fields the client asked for.
+     */
+    readonly isSelfEvent?: (payload: RecordPayload) => boolean;
+    readonly onDiagnostic?: (diagnostic: RealtimeDiagnostic) => void;
+    /** Test seam. Defaults to `Date.now`. */
+    readonly now?: () => number;
+}
+export declare function readRealtimeEpoch(): number;
+export declare function subscribeToRealtimeEpoch(listener: () => void): () => void;
+/** Every broadcast, AFTER it has been written to the store. */
+export declare function subscribeToRealtimeEvents(listener: (event: RealtimeEvent) => void): () => void;
+/** Test seam. Nothing in the library calls this. */
+export declare function resetRealtimeSignals(): void;
+/**
+ * Normalize a caller's scope and give it a stable key.
+ *
+ * IDS ARE SORTED AND STRINGIFIED so two components asking for the same rows in
+ * a different order coalesce onto one subscription rather than opening two —
+ * and so a numeric id and its string form never split an entry, exactly as the
+ * store keys records.
+ */
+export declare function normalizeScope(input: RealtimeScopeInput): RealtimeScope;
+export declare function scopeKey(scope: RealtimeScope): string;
+export declare class SubscriptionRegistry {
+    private readonly transport;
+    private readonly entries;
+    private readonly channels;
+    private readonly options;
+    private readonly healthListeners;
+    private tenant;
+    private connection;
+    private stopConnectionObserver;
+    private timer;
+    private healthSnapshot;
+    private lastError;
+    private started;
+    private disposed;
+    constructor(options: RegistryOptions);
+    /**
+     * Begin observing the connection and renewing leases.
+     *
+     * THE TIMER STARTS HERE, NEVER ON IMPORT. A design-system module that starts
+     * an interval because somebody imported it is a worse defect than the leak it
+     * would be preventing: it runs in every consumer, including the ones that
+     * never touch realtime at all.
+     */
+    start(): void;
+    /**
+     * Stop the timers. REVERSIBLE, and it keeps every entry and every channel.
+     *
+     * THIS IS WHAT STRICTMODE REQUIRES. React mounts every effect, unmounts it,
+     * and mounts it again in development — so a teardown that dropped the entries
+     * would make the remount issue a SECOND subscribe for a registration that is
+     * still perfectly live, and the whole misbehaviour would exist only in
+     * development, which is the worst place for a realtime bug to live because it
+     * is where the thing is being debugged.
+     *
+     * IT DOES NOT UNSUBSCRIBE, and it does not leave the socket channels. Unmount
+     * never touches the server-side registry — the entry lapses against its own
+     * TTL — and the socket belongs to the application that injected it. A tenant
+     * switch is the one place either of those happens, and it has its own method.
+     */
+    stop(): void;
+    /**
+     * Full teardown: stop, leave every channel, forget every entry.
+     *
+     * NOT what a component unmount calls — see `stop`. This exists for an
+     * application deliberately switching realtime off, which is a decision no
+     * lifecycle can infer.
+     */
+    dispose(): void;
+    /**
+     * Switch tenants: tear the server-side registrations down, clear the socket,
+     * and re-establish everything still mounted under the new tenant.
+     *
+     * THIS IS THE ONE PLACE `unsubscribe` IS CALLED. Never-unsubscribe applies to
+     * UNMOUNT, where tearing down can kill another tab's subscription; a
+     * subscription left lapsing on the PREVIOUS tenant's channel is a leak of a
+     * different kind, and one this library can close on its own.
+     */
+    setTenant(tenant: string | number | undefined): void;
+    getTenant(): string | number | undefined;
+    /**
+     * Declare interest in a (type, scope) with a set of event names.
+     *
+     * THE RETURNED RELEASE IS IDEMPOTENT AND EXACTLY PAIRED, which is what makes
+     * StrictMode's mount / unmount / mount leave exactly ONE subscription: the
+     * refcount goes 1, 0, 1 while the server-side registration is never dropped,
+     * so the remount reuses the live lease instead of issuing a second subscribe.
+     */
+    acquire(type: string, scopeInput: RealtimeScopeInput, events: readonly string[]): () => void;
+    private subscribeEntry;
+    /**
+     * Bounded exponential backoff, then a terminal DEAD state.
+     *
+     * NOTHING IS ESCALATED, EVER. The failure that motivates this is a 401 on a
+     * background resubscribe: routed through an app's ordinary HTTP error path it
+     * clears the session and logs somebody out mid-screen. Here it is a number in
+     * `attempts`, a string in `lastError`, and a status a screen can print.
+     */
+    private scheduleRetry;
+    private clearRetry;
+    /**
+     * Is this subscription failing to deliver?
+     *
+     * THREE INPUTS, ANY ONE SUFFICIENT, and the first is the one no reconnect
+     * hook can see: the lease simply runs out while everything else looks
+     * healthy.
+     */
+    private isDead;
+    /**
+     * One pass: renew what is live, revive what is dead.
+     *
+     * Exposed so a consumer — or a test — can run it without waiting for the
+     * interval. Everything it does is idempotent.
+     */
+    tick(): void;
+    private keepalive;
+    private onConnectionState;
+    private ensureChannel;
+    private leaveAllChannels;
+    /**
+     * One broadcast: filter, write, announce.
+     *
+     * THE TENANT IS THE ONE THE CHANNEL WAS JOINED UNDER, captured at bind time
+     * and never read at delivery time. Reading it on arrival reads the tenant as
+     * it is NOW, which is precisely how a payload from the team you just left
+     * lands in the store as the team you just joined.
+     */
+    private deliver;
+    /** The event name that means "entered the set", for the read binding. */
+    get createdEventName(): string;
+    subscribeToHealth: (listener: () => void) => (() => void);
+    /**
+     * The renderable state, memoized so `getSnapshot` returns the identical
+     * object when nothing changed — the constraint every store in this package is
+     * written around.
+     */
+    readHealth: () => RealtimeHealth;
+    private deriveStatus;
+    private notifyHealth;
+    private requestFor;
+    private callTransport;
+    private diagnose;
+}

package/dist/types/lib/realtime/types.d.ts

@@ -0,0 +1,202 @@
+import type { RecordPayload } from "../records";
+/**
+ * What the socket says about itself.
+ *
+ * IT IS NOT THE SAME QUESTION AS "am I receiving events". A registry entry can
+ * lapse server-side while this reads `"connected"` forever, which is exactly
+ * why liveness is computed from three inputs and not from this one.
+ */
+export type RealtimeConnectionState = "connecting" | "connected" | "disconnected";
+/**
+ * WHICH RECORDS a subscription is asking to hear about.
+ *
+ * - `ids` — the rows on screen. The backend keys its registry entry per model
+ *   id, so this is the scope that pins specific records.
+ * - `filter` — a server-evaluated predicate. The backend re-runs it per save,
+ *   which is what makes a `created` event authoritative about set entry. It
+ *   answers "does this record match my filter" and NOTHING about sort position
+ *   or page boundary.
+ * - `all` — every record of the type for this tenant.
+ */
+export type RealtimeScope = {
+    readonly kind: "ids";
+    readonly ids: readonly string[];
+} | {
+    readonly kind: "filter";
+    readonly filter: Readonly<Record<string, unknown>>;
+} | {
+    readonly kind: "all";
+};
+/** What a caller may write, before normalization. `"all"` or ids or a filter. */
+export type RealtimeScopeInput = "all" | readonly (string | number)[] | {
+    readonly filter: Readonly<Record<string, unknown>>;
+};
+/** One server-side registration, as the transport receives it. */
+export interface SubscriptionRequest {
+    /** The NORMALIZED model name — never a `Resource` suffix. */
+    readonly type: string;
+    readonly scope: RealtimeScope;
+    /**
+     * The tenant this registration belongs to, passed rather than inferred so a
+     * request issued before a team switch can never be attributed to the team
+     * that came after it.
+     */
+    readonly tenant: string | number | undefined;
+    /** A stable identity for this (type, scope) pair. Useful as a request key. */
+    readonly key: string;
+}
+/**
+ * What the server said about a registration.
+ *
+ * `expiresAt` IS THE WHOLE POINT OF THIS TYPE. The registry holds it and treats
+ * a subscription as DEAD once the clock passes it minus a margin — never
+ * "letting it expire naturally", which is the prior art's exact wording and its
+ * exact bug: two failed keepalives inside one TTL window and that resource
+ * stops updating forever, silently, with a healthy socket.
+ */
+export interface SubscriptionLease {
+    /** Milliseconds since epoch. Omit only if the server genuinely does not say. */
+    readonly expiresAt?: number;
+}
+/** A joined socket channel. One per type per tenant, and no more. */
+export interface RealtimeChannel {
+    /**
+     * Bind one event name.
+     *
+     * CALLED AGAIN FOR EVERY NEW EVENT NAME A LATER SUBSCRIBER BRINGS, on the
+     * SAME channel object. The prior art returns early when the channel already
+     * exists and never reaches its own bind call, so only the FIRST subscriber's
+     * event names are ever live — two real subscribers collide on that today and
+     * one of them is silently dead in production. A transport implementation must
+     * therefore accept `bind` at any time, not only immediately after joining.
+     */
+    bind(event: string, handler: (payload: RecordPayload) => void): void;
+    /** Leave the channel entirely. Called on a tenant switch and on teardown. */
+    leave(): void;
+}
+/**
+ * Everything environment-specific, in one injected object: the socket, the
+ * three registry endpoints, and the connection observer.
+ *
+ * ONE CONSTRAINT ON THE IMPLEMENTATION THAT IS NOT EXPRESSIBLE IN THE TYPE, and
+ * it is the sharpest one: `subscribe`, `unsubscribe` and `keepalive` MUST NOT
+ * route their failures through an application's global 401 handler. A
+ * background resubscribe is allowed to fail; if that failure clears the
+ * session, a transient auth blip logs somebody out mid-screen — strictly worse
+ * than the stale screen the resubscribe existed to prevent. Reusing the app's
+ * default HTTP client is the easy thing to do and is exactly the bug. The
+ * registry holds up its half: it catches every rejection, backs off, and
+ * renders a DEAD state rather than escalating anything.
+ */
+export interface RealtimeTransport {
+    /** Register interest server-side. Rejecting is normal and is handled. */
+    subscribe(request: SubscriptionRequest): Promise<SubscriptionLease>;
+    /**
+     * Drop a registration.
+     *
+     * CALLED ONLY ON A TENANT SWITCH, never on unmount. The server keys its entry
+     * by USER, so two browser tabs belonging to one person share one entry — and
+     * one tab unmounting a screen would kill the other tab's still-mounted
+     * subscription, silently, with that tab's socket perfectly healthy. In-tab
+     * refcounting cannot fix that; the collision is above the tab. On unmount the
+     * entry is left to lapse against its own TTL, which costs a subscription
+     * outliving its component by a few minutes and nothing else.
+     */
+    unsubscribe(request: SubscriptionRequest): Promise<void>;
+    /**
+     * Renew several registrations at once.
+     *
+     * Resolve with one lease per request, in the SAME ORDER. Rejecting marks
+     * every request in the batch as failed — which is a DEAD subscription, not a
+     * warning, and the registry resubscribes rather than waiting.
+     */
+    keepalive(requests: readonly SubscriptionRequest[]): Promise<readonly SubscriptionLease[]>;
+    /** Join (or return) the channel carrying this type for this tenant. */
+    channel(type: string, tenant: string | number | undefined): RealtimeChannel;
+    connectionState(): RealtimeConnectionState;
+    observeConnection(listener: (state: RealtimeConnectionState) => void): () => void;
+}
+/**
+ * Why a subscription is not delivering, in the words a screen can print.
+ *
+ * A DEBUG PANEL SERVES DEVELOPERS; THE READER NEEDS A WORD ON SCREEN. This app
+ * refuses to collapse distinct absences everywhere else it has them, and a
+ * silently dead realtime layer is exactly the absence that gets collapsed by
+ * default — the prior art's observability is console-only behind a keyboard
+ * shortcut, which is why two live bugs in it went unnoticed for years.
+ */
+export type RealtimeStatus = 
+/** No transport was provided. Realtime is off and the app still works. */
+"unconfigured"
+/** Configured, nothing subscribed yet. */
+ | "idle"
+/** A first subscribe is in flight. */
+ | "connecting"
+/** Every active subscription is registered and the socket is connected. */
+ | "live"
+/** At least one subscription is not delivering. The screen should say so. */
+ | "dead";
+/** One subscription, as a devtools panel or a status line would render it. */
+export interface SubscriptionHealth {
+    readonly key: string;
+    readonly type: string;
+    readonly scope: RealtimeScope;
+    /** Bound event names — the UNION of every subscriber's, never the first's. */
+    readonly events: readonly string[];
+    readonly subscribers: number;
+    readonly expiresAt: number | undefined;
+    readonly dead: boolean;
+    /** Consecutive failed resubscribe attempts. Resets on success. */
+    readonly attempts: number;
+    readonly lastError: string | undefined;
+}
+/** The renderable liveness state. */
+export interface RealtimeHealth {
+    readonly status: RealtimeStatus;
+    readonly connection: RealtimeConnectionState;
+    readonly subscriptions: readonly SubscriptionHealth[];
+    /**
+     * Bumps whenever a subscription that WAS dead is restored.
+     *
+     * It is the "you may have missed events" signal, and it is deliberately a
+     * monotonic counter rather than a set of keys: a lapsed registry entry stops
+     * broadcasts without saying which ones were dropped, so the only honest claim
+     * is that something may be missing. The read binding folds it into a refetch
+     * of what is mounted — which keeps the answer on screen and marks it
+     * refreshing, rather than blanking to a skeleton.
+     */
+    readonly epoch: number;
+    readonly lastError: string | undefined;
+}
+/** Something worth recording. Observability only; never control flow. */
+export interface RealtimeDiagnostic {
+    readonly kind: "subscribed" | "resubscribed" | "subscribe-failed" | "keepalive-failed" | "expired" | "disconnected" | "event" | "self-event-dropped" | "unsubscribed";
+    readonly key?: string;
+    readonly type?: string;
+    readonly event?: string;
+    readonly message?: string;
+    readonly at: number;
+}
+/** One broadcast, after the registry has written it into the store. */
+export interface RealtimeEvent {
+    /** Normalized model name. */
+    readonly type: string;
+    /** The event name as bound, e.g. `"created"`. */
+    readonly event: string;
+    /**
+     * `Type:id`, or `undefined` when the payload was not a record OR the store
+     * refused the write — a record that did not land must not reach a list
+     * either.
+     */
+    readonly key: string | undefined;
+    /**
+     * Whether this is the event that means "entered the set".
+     *
+     * COMPUTED HERE rather than compared by the consumer, because the name is the
+     * backend's (`"created"` by default, configurable on the provider) and a
+     * consumer comparing the string would be the second place that fact lives.
+     */
+    readonly isCreate: boolean;
+    readonly payload: RecordPayload;
+    readonly tenant: string | number | undefined;
+}

package/dist/types/lib/records/define-record-type.d.ts

@@ -0,0 +1,29 @@
+import type { RecordTypeOptions, RecordTypeToken } from "./types";
+/**
+ * Declare a record type.
+ *
+ * THE NAME IS THE NORMALIZED MODEL NAME — `"WorkflowRun"`, NEVER
+ * `"WorkflowRunResource"`. This is the single most likely thing in this module
+ * to be built wrong, because both readings are plausible and exactly one
+ * matches: the store strips a trailing `Resource` from every incoming `__type`
+ * before keying (created payloads carry the suffix, deletes do not), so the
+ * caller always writes the model name. The wrong one produces a store that
+ * fills up and a screen that never moves, with no error anywhere — which is
+ * why passing the suffixed name warns loudly rather than quietly working.
+ *
+ * @param name normalized model name, e.g. `"WorkflowRun"`
+ * @param options `staleFields` — the fields this type's broadcast cannot carry
+ */
+export declare function defineRecordType<T>(name: string, options?: RecordTypeOptions): RecordTypeToken<T>;
+/**
+ * What a type declared, for the store's own use.
+ *
+ * An UNREGISTERED type is not an error: a nested child of a type nobody
+ * declared is still a record with an identity, and refusing it would lose data
+ * the parent legitimately carries. It simply has no stale fields, which is the
+ * correct default — a type that never declared a gap in its broadcast is
+ * treated as having none.
+ */
+export declare function staleFieldsFor(type: string): readonly string[] | "*";
+/** Test seam. Nothing in the library calls this. */
+export declare function resetRecordTypes(): void;

package/dist/types/lib/records/hooks.d.ts

@@ -0,0 +1,46 @@
+import type { ReadOptions, RecordState, RecordTypeToken, StalenessEntry } from "./types";
+/**
+ * Read one record.
+ *
+ * `needs` IS REQUIRED. It names the field set that must have landed from a
+ * FETCH before this key reports `present`; until then the answer is `unknown`,
+ * even when a broadcast has already seeded the key with real values. That is
+ * the whole guard: a projection function handed a broadcast-seeded record
+ * assumes absent means empty and renders a confident, wrong answer.
+ *
+ * `id` may be `null`/`undefined` for a conditional read — the hook then holds
+ * no subscription and reports `unknown`, rather than forcing a caller into two
+ * code paths around a rule of hooks.
+ */
+export declare function useRecord<T>(token: RecordTypeToken<T>, id: string | number | null | undefined, options: ReadOptions): RecordState<T>;
+/**
+ * Read many records at once, sharing one hydration per key with every other
+ * reader of that key.
+ *
+ * IT TAKES A KEY LIST AND DERIVES A STRING FROM IT rather than depending on the
+ * array's identity, so a caller passing a freshly-mapped array on every render
+ * — the normal thing to do — does not re-subscribe and does not violate
+ * `getSnapshot` identity. The alternative, subscribing to the whole store for a
+ * set of records, is the anti-pattern this package already ships once in
+ * `createSimStore.useById`; per-key notification is the entire reason this
+ * store exists.
+ */
+export declare function useRecords<T>(token: RecordTypeToken<T>, ids: readonly (string | number)[], options: ReadOptions): readonly RecordState<T>[];
+/**
+ * The staleness signal: affected ROOTS and their now-stale field sets.
+ *
+ * ITS ONLY CONSUMER IS THE LAYER THAT PERFORMED THE ORIGINAL FETCH. It
+ * re-issues the request it already made — it needs no registry of loaders,
+ * because "which field set" is not a question it has to answer; it is the one
+ * it already asked. The library contributes the signal and nothing else, which
+ * is what keeps every endpoint and every type name out of this package.
+ *
+ * TWO PROPERTIES THE CONSUMER MUST SUPPLY, because they are not expressible
+ * here: coalescing in BREADTH (twenty-five rows going stale in one burst is one
+ * list refetch, not twenty-five record refetches) and in TIME (a minimum
+ * interval, plus dedup against a refetch already in flight — a second signal
+ * arriving mid-flight sets a re-run flag rather than issuing a second request).
+ * Breadth alone is not enough: an event with no change guard on the server
+ * fires continuously during a long job, so it is a stream rather than a burst.
+ */
+export declare function useStaleness(): readonly StalenessEntry[];