@tanstack/preact-pacer 0.0.1 → 0.19.0

package/dist/queuer/useQueuer.d.ts

@@ -0,0 +1,166 @@
+import { ComponentChildren } from "preact";
+import { Store } from "@tanstack/preact-store";
+import { Queuer, QueuerOptions, QueuerState } from "@tanstack/pacer/queuer";
+
+//#region src/queuer/useQueuer.d.ts
+interface PreactQueuer<TValue, TSelected = {}> extends Omit<Queuer<TValue>, 'store'> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the queuer state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the queuer state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <queuer.Subscribe selector={(state) => ({ size: state.size })}>
+   *   {({ size }) => (
+   *     <div>Queue Size: {size}</div>
+   *   )}
+   * </queuer.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: QueuerState<TValue>) => TSelected;
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren;
+  }) => ComponentChildren;
+  /**
+   * Reactive state that will be updated and re-rendered when the queuer state changes
+   *
+   * Use this instead of `queuer.store.state`
+   */
+  readonly state: Readonly<TSelected>;
+  /**
+   * @deprecated Use `queuer.state` instead of `queuer.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<QueuerState<TValue>>>;
+}
+/**
+ * A Preact hook that creates and manages a Queuer instance.
+ *
+ * This is a lower-level hook that provides direct access to the Queuer's functionality without
+ * any built-in state management. This allows you to integrate it with any state management solution
+ * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.
+ *
+ * For a hook with built-in state management, see useQueuedState.
+ *
+ * The Queuer extends the base Queue to add processing capabilities. Items are processed
+ * synchronously in order, with optional delays between processing each item. The queuer includes
+ * an internal tick mechanism that can be started and stopped, making it useful as a scheduler.
+ * When started, it will process one item per tick, with an optional wait time between ticks.
+ *
+ * By default uses FIFO (First In First Out) behavior, but can be configured for LIFO
+ * (Last In First Out) by specifying 'front' position when adding items.
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+ * in two ways:
+ *
+ * **1. Using `queuer.Subscribe` HOC (Recommended for component tree subscriptions)**
+ *
+ * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
+ * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
+ * in child components.
+ *
+ * **2. Using the `selector` parameter (For hook-level subscriptions)**
+ *
+ * The `selector` parameter allows you to specify which state changes will trigger a re-render
+ * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
+ * state changes occur.
+ *
+ * **By default, there will be no reactive state subscriptions** and you must opt-in to state
+ * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
+ * re-renders and gives you full control over when your component updates.
+ *
+ * Available state properties:
+ * - `executionCount`: Number of items that have been processed by the queuer
+ * - `expirationCount`: Number of items that have been removed due to expiration
+ * - `isEmpty`: Whether the queuer has no items to process
+ * - `isFull`: Whether the queuer has reached its maximum capacity
+ * - `isIdle`: Whether the queuer is not currently processing any items
+ * - `isRunning`: Whether the queuer is active and will process items automatically
+ * - `items`: Array of items currently waiting to be processed
+ * - `itemTimestamps`: Timestamps when items were added for expiration tracking
+ * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
+ * - `rejectionCount`: Number of items that have been rejected from being added
+ * - `size`: Number of items currently in the queue
+ * - `status`: Current processing status ('idle' | 'running' | 'stopped')
+ *
+ * @example
+ * ```tsx
+ * // Default behavior - no reactive state subscriptions
+ * const queue = useQueuer(
+ *   (item) => console.log('Processing:', item),
+ *   { started: true, wait: 1000 }
+ * );
+ *
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <queue.Subscribe selector={(state) => ({ size: state.size })}>
+ *   {({ size }) => (
+ *     <div>Queue Size: {size}</div>
+ *   )}
+ * </queue.Subscribe>
+ *
+ * // Opt-in to re-render when queue size changes at hook level (optimized for displaying queue length)
+ * const queue = useQueuer(
+ *   (item) => console.log('Processing:', item),
+ *   { started: true, wait: 1000 },
+ *   (state) => ({
+ *     size: state.size,
+ *     isEmpty: state.isEmpty,
+ *     isFull: state.isFull
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when processing state changes (optimized for loading indicators)
+ * const queue = useQueuer(
+ *   (item) => console.log('Processing:', item),
+ *   { started: true, wait: 1000 },
+ *   (state) => ({
+ *     isRunning: state.isRunning,
+ *     isIdle: state.isIdle,
+ *     status: state.status,
+ *     pendingTick: state.pendingTick
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when execution metrics change (optimized for stats display)
+ * const queue = useQueuer(
+ *   (item) => console.log('Processing:', item),
+ *   { started: true, wait: 1000 },
+ *   (state) => ({
+ *     executionCount: state.executionCount,
+ *     expirationCount: state.expirationCount,
+ *     rejectionCount: state.rejectionCount
+ *   })
+ * );
+ *
+ * // Example with custom state management and scheduling
+ * const [items, setItems] = useState([]);
+ *
+ * const queue = useQueuer(
+ *   (item) => console.log('Processing:', item),
+ *   {
+ *     started: true, // Start processing immediately
+ *     wait: 1000,    // Process one item every second
+ *     onItemsChange: (queue) => setItems(queue.peekAllItems()),
+ *     getPriority: (item) => item.priority // Process higher priority items first
+ *   }
+ * );
+ *
+ * // Add items to process - they'll be handled automatically
+ * queue.addItem('task1');
+ * queue.addItem('task2');
+ *
+ * // Control the scheduler
+ * queue.stop();  // Pause processing
+ * queue.start(); // Resume processing
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { size, isRunning, executionCount } = queue.state;
+ * ```
+ */
+declare function useQueuer<TValue, TSelected = {}>(fn: (item: TValue) => void, options?: QueuerOptions<TValue>, selector?: (state: QueuerState<TValue>) => TSelected): PreactQueuer<TValue, TSelected>;
+//#endregion
+export { PreactQueuer, useQueuer };
+//# sourceMappingURL=useQueuer.d.ts.map

package/dist/queuer/useQueuer.js

@@ -0,0 +1,157 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useMemo, useState } from "preact/hooks";
+import { useStore } from "@tanstack/preact-store";
+import { Queuer } from "@tanstack/pacer/queuer";
+
+//#region src/queuer/useQueuer.ts
+/**
+* A Preact hook that creates and manages a Queuer instance.
+*
+* This is a lower-level hook that provides direct access to the Queuer's functionality without
+* any built-in state management. This allows you to integrate it with any state management solution
+* you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.
+*
+* For a hook with built-in state management, see useQueuedState.
+*
+* The Queuer extends the base Queue to add processing capabilities. Items are processed
+* synchronously in order, with optional delays between processing each item. The queuer includes
+* an internal tick mechanism that can be started and stopped, making it useful as a scheduler.
+* When started, it will process one item per tick, with an optional wait time between ticks.
+*
+* By default uses FIFO (First In First Out) behavior, but can be configured for LIFO
+* (Last In First Out) by specifying 'front' position when adding items.
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+* in two ways:
+*
+* **1. Using `queuer.Subscribe` HOC (Recommended for component tree subscriptions)**
+*
+* Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without
+* needing to pass a selector to the hook. This is ideal when you want to subscribe to state
+* in child components.
+*
+* **2. Using the `selector` parameter (For hook-level subscriptions)**
+*
+* The `selector` parameter allows you to specify which state changes will trigger a re-render
+* at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant
+* state changes occur.
+*
+* **By default, there will be no reactive state subscriptions** and you must opt-in to state
+* tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary
+* re-renders and gives you full control over when your component updates.
+*
+* Available state properties:
+* - `executionCount`: Number of items that have been processed by the queuer
+* - `expirationCount`: Number of items that have been removed due to expiration
+* - `isEmpty`: Whether the queuer has no items to process
+* - `isFull`: Whether the queuer has reached its maximum capacity
+* - `isIdle`: Whether the queuer is not currently processing any items
+* - `isRunning`: Whether the queuer is active and will process items automatically
+* - `items`: Array of items currently waiting to be processed
+* - `itemTimestamps`: Timestamps when items were added for expiration tracking
+* - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
+* - `rejectionCount`: Number of items that have been rejected from being added
+* - `size`: Number of items currently in the queue
+* - `status`: Current processing status ('idle' | 'running' | 'stopped')
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const queue = useQueuer(
+*   (item) => console.log('Processing:', item),
+*   { started: true, wait: 1000 }
+* );
+*
+* // Subscribe to state changes deep in component tree using Subscribe HOC
+* <queue.Subscribe selector={(state) => ({ size: state.size })}>
+*   {({ size }) => (
+*     <div>Queue Size: {size}</div>
+*   )}
+* </queue.Subscribe>
+*
+* // Opt-in to re-render when queue size changes at hook level (optimized for displaying queue length)
+* const queue = useQueuer(
+*   (item) => console.log('Processing:', item),
+*   { started: true, wait: 1000 },
+*   (state) => ({
+*     size: state.size,
+*     isEmpty: state.isEmpty,
+*     isFull: state.isFull
+*   })
+* );
+*
+* // Opt-in to re-render when processing state changes (optimized for loading indicators)
+* const queue = useQueuer(
+*   (item) => console.log('Processing:', item),
+*   { started: true, wait: 1000 },
+*   (state) => ({
+*     isRunning: state.isRunning,
+*     isIdle: state.isIdle,
+*     status: state.status,
+*     pendingTick: state.pendingTick
+*   })
+* );
+*
+* // Opt-in to re-render when execution metrics change (optimized for stats display)
+* const queue = useQueuer(
+*   (item) => console.log('Processing:', item),
+*   { started: true, wait: 1000 },
+*   (state) => ({
+*     executionCount: state.executionCount,
+*     expirationCount: state.expirationCount,
+*     rejectionCount: state.rejectionCount
+*   })
+* );
+*
+* // Example with custom state management and scheduling
+* const [items, setItems] = useState([]);
+*
+* const queue = useQueuer(
+*   (item) => console.log('Processing:', item),
+*   {
+*     started: true, // Start processing immediately
+*     wait: 1000,    // Process one item every second
+*     onItemsChange: (queue) => setItems(queue.peekAllItems()),
+*     getPriority: (item) => item.priority // Process higher priority items first
+*   }
+* );
+*
+* // Add items to process - they'll be handled automatically
+* queue.addItem('task1');
+* queue.addItem('task2');
+*
+* // Control the scheduler
+* queue.stop();  // Pause processing
+* queue.start(); // Resume processing
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { size, isRunning, executionCount } = queue.state;
+* ```
+*/
+function useQueuer(fn, options = {}, selector = () => ({})) {
+	const mergedOptions = {
+		...useDefaultPacerOptions().queuer,
+		...options
+	};
+	const [queuer] = useState(() => {
+		const queuerInstance = new Queuer(fn, mergedOptions);
+		queuerInstance.Subscribe = function Subscribe(props) {
+			const selected = useStore(queuerInstance.store, props.selector);
+			return typeof props.children === "function" ? props.children(selected) : props.children;
+		};
+		return queuerInstance;
+	});
+	queuer.fn = fn;
+	queuer.setOptions(mergedOptions);
+	const state = useStore(queuer.store, selector);
+	return useMemo(() => ({
+		...queuer,
+		state
+	}), [queuer, state]);
+}
+
+//#endregion
+export { useQueuer };
+//# sourceMappingURL=useQueuer.js.map

package/dist/queuer/useQueuer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useQueuer.js","names":[],"sources":["../../src/queuer/useQueuer.ts"],"sourcesContent":["import { useMemo, useState } from 'preact/hooks'\nimport { Queuer } from '@tanstack/pacer/queuer'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactQueuer<TValue, TSelected = {}> extends Omit<\n  Queuer<TValue>,\n  'store'\n> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the queuer state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the queuer state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <queuer.Subscribe selector={(state) => ({ size: state.size })}>\n   *   {({ size }) => (\n   *     <div>Queue Size: {size}</div>\n   *   )}\n   * </queuer.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: QueuerState<TValue>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the queuer state changes\n   *\n   * Use this instead of `queuer.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `queuer.state` instead of `queuer.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<QueuerState<TValue>>>\n}\n\n/**\n * A Preact hook that creates and manages a Queuer instance.\n *\n * This is a lower-level hook that provides direct access to the Queuer's functionality without\n * any built-in state management. This allows you to integrate it with any state management solution\n * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.\n *\n * For a hook with built-in state management, see useQueuedState.\n *\n * The Queuer extends the base Queue to add processing capabilities. Items are processed\n * synchronously in order, with optional delays between processing each item. The queuer includes\n * an internal tick mechanism that can be started and stopped, making it useful as a scheduler.\n * When started, it will process one item per tick, with an optional wait time between ticks.\n *\n * By default uses FIFO (First In First Out) behavior, but can be configured for LIFO\n * (Last In First Out) by specifying 'front' position when adding items.\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 `queuer.Subscribe` HOC (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` HOC to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger a re-render\n * at the hook level, optimizing performance by preventing unnecessary re-renders when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` HOC. This prevents unnecessary\n * re-renders and gives you full control over when your component updates.\n *\n * Available state properties:\n * - `executionCount`: Number of items that have been processed by the queuer\n * - `expirationCount`: Number of items that have been removed due to expiration\n * - `isEmpty`: Whether the queuer has no items to process\n * - `isFull`: Whether the queuer has reached its maximum capacity\n * - `isIdle`: Whether the queuer is not currently processing any items\n * - `isRunning`: Whether the queuer is active and will process items automatically\n * - `items`: Array of items currently waiting to be processed\n * - `itemTimestamps`: Timestamps when items were added for expiration tracking\n * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item\n * - `rejectionCount`: Number of items that have been rejected from being added\n * - `size`: Number of items currently in the queue\n * - `status`: Current processing status ('idle' | 'running' | 'stopped')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const queue = useQueuer(\n *   (item) => console.log('Processing:', item),\n *   { started: true, wait: 1000 }\n * );\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <queue.Subscribe selector={(state) => ({ size: state.size })}>\n *   {({ size }) => (\n *     <div>Queue Size: {size}</div>\n *   )}\n * </queue.Subscribe>\n *\n * // Opt-in to re-render when queue size changes at hook level (optimized for displaying queue length)\n * const queue = useQueuer(\n *   (item) => console.log('Processing:', item),\n *   { started: true, wait: 1000 },\n *   (state) => ({\n *     size: state.size,\n *     isEmpty: state.isEmpty,\n *     isFull: state.isFull\n *   })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const queue = useQueuer(\n *   (item) => console.log('Processing:', item),\n *   { started: true, wait: 1000 },\n *   (state) => ({\n *     isRunning: state.isRunning,\n *     isIdle: state.isIdle,\n *     status: state.status,\n *     pendingTick: state.pendingTick\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const queue = useQueuer(\n *   (item) => console.log('Processing:', item),\n *   { started: true, wait: 1000 },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     expirationCount: state.expirationCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Example with custom state management and scheduling\n * const [items, setItems] = useState([]);\n *\n * const queue = useQueuer(\n *   (item) => console.log('Processing:', item),\n *   {\n *     started: true, // Start processing immediately\n *     wait: 1000,    // Process one item every second\n *     onItemsChange: (queue) => setItems(queue.peekAllItems()),\n *     getPriority: (item) => item.priority // Process higher priority items first\n *   }\n * );\n *\n * // Add items to process - they'll be handled automatically\n * queue.addItem('task1');\n * queue.addItem('task2');\n *\n * // Control the scheduler\n * queue.stop();  // Pause processing\n * queue.start(); // Resume processing\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { size, isRunning, executionCount } = queue.state;\n * ```\n */\nexport function useQueuer<TValue, TSelected = {}>(\n  fn: (item: TValue) => void,\n  options: QueuerOptions<TValue> = {},\n  selector: (state: QueuerState<TValue>) => TSelected = () => ({}) as TSelected,\n): PreactQueuer<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().queuer,\n    ...options,\n  } as QueuerOptions<TValue>\n\n  const [queuer] = useState(() => {\n    const queuerInstance = new Queuer<TValue>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactQueuer<TValue, TSelected>\n\n    queuerInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: QueuerState<TValue>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(queuerInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return queuerInstance\n  })\n\n  queuer.fn = fn\n  queuer.setOptions(mergedOptions)\n\n  const state = useStore(queuer.store, selector)\n\n  return useMemo(\n    () =>\n      ({\n        ...queuer,\n        state,\n      }) as PreactQueuer<TValue, TSelected>, // omit `store` in favor of `state`\n    [queuer, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyKA,SAAgB,UACd,IACA,UAAiC,EAAE,EACnC,kBAA6D,EAAE,GAC9B;CACjC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,UAAU,eAAe;EAC9B,MAAM,iBAAiB,IAAI,OACzB,IACA,cACD;AAED,iBAAe,YAAY,SAAS,UAAqB,OAGtD;GACD,MAAM,WAAW,SAAS,eAAe,OAAO,MAAM,SAAS;AAE/D,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,QAAO,KAAK;AACZ,QAAO,WAAW,cAAc;CAEhC,MAAM,QAAQ,SAAS,OAAO,OAAO,SAAS;AAE9C,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,QAAQ,MAAM,CAChB"}

package/dist/rate-limiter/index.cjs

@@ -0,0 +1,16 @@
+const require_useRateLimiter = require('./useRateLimiter.cjs');
+const require_useRateLimitedCallback = require('./useRateLimitedCallback.cjs');
+const require_useRateLimitedState = require('./useRateLimitedState.cjs');
+const require_useRateLimitedValue = require('./useRateLimitedValue.cjs');
+
+exports.useRateLimitedCallback = require_useRateLimitedCallback.useRateLimitedCallback;
+exports.useRateLimitedState = require_useRateLimitedState.useRateLimitedState;
+exports.useRateLimitedValue = require_useRateLimitedValue.useRateLimitedValue;
+exports.useRateLimiter = require_useRateLimiter.useRateLimiter;
+var _tanstack_pacer_rate_limiter = require("@tanstack/pacer/rate-limiter");
+Object.keys(_tanstack_pacer_rate_limiter).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return _tanstack_pacer_rate_limiter[k]; }
+  });
+});

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

@@ -0,0 +1,6 @@
+import { useRateLimitedCallback } from "./useRateLimitedCallback.cjs";
+import { PreactRateLimiter, useRateLimiter } from "./useRateLimiter.cjs";
+import { useRateLimitedState } from "./useRateLimitedState.cjs";
+import { useRateLimitedValue } from "./useRateLimitedValue.cjs";
+export * from "@tanstack/pacer/rate-limiter";
+export { PreactRateLimiter, useRateLimitedCallback, useRateLimitedState, useRateLimitedValue, useRateLimiter };

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

@@ -0,0 +1,6 @@
+import { useRateLimitedCallback } from "./useRateLimitedCallback.js";
+import { PreactRateLimiter, useRateLimiter } from "./useRateLimiter.js";
+import { useRateLimitedState } from "./useRateLimitedState.js";
+import { useRateLimitedValue } from "./useRateLimitedValue.js";
+export * from "@tanstack/pacer/rate-limiter";
+export { PreactRateLimiter, useRateLimitedCallback, useRateLimitedState, useRateLimitedValue, useRateLimiter };

package/dist/rate-limiter/index.js

@@ -0,0 +1,8 @@
+import { useRateLimiter } from "./useRateLimiter.js";
+import { useRateLimitedCallback } from "./useRateLimitedCallback.js";
+import { useRateLimitedState } from "./useRateLimitedState.js";
+import { useRateLimitedValue } from "./useRateLimitedValue.js";
+
+export * from "@tanstack/pacer/rate-limiter"
+
+export { useRateLimitedCallback, useRateLimitedState, useRateLimitedValue, useRateLimiter };

package/dist/rate-limiter/useRateLimitedCallback.cjs

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"useRateLimitedCallback.cjs","names":["useRateLimiter"],"sources":["../../src/rate-limiter/useRateLimitedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useRateLimiter } from './useRateLimiter'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A Preact hook that creates a rate-limited version of a callback function.\n * This hook is essentially a wrapper around the basic `rateLimiter` function\n * that is exported from `@tanstack/pacer`,\n * but optimized for Preact with reactive options and a stable function reference.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all calls until the limit\n * is reached, then blocks subsequent calls until the window resets. Unlike throttling\n * or debouncing, it does not attempt to space out or intelligently collapse calls.\n * This can lead to bursts of rapid executions followed by periods where all calls\n * are blocked.\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, consider:\n * - useThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)\n * - useDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits,\n * like API rate limits or other scenarios requiring hard caps on execution frequency.\n *\n * This hook provides a simpler API compared to `useRateLimiter`, making it ideal for basic\n * rate limiting needs. However, it does not expose the underlying RateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useRateLimiter` hook instead.\n *\n * @example\n * ```tsx\n * // Rate limit API calls to maximum 5 calls per minute with a sliding window\n * const makeApiCall = useRateLimitedCallback(\n *   (data: ApiData) => {\n *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n *   },\n *   {\n *     limit: 5,\n *     window: 60000, // 1 minute\n *     windowType: 'sliding',\n *     onReject: () => {\n *       console.warn('API rate limit reached. Please wait before trying again.');\n *     }\n *   }\n * );\n * ```\n */\nexport function useRateLimitedCallback<TFn extends AnyFunction>(\n  fn: TFn,\n  options: RateLimiterOptions<TFn>,\n): (...args: Parameters<TFn>) => boolean {\n  const rateLimitedFn = useRateLimiter(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) => rateLimitedFn(...args),\n    [rateLimitedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgB,uBACd,IACA,SACuC;CACvC,MAAM,gBAAgBA,sCAAe,IAAI,QAAQ,CAAC;AAClD,uCACG,GAAG,SAA0B,cAAc,GAAG,KAAK,EACpD,CAAC,cAAc,CAChB"}

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

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

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

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

package/dist/rate-limiter/useRateLimitedCallback.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"useRateLimitedCallback.js","names":[],"sources":["../../src/rate-limiter/useRateLimitedCallback.ts"],"sourcesContent":["import { useCallback } from 'preact/hooks'\nimport { useRateLimiter } from './useRateLimiter'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type { RateLimiterOptions } from '@tanstack/pacer/rate-limiter'\n\n/**\n * A Preact hook that creates a rate-limited version of a callback function.\n * This hook is essentially a wrapper around the basic `rateLimiter` function\n * that is exported from `@tanstack/pacer`,\n * but optimized for Preact with reactive options and a stable function reference.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all calls until the limit\n * is reached, then blocks subsequent calls until the window resets. Unlike throttling\n * or debouncing, it does not attempt to space out or intelligently collapse calls.\n * This can lead to bursts of rapid executions followed by periods where all calls\n * are blocked.\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, consider:\n * - useThrottledCallback: When you want consistent spacing between executions (e.g. UI updates)\n * - useDebouncedCallback: When you want to collapse rapid calls into a single execution (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits,\n * like API rate limits or other scenarios requiring hard caps on execution frequency.\n *\n * This hook provides a simpler API compared to `useRateLimiter`, making it ideal for basic\n * rate limiting needs. However, it does not expose the underlying RateLimiter instance.\n *\n * For advanced usage requiring features like:\n * - Manual cancellation\n * - Access to execution counts\n * - Custom useCallback dependencies\n *\n * Consider using the `useRateLimiter` hook instead.\n *\n * @example\n * ```tsx\n * // Rate limit API calls to maximum 5 calls per minute with a sliding window\n * const makeApiCall = useRateLimitedCallback(\n *   (data: ApiData) => {\n *     return fetch('/api/endpoint', { method: 'POST', body: JSON.stringify(data) });\n *   },\n *   {\n *     limit: 5,\n *     window: 60000, // 1 minute\n *     windowType: 'sliding',\n *     onReject: () => {\n *       console.warn('API rate limit reached. Please wait before trying again.');\n *     }\n *   }\n * );\n * ```\n */\nexport function useRateLimitedCallback<TFn extends AnyFunction>(\n  fn: TFn,\n  options: RateLimiterOptions<TFn>,\n): (...args: Parameters<TFn>) => boolean {\n  const rateLimitedFn = useRateLimiter(fn, options).maybeExecute\n  return useCallback(\n    (...args: Parameters<TFn>) => rateLimitedFn(...args),\n    [rateLimitedFn],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0DA,SAAgB,uBACd,IACA,SACuC;CACvC,MAAM,gBAAgB,eAAe,IAAI,QAAQ,CAAC;AAClD,QAAO,aACJ,GAAG,SAA0B,cAAc,GAAG,KAAK,EACpD,CAAC,cAAc,CAChB"}