@tanstack/solid-pacer 0.21.1 → 0.23.0

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

@@ -1,94 +0,0 @@
-import { SolidRateLimiter, SolidRateLimiterOptions } from "./createRateLimiter.cjs";
-import { Accessor, Setter } from "solid-js";
-import { RateLimiterState } from "@tanstack/pacer/rate-limiter";
-
-//#region src/rate-limiter/createRateLimitedSignal.d.ts
-/**
- * A Solid hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.
- * This hook combines Solid's createSignal 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:
- * - createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)
- * - createDebouncedSignal: 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 accessor
- * - 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 createRateLimiter 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 reactive updates,
- * optimizing performance by preventing unnecessary subscriptions 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 reactive updates and gives you
- * full control over when your component subscribes to state changes. Only when you provide a selector will
- * the reactive system track the selected state values.
- *
- * Available rate limiter state properties:
- * - `callsInWindow`: Number of calls made in the current window
- * - `remainingInWindow`: Number of calls remaining in the current window
- * - `windowStart`: Unix timestamp when the current window started
- * - `nextWindowStart`: Unix timestamp when the next window will start
- * - `msUntilNextWindow`: Milliseconds until the next window starts
- * - `isAtLimit`: Whether the call limit for the current window has been reached
- * - `status`: Current status ('disabled' | 'idle' | 'at-limit')
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {
- *   limit: 5,
- *   window: 60000,
- *   windowType: 'sliding'
- * });
- *
- * // Opt-in to reactive updates when limit state changes (optimized for UI feedback)
- * const [value, setValue, rateLimiter] = createRateLimitedSignal(
- *   0,
- *   { limit: 5, window: 60000 },
- *   (state) => ({ isAtLimit: state.isAtLimit, remainingInWindow: state.remainingInWindow })
- * );
- *
- * // With rejection callback and fixed window
- * const [value, setValue] = createRateLimitedSignal(0, {
- *   limit: 3,
- *   window: 5000,
- *   windowType: 'fixed',
- *   onReject: (rateLimiter) => {
- *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
- *   }
- * });
- *
- * // Access rateLimiter state via signals
- * const handleSubmit = () => {
- *   const remaining = rateLimiter.state().remainingInWindow;
- *   if (remaining > 0) {
- *     setValue(newValue);
- *   } else {
- *     showRateLimitWarning();
- *   }
- * };
- * ```
- */
-declare function createRateLimitedSignal<TValue, TSelected = {}>(value: TValue, initialOptions: SolidRateLimiterOptions<Setter<TValue>, TSelected>, selector?: (state: RateLimiterState) => TSelected): [Accessor<TValue>, Setter<TValue>, SolidRateLimiter<Setter<TValue>, TSelected>];
-//#endregion
-export { createRateLimitedSignal };
-//# sourceMappingURL=createRateLimitedSignal.d.cts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"createRateLimitedSignal.js","names":[],"sources":["../../src/rate-limiter/createRateLimitedSignal.ts"],"sourcesContent":["import { createSignal } from 'solid-js'\nimport { createRateLimiter } from './createRateLimiter'\nimport type {\n  SolidRateLimiter,\n  SolidRateLimiterOptions,\n} from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterState } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A Solid hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.\n * This hook combines Solid's createSignal 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 * - createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedSignal: 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 accessor\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 createRateLimiter 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 reactive updates,\n * optimizing performance by preventing unnecessary subscriptions 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 reactive updates and gives you\n * full control over when your component subscribes to state changes. Only when you provide a selector will\n * the reactive system track the selected state values.\n *\n * Available rate limiter state properties:\n * - `callsInWindow`: Number of calls made in the current window\n * - `remainingInWindow`: Number of calls remaining in the current window\n * - `windowStart`: Unix timestamp when the current window started\n * - `nextWindowStart`: Unix timestamp when the next window will start\n * - `msUntilNextWindow`: Milliseconds until the next window starts\n * - `isAtLimit`: Whether the call limit for the current window has been reached\n * - `status`: Current status ('disabled' | 'idle' | 'at-limit')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Opt-in to reactive updates when limit state changes (optimized for UI feedback)\n * const [value, setValue, rateLimiter] = createRateLimitedSignal(\n *   0,\n *   { limit: 5, window: 60000 },\n *   (state) => ({ isAtLimit: state.isAtLimit, remainingInWindow: state.remainingInWindow })\n * );\n *\n * // With rejection callback and fixed window\n * const [value, setValue] = createRateLimitedSignal(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 state via signals\n * const handleSubmit = () => {\n *   const remaining = rateLimiter.state().remainingInWindow;\n *   if (remaining > 0) {\n *     setValue(newValue);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n * ```\n */\nexport function createRateLimitedSignal<TValue, TSelected = {}>(\n  value: TValue,\n  initialOptions: SolidRateLimiterOptions<Setter<TValue>, TSelected>,\n  selector?: (state: RateLimiterState) => TSelected,\n): [\n  Accessor<TValue>,\n  Setter<TValue>,\n  SolidRateLimiter<Setter<TValue>, TSelected>,\n] {\n  const [rateLimitedValue, setRateLimitedValue] = createSignal<TValue>(value)\n\n  const rateLimiter = createRateLimiter(\n    setRateLimitedValue,\n    initialOptions,\n    selector,\n  )\n\n  return [\n    rateLimitedValue,\n    rateLimiter.maybeExecute as Setter<TValue>,\n    rateLimiter,\n  ]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8FA,SAAgB,wBACd,OACA,gBACA,UAKA;CACA,MAAM,CAAC,kBAAkB,uBAAuB,aAAqB,MAAM;CAE3E,MAAM,cAAc,kBAClB,qBACA,gBACA,SACD;CAED,OAAO;EACL;EACA,YAAY;EACZ;EACD"}

package/dist/rate-limiter/createRateLimitedValue.cjs

@@ -1,102 +0,0 @@
-const require_createRateLimitedSignal = require('./createRateLimitedSignal.cjs');
-let solid_js = require("solid-js");
-
-//#region src/rate-limiter/createRateLimitedValue.ts
-/**
-* A high-level Solid 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 Solid's createSignal 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:
-* - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)
-* - createDebouncedValue: 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:
-* - An accessor function that provides the rate-limited value
-* - The rate limiter instance with control methods
-*
-* For more direct control over rate limiting behavior without Solid state management,
-* consider using the lower-level createRateLimiter 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 reactive updates,
-* optimizing performance by preventing unnecessary subscriptions 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 reactive updates and gives you
-* full control over when your component subscribes to state changes. Only when you provide a selector will
-* the reactive system track the selected state values.
-*
-* 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] = createRateLimitedValue(rawValue, {
-*   limit: 5,
-*   window: 60000,
-*   windowType: 'sliding'
-* });
-*
-* // Opt-in to reactive updates when execution count changes (optimized for tracking successful updates)
-* const [rateLimitedValue, rateLimiter] = createRateLimitedValue(
-*   rawValue,
-*   { limit: 5, window: 60000, windowType: 'sliding' },
-*   (state) => ({ executionCount: state.executionCount })
-* );
-*
-* // Opt-in to reactive updates when rejection count changes (optimized for tracking rate limit violations)
-* const [rateLimitedValue, rateLimiter] = createRateLimitedValue(
-*   rawValue,
-*   { limit: 5, window: 60000, windowType: 'sliding' },
-*   (state) => ({ rejectionCount: state.rejectionCount })
-* );
-*
-* // Opt-in to reactive updates when execution times change (optimized for window calculations)
-* const [rateLimitedValue, rateLimiter] = createRateLimitedValue(
-*   rawValue,
-*   { limit: 5, window: 60000, windowType: 'sliding' },
-*   (state) => ({ executionTimes: state.executionTimes })
-* );
-*
-* // With rejection callback and fixed window
-* const [rateLimitedValue, rateLimiter] = createRateLimitedValue(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 createRateLimitedValue(value, initialOptions, selector) {
-	const [rateLimitedValue, setRateLimitedValue, rateLimiter] = require_createRateLimitedSignal.createRateLimitedSignal(value(), initialOptions, selector);
-	(0, solid_js.createEffect)(() => {
-		setRateLimitedValue(value());
-	});
-	return [rateLimitedValue, rateLimiter];
-}
-
-//#endregion
-exports.createRateLimitedValue = createRateLimitedValue;
-//# sourceMappingURL=createRateLimitedValue.cjs.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"createRateLimitedValue.cjs","names":["createRateLimitedSignal"],"sources":["../../src/rate-limiter/createRateLimitedValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createRateLimitedSignal } from './createRateLimitedSignal'\nimport type {\n  SolidRateLimiter,\n  SolidRateLimiterOptions,\n} from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterState } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A high-level Solid 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 Solid's createSignal 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 * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedValue: 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 * - An accessor function that provides the rate-limited value\n * - The rate limiter instance with control methods\n *\n * For more direct control over rate limiting behavior without Solid state management,\n * consider using the lower-level createRateLimiter 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 reactive updates,\n * optimizing performance by preventing unnecessary subscriptions 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 reactive updates and gives you\n * full control over when your component subscribes to state changes. Only when you provide a selector will\n * the reactive system track the selected state values.\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] = createRateLimitedValue(rawValue, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Opt-in to reactive updates when execution count changes (optimized for tracking successful updates)\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(\n *   rawValue,\n *   { limit: 5, window: 60000, windowType: 'sliding' },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to reactive updates when rejection count changes (optimized for tracking rate limit violations)\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(\n *   rawValue,\n *   { limit: 5, window: 60000, windowType: 'sliding' },\n *   (state) => ({ rejectionCount: state.rejectionCount })\n * );\n *\n * // Opt-in to reactive updates when execution times change (optimized for window calculations)\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(\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] = createRateLimitedValue(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 createRateLimitedValue<TValue, TSelected = {}>(\n  value: Accessor<TValue>,\n  initialOptions: SolidRateLimiterOptions<Setter<TValue>, TSelected>,\n  selector?: (state: RateLimiterState) => TSelected,\n): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>, TSelected>] {\n  const [rateLimitedValue, setRateLimitedValue, rateLimiter] =\n    createRateLimitedSignal(value(), initialOptions, selector)\n\n  createEffect(() => {\n    setRateLimitedValue(value() as any)\n  })\n\n  return [rateLimitedValue, rateLimiter]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgGA,SAAgB,uBACd,OACA,gBACA,UACiE;CACjE,MAAM,CAAC,kBAAkB,qBAAqB,eAC5CA,wDAAwB,OAAO,EAAE,gBAAgB,SAAS;CAE5D,iCAAmB;EACjB,oBAAoB,OAAO,CAAQ;GACnC;CAEF,OAAO,CAAC,kBAAkB,YAAY"}

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

@@ -1,96 +0,0 @@
-import { SolidRateLimiter, SolidRateLimiterOptions } from "./createRateLimiter.cjs";
-import { Accessor, Setter } from "solid-js";
-import { RateLimiterState } from "@tanstack/pacer/rate-limiter";
-
-//#region src/rate-limiter/createRateLimitedValue.d.ts
-/**
- * A high-level Solid 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 Solid's createSignal 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:
- * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)
- * - createDebouncedValue: 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:
- * - An accessor function that provides the rate-limited value
- * - The rate limiter instance with control methods
- *
- * For more direct control over rate limiting behavior without Solid state management,
- * consider using the lower-level createRateLimiter 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 reactive updates,
- * optimizing performance by preventing unnecessary subscriptions 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 reactive updates and gives you
- * full control over when your component subscribes to state changes. Only when you provide a selector will
- * the reactive system track the selected state values.
- *
- * 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] = createRateLimitedValue(rawValue, {
- *   limit: 5,
- *   window: 60000,
- *   windowType: 'sliding'
- * });
- *
- * // Opt-in to reactive updates when execution count changes (optimized for tracking successful updates)
- * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(
- *   rawValue,
- *   { limit: 5, window: 60000, windowType: 'sliding' },
- *   (state) => ({ executionCount: state.executionCount })
- * );
- *
- * // Opt-in to reactive updates when rejection count changes (optimized for tracking rate limit violations)
- * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(
- *   rawValue,
- *   { limit: 5, window: 60000, windowType: 'sliding' },
- *   (state) => ({ rejectionCount: state.rejectionCount })
- * );
- *
- * // Opt-in to reactive updates when execution times change (optimized for window calculations)
- * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(
- *   rawValue,
- *   { limit: 5, window: 60000, windowType: 'sliding' },
- *   (state) => ({ executionTimes: state.executionTimes })
- * );
- *
- * // With rejection callback and fixed window
- * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(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;
- * ```
- */
-declare function createRateLimitedValue<TValue, TSelected = {}>(value: Accessor<TValue>, initialOptions: SolidRateLimiterOptions<Setter<TValue>, TSelected>, selector?: (state: RateLimiterState) => TSelected): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>, TSelected>];
-//#endregion
-export { createRateLimitedValue };
-//# sourceMappingURL=createRateLimitedValue.d.cts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"createRateLimitedValue.js","names":[],"sources":["../../src/rate-limiter/createRateLimitedValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createRateLimitedSignal } from './createRateLimitedSignal'\nimport type {\n  SolidRateLimiter,\n  SolidRateLimiterOptions,\n} from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type { RateLimiterState } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A high-level Solid 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 Solid's createSignal 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 * - createThrottledValue: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedValue: 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 * - An accessor function that provides the rate-limited value\n * - The rate limiter instance with control methods\n *\n * For more direct control over rate limiting behavior without Solid state management,\n * consider using the lower-level createRateLimiter 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 reactive updates,\n * optimizing performance by preventing unnecessary subscriptions 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 reactive updates and gives you\n * full control over when your component subscribes to state changes. Only when you provide a selector will\n * the reactive system track the selected state values.\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] = createRateLimitedValue(rawValue, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Opt-in to reactive updates when execution count changes (optimized for tracking successful updates)\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(\n *   rawValue,\n *   { limit: 5, window: 60000, windowType: 'sliding' },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to reactive updates when rejection count changes (optimized for tracking rate limit violations)\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(\n *   rawValue,\n *   { limit: 5, window: 60000, windowType: 'sliding' },\n *   (state) => ({ rejectionCount: state.rejectionCount })\n * );\n *\n * // Opt-in to reactive updates when execution times change (optimized for window calculations)\n * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(\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] = createRateLimitedValue(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 createRateLimitedValue<TValue, TSelected = {}>(\n  value: Accessor<TValue>,\n  initialOptions: SolidRateLimiterOptions<Setter<TValue>, TSelected>,\n  selector?: (state: RateLimiterState) => TSelected,\n): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>, TSelected>] {\n  const [rateLimitedValue, setRateLimitedValue, rateLimiter] =\n    createRateLimitedSignal(value(), initialOptions, selector)\n\n  createEffect(() => {\n    setRateLimitedValue(value() as any)\n  })\n\n  return [rateLimitedValue, rateLimiter]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgGA,SAAgB,uBACd,OACA,gBACA,UACiE;CACjE,MAAM,CAAC,kBAAkB,qBAAqB,eAC5C,wBAAwB,OAAO,EAAE,gBAAgB,SAAS;CAE5D,mBAAmB;EACjB,oBAAoB,OAAO,CAAQ;GACnC;CAEF,OAAO,CAAC,kBAAkB,YAAY"}

package/dist/rate-limiter/createRateLimiter.cjs

@@ -1,157 +0,0 @@
-const require_PacerProvider = require('../provider/PacerProvider.cjs');
-let solid_js = require("solid-js");
-let _tanstack_solid_store = require("@tanstack/solid-store");
-let _tanstack_pacer_rate_limiter = require("@tanstack/pacer/rate-limiter");
-
-//#region src/rate-limiter/createRateLimiter.ts
-/**
-* A low-level Solid 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 (createSignal, 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. You can subscribe to state changes
-* in two ways:
-*
-* **1. Using `rateLimiter.Subscribe` component (Recommended for component tree subscriptions)**
-*
-* Use the `Subscribe` component 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 reactive updates
-* at the hook level, optimizing performance by preventing unnecessary updates 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` component. This prevents unnecessary
-* updates and gives you full control over when your component tracks state changes.
-*
-* Available state properties:
-* - `executionCount`: Number of function executions that have been completed
-* - `rejectionCount`: Number of function calls that were rejected due to rate limiting
-* - `remainingInWindow`: Number of executions remaining in the current window
-* - `nextWindowTime`: Timestamp when the next window begins
-* - `currentWindowStart`: Timestamp when the current window started
-*
-* @example
-* ```tsx
-* // Default behavior - no reactive state subscriptions
-* const rateLimiter = createRateLimiter(apiCall, {
-*   limit: 5,
-*   window: 60000,
-*   windowType: 'sliding',
-* });
-*
-* // Subscribe to state changes deep in component tree using Subscribe component
-* <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
-*   {(state) => (
-*     <div>Rejections: {state().rejectionCount}</div>
-*   )}
-* </rateLimiter.Subscribe>
-*
-* // Opt-in to track execution count changes at hook level (optimized for tracking successful executions)
-* const rateLimiter = createRateLimiter(
-*   apiCall,
-*   {
-*     limit: 5,
-*     window: 60000,
-*     windowType: 'sliding',
-*   },
-*   (state) => ({ executionCount: state.executionCount })
-* );
-*
-* // Opt-in to track rejection count changes (optimized for tracking rate limit violations)
-* const rateLimiter = createRateLimiter(
-*   apiCall,
-*   {
-*     limit: 5,
-*     window: 60000,
-*     windowType: 'sliding',
-*   },
-*   (state) => ({ rejectionCount: state.rejectionCount })
-* );
-*
-* // Opt-in to track execution times changes (optimized for window calculations)
-* const rateLimiter = createRateLimiter(
-*   apiCall,
-*   {
-*     limit: 5,
-*     window: 60000,
-*     windowType: 'sliding',
-*   },
-*   (state) => ({ executionTimes: state.executionTimes })
-* );
-*
-* // Multiple state properties - track when any of these change
-* const rateLimiter = createRateLimiter(
-*   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 createRateLimiter(fn, options, selector = () => ({})) {
-	const mergedOptions = {
-		...require_PacerProvider.useDefaultPacerOptions().rateLimiter,
-		...options
-	};
-	const rateLimiter = new _tanstack_pacer_rate_limiter.RateLimiter(fn, mergedOptions);
-	rateLimiter.Subscribe = function Subscribe(props) {
-		const selected = (0, _tanstack_solid_store.useSelector)(rateLimiter.store, props.selector, { compare: _tanstack_solid_store.shallow });
-		return typeof props.children === "function" ? props.children(selected) : props.children;
-	};
-	const state = (0, _tanstack_solid_store.useSelector)(rateLimiter.store, selector, { compare: _tanstack_solid_store.shallow });
-	(0, solid_js.createEffect)(() => {
-		(0, solid_js.onCleanup)(() => {
-			if (mergedOptions.onUnmount) mergedOptions.onUnmount(rateLimiter);
-		});
-	});
-	return {
-		...rateLimiter,
-		state
-	};
-}
-
-//#endregion
-exports.createRateLimiter = createRateLimiter;
-//# sourceMappingURL=createRateLimiter.cjs.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"createRateLimiter.cjs","names":["useDefaultPacerOptions","RateLimiter","shallow"],"sources":["../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { createEffect, onCleanup } from 'solid-js'\nimport { shallow, useSelector } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor, JSX } from 'solid-js'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n  RateLimiterOptions,\n  RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\n\nexport interface SolidRateLimiterOptions<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends RateLimiterOptions<TFn> {\n  /**\n   * Optional callback invoked when the owning component unmounts. Receives the rate limiter instance.\n   * When provided, replaces the default cleanup; use it to call reset(), add logging, etc.\n   */\n  onUnmount?: (rateLimiter: SolidRateLimiter<TFn, TSelected>) => void\n}\n\nexport interface SolidRateLimiter<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<RateLimiter<TFn>, 'store'> {\n  /**\n   * A Solid component that allows you to subscribe to the rate limiter state.\n   *\n   * This is useful for tracking 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   *   {(state) => (\n   *     <div>Rejections: {state().rejectionCount}</div>\n   *   )}\n   * </rateLimiter.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: RateLimiterState) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) => JSX.Element\n  /**\n   * Reactive state that will be updated when the rate limiter state changes\n   *\n   * Use this instead of `rateLimiter.store.state`\n   */\n  readonly state: Accessor<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<RateLimiterState>>\n}\n\n/**\n * A low-level Solid 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 (createSignal, 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. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `rateLimiter.Subscribe` component (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` component 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 reactive updates\n * at the hook level, optimizing performance by preventing unnecessary updates 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` component. This prevents unnecessary\n * updates and gives you full control over when your component tracks state changes.\n *\n * Available state properties:\n * - `executionCount`: Number of function executions that have been completed\n * - `rejectionCount`: Number of function calls that were rejected due to rate limiting\n * - `remainingInWindow`: Number of executions remaining in the current window\n * - `nextWindowTime`: Timestamp when the next window begins\n * - `currentWindowStart`: Timestamp when the current window started\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const rateLimiter = createRateLimiter(apiCall, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding',\n * });\n *\n * // Subscribe to state changes deep in component tree using Subscribe component\n * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>\n *   {(state) => (\n *     <div>Rejections: {state().rejectionCount}</div>\n *   )}\n * </rateLimiter.Subscribe>\n *\n * // Opt-in to track execution count changes at hook level (optimized for tracking successful executions)\n * const rateLimiter = createRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to track rejection count changes (optimized for tracking rate limit violations)\n * const rateLimiter = createRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({ rejectionCount: state.rejectionCount })\n * );\n *\n * // Opt-in to track execution times changes (optimized for window calculations)\n * const rateLimiter = createRateLimiter(\n *   apiCall,\n *   {\n *     limit: 5,\n *     window: 60000,\n *     windowType: 'sliding',\n *   },\n *   (state) => ({ executionTimes: state.executionTimes })\n * );\n *\n * // Multiple state properties - track when any of these change\n * const rateLimiter = createRateLimiter(\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 createRateLimiter<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: SolidRateLimiterOptions<TFn, TSelected>,\n  selector: (state: RateLimiterState) => TSelected = () => ({}) as TSelected,\n): SolidRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().rateLimiter,\n    ...options,\n  } as SolidRateLimiterOptions<TFn, TSelected>\n  const rateLimiter = new RateLimiter<TFn>(\n    fn,\n    mergedOptions,\n  ) as unknown as SolidRateLimiter<TFn, TSelected>\n\n  rateLimiter.Subscribe = function Subscribe<TSelected>(props: {\n    selector: (state: RateLimiterState) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) {\n    const selected = useSelector(rateLimiter.store, props.selector, {\n      compare: shallow,\n    })\n\n    return typeof props.children === 'function'\n      ? props.children(selected)\n      : props.children\n  }\n\n  const state = useSelector(rateLimiter.store, selector, { compare: shallow })\n\n  createEffect(() => {\n    onCleanup(() => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(rateLimiter)\n      }\n    })\n  })\n\n  return {\n    ...rateLimiter,\n    state,\n  } as SolidRateLimiter<TFn, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwLA,SAAgB,kBACd,IACA,SACA,kBAA0D,EAAE,GAC1B;CAClC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CACD,MAAM,cAAc,IAAIC,yCACtB,IACA,cACD;CAED,YAAY,YAAY,SAAS,UAAqB,OAGnD;EACD,MAAM,kDAAuB,YAAY,OAAO,MAAM,UAAU,EAC9D,SAASC,+BACV,CAAC;EAEF,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;CAGZ,MAAM,+CAAoB,YAAY,OAAO,UAAU,EAAE,SAASA,+BAAS,CAAC;CAE5E,iCAAmB;EACjB,8BAAgB;GACd,IAAI,cAAc,WAChB,cAAc,UAAU,YAAY;IAEtC;GACF;CAEF,OAAO;EACL,GAAG;EACH;EACD"}