@tanstack/solid-pacer 0.15.3 → 0.16.1

package/dist/rate-limiter/createRateLimitedValue.cjs

@@ -0,0 +1,102 @@
+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

@@ -0,0 +1 @@
+{"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 { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type {\n  RateLimiterOptions,\n  RateLimiterState,\n} 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: RateLimiterOptions<Setter<TValue>>,\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;AAE5D,kCAAmB;AACjB,sBAAoB,OAAO,CAAQ;GACnC;AAEF,QAAO,CAAC,kBAAkB,YAAY"}

package/dist/{cjs/rate-limiter → rate-limiter}/createRateLimitedValue.d.cts

@@ -1,6 +1,9 @@
-import { SolidRateLimiter } from './createRateLimiter.cjs';
-import { Accessor, Setter } from 'solid-js';
-import { RateLimiterOptions, RateLimiterState } from '@tanstack/pacer/rate-limiter';
+import { SolidRateLimiter } from "./createRateLimiter.cjs";
+import { Accessor, Setter } from "solid-js";
+import { RateLimiterOptions, 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.
@@ -40,13 +43,9 @@ import { RateLimiterOptions, RateLimiterState } from '@tanstack/pacer/rate-limit
  * 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')
+ * - `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
@@ -57,21 +56,42 @@ import { RateLimiterOptions, RateLimiterState } from '@tanstack/pacer/rate-limit
  *   windowType: 'sliding'
  * });
  *
- * // Opt-in to reactive updates when limit state changes (optimized for UI feedback)
+ * // Opt-in to reactive updates when execution count changes (optimized for tracking successful updates)
  * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(
  *   rawValue,
- *   { limit: 5, window: 60000 },
- *   (state) => ({ isAtLimit: state.isAtLimit, remainingInWindow: state.remainingInWindow })
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ executionCount: state.executionCount })
  * );
  *
- * // Use the rate-limited value
- * console.log(rateLimitedValue()); // Access the current rate-limited value
+ * // 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 })
+ * );
  *
- * // Access rate limiter state via signals
- * console.log('Is at limit:', rateLimiter.state().isAtLimit);
+ * // 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`);
+ *   }
+ * });
  *
- * // Control the rate limiter
- * rateLimiter.reset(); // Reset the rate limit window
+ * // Access the selected rate limiter state (will be empty object {} unless selector provided)
+ * const { executionCount, rejectionCount } = rateLimiter.state;
  * ```
  */
-export declare function createRateLimitedValue<TValue, TSelected = {}>(value: Accessor<TValue>, initialOptions: RateLimiterOptions<Setter<TValue>>, selector?: (state: RateLimiterState) => TSelected): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>, TSelected>];
+declare function createRateLimitedValue<TValue, TSelected = {}>(value: Accessor<TValue>, initialOptions: RateLimiterOptions<Setter<TValue>>, selector?: (state: RateLimiterState) => TSelected): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>, TSelected>];
+//#endregion
+export { createRateLimitedValue };
+//# sourceMappingURL=createRateLimitedValue.d.cts.map

package/dist/{esm/rate-limiter → rate-limiter}/createRateLimitedValue.d.ts

@@ -1,6 +1,9 @@
-import { SolidRateLimiter } from './createRateLimiter.js';
-import { Accessor, Setter } from 'solid-js';
-import { RateLimiterOptions, RateLimiterState } from '@tanstack/pacer/rate-limiter';
+import { SolidRateLimiter } from "./createRateLimiter.js";
+import { Accessor, Setter } from "solid-js";
+import { RateLimiterOptions, 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.
@@ -40,13 +43,9 @@ import { RateLimiterOptions, RateLimiterState } from '@tanstack/pacer/rate-limit
  * 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')
+ * - `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
@@ -57,21 +56,42 @@ import { RateLimiterOptions, RateLimiterState } from '@tanstack/pacer/rate-limit
  *   windowType: 'sliding'
  * });
  *
- * // Opt-in to reactive updates when limit state changes (optimized for UI feedback)
+ * // Opt-in to reactive updates when execution count changes (optimized for tracking successful updates)
  * const [rateLimitedValue, rateLimiter] = createRateLimitedValue(
  *   rawValue,
- *   { limit: 5, window: 60000 },
- *   (state) => ({ isAtLimit: state.isAtLimit, remainingInWindow: state.remainingInWindow })
+ *   { limit: 5, window: 60000, windowType: 'sliding' },
+ *   (state) => ({ executionCount: state.executionCount })
  * );
  *
- * // Use the rate-limited value
- * console.log(rateLimitedValue()); // Access the current rate-limited value
+ * // 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 })
+ * );
  *
- * // Access rate limiter state via signals
- * console.log('Is at limit:', rateLimiter.state().isAtLimit);
+ * // 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`);
+ *   }
+ * });
  *
- * // Control the rate limiter
- * rateLimiter.reset(); // Reset the rate limit window
+ * // Access the selected rate limiter state (will be empty object {} unless selector provided)
+ * const { executionCount, rejectionCount } = rateLimiter.state;
  * ```
  */
-export declare function createRateLimitedValue<TValue, TSelected = {}>(value: Accessor<TValue>, initialOptions: RateLimiterOptions<Setter<TValue>>, selector?: (state: RateLimiterState) => TSelected): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>, TSelected>];
+declare function createRateLimitedValue<TValue, TSelected = {}>(value: Accessor<TValue>, initialOptions: RateLimiterOptions<Setter<TValue>>, selector?: (state: RateLimiterState) => TSelected): [Accessor<TValue>, SolidRateLimiter<Setter<TValue>, TSelected>];
+//#endregion
+export { createRateLimitedValue };
+//# sourceMappingURL=createRateLimitedValue.d.ts.map

package/dist/rate-limiter/createRateLimitedValue.js

@@ -0,0 +1,102 @@
+import { createRateLimitedSignal } from "./createRateLimitedSignal.js";
+import { createEffect } from "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] = createRateLimitedSignal(value(), initialOptions, selector);
+	createEffect(() => {
+		setRateLimitedValue(value());
+	});
+	return [rateLimitedValue, rateLimiter];
+}
+
+//#endregion
+export { createRateLimitedValue };
+//# sourceMappingURL=createRateLimitedValue.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createRateLimitedValue.js","names":[],"sources":["../../src/rate-limiter/createRateLimitedValue.ts"],"sourcesContent":["import { createEffect } from 'solid-js'\nimport { createRateLimitedSignal } from './createRateLimitedSignal'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type {\n  RateLimiterOptions,\n  RateLimiterState,\n} 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: RateLimiterOptions<Setter<TValue>>,\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;AAE5D,oBAAmB;AACjB,sBAAoB,OAAO,CAAQ;GACnC;AAEF,QAAO,CAAC,kBAAkB,YAAY"}

package/dist/rate-limiter/createRateLimiter.cjs

@@ -0,0 +1,95 @@
+const require_PacerProvider = require('../provider/PacerProvider.cjs');
+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. 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
+* - `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',
+*   onReject: (rateLimiter) => {
+*     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
+*   }
+* });
+*
+* // Opt-in to re-render when rate limit state changes (optimized for UI feedback)
+* const rateLimiter = createRateLimiter(
+*   apiCall,
+*   { limit: 5, window: 60000 },
+*   (state) => ({
+*     remainingInWindow: state.remainingInWindow,
+*     rejectionCount: state.rejectionCount
+*   })
+* );
+*
+* // Opt-in to re-render when execution metrics change (optimized for tracking progress)
+* const rateLimiter = createRateLimiter(
+*   apiCall,
+*   { limit: 5, window: 60000 },
+*   (state) => ({
+*     executionCount: state.executionCount,
+*     nextWindowTime: state.nextWindowTime
+*   })
+* );
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { remainingInWindow, rejectionCount } = rateLimiter.state();
+* ```
+*/
+function createRateLimiter(fn, options, selector = () => ({})) {
+	const rateLimiter = new __tanstack_pacer_rate_limiter.RateLimiter(fn, {
+		...require_PacerProvider.useDefaultPacerOptions().rateLimiter,
+		...options
+	});
+	const state = (0, __tanstack_solid_store.useStore)(rateLimiter.store, selector);
+	return {
+		...rateLimiter,
+		state
+	};
+}
+
+//#endregion
+exports.createRateLimiter = createRateLimiter;
+//# sourceMappingURL=createRateLimiter.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createRateLimiter.cjs","names":["RateLimiter","useDefaultPacerOptions"],"sources":["../../src/rate-limiter/createRateLimiter.ts"],"sourcesContent":["import { RateLimiter } from '@tanstack/pacer/rate-limiter'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor } 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 SolidRateLimiter<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<RateLimiter<TFn>, 'store'> {\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 `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 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. 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 * - `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 *   onReject: (rateLimiter) => {\n *     console.log(`Rate limit exceeded. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // Opt-in to re-render when rate limit state changes (optimized for UI feedback)\n * const rateLimiter = createRateLimiter(\n *   apiCall,\n *   { limit: 5, window: 60000 },\n *   (state) => ({\n *     remainingInWindow: state.remainingInWindow,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for tracking progress)\n * const rateLimiter = createRateLimiter(\n *   apiCall,\n *   { limit: 5, window: 60000 },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     nextWindowTime: state.nextWindowTime\n *   })\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { remainingInWindow, rejectionCount } = rateLimiter.state();\n * ```\n */\nexport function createRateLimiter<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: RateLimiterOptions<TFn>,\n  selector: (state: RateLimiterState) => TSelected = () => ({}) as TSelected,\n): SolidRateLimiter<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().rateLimiter,\n    ...options,\n  } as RateLimiterOptions<TFn>\n\n  const rateLimiter = new RateLimiter<TFn>(fn, mergedOptions)\n\n  const state = useStore(rateLimiter.store, selector)\n\n  return {\n    ...rateLimiter,\n    state,\n  } as SolidRateLimiter<TFn, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwGA,SAAgB,kBACd,IACA,SACA,kBAA0D,EAAE,GAC1B;CAMlC,MAAM,cAAc,IAAIA,0CAAiB,IALnB;EACpB,GAAGC,8CAAwB,CAAC;EAC5B,GAAG;EACJ,CAE0D;CAE3D,MAAM,6CAAiB,YAAY,OAAO,SAAS;AAEnD,QAAO;EACL,GAAG;EACH;EACD"}

package/dist/{cjs/rate-limiter → rate-limiter}/createRateLimiter.d.cts

@@ -1,20 +1,22 @@
-import { RateLimiter, RateLimiterOptions, RateLimiterState } from '@tanstack/pacer/rate-limiter';
-import { Store } from '@tanstack/solid-store';
-import { Accessor } from 'solid-js';
-import { AnyFunction } from '@tanstack/pacer/types';
-export interface SolidRateLimiter<TFn extends AnyFunction, TSelected = {}> extends Omit<RateLimiter<TFn>, 'store'> {
-    /**
-     * Reactive state that will be updated when the rate limiter state changes
-     *
-     * Use this instead of `rateLimiter.store.state`
-     */
-    readonly state: Accessor<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>>;
+import { Store } from "@tanstack/solid-store";
+import { Accessor } from "solid-js";
+import { AnyFunction } from "@tanstack/pacer/types";
+import { RateLimiter, RateLimiterOptions, RateLimiterState } from "@tanstack/pacer/rate-limiter";
+
+//#region src/rate-limiter/createRateLimiter.d.ts
+interface SolidRateLimiter<TFn extends AnyFunction, TSelected = {}> extends Omit<RateLimiter<TFn>, 'store'> {
+  /**
+   * Reactive state that will be updated when the rate limiter state changes
+   *
+   * Use this instead of `rateLimiter.store.state`
+   */
+  readonly state: Accessor<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 Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.
@@ -91,4 +93,7 @@ export interface SolidRateLimiter<TFn extends AnyFunction, TSelected = {}> exten
  * const { remainingInWindow, rejectionCount } = rateLimiter.state();
  * ```
  */
-export declare function createRateLimiter<TFn extends AnyFunction, TSelected = {}>(fn: TFn, initialOptions: RateLimiterOptions<TFn>, selector?: (state: RateLimiterState) => TSelected): SolidRateLimiter<TFn, TSelected>;
+declare function createRateLimiter<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: RateLimiterOptions<TFn>, selector?: (state: RateLimiterState) => TSelected): SolidRateLimiter<TFn, TSelected>;
+//#endregion
+export { SolidRateLimiter, createRateLimiter };
+//# sourceMappingURL=createRateLimiter.d.cts.map

package/dist/{esm/rate-limiter → rate-limiter}/createRateLimiter.d.ts

@@ -1,20 +1,22 @@
-import { RateLimiter, RateLimiterOptions, RateLimiterState } from '@tanstack/pacer/rate-limiter';
-import { Store } from '@tanstack/solid-store';
-import { Accessor } from 'solid-js';
-import { AnyFunction } from '@tanstack/pacer/types';
-export interface SolidRateLimiter<TFn extends AnyFunction, TSelected = {}> extends Omit<RateLimiter<TFn>, 'store'> {
-    /**
-     * Reactive state that will be updated when the rate limiter state changes
-     *
-     * Use this instead of `rateLimiter.store.state`
-     */
-    readonly state: Accessor<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>>;
+import { Accessor } from "solid-js";
+import { Store } from "@tanstack/solid-store";
+import { RateLimiter, RateLimiterOptions, RateLimiterState } from "@tanstack/pacer/rate-limiter";
+import { AnyFunction } from "@tanstack/pacer/types";
+
+//#region src/rate-limiter/createRateLimiter.d.ts
+interface SolidRateLimiter<TFn extends AnyFunction, TSelected = {}> extends Omit<RateLimiter<TFn>, 'store'> {
+  /**
+   * Reactive state that will be updated when the rate limiter state changes
+   *
+   * Use this instead of `rateLimiter.store.state`
+   */
+  readonly state: Accessor<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 Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution.
@@ -91,4 +93,7 @@ export interface SolidRateLimiter<TFn extends AnyFunction, TSelected = {}> exten
  * const { remainingInWindow, rejectionCount } = rateLimiter.state();
  * ```
  */
-export declare function createRateLimiter<TFn extends AnyFunction, TSelected = {}>(fn: TFn, initialOptions: RateLimiterOptions<TFn>, selector?: (state: RateLimiterState) => TSelected): SolidRateLimiter<TFn, TSelected>;
+declare function createRateLimiter<TFn extends AnyFunction, TSelected = {}>(fn: TFn, options: RateLimiterOptions<TFn>, selector?: (state: RateLimiterState) => TSelected): SolidRateLimiter<TFn, TSelected>;
+//#endregion
+export { SolidRateLimiter, createRateLimiter };
+//# sourceMappingURL=createRateLimiter.d.ts.map