@darajs/core 1.29.6 → 1.29.8

package/dist/shared/interactivity/polling.d.ts

@@ -0,0 +1,116 @@
+type TimerHandle = ReturnType<typeof setTimeout>;
+type RunCause = 'dependency' | 'poll';
+interface PollerOptions {
+    clearTimeout?: (timer: TimerHandle) => void;
+    getVisibilityState?: () => DocumentVisibilityState;
+    jitterRatio?: number;
+    now?: () => number;
+    random?: () => number;
+    setTimeout?: (callback: () => void, delay: number) => TimerHandle;
+    visibilityTarget?: Pick<Document, 'addEventListener' | 'removeEventListener'>;
+}
+export interface PollScope {
+    claims: Map<string, string>;
+    id: string;
+}
+export type SavedValue<T> = {
+    found: false;
+} | {
+    found: true;
+    value: T;
+};
+export interface PollRun<T> {
+    cause: RunCause;
+    inputKey?: string;
+    key: string;
+    read?: () => SavedValue<T>;
+    signal?: AbortSignal;
+    work: (signal: AbortSignal) => Promise<T>;
+    write: (value: T) => void;
+}
+/** Check whether an error represents intentional request cancellation. */
+export declare function isAbortError(error: unknown): boolean;
+/**
+ * Coordinates non-overlapping, fixed-delay polling for request identities.
+ *
+ * A request identity includes the rendered variable/component identity and its
+ * serialized request extras. Multiple React consumers of the same identity
+ * share one timer and one active request generation.
+ */
+export declare class Poller {
+    #private;
+    constructor(options?: PollerOptions);
+    /**
+     * Register one rendered polling consumer.
+     *
+     * The returned cleanup releases the consumer. The final cleanup aborts the
+     * owned request on the next macrotask so React StrictMode can immediately
+     * reacquire the same identity without cancelling useful work.
+     */
+    subscribe(key: string, intervalSeconds: number | undefined, refresh: () => void): () => void;
+    /**
+     * Claim a key during render so Suspense cannot skip its ownership effect.
+     *
+     * A later owner commit prunes claims left by an abandoned render.
+     */
+    claimKey(ownerId: string, hookId: string, key: string): void;
+    /** Apply the hook claims collected by one committed owner render. */
+    commitOwner(ownerId: string, claims: ReadonlyMap<string, string>): void;
+    /** Keep one key after its hook commits. */
+    mountKey(ownerId: string, hookId: string, key: string): void;
+    /** Drop a committed hook key after the StrictMode remount window. */
+    unmountKey(ownerId: string, hookId: string, key: string): void;
+    /** Release a rendered owner after the StrictMode remount window. */
+    releaseOwner(ownerId: string): void;
+    /**
+     * Run one request for a polling identity.
+     *
+     * Matching callers share one promise. Dependency runs replace older work,
+     * while a poll that arrives during a run leaves one follow-up refresh.
+     */
+    run<T>({ cause, inputKey, key, read, signal, work, write }: PollRun<T>): Promise<T>;
+    /** Refresh now, or keep one refresh while busy. */
+    runNow(key: string): void;
+    /** Abort and remove every polling identity. Intended for test isolation. */
+    clear(): void;
+    /** Current time according to the injected clock. */
+    now(): number;
+}
+/**
+ * Register fixed-delay polling for a request identity.
+ *
+ * `refresh` only invalidates the corresponding selector. Request lifecycle,
+ * backpressure, retries, and cancellation remain owned by the poller.
+ */
+export declare function usePolling(key: string, intervalSeconds: number | undefined, refresh: () => void): void;
+/**
+ * Create a render-local map of hooks to polling keys.
+ *
+ * The commit drops claims left by hooks that did not render.
+ */
+export declare function usePollScope(): PollScope;
+/**
+ * Keep one request key for a rendered hook.
+ *
+ * The hook must claim the key during render because an initial suspended render
+ * runs no effect. The claim only marks ownership; it starts no work. The passive
+ * effect keeps the claim after commit and stays mounted when Suspense hides an
+ * existing tree.
+ */
+export declare function usePollKey(scope: PollScope | undefined, key: string): void;
+/** Run one request using the production poller. */
+export declare function runPoll<T>(run: PollRun<T>): Promise<T>;
+/** Create a force key that identifies a poller-owned refresh. */
+export declare function createPollForceKey(): string;
+/** Check whether a selector force key originated from the poller. */
+export declare function isPollForceKey(forceKey: string | null | undefined): boolean;
+/** Extract Retry-After as a non-negative delay in milliseconds. */
+export declare function parseRetryAfter(response: Response, now?: number): number | undefined;
+/** Keep Retry-After beside an error without changing the error object. */
+export declare function markRetryAfter(error: unknown, response: Response): unknown;
+/** Await a promise while preserving ownership of request cancellation. */
+export declare function waitOrAbort<T>(promise: Promise<T>, signal?: AbortSignal): Promise<T>;
+/** Clear production polling state. Intended for test isolation. */
+export declare function clearPolling_TEST(): void;
+export {};
+//# sourceMappingURL=polling.d.ts.map

package/dist/shared/interactivity/polling.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"polling.d.ts","sourceRoot":"","sources":["../../../js/shared/interactivity/polling.tsx"],"names":[],"mappings":"AASA,KAAK,WAAW,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;AACjD,KAAK,QAAQ,GAAG,YAAY,GAAG,MAAM,CAAC;AAiCtC,UAAU,aAAa;IACnB,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAC;IAC5C,kBAAkB,CAAC,EAAE,MAAM,uBAAuB,CAAC;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,KAAK,EAAE,MAAM,KAAK,WAAW,CAAC;IAClE,gBAAgB,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,kBAAkB,GAAG,qBAAqB,CAAC,CAAC;CACjF;AAUD,MAAM,WAAW,SAAS;IACtB,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,EAAE,EAAE,MAAM,CAAC;CACd;AAyBD,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAEzE,MAAM,WAAW,OAAO,CAAC,CAAC;IACtB,KAAK,EAAE,QAAQ,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC;IAC3B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,IAAI,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC1C,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;CAC7B;AASD,0EAA0E;AAC1E,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAKpD;AAOD;;;;;;GAMG;AACH,qBAAa,MAAM;;IAaf,YAAY,OAAO,GAAE,aAAkB,EAUtC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAiE3F;IAED;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAW3D;IAED,qEAAqE;IACrE,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAqCtE;IAED,2CAA2C;IAC3C,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAoB3D;IAED,qEAAqE;IACrE,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAiB7D;IAED,oEAAoE;IACpE,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAMlC;IAED;;;;;OAKG;IACH,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAclF;IAqHD,mDAAmD;IACnD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAmBxB;IAED,4EAA4E;IAC5E,KAAK,IAAI,IAAI,CAuBZ;IAED,oDAAoD;IACpD,GAAG,IAAI,MAAM,CAEZ;CAsOJ;AAID;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,IAAI,GAAG,IAAI,CAOtG;AAED;;;;GAIG;AACH,wBAAgB,YAAY,IAAI,SAAS,CAUxC;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI,CAe1E;AAED,mDAAmD;AACnD,wBAAgB,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAEtD;AAED,iEAAiE;AACjE,wBAAgB,kBAAkB,IAAI,MAAM,CAE3C;AAED,qEAAqE;AACrE,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAE3E;AAED,mEAAmE;AACnE,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,SAAe,GAAG,MAAM,GAAG,SAAS,CAgB1F;AAED,0EAA0E;AAC1E,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAM1E;AAED,0EAA0E;AAC1E,wBAAsB,WAAW,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAyB1F;AAED,mEAAmE;AACnE,wBAAgB,iBAAiB,IAAI,IAAI,CAExC"}