@danxbot/ui 3.7.0 → 3.8.0

package/dist/types/index.d.ts

@@ -110,3 +110,6 @@ export { UseCaseCard, RoadmapItemCard, RoadmapSwimlaneBoard, UseCaseLedgerPage,
 export { ProvenanceDisclosure, ProvenanceBadge, ConfidenceMeter, provenanceStateLabel, confidenceBand, type ProvenanceRecord, type ProvenanceState, type ProvenanceSource, type ProvenanceCheck, type ProvenanceCall, type ProvenanceSignoff, type ConfidenceBand, type ProvenanceDisclosureProps, type ProvenanceTriggerBadge, type ProvenanceBadgeProps, type ProvenanceBadgeAppearance, type ConfidenceMeterProps, } from "./components/provenance";
 export { createSimStore, resetSimStores, useSimSettings, setSimSettings, getNetworkSpeed, getDataSource, simulateLatency, SimNetworkError, type SimStore, type SimStoreOptions, type SimSettings, type NetworkSpeed, type DataSource, type SimNamespace, } from "./lib/sim";
 export { NodeCanvas, LAYOUT_DEFAULTS, layoutTree, pathToNode, type NodeCanvasProps, type CanvasEdge, type CanvasLayout, type CanvasNode, type CanvasOrientation, type LayoutOptions, type NodeRenderContext, type NodeRenderer, type PlacedNode, } from "./components/node-canvas";
+export { defineRecordType, resetRecordTypes, useRecord, useRecords, useStaleness, write, writeAll, peekRecord, readState, readStaleness, subscribeToKey, subscribeToStaleness, retainKeys, sweepRecords, setRecordStoreTenant, getRecordStoreTenant, flushRecordNotifications, resetRecordStore, recordStoreStats, UNKNOWN_STATE, normalizeTypeName, normalizeTimestamp, recordKey, isRecordRef, type RecordRef, type ReadOptions, type RecordPayload, type RecordState, type RecordTypeOptions, type RecordTypeToken, type StalenessEntry, type WriteAllResult, type WriteOptions, type WriteResult, type WriteSource, type WriteVerdict, } from "./lib/records";
+export { RealtimeProvider, useRealtime, useRealtimeEpoch, useRealtimeHealth, useRealtimeRegistry, SubscriptionRegistry, normalizeScope, scopeKey, readRealtimeEpoch, subscribeToRealtimeEpoch, subscribeToRealtimeEvents, resetRealtimeSignals, type RealtimeChannel, type RealtimeConnectionState, type RealtimeDiagnostic, type RealtimeEvent, type RealtimeHealth, type RealtimeProviderProps, type RealtimeScope, type RealtimeScopeInput, type RealtimeStatus, type RealtimeTransport, type RegistryOptions, type SubscriptionHealth, type SubscriptionLease, type SubscriptionRequest, } from "./lib/realtime";
+export { useRecordRead, useRecordListRead, useRecordStoreSweep, applyMutationResult, acquireSlot, appendCreatedKey, emptySlotSnapshot, readSlot, resetSlots, slotKeys, subscribeToSlot, writeSlot, RefetchRunner, registerActiveRead, resetActiveReads, type ActiveRead, type ListFetch, type ListFetchResult, type ListReadOptions, type ListReadResult, type ReadError, type RecordFetch, type RecordReadOptions, type RecordReadResult, type RunnerOptions, type SlotSnapshot, } from "./lib/reads";

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

@@ -0,0 +1,49 @@
+import { type RecordPayload, type RecordTypeToken, type WriteResult } from "../records";
+import type { ListReadOptions, ListReadResult, RecordReadOptions, RecordReadResult } from "./types";
+/**
+ * Read one record: fetch it, write it into the store tagged with the field set
+ * it asked for, and return the store's answer.
+ *
+ * `id` may be null for a conditional read — the hook then fetches nothing and
+ * reports `unknown`, rather than forcing a caller around a rule of hooks.
+ */
+export declare function useRecordRead<T>(token: RecordTypeToken<T>, id: string | number | null | undefined, options: RecordReadOptions): RecordReadResult<T>;
+/**
+ * Read a page: fetch it, write every row into the store, and record which keys
+ * answered the query in a LIST SLOT.
+ *
+ * The slot is what makes a `created` broadcast visible and a tombstone
+ * removable without a fetch — and it is where `meta` lives, because pagination
+ * has no identity and can never be a record.
+ */
+export declare function useRecordListRead<T, TMeta = unknown>(token: RecordTypeToken<T>, options: ListReadOptions<TMeta>): ListReadResult<T, TMeta>;
+/**
+ * Write a mutation's returned item into the store.
+ *
+ * A MUTATION RESPONSE IS A FETCH, and this exists because that is a question an
+ * implementer will otherwise answer by coin flip. It is a full server answer to
+ * a request this client made: it may satisfy a field-set tag, it clears
+ * staleness on every field it carries, and it must NEVER be dropped by the
+ * self-echo filter — that filter applies to broadcasts, and dropping a
+ * mutation's own response would discard the server-computed fields the caller
+ * asked for. Structurally it cannot be dropped, because the filter lives on the
+ * broadcast path and this does not go through it.
+ */
+export declare function applyMutationResult(payload: RecordPayload, options: {
+    tag: string;
+    tenant?: string | number;
+}): WriteResult;
+/**
+ * Sweep unreachable records on a bounded schedule, for as long as this is
+ * mounted.
+ *
+ * IT IS A HOOK, NOT AN INTERVAL STARTED ON IMPORT. A design-system module that
+ * schedules work because somebody imported it is a worse defect than the leak
+ * it prevents — it runs in every consumer, including ones with no store at all.
+ * So the library exports the sweep and the CONSUMER decides when: this hook at
+ * an app root, a call at a navigation boundary, or both. A navigation boundary
+ * alone is not enough, because a broadcast can create a key no root reaches and
+ * a screen nobody navigates away from accumulates those for as long as the tab
+ * is open.
+ */
+export declare function useRecordStoreSweep(intervalMs?: number): void;

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

@@ -0,0 +1,4 @@
+export { useRecordRead, useRecordListRead, applyMutationResult, useRecordStoreSweep } from "./hooks";
+export { acquireSlot, appendCreatedKey, emptySlotSnapshot, readSlot, resetSlots, slotKeys, subscribeToSlot, writeSlot, type SlotSnapshot, } from "./slots";
+export { RefetchRunner, registerActiveRead, resetActiveReads, type ActiveRead, type RunnerOptions } from "./refetch";
+export type { ListFetch, ListFetchResult, ListReadOptions, ListReadResult, ReadError, RecordFetch, RecordReadOptions, RecordReadResult, } from "./types";

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

@@ -0,0 +1,52 @@
+export interface RunnerOptions {
+    readonly minIntervalMs?: number;
+    /** Test seam. Defaults to `Date.now`. */
+    readonly now?: () => number;
+}
+/**
+ * One read's refetch discipline: a floor between runs, and one request in
+ * flight at a time.
+ *
+ * A SECOND SIGNAL ARRIVING MID-FLIGHT SETS A RE-RUN FLAG rather than issuing a
+ * second request. Two overlapping refetches of the same target are not twice as
+ * fresh; they are two answers racing to write, and the loser can be the newer
+ * one.
+ */
+export declare class RefetchRunner {
+    private readonly run;
+    private inFlight;
+    private rerun;
+    private lastFinishedAt;
+    private timer;
+    private disposed;
+    private readonly minIntervalMs;
+    private readonly now;
+    constructor(run: () => Promise<void>, options?: RunnerOptions);
+    /** Ask for a refetch. Respects the floor and the in-flight request. */
+    request(): void;
+    /**
+     * Run now, floor and all.
+     *
+     * For the FIRST fetch and for a key change — neither is a refetch, and making
+     * a fresh screen wait out an interval that exists to damp a broadcast stream
+     * would be the floor working against its own purpose.
+     */
+    runNow(): void;
+    private execute;
+    dispose(): void;
+}
+/** One mounted read, as the driver sees it. */
+export interface ActiveRead {
+    /** The keys this read is responsible for. Re-read per signal: a list's move. */
+    roots(): readonly string[];
+    /** Ask this read to re-issue the request it already made. */
+    request(): void;
+}
+/**
+ * Register a read so staleness and liveness recovery can reach it.
+ *
+ * @returns unregister
+ */
+export declare function registerActiveRead(read: ActiveRead): () => void;
+/** Test seam. Nothing in the library calls this. */
+export declare function resetActiveReads(): void;

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

@@ -0,0 +1,52 @@
+export interface SlotSnapshot<T = unknown, TMeta = unknown> {
+    readonly items: readonly T[];
+    readonly pending: readonly T[];
+    readonly pendingCount: number;
+    readonly meta: TMeta | undefined;
+    /** Every key the slot holds, fetched and pending. The refetch roots. */
+    readonly keys: readonly string[];
+}
+/** `getServerSnapshot`, and the answer for a slot nothing has written yet. */
+export declare function emptySlotSnapshot(): SlotSnapshot;
+/**
+ * Claim a slot for the duration of the returned release.
+ *
+ * REFCOUNTED AND IDEMPOTENT, which is what makes StrictMode's mount / unmount /
+ * mount leave the slot — and its retained keys — exactly as it found them.
+ */
+export declare function acquireSlot(id: string, options: {
+    type: string;
+    tag: string;
+    acceptsCreated: boolean;
+}): () => void;
+/**
+ * Replace a slot's membership with a fetch's answer.
+ *
+ * A key that arrived through a `created` event and is now in the fetched page
+ * stops being pending — the fetch has placed it, which is the only thing that
+ * ever could.
+ */
+export declare function writeSlot(id: string, keys: readonly string[], meta: unknown): void;
+/**
+ * Append a record that entered the set elsewhere.
+ *
+ * WITH NO POSITION. The server owns sort order and page boundary; a client that
+ * inserts at a guessed index renders a list that is subtly, confidently wrong.
+ */
+export declare function appendCreatedKey(type: string, key: string): void;
+export declare function subscribeToSlot(id: string, listener: () => void): () => void;
+/** The keys a slot holds right now — the roots a targeted refetch matches on. */
+export declare function slotKeys(id: string): readonly string[];
+/**
+ * The slot's projection, memoized to a stable reference.
+ *
+ * IT RECOMPUTES AND THEN COMPARES rather than trusting its dirty flag, because
+ * a member notification does not always change what this slot renders — a
+ * record whose field-set tag is still unsatisfied moves nothing here — and
+ * handing back a fresh array for an unchanged list re-renders every consumer
+ * for nothing. The elements themselves are the store's own reference-stable
+ * snapshots, so comparing them is one identity check each.
+ */
+export declare function readSlot(id: string): SlotSnapshot;
+/** Test seam. Nothing in the library calls this. */
+export declare function resetSlots(): void;

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;
+}