@tanstack/pacer 0.21.1 → 0.23.0

package/dist/rate-limiter.cjs

@@ -1,263 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_utils = require('./utils.cjs');
-const require_event_client = require('./event-client.cjs');
-let _tanstack_store = require("@tanstack/store");
-
-//#region src/rate-limiter.ts
-function getDefaultRateLimiterState() {
-	return {
-		executionCount: 0,
-		executionTimes: [],
-		isExceeded: false,
-		rejectionCount: 0,
-		status: "idle",
-		maybeExecuteCount: 0
-	};
-}
-/**
-* Utility function for sharing common `RateLimiterOptions` options between different `RateLimiter` instances.
-*/
-function rateLimiterOptions(options) {
-	return options;
-}
-const defaultOptions = {
-	enabled: true,
-	limit: 1,
-	window: 0,
-	windowType: "fixed"
-};
-/**
-* A class that creates a rate-limited function.
-*
-* Rate limiting is a simple approach that 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.
-* This synchronous version is lighter weight and often all you need - upgrade to AsyncRateLimiter when you need promises, retry support, abort capabilities, or advanced error handling.
-*
-* The rate limiter supports two types of windows:
-* - '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.
-*
-* For smoother execution patterns, consider using:
-* - 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)
-*
-* 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.
-*
-* State Management:
-* - Uses TanStack Store for reactive state management
-* - Use `initialState` to provide initial state values when creating the rate limiter
-* - Use `onExecute` callback to react to function execution and implement custom logic
-* - Use `onReject` callback to react to executions being rejected when rate limit is exceeded
-* - The state includes execution count, execution times, and rejection count
-* - State can be accessed via `rateLimiter.store.state` when using the class directly
-* - When using framework adapters (React/Solid), state is accessed from `rateLimiter.state`
-*
-* @example
-* ```ts
-* const rateLimiter = new RateLimiter(
-*   (id: string) => api.getData(id),
-*   {
-*     limit: 5,
-*     window: 1000,
-*     windowType: 'sliding',
-*   }
-* );
-*
-* // Will execute immediately until limit reached, then block
-* rateLimiter.maybeExecute('123');
-* ```
-*/
-var RateLimiter = class {
-	#timeoutIds;
-	constructor(fn, initialOptions) {
-		this.fn = fn;
-		this.store = new _tanstack_store.Store(getDefaultRateLimiterState());
-		this.#timeoutIds = /* @__PURE__ */ new Set();
-		this.setOptions = (newOptions) => {
-			this.options = {
-				...this.options,
-				...newOptions
-			};
-		};
-		this.#setState = (newState) => {
-			this.store.setState((state) => {
-				const combinedState = {
-					...state,
-					...newState
-				};
-				const isExceeded = combinedState.executionTimes.length >= this.#getLimit();
-				const status = !this.#getEnabled() ? "disabled" : isExceeded ? "exceeded" : "idle";
-				return {
-					...combinedState,
-					isExceeded,
-					status
-				};
-			});
-			require_event_client.emitChange("RateLimiter", this);
-		};
-		this.#getEnabled = () => {
-			return !!require_utils.parseFunctionOrValue(this.options.enabled, this);
-		};
-		this.#getLimit = () => {
-			return require_utils.parseFunctionOrValue(this.options.limit, this);
-		};
-		this.#getWindow = () => {
-			return require_utils.parseFunctionOrValue(this.options.window, this);
-		};
-		this.maybeExecute = (...args) => {
-			this.#setState({ maybeExecuteCount: this.store.state.maybeExecuteCount + 1 });
-			this.#cleanupOldExecutions();
-			if (this.#getExecutionTimesInWindow().length < this.#getLimit()) {
-				this.#execute(...args);
-				return true;
-			}
-			this.#setState({ rejectionCount: this.store.state.rejectionCount + 1 });
-			this.options.onReject?.(this);
-			return false;
-		};
-		this.#execute = (...args) => {
-			if (!this.#getEnabled()) return;
-			const now = Date.now();
-			this.fn(...args);
-			this.store.state.executionTimes.push(now);
-			this.#setCleanupTimeout(now);
-			this.#setState({ executionCount: this.store.state.executionCount + 1 });
-			this.options.onExecute?.(args, this);
-		};
-		this.#getExecutionTimesInWindow = () => {
-			if (this.options.windowType === "sliding") return this.store.state.executionTimes.filter((time) => time > Date.now() - this.#getWindow());
-			else {
-				if (this.store.state.executionTimes.length === 0) return [];
-				const windowStart = Math.min(...this.store.state.executionTimes);
-				const windowEnd = windowStart + this.#getWindow();
-				if (Date.now() > windowEnd) return [];
-				return this.store.state.executionTimes.filter((time) => time >= windowStart && time <= windowEnd);
-			}
-		};
-		this.#setCleanupTimeout = (executionTime) => {
-			if (this.options.windowType === "sliding" || this.#timeoutIds.size === 0) {
-				const timeUntilExpiration = executionTime - Date.now() + this.#getWindow() + 1;
-				const timeoutId = setTimeout(() => {
-					this.#cleanupOldExecutions();
-					this.#clearTimeout(timeoutId);
-				}, timeUntilExpiration);
-				this.#timeoutIds.add(timeoutId);
-			}
-		};
-		this.#clearTimeout = (timeoutId) => {
-			clearTimeout(timeoutId);
-			this.#timeoutIds.delete(timeoutId);
-		};
-		this.#clearTimeouts = () => {
-			this.#timeoutIds.forEach((timeoutId) => clearTimeout(timeoutId));
-			this.#timeoutIds.clear();
-		};
-		this.#cleanupOldExecutions = () => {
-			this.#setState({ executionTimes: this.#getExecutionTimesInWindow() });
-		};
-		this.getRemainingInWindow = () => {
-			const relevantExecutionTimes = this.#getExecutionTimesInWindow();
-			return Math.max(0, this.#getLimit() - relevantExecutionTimes.length);
-		};
-		this.getMsUntilNextWindow = () => {
-			if (this.getRemainingInWindow() > 0) return 0;
-			return (this.store.state.executionTimes[0] ?? Infinity) + this.#getWindow() - Date.now();
-		};
-		this.reset = () => {
-			this.#setState(getDefaultRateLimiterState());
-			this.#clearTimeouts();
-		};
-		this.key = initialOptions.key;
-		this.options = {
-			...defaultOptions,
-			...initialOptions
-		};
-		this.#setState(this.options.initialState ?? {});
-		for (const executionTime of this.#getExecutionTimesInWindow()) this.#setCleanupTimeout(executionTime);
-		if (this.key) require_event_client.pacerEventClient.on("d-RateLimiter", (event) => {
-			if (event.payload.key !== this.key) return;
-			this.#setState(event.payload.store.state);
-			this.setOptions(event.payload.options);
-		});
-	}
-	#setState;
-	/**
-	* Returns the current enabled state of the rate limiter
-	*/
-	#getEnabled;
-	/**
-	* Returns the current limit of executions allowed within the time window
-	*/
-	#getLimit;
-	/**
-	* Returns the current time window in milliseconds
-	*/
-	#getWindow;
-	#execute;
-	#getExecutionTimesInWindow;
-	#setCleanupTimeout;
-	#clearTimeout;
-	#clearTimeouts;
-	#cleanupOldExecutions;
-};
-/**
-* Creates a rate-limited function that will execute the provided function up to a maximum number of times within a time window.
-*
-* This synchronous version is lighter weight and often all you need - upgrade to asyncRateLimit when you need promises, retry support, abort capabilities, or advanced error handling.
-*
-* Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:
-* - 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
-*
-* The rate limiter supports two types of windows:
-* - '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.
-*
-* State Management:
-* - Uses TanStack Store for reactive state management
-* - Use `initialState` to provide initial state values when creating the rate limiter
-* - Use `onExecute` callback to react to function execution and implement custom logic
-* - Use `onReject` callback to react to executions being rejected when rate limit is exceeded
-* - The state includes execution count, execution times, and rejection count
-* - State can be accessed via the underlying RateLimiter instance's `store.state` property
-* - When using framework adapters (React/Solid), state is accessed from the hook's state property
-*
-* Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically
-* need to enforce a hard limit on the number of executions within a time period.
-*
-* @example
-* ```ts
-* // Rate limit to 5 calls per minute with a sliding window
-* const rateLimited = rateLimit(makeApiCall, {
-*   limit: 5,
-*   window: 60000,
-*   windowType: 'sliding',
-*   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
-* rateLimited();
-*
-* // For more even execution, consider using throttle instead:
-* const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
-* ```
-*/
-function rateLimit(fn, initialOptions) {
-	return new RateLimiter(fn, initialOptions).maybeExecute;
-}
-
-//#endregion
-exports.RateLimiter = RateLimiter;
-exports.rateLimit = rateLimit;
-exports.rateLimiterOptions = rateLimiterOptions;
-//# sourceMappingURL=rate-limiter.cjs.map

package/dist/rate-limiter.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"rate-limiter.cjs","names":["Store","#getLimit","#getEnabled","parseFunctionOrValue","#setState","#cleanupOldExecutions","#getExecutionTimesInWindow","#execute","#setCleanupTimeout","#getWindow","#timeoutIds","#clearTimeout","#clearTimeouts"],"sources":["../src/rate-limiter.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\nimport type { AnyFunction } from './types'\n\nexport interface RateLimiterState {\n  /**\n   * Number of function executions that have been completed\n   */\n  executionCount: 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   * Number of times maybeExecute has been called (for reduction calculations)\n   */\n  maybeExecuteCount: number\n  /**\n   * Number of function executions that have been rejected due to rate limiting\n   */\n  rejectionCount: 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' | 'exceeded' | 'idle'\n}\n\nfunction getDefaultRateLimiterState(): RateLimiterState {\n  return {\n    executionCount: 0,\n    executionTimes: [],\n    isExceeded: false,\n    rejectionCount: 0,\n    status: 'idle',\n    maybeExecuteCount: 0,\n  }\n}\n\n/**\n * Options for configuring a rate-limited function\n */\nexport interface RateLimiterOptions<TFn extends AnyFunction> {\n  /**\n   * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean | ((rateLimiter: RateLimiter<TFn>) => boolean)\n  /**\n   * Initial state for the rate limiter\n   */\n  initialState?: Partial<RateLimiterState>\n  /**\n   * Optional key to identify this rate limiter instance.\n   * If provided, the 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 callback function that receives the rate limiter instance and returns a number.\n   */\n  limit: number | ((rateLimiter: RateLimiter<TFn>) => number)\n  /**\n   * Callback function that is called after the function is executed\n   */\n  onExecute?: (args: Parameters<TFn>, rateLimiter: RateLimiter<TFn>) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (rateLimiter: RateLimiter<TFn>) => void\n  /**\n   * Time window in milliseconds within which the limit applies.\n   * Can be a number or a callback function that receives the rate limiter instance and returns a number.\n   */\n  window: number | ((rateLimiter: RateLimiter<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 `RateLimiterOptions` options between different `RateLimiter` instances.\n */\nexport function rateLimiterOptions<\n  TFn extends AnyFunction = AnyFunction,\n  TOptions extends Partial<RateLimiterOptions<TFn>> = Partial<\n    RateLimiterOptions<TFn>\n  >,\n>(options: TOptions): TOptions {\n  return options\n}\n\nconst defaultOptions: Omit<\n  Required<RateLimiterOptions<any>>,\n  'initialState' | 'onExecute' | 'onReject' | 'key'\n> = {\n  enabled: true,\n  limit: 1,\n  window: 0,\n  windowType: 'fixed',\n}\n\n/**\n * A class that creates a rate-limited function.\n *\n * Rate limiting is a simple approach that 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 * This synchronous version is lighter weight and often all you need - upgrade to AsyncRateLimiter when you need promises, retry support, abort capabilities, or advanced error handling.\n *\n * The rate limiter supports two types of windows:\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 * For smoother execution patterns, consider using:\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 * 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 *\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 * - Use `onExecute` callback to react to function execution and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution count, execution times, and rejection count\n * - State can be accessed via `rateLimiter.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `rateLimiter.state`\n *\n * @example\n * ```ts\n * const rateLimiter = new RateLimiter(\n *   (id: string) => api.getData(id),\n *   {\n *     limit: 5,\n *     window: 1000,\n *     windowType: 'sliding',\n *   }\n * );\n *\n * // Will execute immediately until limit reached, then block\n * rateLimiter.maybeExecute('123');\n * ```\n */\nexport class RateLimiter<TFn extends AnyFunction> {\n  readonly store: Store<Readonly<RateLimiterState>> =\n    new Store<RateLimiterState>(getDefaultRateLimiterState())\n  key: string | undefined\n  options: RateLimiterOptions<TFn>\n  #timeoutIds: Set<ReturnType<typeof setTimeout>> = new Set()\n\n  constructor(\n    public fn: TFn,\n    initialOptions: RateLimiterOptions<TFn>,\n  ) {\n    this.key = initialOptions.key\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\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-RateLimiter', (event) => {\n        if (event.payload.key !== this.key) return\n        this.#setState(event.payload.store.state as Partial<RateLimiterState>)\n        this.setOptions(\n          event.payload.options as Partial<RateLimiterOptions<TFn>>,\n        )\n      })\n    }\n  }\n\n  /**\n   * Updates the rate limiter options\n   */\n  setOptions = (newOptions: Partial<RateLimiterOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n  }\n\n  #setState = (newState: Partial<RateLimiterState>): 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        : isExceeded\n          ? 'exceeded'\n          : 'idle'\n      return {\n        ...combinedState,\n        isExceeded,\n        status,\n      }\n    })\n    emitChange('RateLimiter', this)\n  }\n\n  /**\n   * Returns the current enabled state of the 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   * @example\n   * ```ts\n   * const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will return true\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // true\n   *\n   * // Additional calls within the window will return false\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // false\n   * ```\n   */\n  maybeExecute = (...args: Parameters<TFn>): boolean => {\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      this.#execute(...args)\n      return true\n    }\n\n    this.#setState({\n      rejectionCount: this.store.state.rejectionCount + 1,\n    })\n    this.options.onReject?.(this)\n    return false\n  }\n\n  #execute = (...args: Parameters<TFn>): void => {\n    if (!this.#getEnabled()) return\n    const now = Date.now()\n    this.fn(...args) // EXECUTE!\n    this.store.state.executionTimes.push(now) // mutate state directly for performance\n\n    this.#setCleanupTimeout(now)\n\n    this.#setState({\n      executionCount: this.store.state.executionCount + 1,\n    })\n    this.options.onExecute?.(args, this)\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   */\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   * Resets the rate limiter state\n   */\n  reset = (): void => {\n    this.#setState(getDefaultRateLimiterState())\n    this.#clearTimeouts()\n  }\n}\n\n/**\n * Creates a rate-limited function that will execute the provided function up to a maximum number of times within a time window.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to asyncRateLimit when you need promises, retry support, abort capabilities, or advanced error handling.\n *\n * Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:\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 * The rate limiter supports two types of windows:\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution count, execution times, and rejection count\n * - State can be accessed via the underlying RateLimiter instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\n *\n * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically\n * need to enforce a hard limit on the number of executions within a time period.\n *\n * @example\n * ```ts\n * // Rate limit to 5 calls per minute with a sliding window\n * const rateLimited = rateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\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 * 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 rateLimit<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n) {\n  const rateLimiter = new RateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute\n}\n"],"mappings":";;;;;;AAgCA,SAAS,6BAA+C;CACtD,OAAO;EACL,gBAAgB;EAChB,gBAAgB,EAAE;EAClB,YAAY;EACZ,gBAAgB;EAChB,QAAQ;EACR,mBAAmB;EACpB;;;;;AAmDH,SAAgB,mBAKd,SAA6B;CAC7B,OAAO;;AAGT,MAAM,iBAGF;CACF,SAAS;CACT,OAAO;CACP,QAAQ;CACR,YAAY;CACb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CD,IAAa,cAAb,MAAkD;CAKhD;CAEA,YACE,AAAO,IACP,gBACA;EAFO;eANP,IAAIA,sBAAwB,4BAA4B,CAAC;qCAGT,IAAI,KAAK;qBA8B7C,eAAuD;GACnE,KAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;IAAY;;oBAGtC,aAA8C;GACzD,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,gBAAgB;KACpB,GAAG;KACH,GAAG;KACJ;IACD,MAAM,aAAa,cAAc,eAAe,UAAU,KAAKC,WAAW;IAC1E,MAAM,SAAS,CAAC,KAAKC,aAAa,GAC9B,aACA,aACE,aACA;IACN,OAAO;KACL,GAAG;KACH;KACA;KACD;KACD;GACF,gCAAW,eAAe,KAAK;;2BAMJ;GAC3B,OAAO,CAAC,CAACC,mCAAqB,KAAK,QAAQ,SAAS,KAAK;;yBAMjC;GACxB,OAAOA,mCAAqB,KAAK,QAAQ,OAAO,KAAK;;0BAM5B;GACzB,OAAOA,mCAAqB,KAAK,QAAQ,QAAQ,KAAK;;uBAkBxC,GAAG,SAAmC;GACpD,KAAKC,UAAU,EACb,mBAAmB,KAAK,MAAM,MAAM,oBAAoB,GACzD,CAAC;GAEF,KAAKC,uBAAuB;GAI5B,IAF+B,KAAKC,4BAEV,CAAC,SAAS,KAAKL,WAAW,EAAE;IACpD,KAAKM,SAAS,GAAG,KAAK;IACtB,OAAO;;GAGT,KAAKH,UAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,GACnD,CAAC;GACF,KAAK,QAAQ,WAAW,KAAK;GAC7B,OAAO;;mBAGG,GAAG,SAAgC;GAC7C,IAAI,CAAC,KAAKF,aAAa,EAAE;GACzB,MAAM,MAAM,KAAK,KAAK;GACtB,KAAK,GAAG,GAAG,KAAK;GAChB,KAAK,MAAM,MAAM,eAAe,KAAK,IAAI;GAEzC,KAAKM,mBAAmB,IAAI;GAE5B,KAAKJ,UAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,GACnD,CAAC;GACF,KAAK,QAAQ,YAAY,MAAM,KAAK;;0CAGY;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,KAAKL,WAAW,GAAG,uBAAuB,OAAO;;oCAMjC;GACnC,IAAI,KAAK,sBAAsB,GAAG,GAChC,OAAO;GAGT,QADwB,KAAK,MAAM,MAAM,eAAe,MAAM,YACrC,KAAKQ,YAAY,GAAG,KAAK,KAAK;;qBAMrC;GAClB,KAAKL,UAAU,4BAA4B,CAAC;GAC5C,KAAKQ,gBAAgB;;EA5MrB,KAAK,MAAM,eAAe;EAC1B,KAAK,UAAU;GACb,GAAG;GACH,GAAG;GACJ;EACD,KAAKR,UAAU,KAAK,QAAQ,gBAAgB,EAAE,CAAC;EAC/C,KAAK,MAAM,iBAAiB,KAAKE,4BAA4B,EAC3D,KAAKE,mBAAmB,cAAc;EAGxC,IAAI,KAAK,KACP,sCAAiB,GAAG,kBAAkB,UAAU;GAC9C,IAAI,MAAM,QAAQ,QAAQ,KAAK,KAAK;GACpC,KAAKJ,UAAU,MAAM,QAAQ,MAAM,MAAmC;GACtE,KAAK,WACH,MAAM,QAAQ,QACf;IACD;;CAWN;;;;CAwBA;;;;CAOA;;;;CAOA;CAwCA;CAcA;CA6BA;CAeA;CAKA;CAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkFF,SAAgB,UACd,IACA,gBACA;CAEA,OAAO,IADiB,YAAY,IAAI,eACtB,CAAC"}

package/dist/rate-limiter.d.cts

@@ -1,215 +0,0 @@
-import { AnyFunction } from "./types.cjs";
-import { Store } from "@tanstack/store";
-
-//#region src/rate-limiter.d.ts
-interface RateLimiterState {
-  /**
-   * Number of function executions that have been completed
-   */
-  executionCount: number;
-  /**
-   * Array of timestamps when executions occurred for rate limiting calculations
-   */
-  executionTimes: Array<number>;
-  /**
-   * Whether the rate limiter has exceeded the limit
-   */
-  isExceeded: boolean;
-  /**
-   * Number of times maybeExecute has been called (for reduction calculations)
-   */
-  maybeExecuteCount: number;
-  /**
-   * Number of function executions that have been rejected due to rate limiting
-   */
-  rejectionCount: number;
-  /**
-   * Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded
-   */
-  status: 'disabled' | 'exceeded' | 'idle';
-}
-/**
- * Options for configuring a rate-limited function
- */
-interface RateLimiterOptions<TFn extends AnyFunction> {
-  /**
-   * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.
-   * Defaults to true.
-   */
-  enabled?: boolean | ((rateLimiter: RateLimiter<TFn>) => boolean);
-  /**
-   * Initial state for the rate limiter
-   */
-  initialState?: Partial<RateLimiterState>;
-  /**
-   * Optional key to identify this rate limiter instance.
-   * If provided, the 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 callback function that receives the rate limiter instance and returns a number.
-   */
-  limit: number | ((rateLimiter: RateLimiter<TFn>) => number);
-  /**
-   * Callback function that is called after the function is executed
-   */
-  onExecute?: (args: Parameters<TFn>, rateLimiter: RateLimiter<TFn>) => void;
-  /**
-   * Optional callback function that is called when an execution is rejected due to rate limiting
-   */
-  onReject?: (rateLimiter: RateLimiter<TFn>) => void;
-  /**
-   * Time window in milliseconds within which the limit applies.
-   * Can be a number or a callback function that receives the rate limiter instance and returns a number.
-   */
-  window: number | ((rateLimiter: RateLimiter<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 `RateLimiterOptions` options between different `RateLimiter` instances.
- */
-declare function rateLimiterOptions<TFn extends AnyFunction = AnyFunction, TOptions extends Partial<RateLimiterOptions<TFn>> = Partial<RateLimiterOptions<TFn>>>(options: TOptions): TOptions;
-/**
- * A class that creates a rate-limited function.
- *
- * Rate limiting is a simple approach that 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.
- * This synchronous version is lighter weight and often all you need - upgrade to AsyncRateLimiter when you need promises, retry support, abort capabilities, or advanced error handling.
- *
- * The rate limiter supports two types of windows:
- * - '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.
- *
- * For smoother execution patterns, consider using:
- * - 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)
- *
- * 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.
- *
- * State Management:
- * - Uses TanStack Store for reactive state management
- * - Use `initialState` to provide initial state values when creating the rate limiter
- * - Use `onExecute` callback to react to function execution and implement custom logic
- * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded
- * - The state includes execution count, execution times, and rejection count
- * - State can be accessed via `rateLimiter.store.state` when using the class directly
- * - When using framework adapters (React/Solid), state is accessed from `rateLimiter.state`
- *
- * @example
- * ```ts
- * const rateLimiter = new RateLimiter(
- *   (id: string) => api.getData(id),
- *   {
- *     limit: 5,
- *     window: 1000,
- *     windowType: 'sliding',
- *   }
- * );
- *
- * // Will execute immediately until limit reached, then block
- * rateLimiter.maybeExecute('123');
- * ```
- */
-declare class RateLimiter<TFn extends AnyFunction> {
-  #private;
-  fn: TFn;
-  readonly store: Store<Readonly<RateLimiterState>>;
-  key: string | undefined;
-  options: RateLimiterOptions<TFn>;
-  constructor(fn: TFn, initialOptions: RateLimiterOptions<TFn>);
-  /**
-   * Updates the rate limiter options
-   */
-  setOptions: (newOptions: Partial<RateLimiterOptions<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.
-   *
-   * @example
-   * ```ts
-   * const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });
-   *
-   * // First 5 calls will return true
-   * rateLimiter.maybeExecute('arg1', 'arg2'); // true
-   *
-   * // Additional calls within the window will return false
-   * rateLimiter.maybeExecute('arg1', 'arg2'); // false
-   * ```
-   */
-  maybeExecute: (...args: Parameters<TFn>) => boolean;
-  /**
-   * 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
-   */
-  getMsUntilNextWindow: () => number;
-  /**
-   * Resets the rate limiter state
-   */
-  reset: () => void;
-}
-/**
- * Creates a rate-limited function that will execute the provided function up to a maximum number of times within a time window.
- *
- * This synchronous version is lighter weight and often all you need - upgrade to asyncRateLimit when you need promises, retry support, abort capabilities, or advanced error handling.
- *
- * Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:
- * - 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
- *
- * The rate limiter supports two types of windows:
- * - '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.
- *
- * State Management:
- * - Uses TanStack Store for reactive state management
- * - Use `initialState` to provide initial state values when creating the rate limiter
- * - Use `onExecute` callback to react to function execution and implement custom logic
- * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded
- * - The state includes execution count, execution times, and rejection count
- * - State can be accessed via the underlying RateLimiter instance's `store.state` property
- * - When using framework adapters (React/Solid), state is accessed from the hook's state property
- *
- * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically
- * need to enforce a hard limit on the number of executions within a time period.
- *
- * @example
- * ```ts
- * // Rate limit to 5 calls per minute with a sliding window
- * const rateLimited = rateLimit(makeApiCall, {
- *   limit: 5,
- *   window: 60000,
- *   windowType: 'sliding',
- *   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
- * rateLimited();
- *
- * // For more even execution, consider using throttle instead:
- * const throttled = throttle(makeApiCall, { wait: 12000 }); // One call every 12 seconds
- * ```
- */
-declare function rateLimit<TFn extends AnyFunction>(fn: TFn, initialOptions: RateLimiterOptions<TFn>): (...args: Parameters<TFn>) => boolean;
-//#endregion
-export { RateLimiter, RateLimiterOptions, RateLimiterState, rateLimit, rateLimiterOptions };
-//# sourceMappingURL=rate-limiter.d.cts.map

package/dist/rate-limiter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"rate-limiter.js","names":["#getLimit","#getEnabled","#setState","#cleanupOldExecutions","#getExecutionTimesInWindow","#execute","#setCleanupTimeout","#getWindow","#timeoutIds","#clearTimeout","#clearTimeouts"],"sources":["../src/rate-limiter.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\nimport type { AnyFunction } from './types'\n\nexport interface RateLimiterState {\n  /**\n   * Number of function executions that have been completed\n   */\n  executionCount: 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   * Number of times maybeExecute has been called (for reduction calculations)\n   */\n  maybeExecuteCount: number\n  /**\n   * Number of function executions that have been rejected due to rate limiting\n   */\n  rejectionCount: 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' | 'exceeded' | 'idle'\n}\n\nfunction getDefaultRateLimiterState(): RateLimiterState {\n  return {\n    executionCount: 0,\n    executionTimes: [],\n    isExceeded: false,\n    rejectionCount: 0,\n    status: 'idle',\n    maybeExecuteCount: 0,\n  }\n}\n\n/**\n * Options for configuring a rate-limited function\n */\nexport interface RateLimiterOptions<TFn extends AnyFunction> {\n  /**\n   * Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Defaults to true.\n   */\n  enabled?: boolean | ((rateLimiter: RateLimiter<TFn>) => boolean)\n  /**\n   * Initial state for the rate limiter\n   */\n  initialState?: Partial<RateLimiterState>\n  /**\n   * Optional key to identify this rate limiter instance.\n   * If provided, the 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 callback function that receives the rate limiter instance and returns a number.\n   */\n  limit: number | ((rateLimiter: RateLimiter<TFn>) => number)\n  /**\n   * Callback function that is called after the function is executed\n   */\n  onExecute?: (args: Parameters<TFn>, rateLimiter: RateLimiter<TFn>) => void\n  /**\n   * Optional callback function that is called when an execution is rejected due to rate limiting\n   */\n  onReject?: (rateLimiter: RateLimiter<TFn>) => void\n  /**\n   * Time window in milliseconds within which the limit applies.\n   * Can be a number or a callback function that receives the rate limiter instance and returns a number.\n   */\n  window: number | ((rateLimiter: RateLimiter<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 `RateLimiterOptions` options between different `RateLimiter` instances.\n */\nexport function rateLimiterOptions<\n  TFn extends AnyFunction = AnyFunction,\n  TOptions extends Partial<RateLimiterOptions<TFn>> = Partial<\n    RateLimiterOptions<TFn>\n  >,\n>(options: TOptions): TOptions {\n  return options\n}\n\nconst defaultOptions: Omit<\n  Required<RateLimiterOptions<any>>,\n  'initialState' | 'onExecute' | 'onReject' | 'key'\n> = {\n  enabled: true,\n  limit: 1,\n  window: 0,\n  windowType: 'fixed',\n}\n\n/**\n * A class that creates a rate-limited function.\n *\n * Rate limiting is a simple approach that 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 * This synchronous version is lighter weight and often all you need - upgrade to AsyncRateLimiter when you need promises, retry support, abort capabilities, or advanced error handling.\n *\n * The rate limiter supports two types of windows:\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 * For smoother execution patterns, consider using:\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 * 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 *\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 * - Use `onExecute` callback to react to function execution and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution count, execution times, and rejection count\n * - State can be accessed via `rateLimiter.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `rateLimiter.state`\n *\n * @example\n * ```ts\n * const rateLimiter = new RateLimiter(\n *   (id: string) => api.getData(id),\n *   {\n *     limit: 5,\n *     window: 1000,\n *     windowType: 'sliding',\n *   }\n * );\n *\n * // Will execute immediately until limit reached, then block\n * rateLimiter.maybeExecute('123');\n * ```\n */\nexport class RateLimiter<TFn extends AnyFunction> {\n  readonly store: Store<Readonly<RateLimiterState>> =\n    new Store<RateLimiterState>(getDefaultRateLimiterState())\n  key: string | undefined\n  options: RateLimiterOptions<TFn>\n  #timeoutIds: Set<ReturnType<typeof setTimeout>> = new Set()\n\n  constructor(\n    public fn: TFn,\n    initialOptions: RateLimiterOptions<TFn>,\n  ) {\n    this.key = initialOptions.key\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\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-RateLimiter', (event) => {\n        if (event.payload.key !== this.key) return\n        this.#setState(event.payload.store.state as Partial<RateLimiterState>)\n        this.setOptions(\n          event.payload.options as Partial<RateLimiterOptions<TFn>>,\n        )\n      })\n    }\n  }\n\n  /**\n   * Updates the rate limiter options\n   */\n  setOptions = (newOptions: Partial<RateLimiterOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n  }\n\n  #setState = (newState: Partial<RateLimiterState>): 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        : isExceeded\n          ? 'exceeded'\n          : 'idle'\n      return {\n        ...combinedState,\n        isExceeded,\n        status,\n      }\n    })\n    emitChange('RateLimiter', this)\n  }\n\n  /**\n   * Returns the current enabled state of the 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   * @example\n   * ```ts\n   * const rateLimiter = new RateLimiter(fn, { limit: 5, window: 1000 });\n   *\n   * // First 5 calls will return true\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // true\n   *\n   * // Additional calls within the window will return false\n   * rateLimiter.maybeExecute('arg1', 'arg2'); // false\n   * ```\n   */\n  maybeExecute = (...args: Parameters<TFn>): boolean => {\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      this.#execute(...args)\n      return true\n    }\n\n    this.#setState({\n      rejectionCount: this.store.state.rejectionCount + 1,\n    })\n    this.options.onReject?.(this)\n    return false\n  }\n\n  #execute = (...args: Parameters<TFn>): void => {\n    if (!this.#getEnabled()) return\n    const now = Date.now()\n    this.fn(...args) // EXECUTE!\n    this.store.state.executionTimes.push(now) // mutate state directly for performance\n\n    this.#setCleanupTimeout(now)\n\n    this.#setState({\n      executionCount: this.store.state.executionCount + 1,\n    })\n    this.options.onExecute?.(args, this)\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   */\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   * Resets the rate limiter state\n   */\n  reset = (): void => {\n    this.#setState(getDefaultRateLimiterState())\n    this.#clearTimeouts()\n  }\n}\n\n/**\n * Creates a rate-limited function that will execute the provided function up to a maximum number of times within a time window.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to asyncRateLimit when you need promises, retry support, abort capabilities, or advanced error handling.\n *\n * Note that rate limiting is a simpler form of execution control compared to throttling or debouncing:\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 * The rate limiter supports two types of windows:\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 * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the rate limiter\n * - Use `onExecute` callback to react to function execution and implement custom logic\n * - Use `onReject` callback to react to executions being rejected when rate limit is exceeded\n * - The state includes execution count, execution times, and rejection count\n * - State can be accessed via the underlying RateLimiter instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\n *\n * Consider using throttle() or debounce() if you need more intelligent execution control. Use rate limiting when you specifically\n * need to enforce a hard limit on the number of executions within a time period.\n *\n * @example\n * ```ts\n * // Rate limit to 5 calls per minute with a sliding window\n * const rateLimited = rateLimit(makeApiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\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 * 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 rateLimit<TFn extends AnyFunction>(\n  fn: TFn,\n  initialOptions: RateLimiterOptions<TFn>,\n) {\n  const rateLimiter = new RateLimiter(fn, initialOptions)\n  return rateLimiter.maybeExecute\n}\n"],"mappings":";;;;;AAgCA,SAAS,6BAA+C;CACtD,OAAO;EACL,gBAAgB;EAChB,gBAAgB,EAAE;EAClB,YAAY;EACZ,gBAAgB;EAChB,QAAQ;EACR,mBAAmB;EACpB;;;;;AAmDH,SAAgB,mBAKd,SAA6B;CAC7B,OAAO;;AAGT,MAAM,iBAGF;CACF,SAAS;CACT,OAAO;CACP,QAAQ;CACR,YAAY;CACb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CD,IAAa,cAAb,MAAkD;CAKhD;CAEA,YACE,AAAO,IACP,gBACA;EAFO;eANP,IAAI,MAAwB,4BAA4B,CAAC;qCAGT,IAAI,KAAK;qBA8B7C,eAAuD;GACnE,KAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;IAAY;;oBAGtC,aAA8C;GACzD,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,aACE,aACA;IACN,OAAO;KACL,GAAG;KACH;KACA;KACD;KACD;GACF,WAAW,eAAe,KAAK;;2BAMJ;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;;uBAkBxC,GAAG,SAAmC;GACpD,KAAKC,UAAU,EACb,mBAAmB,KAAK,MAAM,MAAM,oBAAoB,GACzD,CAAC;GAEF,KAAKC,uBAAuB;GAI5B,IAF+B,KAAKC,4BAEV,CAAC,SAAS,KAAKJ,WAAW,EAAE;IACpD,KAAKK,SAAS,GAAG,KAAK;IACtB,OAAO;;GAGT,KAAKH,UAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,GACnD,CAAC;GACF,KAAK,QAAQ,WAAW,KAAK;GAC7B,OAAO;;mBAGG,GAAG,SAAgC;GAC7C,IAAI,CAAC,KAAKD,aAAa,EAAE;GACzB,MAAM,MAAM,KAAK,KAAK;GACtB,KAAK,GAAG,GAAG,KAAK;GAChB,KAAK,MAAM,MAAM,eAAe,KAAK,IAAI;GAEzC,KAAKK,mBAAmB,IAAI;GAE5B,KAAKJ,UAAU,EACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB,GACnD,CAAC;GACF,KAAK,QAAQ,YAAY,MAAM,KAAK;;0CAGY;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;;oCAMjC;GACnC,IAAI,KAAK,sBAAsB,GAAG,GAChC,OAAO;GAGT,QADwB,KAAK,MAAM,MAAM,eAAe,MAAM,YACrC,KAAKO,YAAY,GAAG,KAAK,KAAK;;qBAMrC;GAClB,KAAKL,UAAU,4BAA4B,CAAC;GAC5C,KAAKQ,gBAAgB;;EA5MrB,KAAK,MAAM,eAAe;EAC1B,KAAK,UAAU;GACb,GAAG;GACH,GAAG;GACJ;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,kBAAkB,UAAU;GAC9C,IAAI,MAAM,QAAQ,QAAQ,KAAK,KAAK;GACpC,KAAKJ,UAAU,MAAM,QAAQ,MAAM,MAAmC;GACtE,KAAK,WACH,MAAM,QAAQ,QACf;IACD;;CAWN;;;;CAwBA;;;;CAOA;;;;CAOA;CAwCA;CAcA;CA6BA;CAeA;CAKA;CAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkFF,SAAgB,UACd,IACA,gBACA;CAEA,OAAO,IADiB,YAAY,IAAI,eACtB,CAAC"}