@tanstack/preact-pacer 0.0.1 → 0.18.0

package/dist/rate-limiter/useRateLimitedValue.js

@@ -0,0 +1,102 @@
+import { useRateLimitedState } from "./useRateLimitedState.js";
+import { useEffect } from "preact/hooks";
+
+//#region src/rate-limiter/useRateLimitedValue.ts
+/**
+* A high-level Preact hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window.
+* This hook uses Preact's useState internally to manage the rate-limited state.
+*
+* Rate limiting is a simple "hard limit" approach - it allows all updates until the limit is reached, then blocks
+* subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
+* or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.
+*
+* The rate limiter supports two types of windows:
+* - 'fixed': A strict window that resets after the window period. All updates within the window count
+*   towards the limit, and the window resets completely after the period.
+* - 'sliding': A rolling window that allows updates as old ones expire. This provides a more
+*   consistent rate of updates over time.
+*
+* For smoother update patterns, consider:
+* - useThrottledValue: When you want consistent spacing between updates (e.g. UI changes)
+* - useDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)
+*
+* Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.
+*
+* The hook returns a tuple containing:
+* - The rate-limited value that updates according to the configured rate limit
+* - The rate limiter instance with control methods
+*
+* For more direct control over rate limiting behavior without Preact state management,
+* consider using the lower-level useRateLimiter hook instead.
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management via the underlying rate limiter instance.
+* The `selector` parameter allows you to specify which rate limiter state changes will trigger a re-render,
+* 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. This prevents unnecessary re-renders and gives you
+* full control over when your component updates. Only when you provide a selector will the
+* component re-render when the selected state values change.
+*
+* Available rate limiter state properties:
+* - `executionCount`: Number of function executions that have been completed
+* - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
+* - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const [rateLimitedValue, rateLimiter] = useRateLimitedValue(rawValue, {
+*   limit: 5,
+*   window: 60000,
+*   windowType: 'sliding'
+* });
+*
+* // Opt-in to re-render when execution count changes (optimized for tracking successful updates)
+* const [rateLimitedValue, rateLimiter] = useRateLimitedValue(
+*   rawValue,
+*   { limit: 5, window: 60000, windowType: 'sliding' },
+*   (state) => ({ executionCount: state.executionCount })
+* );
+*
+* // Opt-in to re-render when rejection count changes (optimized for tracking rate limit violations)
+* const [rateLimitedValue, rateLimiter] = useRateLimitedValue(
+*   rawValue,
+*   { limit: 5, window: 60000, windowType: 'sliding' },
+*   (state) => ({ rejectionCount: state.rejectionCount })
+* );
+*
+* // Opt-in to re-render when execution times change (optimized for window calculations)
+* const [rateLimitedValue, rateLimiter] = useRateLimitedValue(
+*   rawValue,
+*   { limit: 5, window: 60000, windowType: 'sliding' },
+*   (state) => ({ executionTimes: state.executionTimes })
+* );
+*
+* // With rejection callback and fixed window
+* const [rateLimitedValue, rateLimiter] = useRateLimitedValue(rawValue, {
+*   limit: 3,
+*   window: 5000,
+*   windowType: 'fixed',
+*   onReject: (rateLimiter) => {
+*     console.log(`Update rejected. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
+*   }
+* });
+*
+* // Access the selected rate limiter state (will be empty object {} unless selector provided)
+* const { executionCount, rejectionCount } = rateLimiter.state;
+* ```
+*/
+function useRateLimitedValue(value, options, selector) {
+	const [rateLimitedValue, setRateLimitedValue, rateLimiter] = useRateLimitedState(value, options, selector);
+	useEffect(() => {
+		setRateLimitedValue(value);
+	}, [value, setRateLimitedValue]);
+	return [rateLimitedValue, rateLimiter];
+}
+
+//#endregion
+export { useRateLimitedValue };
+//# sourceMappingURL=useRateLimitedValue.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useRateLimitedValue.js","names":[],"sources":["../../src/rate-limiter/useRateLimitedValue.ts"],"sourcesContent":["import { useEffect } from 'preact/hooks'\nimport { useRateLimitedState } from './useRateLimitedState'\nimport type { Dispatch, StateUpdater } from 'preact/hooks'\nimport type { PreactRateLimiter } from './useRateLimiter'\nimport type {\n  RateLimiterOptions,\n  RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\n\n/**\n * A high-level Preact hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window.\n * This hook uses Preact's useState internally to manage the rate-limited state.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All updates within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more\n *   consistent rate of updates over time.\n *\n * For smoother update patterns, consider:\n * - useThrottledValue: When you want consistent spacing between updates (e.g. UI changes)\n * - useDebouncedValue: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns a tuple containing:\n * - The rate-limited value that updates according to the configured rate limit\n * - The rate limiter instance with control methods\n *\n * For more direct control over rate limiting behavior without Preact state management,\n * consider using the lower-level useRateLimiter hook instead.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying rate limiter instance.\n * The `selector` parameter allows you to specify which rate limiter state changes will trigger a re-render,\n * optimizing performance by preventing unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available rate limiter state properties:\n * - `executionCount`: Number of function executions that have been completed\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [rateLimitedValue, rateLimiter] = useRateLimitedValue(rawValue, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Opt-in to re-render when execution count changes (optimized for tracking successful updates)\n * const [rateLimitedValue, rateLimiter] = useRateLimitedValue(\n *   rawValue,\n *   { limit: 5, window: 60000, windowType: 'sliding' },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to re-render when rejection count changes (optimized for tracking rate limit violations)\n * const [rateLimitedValue, rateLimiter] = useRateLimitedValue(\n *   rawValue,\n *   { limit: 5, window: 60000, windowType: 'sliding' },\n *   (state) => ({ rejectionCount: state.rejectionCount })\n * );\n *\n * // Opt-in to re-render when execution times change (optimized for window calculations)\n * const [rateLimitedValue, rateLimiter] = useRateLimitedValue(\n *   rawValue,\n *   { limit: 5, window: 60000, windowType: 'sliding' },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // With rejection callback and fixed window\n * const [rateLimitedValue, rateLimiter] = useRateLimitedValue(rawValue, {\n *   limit: 3,\n *   window: 5000,\n *   windowType: 'fixed',\n *   onReject: (rateLimiter) => {\n *     console.log(`Update rejected. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // Access the selected rate limiter state (will be empty object {} unless selector provided)\n * const { executionCount, rejectionCount } = rateLimiter.state;\n * ```\n */\nexport function useRateLimitedValue<TValue, TSelected = RateLimiterState>(\n  value: TValue,\n  options: RateLimiterOptions<Dispatch<StateUpdater<TValue>>>,\n  selector?: (state: RateLimiterState) => TSelected,\n): [TValue, PreactRateLimiter<Dispatch<StateUpdater<TValue>>, TSelected>] {\n  const [rateLimitedValue, setRateLimitedValue, rateLimiter] =\n    useRateLimitedState(value, options, selector)\n\n  useEffect(() => {\n    ;(setRateLimitedValue as (value: TValue) => void)(value)\n  }, [value, setRateLimitedValue])\n\n  return [rateLimitedValue, rateLimiter]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgGA,SAAgB,oBACd,OACA,SACA,UACwE;CACxE,MAAM,CAAC,kBAAkB,qBAAqB,eAC5C,oBAAoB,OAAO,SAAS,SAAS;AAE/C,iBAAgB;AACb,EAAC,oBAAgD,MAAM;IACvD,CAAC,OAAO,oBAAoB,CAAC;AAEhC,QAAO,CAAC,kBAAkB,YAAY"}

package/dist/rate-limiter/useRateLimiter.cjs

@@ -0,0 +1,138 @@
+const require_PacerProvider = require('../provider/PacerProvider.cjs');
+let preact_hooks = require("preact/hooks");
+let __tanstack_preact_store = require("@tanstack/preact-store");
+let __tanstack_pacer_rate_limiter = require("@tanstack/pacer/rate-limiter");
+
+//#region src/rate-limiter/useRateLimiter.ts
+/**
+* A low-level Preact hook that creates a `RateLimiter` instance to enforce rate limits on function execution.
+*
+* 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 is a simple "hard limit" approach that allows executions until a maximum count is reached within
+* a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,
+* it does not attempt to space out or collapse executions intelligently.
+*
+* 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:
+* - Use throttling when you want consistent spacing between executions (e.g. UI updates)
+* - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
+* - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
+* to specify which state changes will trigger a re-render, 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. This prevents unnecessary re-renders and gives you
+* full control over when your component updates. Only when you provide a selector will the
+* component re-render when the selected state values change.
+*
+* Available state properties:
+* - `executionCount`: Number of function executions that have been completed
+* - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
+* - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
+*
+* The hook returns an object containing:
+* - maybeExecute: The rate-limited function that respects the configured limits
+* - getExecutionCount: Returns the number of successful executions
+* - getRejectionCount: Returns the number of rejected executions due to rate limiting
+* - getRemainingInWindow: Returns how many more executions are allowed in the current window
+* - reset: Resets the execution counts and window timing
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const rateLimiter = useRateLimiter(apiCall, {
+*   limit: 5,
+*   window: 60000,
+*   windowType: 'sliding',
+* });
+*
+* // Opt-in to re-render when execution count changes (optimized for tracking successful executions)
+* const rateLimiter = useRateLimiter(
+*   apiCall,
+*   {
+*     limit: 5,
+*     window: 60000,
+*     windowType: 'sliding',
+*   },
+*   (state) => ({ executionCount: state.executionCount })
+* );
+*
+* // Opt-in to re-render when rejection count changes (optimized for tracking rate limit violations)
+* const rateLimiter = useRateLimiter(
+*   apiCall,
+*   {
+*     limit: 5,
+*     window: 60000,
+*     windowType: 'sliding',
+*   },
+*   (state) => ({ rejectionCount: state.rejectionCount })
+* );
+*
+* // Opt-in to re-render when execution times change (optimized for window calculations)
+* const rateLimiter = useRateLimiter(
+*   apiCall,
+*   {
+*     limit: 5,
+*     window: 60000,
+*     windowType: 'sliding',
+*   },
+*   (state) => ({ executionTimes: state.executionTimes })
+* );
+*
+* // Multiple state properties - re-render when any of these change
+* const rateLimiter = useRateLimiter(
+*   apiCall,
+*   {
+*     limit: 5,
+*     window: 60000,
+*     windowType: 'sliding',
+*   },
+*   (state) => ({
+*     executionCount: state.executionCount,
+*     rejectionCount: state.rejectionCount
+*   })
+* );
+*
+* // Monitor rate limit status
+* const handleClick = () => {
+*   const remaining = rateLimiter.getRemainingInWindow();
+*   if (remaining > 0) {
+*     rateLimiter.maybeExecute(data);
+*   } else {
+*     showRateLimitWarning();
+*   }
+* };
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { executionCount, rejectionCount } = rateLimiter.state;
+* ```
+*/
+function useRateLimiter(fn, options, selector = () => ({})) {
+	const mergedOptions = {
+		...require_PacerProvider.useDefaultPacerOptions().rateLimiter,
+		...options
+	};
+	const [rateLimiter] = (0, preact_hooks.useState)(() => new __tanstack_pacer_rate_limiter.RateLimiter(fn, mergedOptions));
+	rateLimiter.fn = fn;
+	rateLimiter.setOptions(mergedOptions);
+	const state = (0, __tanstack_preact_store.useStore)(rateLimiter.store, selector);
+	return (0, preact_hooks.useMemo)(() => ({
+		...rateLimiter,
+		state
+	}), [rateLimiter, state]);
+}
+
+//#endregion
+exports.useRateLimiter = useRateLimiter;
+//# sourceMappingURL=useRateLimiter.cjs.map

package/dist/rate-limiter/useRateLimiter.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRateLimiter.cjs","names":["useDefaultPacerOptions","RateLimiter"],"sources":["../../src/rate-limiter/useRateLimiter.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type {\n  RateLimiterOptions,\n  RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\nimport type { AnyFunction } from '@tanstack/pacer/types'\n\nexport interface PreactRateLimiter<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<RateLimiter<TFn>, 'store'> {\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 `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<RateLimiterState>>\n}\n\n/**\n * A low-level Preact hook that creates a `RateLimiter` instance to enforce rate limits on function execution.\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 is a simple \"hard limit\" approach that allows executions until a maximum count is reached within\n * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,\n * it does not attempt to space out or collapse executions intelligently.\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:\n * - Use throttling when you want consistent spacing between executions (e.g. UI updates)\n * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)\n * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available state properties:\n * - `executionCount`: Number of function executions that have been completed\n * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations\n * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting\n *\n * The hook returns an object containing:\n * - maybeExecute: The rate-limited function that respects the configured limits\n * - getExecutionCount: Returns the number of successful executions\n * - getRejectionCount: Returns the number of rejected executions due to rate limiting\n * - getRemainingInWindow: Returns how many more executions are allowed in the current window\n * - reset: Resets the execution counts and window timing\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const rateLimiter = useRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\n * });\n *\n * // Opt-in to re-render when execution count changes (optimized for tracking successful executions)\n * const rateLimiter = useRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to re-render when rejection count changes (optimized for tracking rate limit violations)\n * const rateLimiter = useRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({ rejectionCount: state.rejectionCount })\n * );\n *\n * // Opt-in to re-render when execution times change (optimized for window calculations)\n * const rateLimiter = useRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // Multiple state properties - re-render when any of these change\n * const rateLimiter = useRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Monitor rate limit status\n * const handleClick = () => {\n *   const remaining = rateLimiter.getRemainingInWindow();\n *   if (remaining > 0) {\n *     rateLimiter.maybeExecute(data);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { executionCount, rejectionCount } = rateLimiter.state;\n * ```\n */\nexport function useRateLimiter<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: RateLimiterOptions<TFn>,\n  selector: (state: RateLimiterState) => TSelected = () => ({}) as TSelected,\n): PreactRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().rateLimiter,\n    ...options,\n  } as RateLimiterOptions<TFn>\n\n  const [rateLimiter] = useState(() => new RateLimiter<TFn>(fn, mergedOptions))\n\n  rateLimiter.fn = fn\n  rateLimiter.setOptions(mergedOptions)\n\n  const state = useStore(rateLimiter.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...rateLimiter,\n        state,\n      }) as PreactRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`\n    [rateLimiter, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+IA,SAAgB,eACd,IACA,SACA,kBAA0D,EAAE,GACzB;CACnC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,gDAA8B,IAAIC,0CAAiB,IAAI,cAAc,CAAC;AAE7E,aAAY,KAAK;AACjB,aAAY,WAAW,cAAc;CAErC,MAAM,8CAAiB,YAAY,OAAO,SAAS;AAEnD,yCAEK;EACC,GAAG;EACH;EACD,GACH,CAAC,aAAa,MAAM,CACrB"}

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

@@ -0,0 +1,137 @@
+import { Store } from "@tanstack/preact-store";
+import { AnyFunction } from "@tanstack/pacer/types";
+import { RateLimiter, RateLimiterOptions, RateLimiterState } from "@tanstack/pacer/rate-limiter";
+
+//#region src/rate-limiter/useRateLimiter.d.ts
+interface PreactRateLimiter<TFn extends AnyFunction, TSelected = {}> extends Omit<RateLimiter<TFn>, 'store'> {
+  /**
+   * 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 `useStore` hook internally.
+   * Although, you can make the state reactive by using the `useStore` in your own usage.
+   */
+  readonly store: Store<Readonly<RateLimiterState>>;
+}
+/**
+ * A low-level Preact hook that creates a `RateLimiter` instance to enforce rate limits on function execution.
+ *
+ * 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 is a simple "hard limit" approach that allows executions until a maximum count is reached within
+ * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,
+ * it does not attempt to space out or collapse executions intelligently.
+ *
+ * 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:
+ * - Use throttling when you want consistent spacing between executions (e.g. UI updates)
+ * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
+ * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
+ * to specify which state changes will trigger a re-render, 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. This prevents unnecessary re-renders and gives you
+ * full control over when your component updates. Only when you provide a selector will the
+ * component re-render when the selected state values change.
+ *
+ * Available state properties:
+ * - `executionCount`: Number of function executions that have been completed
+ * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
+ * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
+ *
+ * The hook returns an object containing:
+ * - maybeExecute: The rate-limited function that respects the configured limits
+ * - getExecutionCount: Returns the number of successful executions
+ * - getRejectionCount: Returns the number of rejected executions due to rate limiting
+ * - getRemainingInWindow: Returns how many more executions are allowed in the current window
+ * - reset: Resets the execution counts and window timing
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const rateLimiter = useRateLimiter(apiCall, {
+ *   limit: 5,
+ *   window: 60000,
+ *   windowType: 'sliding',
+ * });
+ *
+ * // Opt-in to re-render when execution count changes (optimized for tracking successful executions)
+ * const rateLimiter = useRateLimiter(
+ *   apiCall,
+ *   {
+ *     limit: 5,
+ *     window: 60000,
+ *     windowType: 'sliding',
+ *   },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Opt-in to re-render when rejection count changes (optimized for tracking rate limit violations)
+ * const rateLimiter = useRateLimiter(
+ *   apiCall,
+ *   {
+ *     limit: 5,
+ *     window: 60000,
+ *     windowType: 'sliding',
+ *   },
+ *   (state) => ({ rejectionCount: state.rejectionCount })
+ * );
+ *
+ * // Opt-in to re-render when execution times change (optimized for window calculations)
+ * const rateLimiter = useRateLimiter(
+ *   apiCall,
+ *   {
+ *     limit: 5,
+ *     window: 60000,
+ *     windowType: 'sliding',
+ *   },
+ *   (state) => ({ executionTimes: state.executionTimes })
+ * );
+ *
+ * // Multiple state properties - re-render when any of these change
+ * const rateLimiter = useRateLimiter(
+ *   apiCall,
+ *   {
+ *     limit: 5,
+ *     window: 60000,
+ *     windowType: 'sliding',
+ *   },
+ *   (state) => ({
+ *     executionCount: state.executionCount,
+ *     rejectionCount: state.rejectionCount
+ *   })
+ * );
+ *
+ * // Monitor rate limit status
+ * const handleClick = () => {
+ *   const remaining = rateLimiter.getRemainingInWindow();
+ *   if (remaining > 0) {
+ *     rateLimiter.maybeExecute(data);
+ *   } else {
+ *     showRateLimitWarning();
+ *   }
+ * };
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { executionCount, rejectionCount } = rateLimiter.state;
+ * ```
+ */
+declare function useRateLimiter<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: RateLimiterOptions<TFn>, selector?: (state: RateLimiterState) => TSelected): PreactRateLimiter<TFn, TSelected>;
+//#endregion
+export { PreactRateLimiter, useRateLimiter };
+//# sourceMappingURL=useRateLimiter.d.cts.map

package/dist/rate-limiter/useRateLimiter.d.ts

@@ -0,0 +1,137 @@
+import { Store } from "@tanstack/preact-store";
+import { RateLimiter, RateLimiterOptions, RateLimiterState } from "@tanstack/pacer/rate-limiter";
+import { AnyFunction } from "@tanstack/pacer/types";
+
+//#region src/rate-limiter/useRateLimiter.d.ts
+interface PreactRateLimiter<TFn extends AnyFunction, TSelected = {}> extends Omit<RateLimiter<TFn>, 'store'> {
+  /**
+   * 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 `useStore` hook internally.
+   * Although, you can make the state reactive by using the `useStore` in your own usage.
+   */
+  readonly store: Store<Readonly<RateLimiterState>>;
+}
+/**
+ * A low-level Preact hook that creates a `RateLimiter` instance to enforce rate limits on function execution.
+ *
+ * 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 is a simple "hard limit" approach that allows executions until a maximum count is reached within
+ * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,
+ * it does not attempt to space out or collapse executions intelligently.
+ *
+ * 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:
+ * - Use throttling when you want consistent spacing between executions (e.g. UI updates)
+ * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
+ * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
+ * to specify which state changes will trigger a re-render, 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. This prevents unnecessary re-renders and gives you
+ * full control over when your component updates. Only when you provide a selector will the
+ * component re-render when the selected state values change.
+ *
+ * Available state properties:
+ * - `executionCount`: Number of function executions that have been completed
+ * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
+ * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
+ *
+ * The hook returns an object containing:
+ * - maybeExecute: The rate-limited function that respects the configured limits
+ * - getExecutionCount: Returns the number of successful executions
+ * - getRejectionCount: Returns the number of rejected executions due to rate limiting
+ * - getRemainingInWindow: Returns how many more executions are allowed in the current window
+ * - reset: Resets the execution counts and window timing
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const rateLimiter = useRateLimiter(apiCall, {
+ *   limit: 5,
+ *   window: 60000,
+ *   windowType: 'sliding',
+ * });
+ *
+ * // Opt-in to re-render when execution count changes (optimized for tracking successful executions)
+ * const rateLimiter = useRateLimiter(
+ *   apiCall,
+ *   {
+ *     limit: 5,
+ *     window: 60000,
+ *     windowType: 'sliding',
+ *   },
+ *   (state) => ({ executionCount: state.executionCount })
+ * );
+ *
+ * // Opt-in to re-render when rejection count changes (optimized for tracking rate limit violations)
+ * const rateLimiter = useRateLimiter(
+ *   apiCall,
+ *   {
+ *     limit: 5,
+ *     window: 60000,
+ *     windowType: 'sliding',
+ *   },
+ *   (state) => ({ rejectionCount: state.rejectionCount })
+ * );
+ *
+ * // Opt-in to re-render when execution times change (optimized for window calculations)
+ * const rateLimiter = useRateLimiter(
+ *   apiCall,
+ *   {
+ *     limit: 5,
+ *     window: 60000,
+ *     windowType: 'sliding',
+ *   },
+ *   (state) => ({ executionTimes: state.executionTimes })
+ * );
+ *
+ * // Multiple state properties - re-render when any of these change
+ * const rateLimiter = useRateLimiter(
+ *   apiCall,
+ *   {
+ *     limit: 5,
+ *     window: 60000,
+ *     windowType: 'sliding',
+ *   },
+ *   (state) => ({
+ *     executionCount: state.executionCount,
+ *     rejectionCount: state.rejectionCount
+ *   })
+ * );
+ *
+ * // Monitor rate limit status
+ * const handleClick = () => {
+ *   const remaining = rateLimiter.getRemainingInWindow();
+ *   if (remaining > 0) {
+ *     rateLimiter.maybeExecute(data);
+ *   } else {
+ *     showRateLimitWarning();
+ *   }
+ * };
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { executionCount, rejectionCount } = rateLimiter.state;
+ * ```
+ */
+declare function useRateLimiter<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: RateLimiterOptions<TFn>, selector?: (state: RateLimiterState) => TSelected): PreactRateLimiter<TFn, TSelected>;
+//#endregion
+export { PreactRateLimiter, useRateLimiter };
+//# sourceMappingURL=useRateLimiter.d.ts.map