@tanstack/pacer 0.21.1 → 0.23.0

package/dist/async-rate-limiter.d.cts

@@ -1,357 +0,0 @@
-import { AnyAsyncFunction } from "./types.cjs";
-import { AsyncRetryer, AsyncRetryerOptions } from "./async-retryer.cjs";
-import { Store } from "@tanstack/store";
-
-//#region src/async-rate-limiter.d.ts
-interface AsyncRateLimiterState<TFn extends AnyAsyncFunction> {
-  /**
-   * Number of function executions that have resulted in errors
-   */
-  errorCount: number;
-  /**
-   * Array of timestamps when executions occurred for rate limiting calculations
-   */
-  executionTimes: Array<number>;
-  /**
-   * Whether the rate limiter has exceeded the limit
-   */
-  isExceeded: boolean;
-  /**
-   * Whether the rate-limited function is currently executing asynchronously
-   */
-  isExecuting: boolean;
-  /**
-   * The result from the most recent successful function execution
-   */
-  lastResult: ReturnType<TFn> | undefined;
-  /**
-   * Number of function executions that have been rejected due to rate limiting
-   */
-  rejectionCount: number;
-  /**
-   * Number of function executions that have completed (either successfully or with errors)
-   */
-  settleCount: number;
-  /**
-   * Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded
-   */
-  status: 'disabled' | 'executing' | 'exceeded' | 'idle';
-  /**
-   * Number of function executions that have completed successfully
-   */
-  successCount: number;
-  /**
-   * Number of times maybeExecute has been called (for reduction calculations)
-   */
-  maybeExecuteCount: number;
-}
-/**
- * Options for configuring an async rate-limited function
- */
-interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {
-  /**
-   * Options for configuring the underlying async retryer
-   */
-  asyncRetryerOptions?: AsyncRetryerOptions<TFn>;
-  /**
-   * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.
-   * Can be a boolean or a function that returns a boolean.
-   * Defaults to true.
-   */
-  enabled?: boolean | ((rateLimiter: AsyncRateLimiter<TFn>) => boolean);
-  /**
-   * Initial state for the rate limiter
-   */
-  initialState?: Partial<AsyncRateLimiterState<TFn>>;
-  /**
-   * Optional key to identify this async rate limiter instance.
-   * If provided, the async rate limiter will be identified by this key in the devtools and PacerProvider if applicable.
-   */
-  key?: string;
-  /**
-   * Maximum number of executions allowed within the time window.
-   * Can be a number or a function that returns a number.
-   */
-  limit: number | ((rateLimiter: AsyncRateLimiter<TFn>) => number);
-  /**
-   * Optional error handler for when the rate-limited function throws.
-   * If provided, the handler will be called with the error and rate limiter instance.
-   * This can be used alongside throwOnError - the handler will be called before any error is thrown.
-   */
-  onError?: (error: Error, args: Parameters<TFn>, rateLimiter: AsyncRateLimiter<TFn>) => void;
-  /**
-   * Optional callback function that is called when an execution is rejected due to rate limiting
-   */
-  onReject?: (args: Parameters<TFn>, rateLimiter: AsyncRateLimiter<TFn>) => void;
-  /**
-   * Optional function to call when the rate-limited function is executed
-   */
-  onSettled?: (args: Parameters<TFn>, rateLimiter: AsyncRateLimiter<TFn>) => void;
-  /**
-   * Optional function to call when the rate-limited function is executed
-   */
-  onSuccess?: (result: ReturnType<TFn>, args: Parameters<TFn>, rateLimiter: AsyncRateLimiter<TFn>) => void;
-  /**
-   * Whether to throw errors when they occur.
-   * Defaults to true if no onError handler is provided, false if an onError handler is provided.
-   * Can be explicitly set to override these defaults.
-   */
-  throwOnError?: boolean;
-  /**
-   * Time window in milliseconds within which the limit applies.
-   * Can be a number or a function that returns a number.
-   */
-  window: number | ((rateLimiter: AsyncRateLimiter<TFn>) => number);
-  /**
-   * Type of window to use for rate limiting
-   * - 'fixed': Uses a fixed window that resets after the window period
-   * - 'sliding': Uses a sliding window that allows executions as old ones expire
-   * Defaults to 'fixed'
-   */
-  windowType?: 'fixed' | 'sliding';
-}
-/**
- * Utility function for sharing common `AsyncRateLimiterOptions` options between different `AsyncRateLimiter` instances.
- */
-declare function asyncRateLimiterOptions<TFn extends AnyAsyncFunction = AnyAsyncFunction, TOptions extends Partial<AsyncRateLimiterOptions<TFn>> = Partial<AsyncRateLimiterOptions<TFn>>>(options: TOptions): TOptions;
-/**
- * A class that creates an async rate-limited function.
- *
- * Async vs Sync Versions:
- * The async version provides advanced features over the sync RateLimiter:
- * - Returns promises that can be awaited for rate-limited function results
- * - Built-in retry support via AsyncRetryer integration
- * - Abort support to cancel in-flight executions
- * - Comprehensive error handling with onError callbacks and throwOnError control
- * - Detailed execution tracking (success/error/settle counts, rejection counts)
- * - More sophisticated window management with automatic cleanup
- *
- * The sync RateLimiter is lighter weight and simpler when you don't need async features,
- * return values, or execution control.
- *
- * What is Rate Limiting?
- * Rate limiting allows a function to execute up to a limit within a time window,
- * then blocks all subsequent calls until the window passes. This can lead to "bursty" behavior where
- * all executions happen immediately, followed by a complete block.
- *
- * Window Types:
- * - 'fixed': A strict window that resets after the window period. All executions within the window count
- *   towards the limit, and the window resets completely after the period.
- * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
- *   consistent rate of execution over time.
- *
- * When to Use Rate Limiting:
- * Rate limiting is best used for hard API limits or resource constraints. For UI updates or
- * smoothing out frequent events, throttling or debouncing usually provide better user experience.
- * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)
- * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)
- *
- * State Management:
- * - Uses TanStack Store for reactive state management
- * - Use `initialState` to provide initial state values when creating the rate limiter
- * - `initialState` can be a partial state object
- * - Use `onSuccess` callback to react to successful function execution and implement custom logic
- * - Use `onError` callback to react to function execution errors and implement custom error handling
- * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic
- * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded
- * - The state includes execution times, success/error counts, and current execution status
- * - State can be accessed via `asyncRateLimiter.store.state` when using the class directly
- * - When using framework adapters (React/Solid), state is accessed from `asyncRateLimiter.state`
- *
- * Error Handling:
- * - If an `onError` handler is provided, it will be called with the error and rate limiter instance
- * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
- * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
- * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
- * - The error state can be checked using the underlying AsyncRateLimiter instance
- * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler
- *
- * @example
- * ```ts
- * const rateLimiter = new AsyncRateLimiter(
- *   async (id: string) => await api.getData(id),
- *   {
- *     limit: 5,
- *     window: 1000,
- *     windowType: 'sliding',
- *     onError: (error) => {
- *       console.error('API call failed:', error);
- *     },
- *     onReject: (limiter) => {
- *       console.log(`Rate limit exceeded. Try again in ${limiter.getMsUntilNextWindow()}ms`);
- *     }
- *   }
- * );
- *
- * // Will execute immediately until limit reached, then block
- * // Returns the API response directly
- * const data = await rateLimiter.maybeExecute('123');
- * ```
- */
-declare class AsyncRateLimiter<TFn extends AnyAsyncFunction> {
-  #private;
-  fn: TFn;
-  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>;
-  key: string | undefined;
-  options: AsyncRateLimiterOptions<TFn>;
-  asyncRetryers: Map<number, AsyncRetryer<TFn>>;
-  constructor(fn: TFn, initialOptions: AsyncRateLimiterOptions<TFn>);
-  /**
-   * Updates the async rate limiter options
-   */
-  setOptions: (newOptions: Partial<AsyncRateLimiterOptions<TFn>>) => void;
-  /**
-   * Attempts to execute the rate-limited function if within the configured limits.
-   * Will reject execution if the number of calls in the current window exceeds the limit.
-   *
-   * Error Handling:
-   * - If the rate-limited function throws and no `onError` handler is configured,
-   *   the error will be thrown from this method.
-   * - If an `onError` handler is configured, errors will be caught and passed to the handler,
-   *   and this method will return undefined.
-   * - The error state can be checked using `getErrorCount()` and `getIsExecuting()`.
-   *
-   * @returns A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError
-   * @throws The error from the rate-limited function if no onError handler is configured
-   *
-   * @example
-   * ```ts
-   * const rateLimiter = new AsyncRateLimiter(fn, { limit: 5, window: 1000 });
-   *
-   * // First 5 calls will return a promise that resolves with the result
-   * const result = await rateLimiter.maybeExecute('arg1', 'arg2');
-   *
-   * // Additional calls within the window will return undefined
-   * const result2 = await rateLimiter.maybeExecute('arg1', 'arg2'); // undefined
-   * ```
-   */
-  maybeExecute: (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;
-  /**
-   * Returns the number of remaining executions allowed in the current window
-   */
-  getRemainingInWindow: () => number;
-  /**
-   * Returns the number of milliseconds until the next execution will be possible
-   * For fixed windows, this is the time until the current window resets
-   * For sliding windows, this is the time until the oldest execution expires
-   */
-  getMsUntilNextWindow: () => number;
-  /**
-   * Returns the AbortSignal for a specific execution.
-   * If no maybeExecuteCount is provided, returns the signal for the most recent execution.
-   * Returns null if no execution is found or not currently executing.
-   *
-   * @param maybeExecuteCount - Optional specific execution to get signal for
-   * @example
-   * ```typescript
-   * const rateLimiter = new AsyncRateLimiter(
-   *   async (userId: string) => {
-   *     const signal = rateLimiter.getAbortSignal()
-   *     if (signal) {
-   *       const response = await fetch(`/api/users/${userId}`, { signal })
-   *       return response.json()
-   *     }
-   *   },
-   *   { limit: 5, window: 1000 }
-   * )
-   * ```
-   */
-  getAbortSignal: (maybeExecuteCount?: number) => AbortSignal | null;
-  /**
-   * Aborts all ongoing executions with the internal abort controllers.
-   * Does NOT clear out the execution times or reset the rate limiter.
-   */
-  abort: () => void;
-  /**
-   * Resets the rate limiter state
-   */
-  reset: () => void;
-}
-/**
- * Creates an async rate-limited function that will execute the provided function up to a maximum number of times within a time window.
- *
- * Async vs Sync Versions:
- * The async version provides advanced features over the sync rate limit function:
- * - Returns promises that can be awaited for rate-limited function results
- * - Built-in retry support via AsyncRetryer integration
- * - Abort support to cancel in-flight executions
- * - Comprehensive error handling with onError callbacks and throwOnError control
- * - Detailed execution tracking (success/error/settle counts, rejection counts)
- * - More sophisticated window management with automatic cleanup
- *
- * The sync rate limit function is lighter weight and simpler when you don't need async features,
- * return values, or execution control.
- *
- * What is Rate Limiting?
- * Rate limiting allows a function to execute up to a limit within a time window,
- * then blocks all subsequent calls until the window passes. This can lead to "bursty" behavior where
- * all executions happen immediately, followed by a complete block.
- *
- * Window Types:
- * - 'fixed': A strict window that resets after the window period. All executions within the window count
- *   towards the limit, and the window resets completely after the period.
- * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
- *   consistent rate of execution over time.
- *
- * Configuration Options:
- * - `limit`: Maximum number of executions allowed within the window (required)
- * - `window`: Time window in milliseconds (required)
- * - `windowType`: 'fixed' or 'sliding' (default: 'fixed')
- * - `enabled`: Whether the rate limiter is enabled (default: true)
- * - `asyncRetryerOptions`: Configure retry behavior for executions
- *
- * When to Use Rate Limiting:
- * Rate limiting is best used for hard API limits or resource constraints. For UI updates or
- * smoothing out frequent events, throttling or debouncing usually provide better user experience.
- * - A rate limiter will allow all executions until the limit is reached, then block all subsequent calls until the window resets
- * - A throttler ensures even spacing between executions, which can be better for consistent performance
- * - A debouncer collapses multiple calls into one, which is better for handling bursts of events
- *
- * Error Handling:
- * - If an `onError` handler is provided, it will be called with the error and rate limiter instance
- * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
- * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
- * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
- * - The error state can be checked using the underlying AsyncRateLimiter instance
- * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler
- *
- * State Management:
- * - Uses TanStack Store for reactive state management
- * - Use `initialState` to provide initial state values when creating the rate limiter
- * - `initialState` can be a partial state object
- * - Use `onSuccess` callback to react to successful function execution and implement custom logic
- * - Use `onError` callback to react to function execution errors and implement custom error handling
- * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic
- * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded
- * - The state includes execution times, success/error counts, and current execution status
- * - State can be accessed via the underlying AsyncRateLimiter instance's `store.state` property
- * - When using framework adapters (React/Solid), state is accessed from the hook's state property
- *
- * @example
- * ```ts
- * // Rate limit to 5 calls per minute with a sliding window
- * const rateLimited = asyncRateLimit(makeApiCall, {
- *   limit: 5,
- *   window: 60000,
- *   windowType: 'sliding',
- *   onError: (error) => {
- *     console.error('API call failed:', error);
- *   },
- *   onReject: (rateLimiter) => {
- *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
- *   }
- * });
- *
- * // First 5 calls will execute immediately
- * // Additional calls will be rejected until the minute window resets
- * // Returns the API response directly
- * const result = await rateLimited();
- *
- * // For more even execution, consider using throttle instead:
- * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
- * ```
- */
-declare function asyncRateLimit<TFn extends AnyAsyncFunction>(fn: TFn, initialOptions: AsyncRateLimiterOptions<TFn>): (...args: Parameters<TFn>) => Promise<ReturnType<TFn> | undefined>;
-//#endregion
-export { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState, asyncRateLimit, asyncRateLimiterOptions };
-//# sourceMappingURL=async-rate-limiter.d.cts.map

package/dist/async-rate-limiter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"async-rate-limiter.js","names":["#getLimit","#getEnabled","#setState","#cleanupOldExecutions","#getExecutionTimesInWindow","#execute","#setCleanupTimeout","#getWindow","#timeoutIds","#clearTimeout","#clearTimeouts"],"sources":["../src/async-rate-limiter.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { AsyncRetryer } from './async-retryer'\nimport { parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\nimport type { AsyncRetryerOptions } from './async-retryer'\nimport type { AnyAsyncFunction } from './types'\n\nexport interface AsyncRateLimiterState<TFn extends AnyAsyncFunction> {\n  /**\n   * Number of function executions that have resulted in errors\n   */\n  errorCount: number\n  /**\n   * Array of timestamps when executions occurred for rate limiting calculations\n   */\n  executionTimes: Array<number>\n  /**\n   * Whether the rate limiter has exceeded the limit\n   */\n  isExceeded: boolean\n  /**\n   * Whether the rate-limited function is currently executing asynchronously\n   */\n  isExecuting: boolean\n  /**\n   * The result from the most recent successful function execution\n   */\n  lastResult: ReturnType<TFn> | undefined\n  /**\n   * Number of function executions that have been rejected due to rate limiting\n   */\n  rejectionCount: number\n  /**\n   * Number of function executions that have completed (either successfully or with errors)\n   */\n  settleCount: number\n  /**\n   * Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded\n   */\n  status: 'disabled' | 'executing' | 'exceeded' | 'idle'\n  /**\n   * Number of function executions that have completed successfully\n   */\n  successCount: number\n  /**\n   * Number of times maybeExecute has been called (for reduction calculations)\n   */\n  maybeExecuteCount: number\n}\n\nfunction getDefaultAsyncRateLimiterState<\n  TFn extends AnyAsyncFunction,\n>(): AsyncRateLimiterState<TFn> {\n  return {\n    errorCount: 0,\n    executionTimes: [],\n    isExceeded: false,\n    isExecuting: false,\n    lastResult: undefined,\n    maybeExecuteCount: 0,\n    rejectionCount: 0,\n    settleCount: 0,\n    status: 'idle',\n    successCount: 0,\n  }\n}\n\n/**\n * Options for configuring an async rate-limited function\n */\nexport interface AsyncRateLimiterOptions<TFn extends AnyAsyncFunction> {\n  /**\n   * Options for configuring the underlying async retryer\n   */\n  asyncRetryerOptions?: AsyncRetryerOptions<TFn>\n  /**\n   * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Can be a boolean or a function that returns a boolean.\n   * Defaults to true.\n   */\n  enabled?: boolean | ((rateLimiter: AsyncRateLimiter<TFn>) => boolean)\n  /**\n   * Initial state for the rate limiter\n   */\n  initialState?: Partial<AsyncRateLimiterState<TFn>>\n  /**\n   * Optional key to identify this async rate limiter instance.\n   * If provided, the async rate limiter will be identified by this key in the devtools and PacerProvider if applicable.\n   */\n  key?: string\n  /**\n   * Maximum number of executions allowed within the time window.\n   * Can be a number or a function that returns a number.\n   */\n  limit: number | ((rateLimiter: AsyncRateLimiter<TFn>) => number)\n  /**\n   * Optional error handler for when the rate-limited function throws.\n   * If provided, the handler will be called with the error and rate limiter instance.\n   * This can be used alongside throwOnError - the handler will be called before any error is thrown.\n   */\n  onError?: (\n    error: Error,\n    args: Parameters<TFn>,\n    rateLimiter: AsyncRateLimiter<TFn>,\n  ) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (args: Parameters<TFn>, rateLimiter: AsyncRateLimiter<TFn>) => void\n  /**\n   * Optional function to call when the rate-limited function is executed\n   */\n  onSettled?: (\n    args: Parameters<TFn>,\n    rateLimiter: AsyncRateLimiter<TFn>,\n  ) => void\n  /**\n   * Optional function to call when the rate-limited function is executed\n   */\n  onSuccess?: (\n    result: ReturnType<TFn>,\n    args: Parameters<TFn>,\n    rateLimiter: AsyncRateLimiter<TFn>,\n  ) => void\n  /**\n   * Whether to throw errors when they occur.\n   * Defaults to true if no onError handler is provided, false if an onError handler is provided.\n   * Can be explicitly set to override these defaults.\n   */\n  throwOnError?: boolean\n  /**\n   * Time window in milliseconds within which the limit applies.\n   * Can be a number or a function that returns a number.\n   */\n  window: number | ((rateLimiter: AsyncRateLimiter<TFn>) => number)\n  /**\n   * Type of window to use for rate limiting\n   * - 'fixed': Uses a fixed window that resets after the window period\n   * - 'sliding': Uses a sliding window that allows executions as old ones expire\n   * Defaults to 'fixed'\n   */\n  windowType?: 'fixed' | 'sliding'\n}\n\n/**\n * Utility function for sharing common `AsyncRateLimiterOptions` options between different `AsyncRateLimiter` instances.\n */\nexport function asyncRateLimiterOptions<\n  TFn extends AnyAsyncFunction = AnyAsyncFunction,\n  TOptions extends Partial<AsyncRateLimiterOptions<TFn>> = Partial<\n    AsyncRateLimiterOptions<TFn>\n  >,\n>(options: TOptions): TOptions {\n  return options\n}\n\nconst defaultOptions: Omit<\n  Required<AsyncRateLimiterOptions<any>>,\n  'initialState' | 'onError' | 'onReject' | 'onSettled' | 'onSuccess' | 'key'\n> = {\n  asyncRetryerOptions: {\n    maxAttempts: 1,\n  },\n  enabled: true,\n  limit: 1,\n  window: 0,\n  windowType: 'fixed',\n  throwOnError: true,\n}\n\n/**\n * A class that creates an async rate-limited function.\n *\n * Async vs Sync Versions:\n * The async version provides advanced features over the sync RateLimiter:\n * - Returns promises that can be awaited for rate-limited function results\n * - Built-in retry support via AsyncRetryer integration\n * - Abort support to cancel in-flight executions\n * - Comprehensive error handling with onError callbacks and throwOnError control\n * - Detailed execution tracking (success/error/settle counts, rejection counts)\n * - More sophisticated window management with automatic cleanup\n *\n * The sync RateLimiter is lighter weight and simpler when you don't need async features,\n * return values, or execution control.\n *\n * What is Rate Limiting?\n * Rate limiting allows a function to execute up to a limit within a time window,\n * then blocks all subsequent calls until the window passes. This can lead to \"bursty\" behavior where\n * all executions happen immediately, followed by a complete block.\n *\n * Window Types:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * When to Use Rate Limiting:\n * Rate limiting is best used for hard API limits or resource constraints. For UI updates or\n * smoothing out frequent events, throttling or debouncing usually provide better user experience.\n * - Throttling: Ensures consistent spacing between executions (e.g. max once per 200ms)\n * - Debouncing: Waits for a pause in calls before executing (e.g. after 500ms of no calls)\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - `initialState` can be a partial state object\n * - Use `onSuccess` callback to react to successful function execution and implement custom logic\n * - Use `onError` callback to react to function execution errors and implement custom error handling\n * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution times, success/error counts, and current execution status\n * - State can be accessed via `asyncRateLimiter.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `asyncRateLimiter.state`\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\n *\n * @example\n * ```ts\n * const rateLimiter = new AsyncRateLimiter(\n *   async (id: string) => await api.getData(id),\n *   {\n *     limit: 5,\n *     window: 1000,\n *     windowType: 'sliding',\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     },\n *     onReject: (limiter) => {\n *       console.log(`Rate limit exceeded. Try again in ${limiter.getMsUntilNextWindow()}ms`);\n *     }\n *   }\n * );\n *\n * // Will execute immediately until limit reached, then block\n * // Returns the API response directly\n * const data = await rateLimiter.maybeExecute('123');\n * ```\n */\nexport class AsyncRateLimiter<TFn extends AnyAsyncFunction> {\n  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>> = new Store<\n    AsyncRateLimiterState<TFn>\n  >(getDefaultAsyncRateLimiterState<TFn>())\n  key: string | undefined\n  options: AsyncRateLimiterOptions<TFn>\n  asyncRetryers = new Map<number, AsyncRetryer<TFn>>()\n  #timeoutIds: Set<ReturnType<typeof setTimeout>> = new Set()\n\n  constructor(\n    public fn: TFn,\n    initialOptions: AsyncRateLimiterOptions<TFn>,\n  ) {\n    this.key = initialOptions.key\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n      throwOnError: initialOptions.throwOnError ?? !initialOptions.onError,\n    }\n    this.#setState(this.options.initialState ?? {})\n    for (const executionTime of this.#getExecutionTimesInWindow()) {\n      this.#setCleanupTimeout(executionTime)\n    }\n\n    if (this.key) {\n      pacerEventClient.on('d-AsyncRateLimiter', (event) => {\n        if (event.payload.key !== this.key) return\n        this.#setState(\n          event.payload.store.state as Partial<AsyncRateLimiterState<TFn>>,\n        )\n        this.setOptions(\n          event.payload.options as Partial<AsyncRateLimiterOptions<TFn>>,\n        )\n      })\n    }\n  }\n\n  /**\n   * Updates the async rate limiter options\n   */\n  setOptions = (newOptions: Partial<AsyncRateLimiterOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n  }\n\n  #setState = (newState: Partial<AsyncRateLimiterState<TFn>>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      const isExceeded = combinedState.executionTimes.length >= this.#getLimit()\n      const status = !this.#getEnabled()\n        ? 'disabled'\n        : combinedState.isExecuting\n          ? 'executing'\n          : isExceeded\n            ? 'exceeded'\n            : 'idle'\n      return {\n        ...combinedState,\n        isExceeded,\n        status,\n      }\n    })\n    emitChange('AsyncRateLimiter', this)\n  }\n\n  /**\n   * Returns the current enabled state of the async rate limiter\n   */\n  #getEnabled = (): boolean => {\n    return !!parseFunctionOrValue(this.options.enabled, this)\n  }\n\n  /**\n   * Returns the current limit of executions allowed within the time window\n   */\n  #getLimit = (): number => {\n    return parseFunctionOrValue(this.options.limit, this)\n  }\n\n  /**\n   * Returns the current time window in milliseconds\n   */\n  #getWindow = (): number => {\n    return parseFunctionOrValue(this.options.window, this)\n  }\n\n  /**\n   * Attempts to execute the rate-limited function if within the configured limits.\n   * Will reject execution if the number of calls in the current window exceeds the limit.\n   *\n   * Error Handling:\n   * - If the rate-limited function throws and no `onError` handler is configured,\n   *   the error will be thrown from this method.\n   * - If an `onError` handler is configured, errors will be caught and passed to the handler,\n   *   and this method will return undefined.\n   * - The error state can be checked using `getErrorCount()` and `getIsExecuting()`.\n   *\n   * @returns A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError\n   * @throws The error from the rate-limited function if no onError handler is configured\n   *\n   * @example\n   * ```ts\n   * const rateLimiter = new AsyncRateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will return a promise that resolves with the result\n   * const result = await rateLimiter.maybeExecute('arg1', 'arg2');\n   *\n   * // Additional calls within the window will return undefined\n   * const result2 = await rateLimiter.maybeExecute('arg1', 'arg2'); // undefined\n   * ```\n   */\n  maybeExecute = async (\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> => {\n    this.#setState({\n      maybeExecuteCount: this.store.state.maybeExecuteCount + 1,\n    })\n\n    this.#cleanupOldExecutions()\n\n    const relevantExecutionTimes = this.#getExecutionTimesInWindow()\n\n    if (relevantExecutionTimes.length < this.#getLimit()) {\n      await this.#execute(...args)\n      return this.store.state.lastResult\n    }\n\n    this.#setState({\n      rejectionCount: this.store.state.rejectionCount + 1,\n    })\n    this.options.onReject?.(args, this)\n    return undefined\n  }\n\n  #execute = async (\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> => {\n    if (!this.#getEnabled()) return\n\n    const currentMaybeExecute = this.store.state.maybeExecuteCount\n    const now = Date.now()\n    const executionTimes = [...this.store.state.executionTimes, now]\n    this.#setState({\n      isExecuting: true,\n      executionTimes,\n    })\n\n    try {\n      // Create a new AsyncRetryer for this execution to avoid cancelling concurrent executions\n      const currentAsyncRetryer = new AsyncRetryer(this.fn, {\n        ...this.options.asyncRetryerOptions,\n        key: `${this.key}-retryer-${currentMaybeExecute}`,\n      })\n      this.asyncRetryers.set(currentMaybeExecute, currentAsyncRetryer)\n      const result = await currentAsyncRetryer.execute(...args) // EXECUTE!\n      this.#setCleanupTimeout(now)\n      this.#setState({\n        successCount: this.store.state.successCount + 1,\n        lastResult: result,\n      })\n      this.options.onSuccess?.(result as ReturnType<TFn>, args, this)\n    } catch (error) {\n      this.#setState({\n        errorCount: this.store.state.errorCount + 1,\n      })\n      this.options.onError?.(error as Error, args, this)\n      if (this.options.throwOnError) {\n        throw error\n      }\n    } finally {\n      this.asyncRetryers.delete(currentMaybeExecute) // dispose retryer\n      this.#setState({\n        isExecuting: false,\n        settleCount: this.store.state.settleCount + 1,\n      })\n      this.options.onSettled?.(args, this)\n    }\n\n    return this.store.state.lastResult\n  }\n\n  #getExecutionTimesInWindow = (): Array<number> => {\n    if (this.options.windowType === 'sliding') {\n      // For sliding window, return all executions within the current window\n      return this.store.state.executionTimes.filter(\n        (time) => time > Date.now() - this.#getWindow(),\n      )\n    } else {\n      // For fixed window, return all executions in the current window\n      // The window starts from the oldest execution time\n      if (this.store.state.executionTimes.length === 0) {\n        return []\n      }\n      const oldestExecution = Math.min(...this.store.state.executionTimes)\n      const windowStart = oldestExecution\n      const windowEnd = windowStart + this.#getWindow()\n      const now = Date.now()\n\n      // If the window has expired, return empty array\n      if (now > windowEnd) {\n        return []\n      }\n\n      // Otherwise, return all executions in the current window\n      return this.store.state.executionTimes.filter(\n        (time) => time >= windowStart && time <= windowEnd,\n      )\n    }\n  }\n\n  #setCleanupTimeout = (executionTime: number): void => {\n    if (\n      this.options.windowType === 'sliding' ||\n      this.#timeoutIds.size === 0 // new fixed window\n    ) {\n      const now = Date.now()\n      const timeUntilExpiration = executionTime - now + this.#getWindow() + 1\n      const timeoutId = setTimeout(() => {\n        this.#cleanupOldExecutions()\n        this.#clearTimeout(timeoutId)\n      }, timeUntilExpiration)\n      this.#timeoutIds.add(timeoutId)\n    }\n  }\n\n  #clearTimeout = (timeoutId: ReturnType<typeof setTimeout>): void => {\n    clearTimeout(timeoutId)\n    this.#timeoutIds.delete(timeoutId)\n  }\n\n  #clearTimeouts = (): void => {\n    this.#timeoutIds.forEach((timeoutId) => clearTimeout(timeoutId))\n    this.#timeoutIds.clear()\n  }\n\n  #cleanupOldExecutions = (): void => {\n    this.#setState({\n      executionTimes: this.#getExecutionTimesInWindow(),\n    })\n  }\n\n  /**\n   * Returns the number of remaining executions allowed in the current window\n   */\n  getRemainingInWindow = (): number => {\n    const relevantExecutionTimes = this.#getExecutionTimesInWindow()\n    return Math.max(0, this.#getLimit() - relevantExecutionTimes.length)\n  }\n\n  /**\n   * Returns the number of milliseconds until the next execution will be possible\n   * For fixed windows, this is the time until the current window resets\n   * For sliding windows, this is the time until the oldest execution expires\n   */\n  getMsUntilNextWindow = (): number => {\n    if (this.getRemainingInWindow() > 0) {\n      return 0\n    }\n    const oldestExecution = this.store.state.executionTimes[0] ?? Infinity\n    return oldestExecution + this.#getWindow() - Date.now()\n  }\n\n  /**\n   * Returns the AbortSignal for a specific execution.\n   * If no maybeExecuteCount is provided, returns the signal for the most recent execution.\n   * Returns null if no execution is found or not currently executing.\n   *\n   * @param maybeExecuteCount - Optional specific execution to get signal for\n   * @example\n   * ```typescript\n   * const rateLimiter = new AsyncRateLimiter(\n   *   async (userId: string) => {\n   *     const signal = rateLimiter.getAbortSignal()\n   *     if (signal) {\n   *       const response = await fetch(`/api/users/${userId}`, { signal })\n   *       return response.json()\n   *     }\n   *   },\n   *   { limit: 5, window: 1000 }\n   * )\n   * ```\n   */\n  getAbortSignal = (maybeExecuteCount?: number): AbortSignal | null => {\n    const count = maybeExecuteCount ?? this.store.state.maybeExecuteCount\n    const retryer = this.asyncRetryers.get(count)\n    return retryer?.getAbortSignal() ?? null\n  }\n\n  /**\n   * Aborts all ongoing executions with the internal abort controllers.\n   * Does NOT clear out the execution times or reset the rate limiter.\n   */\n  abort = (): void => {\n    this.asyncRetryers.forEach((retryer) => retryer.abort())\n    this.asyncRetryers.clear()\n    this.#setState({\n      isExecuting: false,\n    })\n  }\n\n  /**\n   * Resets the rate limiter state\n   */\n  reset = (): void => {\n    this.#setState(getDefaultAsyncRateLimiterState())\n    this.#clearTimeouts()\n    this.asyncRetryers.forEach((retryer) => retryer.reset())\n  }\n}\n\n/**\n * Creates an async rate-limited function that will execute the provided function up to a maximum number of times within a time window.\n *\n * Async vs Sync Versions:\n * The async version provides advanced features over the sync rate limit function:\n * - Returns promises that can be awaited for rate-limited function results\n * - Built-in retry support via AsyncRetryer integration\n * - Abort support to cancel in-flight executions\n * - Comprehensive error handling with onError callbacks and throwOnError control\n * - Detailed execution tracking (success/error/settle counts, rejection counts)\n * - More sophisticated window management with automatic cleanup\n *\n * The sync rate limit function is lighter weight and simpler when you don't need async features,\n * return values, or execution control.\n *\n * What is Rate Limiting?\n * Rate limiting allows a function to execute up to a limit within a time window,\n * then blocks all subsequent calls until the window passes. This can lead to \"bursty\" behavior where\n * all executions happen immediately, followed by a complete block.\n *\n * Window Types:\n * - 'fixed': A strict window that resets after the window period. All executions within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more\n *   consistent rate of execution over time.\n *\n * Configuration Options:\n * - `limit`: Maximum number of executions allowed within the window (required)\n * - `window`: Time window in milliseconds (required)\n * - `windowType`: 'fixed' or 'sliding' (default: 'fixed')\n * - `enabled`: Whether the rate limiter is enabled (default: true)\n * - `asyncRetryerOptions`: Configure retry behavior for executions\n *\n * When to Use Rate Limiting:\n * Rate limiting is best used for hard API limits or resource constraints. For UI updates or\n * smoothing out frequent events, throttling or debouncing usually provide better user experience.\n * - A rate limiter will allow all executions until the limit is reached, then block all subsequent calls until the window resets\n * - A throttler ensures even spacing between executions, which can be better for consistent performance\n * - A debouncer collapses multiple calls into one, which is better for handling bursts of events\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and rate limiter instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncRateLimiter instance\n * - Rate limit rejections (when limit is exceeded) are handled separately from execution errors via the `onReject` handler\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - `initialState` can be a partial state object\n * - Use `onSuccess` callback to react to successful function execution and implement custom logic\n * - Use `onError` callback to react to function execution errors and implement custom error handling\n * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution times, success/error counts, and current execution status\n * - State can be accessed via the underlying AsyncRateLimiter instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\n *\n * @example\n * ```ts\n * // Rate limit to 5 calls per minute with a sliding window\n * const rateLimited = asyncRateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\n *   onError: (error) => {\n *     console.error('API call failed:', error);\n *   },\n *   onReject: (rateLimiter) => {\n *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // First 5 calls will execute immediately\n * // Additional calls will be rejected until the minute window resets\n * // Returns the API response directly\n * const result = await rateLimited();\n *\n * // For more even execution, consider using throttle instead:\n * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds\n * ```\n */\nexport function asyncRateLimit<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncRateLimiterOptions<TFn>,\n) {\n  const rateLimiter = new AsyncRateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute\n}\n"],"mappings":";;;;;;AAkDA,SAAS,kCAEuB;CAC9B,OAAO;EACL,YAAY;EACZ,gBAAgB,EAAE;EAClB,YAAY;EACZ,aAAa;EACb,YAAY;EACZ,mBAAmB;EACnB,gBAAgB;EAChB,aAAa;EACb,QAAQ;EACR,cAAc;EACf;;;;;AAmFH,SAAgB,wBAKd,SAA6B;CAC7B,OAAO;;AAGT,MAAM,iBAGF;CACF,qBAAqB,EACnB,aAAa,GACd;CACD,SAAS;CACT,OAAO;CACP,QAAQ;CACR,YAAY;CACZ,cAAc;CACf;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4ED,IAAa,mBAAb,MAA4D;CAO1D;CAEA,YACE,AAAO,IACP,gBACA;EAFO;eATqD,IAAI,MAEhE,iCAAsC,CAAC;uCAGzB,IAAI,KAAgC;qCACF,IAAI,KAAK;qBAiC7C,eAA4D;GACxE,KAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;IAAY;;oBAGtC,aAAwD;GACnE,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,gBAAgB;KACpB,GAAG;KACH,GAAG;KACJ;IACD,MAAM,aAAa,cAAc,eAAe,UAAU,KAAKA,WAAW;IAC1E,MAAM,SAAS,CAAC,KAAKC,aAAa,GAC9B,aACA,cAAc,cACZ,cACA,aACE,aACA;IACR,OAAO;KACL,GAAG;KACH;KACA;KACD;KACD;GACF,WAAW,oBAAoB,KAAK;;2BAMT;GAC3B,OAAO,CAAC,CAAC,qBAAqB,KAAK,QAAQ,SAAS,KAAK;;yBAMjC;GACxB,OAAO,qBAAqB,KAAK,QAAQ,OAAO,KAAK;;0BAM5B;GACzB,OAAO,qBAAqB,KAAK,QAAQ,QAAQ,KAAK;;sBA4BzC,OACb,GAAG,SACsC;GACzC,KAAKC,UAAU,EACb,mBAAmB,KAAK,MAAM,MAAM,oBAAoB,GACzD,CAAC;GAEF,KAAKC,uBAAuB;GAI5B,IAF+B,KAAKC,4BAEV,CAAC,SAAS,KAAKJ,WAAW,EAAE;IACpD,MAAM,KAAKK,SAAS,GAAG,KAAK;IAC5B,OAAO,KAAK,MAAM,MAAM;;GAG1B,KAAKH,UAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,GACnD,CAAC;GACF,KAAK,QAAQ,WAAW,MAAM,KAAK;;kBAI1B,OACT,GAAG,SACsC;GACzC,IAAI,CAAC,KAAKD,aAAa,EAAE;GAEzB,MAAM,sBAAsB,KAAK,MAAM,MAAM;GAC7C,MAAM,MAAM,KAAK,KAAK;GACtB,MAAM,iBAAiB,CAAC,GAAG,KAAK,MAAM,MAAM,gBAAgB,IAAI;GAChE,KAAKC,UAAU;IACb,aAAa;IACb;IACD,CAAC;GAEF,IAAI;IAEF,MAAM,sBAAsB,IAAI,aAAa,KAAK,IAAI;KACpD,GAAG,KAAK,QAAQ;KAChB,KAAK,GAAG,KAAK,IAAI,WAAW;KAC7B,CAAC;IACF,KAAK,cAAc,IAAI,qBAAqB,oBAAoB;IAChE,MAAM,SAAS,MAAM,oBAAoB,QAAQ,GAAG,KAAK;IACzD,KAAKI,mBAAmB,IAAI;IAC5B,KAAKJ,UAAU;KACb,cAAc,KAAK,MAAM,MAAM,eAAe;KAC9C,YAAY;KACb,CAAC;IACF,KAAK,QAAQ,YAAY,QAA2B,MAAM,KAAK;YACxD,OAAO;IACd,KAAKA,UAAU,EACb,YAAY,KAAK,MAAM,MAAM,aAAa,GAC3C,CAAC;IACF,KAAK,QAAQ,UAAU,OAAgB,MAAM,KAAK;IAClD,IAAI,KAAK,QAAQ,cACf,MAAM;aAEA;IACR,KAAK,cAAc,OAAO,oBAAoB;IAC9C,KAAKA,UAAU;KACb,aAAa;KACb,aAAa,KAAK,MAAM,MAAM,cAAc;KAC7C,CAAC;IACF,KAAK,QAAQ,YAAY,MAAM,KAAK;;GAGtC,OAAO,KAAK,MAAM,MAAM;;0CAGwB;GAChD,IAAI,KAAK,QAAQ,eAAe,WAE9B,OAAO,KAAK,MAAM,MAAM,eAAe,QACpC,SAAS,OAAO,KAAK,KAAK,GAAG,KAAKK,YAAY,CAChD;QACI;IAGL,IAAI,KAAK,MAAM,MAAM,eAAe,WAAW,GAC7C,OAAO,EAAE;IAGX,MAAM,cADkB,KAAK,IAAI,GAAG,KAAK,MAAM,MAAM,eAClB;IACnC,MAAM,YAAY,cAAc,KAAKA,YAAY;IAIjD,IAHY,KAAK,KAGV,GAAG,WACR,OAAO,EAAE;IAIX,OAAO,KAAK,MAAM,MAAM,eAAe,QACpC,SAAS,QAAQ,eAAe,QAAQ,UAC1C;;;6BAIiB,kBAAgC;GACpD,IACE,KAAK,QAAQ,eAAe,aAC5B,KAAKC,YAAY,SAAS,GAC1B;IAEA,MAAM,sBAAsB,gBADhB,KAAK,KAC8B,GAAG,KAAKD,YAAY,GAAG;IACtE,MAAM,YAAY,iBAAiB;KACjC,KAAKJ,uBAAuB;KAC5B,KAAKM,cAAc,UAAU;OAC5B,oBAAoB;IACvB,KAAKD,YAAY,IAAI,UAAU;;;wBAIlB,cAAmD;GAClE,aAAa,UAAU;GACvB,KAAKA,YAAY,OAAO,UAAU;;8BAGP;GAC3B,KAAKA,YAAY,SAAS,cAAc,aAAa,UAAU,CAAC;GAChE,KAAKA,YAAY,OAAO;;qCAGU;GAClC,KAAKN,UAAU,EACb,gBAAgB,KAAKE,4BAA4B,EAClD,CAAC;;oCAMiC;GACnC,MAAM,yBAAyB,KAAKA,4BAA4B;GAChE,OAAO,KAAK,IAAI,GAAG,KAAKJ,WAAW,GAAG,uBAAuB,OAAO;;oCAQjC;GACnC,IAAI,KAAK,sBAAsB,GAAG,GAChC,OAAO;GAGT,QADwB,KAAK,MAAM,MAAM,eAAe,MAAM,YACrC,KAAKO,YAAY,GAAG,KAAK,KAAK;;yBAuBvC,sBAAmD;GACnE,MAAM,QAAQ,qBAAqB,KAAK,MAAM,MAAM;GAEpD,OADgB,KAAK,cAAc,IAAI,MACzB,EAAE,gBAAgB,IAAI;;qBAOlB;GAClB,KAAK,cAAc,SAAS,YAAY,QAAQ,OAAO,CAAC;GACxD,KAAK,cAAc,OAAO;GAC1B,KAAKL,UAAU,EACb,aAAa,OACd,CAAC;;qBAMgB;GAClB,KAAKA,UAAU,iCAAiC,CAAC;GACjD,KAAKQ,gBAAgB;GACrB,KAAK,cAAc,SAAS,YAAY,QAAQ,OAAO,CAAC;;EAvSxD,KAAK,MAAM,eAAe;EAC1B,KAAK,UAAU;GACb,GAAG;GACH,GAAG;GACH,cAAc,eAAe,gBAAgB,CAAC,eAAe;GAC9D;EACD,KAAKR,UAAU,KAAK,QAAQ,gBAAgB,EAAE,CAAC;EAC/C,KAAK,MAAM,iBAAiB,KAAKE,4BAA4B,EAC3D,KAAKE,mBAAmB,cAAc;EAGxC,IAAI,KAAK,KACP,iBAAiB,GAAG,uBAAuB,UAAU;GACnD,IAAI,MAAM,QAAQ,QAAQ,KAAK,KAAK;GACpC,KAAKJ,UACH,MAAM,QAAQ,MAAM,MACrB;GACD,KAAK,WACH,MAAM,QAAQ,QACf;IACD;;CAWN;;;;CA0BA;;;;CAOA;;;;CAOA;CAoDA;CA+CA;CA6BA;CAeA;CAKA;CAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+JF,SAAgB,eACd,IACA,gBACA;CAEA,OAAO,IADiB,iBAAiB,IAAI,eAC3B,CAAC"}