@tanstack/preact-pacer 0.23.0 → 0.24.0

package/dist/async-rate-limiter/index.cjs

@@ -1,13 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_useAsyncRateLimiter = require('./useAsyncRateLimiter.cjs');
-const require_useAsyncRateLimitedCallback = require('./useAsyncRateLimitedCallback.cjs');
-
-exports.useAsyncRateLimitedCallback = require_useAsyncRateLimitedCallback.useAsyncRateLimitedCallback;
-exports.useAsyncRateLimiter = require_useAsyncRateLimiter.useAsyncRateLimiter;
-var _tanstack_pacer_async_rate_limiter = require("@tanstack/pacer/async-rate-limiter");
-Object.keys(_tanstack_pacer_async_rate_limiter).forEach(function (k) {
-  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
-    enumerable: true,
-    get: function () { return _tanstack_pacer_async_rate_limiter[k]; }
-  });
-});

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

@@ -1,4 +0,0 @@
-import { PreactAsyncRateLimiter, PreactAsyncRateLimiterOptions, useAsyncRateLimiter } from "./useAsyncRateLimiter.cjs";
-import { useAsyncRateLimitedCallback } from "./useAsyncRateLimitedCallback.cjs";
-export * from "@tanstack/pacer/async-rate-limiter";
-export { PreactAsyncRateLimiter, PreactAsyncRateLimiterOptions, useAsyncRateLimitedCallback, useAsyncRateLimiter };

package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs

@@ -1,65 +0,0 @@
-const require_useAsyncRateLimiter = require('./useAsyncRateLimiter.cjs');
-let preact_hooks = require("preact/hooks");
-
-//#region src/async-rate-limiter/useAsyncRateLimitedCallback.ts
-/**
-* A Preact hook that creates a rate-limited version of an async callback function.
-* This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,
-* providing a stable, async rate-limited function reference for use in Preact components.
-*
-* Async rate limiting is a "hard limit" approach for async functions: it allows all calls
-* until the limit is reached, then blocks (rejects) subsequent calls until the window resets.
-* Unlike throttling or debouncing, it does not attempt to space out or collapse calls.
-* This can lead to bursts of rapid executions followed by periods where all calls are blocked.
-*
-* The async 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:
-* - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)
-* - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)
-*
-* Async rate limiting should primarily be used when you need to enforce strict limits
-* on async operations, like API rate limits or other scenarios requiring hard caps
-* on execution frequency.
-*
-* This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic
-* async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.
-*
-* For advanced usage requiring features like:
-* - Manual cancellation
-* - Access to execution counts
-* - Custom useCallback dependencies
-*
-* Consider using the `useAsyncRateLimiter` hook instead.
-*
-*
-* @example
-* ```tsx
-* // Rate limit async API calls to maximum 5 calls per minute with a sliding window
-* const makeApiCall = useAsyncRateLimitedCallback(
-*   async (data: ApiData) => {
-*     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });
-*   },
-*   {
-*     limit: 5,
-*     window: 60000, // 1 minute
-*     windowType: 'sliding',
-*     onReject: () => {
-*       console.warn('API rate limit reached. Please wait before trying again.');
-*     }
-*   }
-* );
-* ```
-*/
-function useAsyncRateLimitedCallback(fn, options) {
-	const asyncRateLimitedFn = require_useAsyncRateLimiter.useAsyncRateLimiter(fn, options).maybeExecute;
-	return (0, preact_hooks.useCallback)((...args) => asyncRateLimitedFn(...args), [asyncRateLimitedFn]);
-}
-
-//#endregion
-exports.useAsyncRateLimitedCallback = useAsyncRateLimitedCallback;
-//# sourceMappingURL=useAsyncRateLimitedCallback.cjs.map

package/dist/async-rate-limiter/useAsyncRateLimitedCallback.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAsyncRateLimitedCallback.cjs","names":["useAsyncRateLimiter","useCallback"],"sources":["../../src/async-rate-limiter/useAsyncRateLimitedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncRateLimiter } from './useAsyncRateLimiter'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { PreactAsyncRateLimiterOptions } from './useAsyncRateLimiter'\n\n/**\n * A Preact hook that creates a rate-limited version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,\n * providing a stable, async rate-limited function reference for use in Preact components.\n *\n * Async rate limiting is a \"hard limit\" approach for async functions: it allows all calls\n * until the limit is reached, then blocks (rejects) subsequent calls until the window resets.\n * Unlike throttling or debouncing, it does not attempt to space out or collapse calls.\n * This can lead to bursts of rapid executions followed by periods where all calls are blocked.\n *\n * The async 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:\n * - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)\n * - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)\n *\n * Async rate limiting should primarily be used when you need to enforce strict limits\n * on async operations, like API rate limits or other scenarios requiring hard caps\n * on execution frequency.\n *\n * This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic\n * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncRateLimiter` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Rate limit async API calls to maximum 5 calls per minute with a sliding window\n * const makeApiCall = useAsyncRateLimitedCallback(\n *   async (data: ApiData) => {\n *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n *   },\n *   {\n *     limit: 5,\n *     window: 60000, // 1 minute\n *     windowType: 'sliding',\n *     onReject: () => {\n *       console.warn('API rate limit reached. Please wait before trying again.');\n *     }\n *   }\n * );\n * ```\n */\nexport function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: PreactAsyncRateLimiterOptions<TFn, {}>,\n): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined> {\n  const asyncRateLimitedFn = useAsyncRateLimiter(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) => asyncRateLimitedFn(...args),\n    [asyncRateLimitedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgB,4BACd,IACA,SAC6E;CAC7E,MAAM,qBAAqBA,gDAAoB,IAAI,OAAO,CAAC,CAAC;CAC5D,WAAOC,2BACJ,GAAG,SAA0B,mBAAmB,GAAG,IAAI,GACxD,CAAC,kBAAkB,CACrB;AACF"}

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

@@ -1,60 +0,0 @@
-import { PreactAsyncRateLimiterOptions } from "./useAsyncRateLimiter.cjs";
-import { AnyAsyncFunction } from "@tanstack/pacer/types";
-//#region src/async-rate-limiter/useAsyncRateLimitedCallback.d.ts
-/**
- * A Preact hook that creates a rate-limited version of an async callback function.
- * This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,
- * providing a stable, async rate-limited function reference for use in Preact components.
- *
- * Async rate limiting is a "hard limit" approach for async functions: it allows all calls
- * until the limit is reached, then blocks (rejects) subsequent calls until the window resets.
- * Unlike throttling or debouncing, it does not attempt to space out or collapse calls.
- * This can lead to bursts of rapid executions followed by periods where all calls are blocked.
- *
- * The async 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:
- * - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)
- * - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)
- *
- * Async rate limiting should primarily be used when you need to enforce strict limits
- * on async operations, like API rate limits or other scenarios requiring hard caps
- * on execution frequency.
- *
- * This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic
- * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.
- *
- * For advanced usage requiring features like:
- * - Manual cancellation
- * - Access to execution counts
- * - Custom useCallback dependencies
- *
- * Consider using the `useAsyncRateLimiter` hook instead.
- *
- *
- * @example
- * ```tsx
- * // Rate limit async API calls to maximum 5 calls per minute with a sliding window
- * const makeApiCall = useAsyncRateLimitedCallback(
- *   async (data: ApiData) => {
- *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });
- *   },
- *   {
- *     limit: 5,
- *     window: 60000, // 1 minute
- *     windowType: 'sliding',
- *     onReject: () => {
- *       console.warn('API rate limit reached. Please wait before trying again.');
- *     }
- *   }
- * );
- * ```
- */
-declare function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(fn: TFn, options: PreactAsyncRateLimiterOptions<TFn, {}>): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined>;
-//#endregion
-export { useAsyncRateLimitedCallback };
-//# sourceMappingURL=useAsyncRateLimitedCallback.d.cts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useAsyncRateLimitedCallback.js","names":[],"sources":["../../src/async-rate-limiter/useAsyncRateLimitedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useAsyncRateLimiter } from './useAsyncRateLimiter'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type { PreactAsyncRateLimiterOptions } from './useAsyncRateLimiter'\n\n/**\n * A Preact hook that creates a rate-limited version of an async callback function.\n * This hook is a convenient wrapper around the `useAsyncRateLimiter` hook,\n * providing a stable, async rate-limited function reference for use in Preact components.\n *\n * Async rate limiting is a \"hard limit\" approach for async functions: it allows all calls\n * until the limit is reached, then blocks (rejects) subsequent calls until the window resets.\n * Unlike throttling or debouncing, it does not attempt to space out or collapse calls.\n * This can lead to bursts of rapid executions followed by periods where all calls are blocked.\n *\n * The async 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:\n * - useAsyncThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)\n * - useAsyncDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)\n *\n * Async rate limiting should primarily be used when you need to enforce strict limits\n * on async operations, like API rate limits or other scenarios requiring hard caps\n * on execution frequency.\n *\n * This hook provides a simpler API compared to `useAsyncRateLimiter`, making it ideal for basic\n * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useAsyncRateLimiter` hook instead.\n *\n *\n * @example\n * ```tsx\n * // Rate limit async API calls to maximum 5 calls per minute with a sliding window\n * const makeApiCall = useAsyncRateLimitedCallback(\n *   async (data: ApiData) => {\n *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n *   },\n *   {\n *     limit: 5,\n *     window: 60000, // 1 minute\n *     windowType: 'sliding',\n *     onReject: () => {\n *       console.warn('API rate limit reached. Please wait before trying again.');\n *     }\n *   }\n * );\n * ```\n */\nexport function useAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  options: PreactAsyncRateLimiterOptions<TFn, {}>,\n): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined> {\n  const asyncRateLimitedFn = useAsyncRateLimiter(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) => asyncRateLimitedFn(...args),\n    [asyncRateLimitedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgB,4BACd,IACA,SAC6E;CAC7E,MAAM,qBAAqB,oBAAoB,IAAI,OAAO,CAAC,CAAC;CAC5D,OAAO,aACJ,GAAG,SAA0B,mBAAmB,GAAG,IAAI,GACxD,CAAC,kBAAkB,CACrB;AACF"}

package/dist/async-rate-limiter/useAsyncRateLimiter.cjs

@@ -1,209 +0,0 @@
-const require_PacerProvider = require('../provider/PacerProvider.cjs');
-let preact_hooks = require("preact/hooks");
-let _tanstack_preact_store = require("@tanstack/preact-store");
-let _tanstack_pacer_async_rate_limiter = require("@tanstack/pacer/async-rate-limiter");
-
-//#region src/async-rate-limiter/useAsyncRateLimiter.ts
-/**
-* A low-level Preact hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.
-*
-* This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that
-* you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
-*
-* Rate limiting allows an async function to execute up to a specified limit within a time window,
-* then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,
-* managing resource constraints, or controlling bursts of async operations.
-*
-* Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,
-* making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
-* instead of setting the result on a state variable from within the rate-limited function.
-*
-* 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.
-*
-* 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 and Selector
-*
-* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
-* in two ways:
-*
-* **1. Using `rateLimiter.Subscribe` HOC (Recommended for component tree subscriptions)**
-*
-* Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
-* needing to pass a selector to the hook. This is ideal when you want to subscribe to state
-* in child components.
-*
-* **2. Using the `selector` parameter (For hook-level subscriptions)**
-*
-* The `selector` parameter allows you to specify which state changes will trigger a re-render
-* at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
-* state changes occur.
-*
-* **By default, there will be no reactive state subscriptions** and you must opt-in to state
-* tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
-* re-renders and gives you full control over when your component updates.
-*
-* Available state properties:
-* - `errorCount`: Number of function executions that have resulted in errors
-* - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
-* - `isExecuting`: Whether the rate-limited function is currently executing asynchronously
-* - `lastResult`: The result from the most recent successful function execution
-* - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
-* - `settleCount`: Number of function executions that have completed (success or error)
-* - `successCount`: Number of function executions that have completed successfully
-*
-* ## Unmount behavior
-*
-* By default, the hook aborts any in-flight execution when the component unmounts.
-* Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
-* Use the `onUnmount` option to customize this.
-*
-* @example
-* ```tsx
-* // Default behavior - no reactive state subscriptions
-* const asyncRateLimiter = useAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data; // Return value is preserved
-*   },
-*   { limit: 5, window: 1000 } // 5 calls per second
-* );
-*
-* // Subscribe to state changes deep in component tree using Subscribe HOC
-* <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
-*   {({ rejectionCount }) => (
-*     <div>Rejections: {rejectionCount}</div>
-*   )}
-* </asyncRateLimiter.Subscribe>
-*
-* // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
-* const asyncRateLimiter = useAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data;
-*   },
-*   { limit: 5, window: 1000 },
-*   (state) => ({ isExecuting: state.isExecuting })
-* );
-*
-* // Opt-in to re-render when results are available (optimized for data display)
-* const asyncRateLimiter = useAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data;
-*   },
-*   { limit: 5, window: 1000 },
-*   (state) => ({
-*     lastResult: state.lastResult,
-*     successCount: state.successCount
-*   })
-* );
-*
-* // Opt-in to re-render when error/rejection state changes (optimized for error handling)
-* const asyncRateLimiter = useAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data;
-*   },
-*   {
-*     limit: 5,
-*     window: 1000,
-*     onError: (error) => console.error('API call failed:', error),
-*     onReject: (rateLimiter) => console.log('Rate limit exceeded')
-*   },
-*   (state) => ({
-*     errorCount: state.errorCount,
-*     rejectionCount: state.rejectionCount
-*   })
-* );
-*
-* // Opt-in to re-render when execution metrics change (optimized for stats display)
-* const asyncRateLimiter = useAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data;
-*   },
-*   { limit: 5, window: 1000 },
-*   (state) => ({
-*     successCount: state.successCount,
-*     errorCount: state.errorCount,
-*     settleCount: state.settleCount,
-*     rejectionCount: state.rejectionCount
-*   })
-* );
-*
-* // Opt-in to re-render when execution times change (optimized for window calculations)
-* const asyncRateLimiter = useAsyncRateLimiter(
-*   async (id: string) => {
-*     const data = await api.fetchData(id);
-*     return data;
-*   },
-*   { limit: 5, window: 1000 },
-*   (state) => ({ executionTimes: state.executionTimes })
-* );
-*
-* // With state management and return value
-* const [data, setData] = useState(null);
-* const { maybeExecute, state } = useAsyncRateLimiter(
-*   async (query) => {
-*     const result = await searchAPI(query);
-*     setData(result);
-*     return result; // Return value can be used by the caller
-*   },
-*   {
-*     limit: 10,
-*     window: 60000, // 10 calls per minute
-*     onReject: (rateLimiter) => {
-*       console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
-*     },
-*     onError: (error) => {
-*       console.error('API call failed:', error);
-*     }
-*   }
-* );
-*
-* // Access the selected state (will be empty object {} unless selector provided)
-* const { isExecuting, lastResult, rejectionCount } = state;
-* ```
-*/
-function useAsyncRateLimiter(fn, options, selector = () => ({})) {
-	const mergedOptions = {
-		...require_PacerProvider.useDefaultPacerOptions().asyncRateLimiter,
-		...options
-	};
-	const [asyncRateLimiter] = (0, preact_hooks.useState)(() => {
-		const rateLimiterInstance = new _tanstack_pacer_async_rate_limiter.AsyncRateLimiter(fn, mergedOptions);
-		rateLimiterInstance.Subscribe = function Subscribe(props) {
-			const selected = (0, _tanstack_preact_store.useSelector)(rateLimiterInstance.store, props.selector, { compare: _tanstack_preact_store.shallow });
-			return typeof props.children === "function" ? props.children(selected) : props.children;
-		};
-		return rateLimiterInstance;
-	});
-	asyncRateLimiter.fn = fn;
-	asyncRateLimiter.setOptions(mergedOptions);
-	(0, preact_hooks.useEffect)(() => {
-		return () => {
-			if (mergedOptions.onUnmount) mergedOptions.onUnmount(asyncRateLimiter);
-			else asyncRateLimiter.abort();
-		};
-	}, []);
-	const state = (0, _tanstack_preact_store.useSelector)(asyncRateLimiter.store, selector, { compare: _tanstack_preact_store.shallow });
-	return (0, preact_hooks.useMemo)(() => ({
-		...asyncRateLimiter,
-		state
-	}), [asyncRateLimiter, state]);
-}
-
-//#endregion
-exports.useAsyncRateLimiter = useAsyncRateLimiter;
-//# sourceMappingURL=useAsyncRateLimiter.cjs.map

package/dist/async-rate-limiter/useAsyncRateLimiter.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useAsyncRateLimiter.cjs","names":["useDefaultPacerOptions","useState","AsyncRateLimiter","useSelector","shallow","useMemo"],"sources":["../../src/async-rate-limiter/useAsyncRateLimiter.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { AsyncRateLimiter } from '@tanstack/pacer/async-rate-limiter'\nimport { shallow, useSelector } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyAsyncFunction } from '@tanstack/pacer/types'\nimport type {\n  AsyncRateLimiterOptions,\n  AsyncRateLimiterState,\n} from '@tanstack/pacer/async-rate-limiter'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactAsyncRateLimiterOptions<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends AsyncRateLimiterOptions<TFn> {\n  /**\n   * Optional callback invoked when the component unmounts. Receives the rate limiter instance.\n   * When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc.\n   */\n  onUnmount?: (rateLimiter: PreactAsyncRateLimiter<TFn, TSelected>) => void\n}\n\nexport interface PreactAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n> extends Omit<AsyncRateLimiter<TFn>, 'store'> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the rate limiter state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n   *   {({ rejectionCount }) => (\n   *     <div>Rejections: {rejectionCount}</div>\n   *   )}\n   * </rateLimiter.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.\n   * Although, you can make the state reactive by using the `useSelector` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).\n *\n * Rate limiting allows an async function to execute up to a specified limit within a time window,\n * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,\n * managing resource constraints, or controlling bursts of async operations.\n *\n * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,\n * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call\n * instead of setting the result on a state variable from within the rate-limited function.\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 * 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 and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `rateLimiter.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `errorCount`: Number of function executions that have resulted in errors\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `isExecuting`: Whether the rate-limited function is currently executing asynchronously\n * - `lastResult`: The result from the most recent successful function execution\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n * - `settleCount`: Number of function executions that have completed (success or error)\n * - `successCount`: Number of function executions that have completed successfully\n *\n * ## Unmount behavior\n *\n * By default, the hook aborts any in-flight execution when the component unmounts.\n * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.\n * Use the `onUnmount` option to customize this.\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data; // Return value is preserved\n *   },\n *   { limit: 5, window: 1000 } // 5 calls per second\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n *   {({ rejectionCount }) => (\n *     <div>Rejections: {rejectionCount}</div>\n *   )}\n * </asyncRateLimiter.Subscribe>\n *\n * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to re-render when results are available (optimized for data display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     lastResult: state.lastResult,\n *     successCount: state.successCount\n *   })\n * );\n *\n * // Opt-in to re-render when error/rejection state changes (optimized for error handling)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   {\n *     limit: 5,\n *     window: 1000,\n *     onError: (error) => console.error('API call failed:', error),\n *     onReject: (rateLimiter) => console.log('Rate limit exceeded')\n *   },\n *   (state) => ({\n *     errorCount: state.errorCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({\n *     successCount: state.successCount,\n *     errorCount: state.errorCount,\n *     settleCount: state.settleCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution times change (optimized for window calculations)\n * const asyncRateLimiter = useAsyncRateLimiter(\n *   async (id: string) => {\n *     const data = await api.fetchData(id);\n *     return data;\n *   },\n *   { limit: 5, window: 1000 },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // With state management and return value\n * const [data, setData] = useState(null);\n * const { maybeExecute, state } = useAsyncRateLimiter(\n *   async (query) => {\n *     const result = await searchAPI(query);\n *     setData(result);\n *     return result; // Return value can be used by the caller\n *   },\n *   {\n *     limit: 10,\n *     window: 60000, // 10 calls per minute\n *     onReject: (rateLimiter) => {\n *       console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *     },\n *     onError: (error) => {\n *       console.error('API call failed:', error);\n *     }\n *   }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { isExecuting, lastResult, rejectionCount } = state;\n * ```\n */\nexport function useAsyncRateLimiter<\n  TFn extends AnyAsyncFunction,\n  TSelected = {},\n>(\n  fn: TFn,\n  options: PreactAsyncRateLimiterOptions<TFn, TSelected>,\n  selector: (state: AsyncRateLimiterState<TFn>) => TSelected = () =>\n    ({}) as TSelected,\n): PreactAsyncRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncRateLimiter,\n    ...options,\n  } as PreactAsyncRateLimiterOptions<TFn, TSelected>\n\n  const [asyncRateLimiter] = useState(() => {\n    const rateLimiterInstance = new AsyncRateLimiter<TFn>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactAsyncRateLimiter<TFn, TSelected>\n\n    rateLimiterInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: AsyncRateLimiterState<TFn>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useSelector(rateLimiterInstance.store, props.selector, {\n        compare: shallow,\n      })\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return rateLimiterInstance\n  })\n\n  asyncRateLimiter.fn = fn\n  asyncRateLimiter.setOptions(mergedOptions)\n\n  /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */\n  useEffect(() => {\n    return () => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(asyncRateLimiter)\n      } else {\n        asyncRateLimiter.abort()\n      }\n    }\n  }, [])\n  /* eslint-enable react-hooks/exhaustive-deps */\n\n  const state = useSelector(asyncRateLimiter.store, selector, {\n    compare: shallow,\n  })\n\n  return useMemo(\n    () =>\n      ({\n        ...asyncRateLimiter,\n        state,\n      }) as PreactAsyncRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`\n    [asyncRateLimiter, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsOA,SAAgB,oBAId,IACA,SACA,kBACG,CAAC,IACoC;CACxC,MAAM,gBAAgB;EACpB,GAAGA,6CAAuB,CAAC,CAAC;EAC5B,GAAG;CACL;CAEA,MAAM,CAAC,wBAAoBC,6BAAe;EACxC,MAAM,sBAAsB,IAAIC,oDAC9B,IACA,aACF;EAEA,oBAAoB,YAAY,SAAS,UAAqB,OAG3D;GACD,MAAM,eAAWC,oCAAY,oBAAoB,OAAO,MAAM,UAAU,EACtE,SAASC,+BACX,CAAC;GAED,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,QAAQ,IACvB,MAAM;EACZ;EAEA,OAAO;CACT,CAAC;CAED,iBAAiB,KAAK;CACtB,iBAAiB,WAAW,aAAa;CAGzC,kCAAgB;EACd,aAAa;GACX,IAAI,cAAc,WAChB,cAAc,UAAU,gBAAgB;QAExC,iBAAiB,MAAM;EAE3B;CACF,GAAG,CAAC,CAAC;CAGL,MAAM,YAAQD,oCAAY,iBAAiB,OAAO,UAAU,EAC1D,SAASC,+BACX,CAAC;CAED,WAAOC,6BAEF;EACC,GAAG;EACH;CACF,IACF,CAAC,kBAAkB,KAAK,CAC1B;AACF"}

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

@@ -1,219 +0,0 @@
-import { Store } from "@tanstack/preact-store";
-import { ComponentChildren } from "preact";
-import { AnyAsyncFunction } from "@tanstack/pacer/types";
-import { AsyncRateLimiter, AsyncRateLimiterOptions, AsyncRateLimiterState } from "@tanstack/pacer/async-rate-limiter";
-//#region src/async-rate-limiter/useAsyncRateLimiter.d.ts
-interface PreactAsyncRateLimiterOptions<TFn extends AnyAsyncFunction, TSelected = {}> extends AsyncRateLimiterOptions<TFn> {
-  /**
-   * Optional callback invoked when the component unmounts. Receives the rate limiter instance.
-   * When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc.
-   */
-  onUnmount?: (rateLimiter: PreactAsyncRateLimiter<TFn, TSelected>) => void;
-}
-interface PreactAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}> extends Omit<AsyncRateLimiter<TFn>, 'store'> {
-  /**
-   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state.
-   *
-   * This is useful for opting into state re-renders for specific parts of the rate limiter state
-   * deep in your component tree without needing to pass a selector to the hook.
-   *
-   * @example
-   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
-   *   {({ rejectionCount }) => (
-   *     <div>Rejections: {rejectionCount}</div>
-   *   )}
-   * </rateLimiter.Subscribe>
-   */
-  Subscribe: <TSelected>(props: {
-    selector: (state: AsyncRateLimiterState<TFn>) => TSelected;
-    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
-  }) => ComponentChildren;
-  /**
-   * Reactive state that will be updated and re-rendered when the rate limiter state changes
-   *
-   * Use this instead of `rateLimiter.store.state`
-   */
-  readonly state: Readonly<TSelected>;
-  /**
-   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.store.state` if you want to read reactive state.
-   * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.
-   * Although, you can make the state reactive by using the `useSelector` in your own usage.
-   */
-  readonly store: Store<Readonly<AsyncRateLimiterState<TFn>>>;
-}
-/**
- * A low-level Preact hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.
- *
- * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that
- * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
- *
- * Rate limiting allows an async function to execute up to a specified limit within a time window,
- * then blocks subsequent calls until the window passes. This is useful for respecting API rate limits,
- * managing resource constraints, or controlling bursts of async operations.
- *
- * Unlike the non-async RateLimiter, this async version supports returning values from the rate-limited function,
- * making it ideal for API calls and other async operations where you want the result of the `maybeExecute` call
- * instead of setting the result on a state variable from within the rate-limited function.
- *
- * 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.
- *
- * 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 and Selector
- *
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
- * in two ways:
- *
- * **1. Using `rateLimiter.Subscribe` HOC (Recommended for component tree subscriptions)**
- *
- * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
- * in child components.
- *
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
- *
- * The `selector` parameter allows you to specify which state changes will trigger a re-render
- * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
- * state changes occur.
- *
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
- * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
- * re-renders and gives you full control over when your component updates.
- *
- * Available state properties:
- * - `errorCount`: Number of function executions that have resulted in errors
- * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
- * - `isExecuting`: Whether the rate-limited function is currently executing asynchronously
- * - `lastResult`: The result from the most recent successful function execution
- * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
- * - `settleCount`: Number of function executions that have completed (success or error)
- * - `successCount`: Number of function executions that have completed successfully
- *
- * ## Unmount behavior
- *
- * By default, the hook aborts any in-flight execution when the component unmounts.
- * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
- * Use the `onUnmount` option to customize this.
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const asyncRateLimiter = useAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data; // Return value is preserved
- *   },
- *   { limit: 5, window: 1000 } // 5 calls per second
- * );
- *
- * // Subscribe to state changes deep in component tree using Subscribe HOC
- * <asyncRateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
- *   {({ rejectionCount }) => (
- *     <div>Rejections: {rejectionCount}</div>
- *   )}
- * </asyncRateLimiter.Subscribe>
- *
- * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
- * const asyncRateLimiter = useAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({ isExecuting: state.isExecuting })
- * );
- *
- * // Opt-in to re-render when results are available (optimized for data display)
- * const asyncRateLimiter = useAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({
- *     lastResult: state.lastResult,
- *     successCount: state.successCount
- *   })
- * );
- *
- * // Opt-in to re-render when error/rejection state changes (optimized for error handling)
- * const asyncRateLimiter = useAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   {
- *     limit: 5,
- *     window: 1000,
- *     onError: (error) => console.error('API call failed:', error),
- *     onReject: (rateLimiter) => console.log('Rate limit exceeded')
- *   },
- *   (state) => ({
- *     errorCount: state.errorCount,
- *     rejectionCount: state.rejectionCount
- *   })
- * );
- *
- * // Opt-in to re-render when execution metrics change (optimized for stats display)
- * const asyncRateLimiter = useAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({
- *     successCount: state.successCount,
- *     errorCount: state.errorCount,
- *     settleCount: state.settleCount,
- *     rejectionCount: state.rejectionCount
- *   })
- * );
- *
- * // Opt-in to re-render when execution times change (optimized for window calculations)
- * const asyncRateLimiter = useAsyncRateLimiter(
- *   async (id: string) => {
- *     const data = await api.fetchData(id);
- *     return data;
- *   },
- *   { limit: 5, window: 1000 },
- *   (state) => ({ executionTimes: state.executionTimes })
- * );
- *
- * // With state management and return value
- * const [data, setData] = useState(null);
- * const { maybeExecute, state } = useAsyncRateLimiter(
- *   async (query) => {
- *     const result = await searchAPI(query);
- *     setData(result);
- *     return result; // Return value can be used by the caller
- *   },
- *   {
- *     limit: 10,
- *     window: 60000, // 10 calls per minute
- *     onReject: (rateLimiter) => {
- *       console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
- *     },
- *     onError: (error) => {
- *       console.error('API call failed:', error);
- *     }
- *   }
- * );
- *
- * // Access the selected state (will be empty object {} unless selector provided)
- * const { isExecuting, lastResult, rejectionCount } = state;
- * ```
- */
-declare function useAsyncRateLimiter<TFn extends AnyAsyncFunction, TSelected = {}>(fn: TFn, options: PreactAsyncRateLimiterOptions<TFn, TSelected>, selector?: (state: AsyncRateLimiterState<TFn>) => TSelected): PreactAsyncRateLimiter<TFn, TSelected>;
-//#endregion
-export { PreactAsyncRateLimiter, PreactAsyncRateLimiterOptions, useAsyncRateLimiter };
-//# sourceMappingURL=useAsyncRateLimiter.d.cts.map