@tanstack/preact-pacer 0.0.1 → 0.19.0

package/dist/rate-limiter/useRateLimitedState.cjs

@@ -0,0 +1,115 @@
+const require_useRateLimiter = require('./useRateLimiter.cjs');
+let preact_hooks = require("preact/hooks");
+
+//#region src/rate-limiter/useRateLimitedState.ts
+/**
+* A Preact hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.
+* This hook combines Preact's useState with rate limiting functionality to provide controlled state updates.
+*
+* 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:
+* - useThrottledState: When you want consistent spacing between updates (e.g. UI changes)
+* - useDebouncedState: 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 state value
+* - A rate-limited setter function that respects the configured limits
+* - The rateLimiter instance for additional control
+*
+* For more direct control over rate limiting without 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 [value, setValue, rateLimiter] = useRateLimitedState(0, {
+*   limit: 5,
+*   window: 60000,
+*   windowType: 'sliding'
+* });
+*
+* // Opt-in to re-render when execution count changes (optimized for tracking successful updates)
+* const [value, setValue, rateLimiter] = useRateLimitedState(
+*   0,
+*   { 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 [value, setValue, rateLimiter] = useRateLimitedState(
+*   0,
+*   { limit: 5, window: 60000, windowType: 'sliding' },
+*   (state) => ({ rejectionCount: state.rejectionCount })
+* );
+*
+* // Opt-in to re-render when execution times change (optimized for window calculations)
+* const [value, setValue, rateLimiter] = useRateLimitedState(
+*   0,
+*   { limit: 5, window: 60000, windowType: 'sliding' },
+*   (state) => ({ executionTimes: state.executionTimes })
+* );
+*
+* // With rejection callback and fixed window
+* const [value, setValue] = useRateLimitedState(0, {
+*   limit: 3,
+*   window: 5000,
+*   windowType: 'fixed',
+*   onReject: (rateLimiter) => {
+*     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
+*   }
+* });
+*
+* // Access rateLimiter methods if needed
+* const handleSubmit = () => {
+*   const remaining = rateLimiter.getRemainingInWindow();
+*   if (remaining > 0) {
+*     setValue(newValue);
+*   } else {
+*     showRateLimitWarning();
+*   }
+* };
+*
+* // Access the selected rate limiter state (will be empty object {} unless selector provided)
+* const { executionCount, rejectionCount } = rateLimiter.state;
+* ```
+*/
+function useRateLimitedState(value, options, selector) {
+	const [rateLimitedValue, setRateLimitedValue] = (0, preact_hooks.useState)(value);
+	const rateLimiter = require_useRateLimiter.useRateLimiter(setRateLimitedValue, options, selector);
+	return [
+		rateLimitedValue,
+		rateLimiter.maybeExecute,
+		rateLimiter
+	];
+}
+
+//#endregion
+exports.useRateLimitedState = useRateLimitedState;
+//# sourceMappingURL=useRateLimitedState.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useRateLimitedState.cjs","names":["useRateLimiter"],"sources":["../../src/rate-limiter/useRateLimitedState.ts"],"sourcesContent":["import { useState } from 'preact/hooks'\nimport { useRateLimiter } from './useRateLimiter'\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 Preact hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.\n * This hook combines Preact's useState with rate limiting functionality to provide controlled state updates.\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 * - useThrottledState: When you want consistent spacing between updates (e.g. UI changes)\n * - useDebouncedState: 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 state value\n * - A rate-limited setter function that respects the configured limits\n * - The rateLimiter instance for additional control\n *\n * For more direct control over rate limiting without 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 [value, setValue, rateLimiter] = useRateLimitedState(0, {\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 [value, setValue, rateLimiter] = useRateLimitedState(\n *   0,\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 [value, setValue, rateLimiter] = useRateLimitedState(\n *   0,\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 [value, setValue, rateLimiter] = useRateLimitedState(\n *   0,\n *   { limit: 5, window: 60000, windowType: 'sliding' },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // With rejection callback and fixed window\n * const [value, setValue] = useRateLimitedState(0, {\n *   limit: 3,\n *   window: 5000,\n *   windowType: 'fixed',\n *   onReject: (rateLimiter) => {\n *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // Access rateLimiter methods if needed\n * const handleSubmit = () => {\n *   const remaining = rateLimiter.getRemainingInWindow();\n *   if (remaining > 0) {\n *     setValue(newValue);\n *   } else {\n *     showRateLimitWarning();\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 useRateLimitedState<TValue, TSelected = RateLimiterState>(\n  value: TValue,\n  options: RateLimiterOptions<Dispatch<StateUpdater<TValue>>>,\n  selector?: (state: RateLimiterState) => TSelected,\n): [\n  TValue,\n  Dispatch<StateUpdater<TValue>>,\n  PreactRateLimiter<Dispatch<StateUpdater<TValue>>, TSelected>,\n] {\n  const [rateLimitedValue, setRateLimitedValue] = useState(value)\n  const rateLimiter = useRateLimiter(setRateLimitedValue, options, selector)\n  return [\n    rateLimitedValue,\n    rateLimiter.maybeExecute as Dispatch<StateUpdater<TValue>>,\n    rateLimiter,\n  ]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2GA,SAAgB,oBACd,OACA,SACA,UAKA;CACA,MAAM,CAAC,kBAAkB,kDAAgC,MAAM;CAC/D,MAAM,cAAcA,sCAAe,qBAAqB,SAAS,SAAS;AAC1E,QAAO;EACL;EACA,YAAY;EACZ;EACD"}

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

@@ -0,0 +1,108 @@
+import { PreactRateLimiter } from "./useRateLimiter.cjs";
+import { Dispatch, StateUpdater } from "preact/hooks";
+import { RateLimiterOptions, RateLimiterState } from "@tanstack/pacer/rate-limiter";
+
+//#region src/rate-limiter/useRateLimitedState.d.ts
+
+/**
+ * A Preact hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.
+ * This hook combines Preact's useState with rate limiting functionality to provide controlled state updates.
+ *
+ * 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:
+ * - useThrottledState: When you want consistent spacing between updates (e.g. UI changes)
+ * - useDebouncedState: 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 state value
+ * - A rate-limited setter function that respects the configured limits
+ * - The rateLimiter instance for additional control
+ *
+ * For more direct control over rate limiting without 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 [value, setValue, rateLimiter] = useRateLimitedState(0, {
+ *   limit: 5,
+ *   window: 60000,
+ *   windowType: 'sliding'
+ * });
+ *
+ * // Opt-in to re-render when execution count changes (optimized for tracking successful updates)
+ * const [value, setValue, rateLimiter] = useRateLimitedState(
+ *   0,
+ *   { 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 [value, setValue, rateLimiter] = useRateLimitedState(
+ *   0,
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ rejectionCount: state.rejectionCount })
+ * );
+ *
+ * // Opt-in to re-render when execution times change (optimized for window calculations)
+ * const [value, setValue, rateLimiter] = useRateLimitedState(
+ *   0,
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ executionTimes: state.executionTimes })
+ * );
+ *
+ * // With rejection callback and fixed window
+ * const [value, setValue] = useRateLimitedState(0, {
+ *   limit: 3,
+ *   window: 5000,
+ *   windowType: 'fixed',
+ *   onReject: (rateLimiter) => {
+ *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
+ *   }
+ * });
+ *
+ * // Access rateLimiter methods if needed
+ * const handleSubmit = () => {
+ *   const remaining = rateLimiter.getRemainingInWindow();
+ *   if (remaining > 0) {
+ *     setValue(newValue);
+ *   } else {
+ *     showRateLimitWarning();
+ *   }
+ * };
+ *
+ * // Access the selected rate limiter state (will be empty object {} unless selector provided)
+ * const { executionCount, rejectionCount } = rateLimiter.state;
+ * ```
+ */
+declare function useRateLimitedState<TValue, TSelected = RateLimiterState>(value: TValue, options: RateLimiterOptions<Dispatch<StateUpdater<TValue>>>, selector?: (state: RateLimiterState) => TSelected): [TValue, Dispatch<StateUpdater<TValue>>, PreactRateLimiter<Dispatch<StateUpdater<TValue>>, TSelected>];
+//#endregion
+export { useRateLimitedState };
+//# sourceMappingURL=useRateLimitedState.d.cts.map

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

@@ -0,0 +1,108 @@
+import { PreactRateLimiter } from "./useRateLimiter.js";
+import { Dispatch, StateUpdater } from "preact/hooks";
+import { RateLimiterOptions, RateLimiterState } from "@tanstack/pacer/rate-limiter";
+
+//#region src/rate-limiter/useRateLimitedState.d.ts
+
+/**
+ * A Preact hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.
+ * This hook combines Preact's useState with rate limiting functionality to provide controlled state updates.
+ *
+ * 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:
+ * - useThrottledState: When you want consistent spacing between updates (e.g. UI changes)
+ * - useDebouncedState: 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 state value
+ * - A rate-limited setter function that respects the configured limits
+ * - The rateLimiter instance for additional control
+ *
+ * For more direct control over rate limiting without 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 [value, setValue, rateLimiter] = useRateLimitedState(0, {
+ *   limit: 5,
+ *   window: 60000,
+ *   windowType: 'sliding'
+ * });
+ *
+ * // Opt-in to re-render when execution count changes (optimized for tracking successful updates)
+ * const [value, setValue, rateLimiter] = useRateLimitedState(
+ *   0,
+ *   { 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 [value, setValue, rateLimiter] = useRateLimitedState(
+ *   0,
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ rejectionCount: state.rejectionCount })
+ * );
+ *
+ * // Opt-in to re-render when execution times change (optimized for window calculations)
+ * const [value, setValue, rateLimiter] = useRateLimitedState(
+ *   0,
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ executionTimes: state.executionTimes })
+ * );
+ *
+ * // With rejection callback and fixed window
+ * const [value, setValue] = useRateLimitedState(0, {
+ *   limit: 3,
+ *   window: 5000,
+ *   windowType: 'fixed',
+ *   onReject: (rateLimiter) => {
+ *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
+ *   }
+ * });
+ *
+ * // Access rateLimiter methods if needed
+ * const handleSubmit = () => {
+ *   const remaining = rateLimiter.getRemainingInWindow();
+ *   if (remaining > 0) {
+ *     setValue(newValue);
+ *   } else {
+ *     showRateLimitWarning();
+ *   }
+ * };
+ *
+ * // Access the selected rate limiter state (will be empty object {} unless selector provided)
+ * const { executionCount, rejectionCount } = rateLimiter.state;
+ * ```
+ */
+declare function useRateLimitedState<TValue, TSelected = RateLimiterState>(value: TValue, options: RateLimiterOptions<Dispatch<StateUpdater<TValue>>>, selector?: (state: RateLimiterState) => TSelected): [TValue, Dispatch<StateUpdater<TValue>>, PreactRateLimiter<Dispatch<StateUpdater<TValue>>, TSelected>];
+//#endregion
+export { useRateLimitedState };
+//# sourceMappingURL=useRateLimitedState.d.ts.map

package/dist/rate-limiter/useRateLimitedState.js

@@ -0,0 +1,115 @@
+import { useRateLimiter } from "./useRateLimiter.js";
+import { useState } from "preact/hooks";
+
+//#region src/rate-limiter/useRateLimitedState.ts
+/**
+* A Preact hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.
+* This hook combines Preact's useState with rate limiting functionality to provide controlled state updates.
+*
+* 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:
+* - useThrottledState: When you want consistent spacing between updates (e.g. UI changes)
+* - useDebouncedState: 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 state value
+* - A rate-limited setter function that respects the configured limits
+* - The rateLimiter instance for additional control
+*
+* For more direct control over rate limiting without 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 [value, setValue, rateLimiter] = useRateLimitedState(0, {
+*   limit: 5,
+*   window: 60000,
+*   windowType: 'sliding'
+* });
+*
+* // Opt-in to re-render when execution count changes (optimized for tracking successful updates)
+* const [value, setValue, rateLimiter] = useRateLimitedState(
+*   0,
+*   { 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 [value, setValue, rateLimiter] = useRateLimitedState(
+*   0,
+*   { limit: 5, window: 60000, windowType: 'sliding' },
+*   (state) => ({ rejectionCount: state.rejectionCount })
+* );
+*
+* // Opt-in to re-render when execution times change (optimized for window calculations)
+* const [value, setValue, rateLimiter] = useRateLimitedState(
+*   0,
+*   { limit: 5, window: 60000, windowType: 'sliding' },
+*   (state) => ({ executionTimes: state.executionTimes })
+* );
+*
+* // With rejection callback and fixed window
+* const [value, setValue] = useRateLimitedState(0, {
+*   limit: 3,
+*   window: 5000,
+*   windowType: 'fixed',
+*   onReject: (rateLimiter) => {
+*     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
+*   }
+* });
+*
+* // Access rateLimiter methods if needed
+* const handleSubmit = () => {
+*   const remaining = rateLimiter.getRemainingInWindow();
+*   if (remaining > 0) {
+*     setValue(newValue);
+*   } else {
+*     showRateLimitWarning();
+*   }
+* };
+*
+* // Access the selected rate limiter state (will be empty object {} unless selector provided)
+* const { executionCount, rejectionCount } = rateLimiter.state;
+* ```
+*/
+function useRateLimitedState(value, options, selector) {
+	const [rateLimitedValue, setRateLimitedValue] = useState(value);
+	const rateLimiter = useRateLimiter(setRateLimitedValue, options, selector);
+	return [
+		rateLimitedValue,
+		rateLimiter.maybeExecute,
+		rateLimiter
+	];
+}
+
+//#endregion
+export { useRateLimitedState };
+//# sourceMappingURL=useRateLimitedState.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useRateLimitedState.js","names":[],"sources":["../../src/rate-limiter/useRateLimitedState.ts"],"sourcesContent":["import { useState } from 'preact/hooks'\nimport { useRateLimiter } from './useRateLimiter'\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 Preact hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.\n * This hook combines Preact's useState with rate limiting functionality to provide controlled state updates.\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 * - useThrottledState: When you want consistent spacing between updates (e.g. UI changes)\n * - useDebouncedState: 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 state value\n * - A rate-limited setter function that respects the configured limits\n * - The rateLimiter instance for additional control\n *\n * For more direct control over rate limiting without 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 [value, setValue, rateLimiter] = useRateLimitedState(0, {\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 [value, setValue, rateLimiter] = useRateLimitedState(\n *   0,\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 [value, setValue, rateLimiter] = useRateLimitedState(\n *   0,\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 [value, setValue, rateLimiter] = useRateLimitedState(\n *   0,\n *   { limit: 5, window: 60000, windowType: 'sliding' },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // With rejection callback and fixed window\n * const [value, setValue] = useRateLimitedState(0, {\n *   limit: 3,\n *   window: 5000,\n *   windowType: 'fixed',\n *   onReject: (rateLimiter) => {\n *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // Access rateLimiter methods if needed\n * const handleSubmit = () => {\n *   const remaining = rateLimiter.getRemainingInWindow();\n *   if (remaining > 0) {\n *     setValue(newValue);\n *   } else {\n *     showRateLimitWarning();\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 useRateLimitedState<TValue, TSelected = RateLimiterState>(\n  value: TValue,\n  options: RateLimiterOptions<Dispatch<StateUpdater<TValue>>>,\n  selector?: (state: RateLimiterState) => TSelected,\n): [\n  TValue,\n  Dispatch<StateUpdater<TValue>>,\n  PreactRateLimiter<Dispatch<StateUpdater<TValue>>, TSelected>,\n] {\n  const [rateLimitedValue, setRateLimitedValue] = useState(value)\n  const rateLimiter = useRateLimiter(setRateLimitedValue, options, selector)\n  return [\n    rateLimitedValue,\n    rateLimiter.maybeExecute as Dispatch<StateUpdater<TValue>>,\n    rateLimiter,\n  ]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2GA,SAAgB,oBACd,OACA,SACA,UAKA;CACA,MAAM,CAAC,kBAAkB,uBAAuB,SAAS,MAAM;CAC/D,MAAM,cAAc,eAAe,qBAAqB,SAAS,SAAS;AAC1E,QAAO;EACL;EACA,YAAY;EACZ;EACD"}

package/dist/rate-limiter/useRateLimitedValue.cjs

@@ -0,0 +1,102 @@
+const require_useRateLimitedState = require('./useRateLimitedState.cjs');
+let preact_hooks = require("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] = require_useRateLimitedState.useRateLimitedState(value, options, selector);
+	(0, preact_hooks.useEffect)(() => {
+		setRateLimitedValue(value);
+	}, [value, setRateLimitedValue]);
+	return [rateLimitedValue, rateLimiter];
+}
+
+//#endregion
+exports.useRateLimitedValue = useRateLimitedValue;
+//# sourceMappingURL=useRateLimitedValue.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useRateLimitedValue.cjs","names":["useRateLimitedState"],"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,eAC5CA,gDAAoB,OAAO,SAAS,SAAS;AAE/C,mCAAgB;AACb,EAAC,oBAAgD,MAAM;IACvD,CAAC,OAAO,oBAAoB,CAAC;AAEhC,QAAO,CAAC,kBAAkB,YAAY"}