@tanstack/preact-pacer 0.0.1 → 0.19.0

package/dist/throttler/useThrottler.js

@@ -0,0 +1,133 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useEffect, useMemo, useState } from "preact/hooks";
+import { useStore } from "@tanstack/preact-store";
+import { Throttler } from "@tanstack/pacer/throttler";
+
+//#region src/throttler/useThrottler.ts
+/**
+* A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.
+*
+* This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that
+* you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that
+* integrates directly with Preact's useState, see useThrottledState.
+*
+* Throttling ensures a function executes at most once within a specified time window,
+* regardless of how many times it is called. This is useful for rate-limiting
+* expensive operations or UI updates.
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+* in two ways:
+*
+* **1. Using `throttler.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 function executions that have been completed
+* - `lastArgs`: The arguments from the most recent call to maybeExecute
+* - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
+* - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
+* - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
+* - `status`: Current execution status ('disabled' | 'idle' | 'pending')
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const [value, setValue] = useState(0);
+* const throttler = useThrottler(setValue, { wait: 1000 });
+*
+* // Subscribe to state changes deep in component tree using Subscribe HOC
+* <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>
+*   {({ isPending }) => (
+*     <div>{isPending ? 'Processing...' : 'Ready'}</div>
+*   )}
+* </throttler.Subscribe>
+*
+* // Opt-in to re-render when execution count changes at hook level (optimized for tracking executions)
+* const [value, setValue] = useState(0);
+* const throttler = useThrottler(
+*   setValue,
+*   { wait: 1000 },
+*   (state) => ({ executionCount: state.executionCount })
+* );
+*
+* // Opt-in to re-render when throttling state changes (optimized for loading indicators)
+* const [value, setValue] = useState(0);
+* const throttler = useThrottler(
+*   setValue,
+*   { wait: 1000 },
+*   (state) => ({
+*     isPending: state.isPending,
+*     status: state.status
+*   })
+* );
+*
+* // Opt-in to re-render when timing information changes (optimized for timing displays)
+* const [value, setValue] = useState(0);
+* const throttler = useThrottler(
+*   setValue,
+*   { wait: 1000 },
+*   (state) => ({
+*     lastExecutionTime: state.lastExecutionTime,
+*     nextExecutionTime: state.nextExecutionTime
+*   })
+* );
+*
+* // With any state manager
+* const throttler = useThrottler(
+*   (value) => stateManager.setState(value),
+*   {
+*     wait: 2000,
+*     leading: true,   // Execute immediately on first call
+*     trailing: false  // Skip trailing edge updates
+*   }
+* );
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { executionCount, isPending } = throttler.state;
+* ```
+*/
+function useThrottler(fn, options, selector = () => ({})) {
+	const mergedOptions = {
+		...useDefaultPacerOptions().throttler,
+		...options
+	};
+	const [throttler] = useState(() => {
+		const throttlerInstance = new Throttler(fn, mergedOptions);
+		throttlerInstance.Subscribe = function Subscribe(props) {
+			const selected = useStore(throttlerInstance.store, props.selector);
+			return typeof props.children === "function" ? props.children(selected) : props.children;
+		};
+		return throttlerInstance;
+	});
+	throttler.fn = fn;
+	throttler.setOptions(mergedOptions);
+	const state = useStore(throttler.store, selector);
+	useEffect(() => {
+		return () => {
+			throttler.cancel();
+		};
+	}, [throttler]);
+	return useMemo(() => ({
+		...throttler,
+		state
+	}), [throttler, state]);
+}
+
+//#endregion
+export { useThrottler };
+//# sourceMappingURL=useThrottler.js.map

package/dist/throttler/useThrottler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useThrottler.js","names":[],"sources":["../../src/throttler/useThrottler.ts"],"sourcesContent":["import { useEffect, useMemo, useState } from 'preact/hooks'\nimport { Throttler } from '@tanstack/pacer/throttler'\nimport { useStore } from '@tanstack/preact-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/preact-store'\nimport type { AnyFunction } from '@tanstack/pacer/types'\nimport type {\n  ThrottlerOptions,\n  ThrottlerState,\n} from '@tanstack/pacer/throttler'\nimport type { ComponentChildren } from 'preact'\n\nexport interface PreactThrottler<\n  TFn extends AnyFunction,\n  TSelected = {},\n> extends Omit<Throttler<TFn>, 'store'> {\n  /**\n   * A Preact HOC (Higher Order Component) that allows you to subscribe to the throttler state.\n   *\n   * This is useful for opting into state re-renders for specific parts of the throttler state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n   *   {({ isPending }) => (\n   *     <div>{isPending ? 'Loading...' : 'Ready'}</div>\n   *   )}\n   * </throttler.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: ThrottlerState<TFn>) => TSelected\n    children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n  }) => ComponentChildren\n  /**\n   * Reactive state that will be updated and re-rendered when the throttler state changes\n   *\n   * Use this instead of `throttler.store.state`\n   */\n  readonly state: Readonly<TSelected>\n  /**\n   * @deprecated Use `throttler.state` instead of `throttler.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<ThrottlerState<TFn>>>\n}\n\n/**\n * A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute.\n *\n * This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that\n * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc). For a simpler and higher-level hook that\n * integrates directly with Preact's useState, see useThrottledState.\n *\n * Throttling ensures a function executes at most once within a specified time window,\n * regardless of how many times it is called. This is useful for rate-limiting\n * expensive operations or UI updates.\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 `throttler.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 function executions that have been completed\n * - `lastArgs`: The arguments from the most recent call to maybeExecute\n * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds\n * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds\n * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution\n * - `status`: Current execution status ('disabled' | 'idle' | 'pending')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(setValue, { wait: 1000 });\n *\n * // Subscribe to state changes deep in component tree using Subscribe HOC\n * <throttler.Subscribe selector={(state) => ({ isPending: state.isPending })}>\n *   {({ isPending }) => (\n *     <div>{isPending ? 'Processing...' : 'Ready'}</div>\n *   )}\n * </throttler.Subscribe>\n *\n * // Opt-in to re-render when execution count changes at hook level (optimized for tracking executions)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({ executionCount: state.executionCount })\n * );\n *\n * // Opt-in to re-render when throttling state changes (optimized for loading indicators)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({\n *     isPending: state.isPending,\n *     status: state.status\n *   })\n * );\n *\n * // Opt-in to re-render when timing information changes (optimized for timing displays)\n * const [value, setValue] = useState(0);\n * const throttler = useThrottler(\n *   setValue,\n *   { wait: 1000 },\n *   (state) => ({\n *     lastExecutionTime: state.lastExecutionTime,\n *     nextExecutionTime: state.nextExecutionTime\n *   })\n * );\n *\n * // With any state manager\n * const throttler = useThrottler(\n *   (value) => stateManager.setState(value),\n *   {\n *     wait: 2000,\n *     leading: true,   // Execute immediately on first call\n *     trailing: false  // Skip trailing edge updates\n *   }\n * );\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { executionCount, isPending } = throttler.state;\n * ```\n */\nexport function useThrottler<TFn extends AnyFunction, TSelected = {}>(\n  fn: TFn,\n  options: ThrottlerOptions<TFn>,\n  selector: (state: ThrottlerState<TFn>) => TSelected = () => ({}) as TSelected,\n): PreactThrottler<TFn, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().throttler,\n    ...options,\n  } as ThrottlerOptions<TFn>\n\n  const [throttler] = useState(() => {\n    const throttlerInstance = new Throttler<TFn>(\n      fn,\n      mergedOptions,\n    ) as unknown as PreactThrottler<TFn, TSelected>\n\n    throttlerInstance.Subscribe = function Subscribe<TSelected>(props: {\n      selector: (state: ThrottlerState<TFn>) => TSelected\n      children: ((state: TSelected) => ComponentChildren) | ComponentChildren\n    }) {\n      const selected = useStore(throttlerInstance.store, props.selector)\n\n      return typeof props.children === 'function'\n        ? props.children(selected)\n        : props.children\n    }\n\n    return throttlerInstance\n  })\n\n  throttler.fn = fn\n  throttler.setOptions(mergedOptions)\n\n  const state = useStore(throttler.store, selector)\n\n  useEffect(() => {\n    return () => {\n      throttler.cancel()\n    }\n  }, [throttler])\n\n  return useMemo(\n    () =>\n      ({\n        ...throttler,\n        state,\n      }) as PreactThrottler<TFn, TSelected>, // omit `store` in favor of `state`\n    [throttler, state],\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgJA,SAAgB,aACd,IACA,SACA,kBAA6D,EAAE,GAC9B;CACjC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CAED,MAAM,CAAC,aAAa,eAAe;EACjC,MAAM,oBAAoB,IAAI,UAC5B,IACA,cACD;AAED,oBAAkB,YAAY,SAAS,UAAqB,OAGzD;GACD,MAAM,WAAW,SAAS,kBAAkB,OAAO,MAAM,SAAS;AAElE,UAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;AAGZ,SAAO;GACP;AAEF,WAAU,KAAK;AACf,WAAU,WAAW,cAAc;CAEnC,MAAM,QAAQ,SAAS,UAAU,OAAO,SAAS;AAEjD,iBAAgB;AACd,eAAa;AACX,aAAU,QAAQ;;IAEnB,CAAC,UAAU,CAAC;AAEf,QAAO,eAEF;EACC,GAAG;EACH;EACD,GACH,CAAC,WAAW,MAAM,CACnB"}

package/dist/types/index.cjs

@@ -0,0 +1,9 @@
+
+
+var _tanstack_pacer_types = require("@tanstack/pacer/types");
+Object.keys(_tanstack_pacer_types).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return _tanstack_pacer_types[k]; }
+  });
+});

package/dist/types/index.d.cts

@@ -0,0 +1 @@
+export * from "@tanstack/pacer/types";

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from "@tanstack/pacer/types";

package/dist/types/index.js

@@ -0,0 +1,3 @@
+export * from "@tanstack/pacer/types"
+
+export {  };

package/dist/utils/index.cjs

@@ -0,0 +1,9 @@
+
+
+var _tanstack_pacer_utils = require("@tanstack/pacer/utils");
+Object.keys(_tanstack_pacer_utils).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return _tanstack_pacer_utils[k]; }
+  });
+});

package/dist/utils/index.d.cts

@@ -0,0 +1 @@
+export * from "@tanstack/pacer/utils";

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export * from "@tanstack/pacer/utils";

package/dist/utils/index.js

@@ -0,0 +1,3 @@
+export * from "@tanstack/pacer/utils"
+
+export {  };

package/package.json

@@ -1,10 +1,121 @@
 {
   "name": "@tanstack/preact-pacer",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @tanstack/preact-pacer",
+  "version": "0.19.0",
+  "description": "Utilities for debouncing and throttling functions in Preact.",
+  "author": "Tanner Linsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TanStack/pacer.git",
+    "directory": "packages/preact-pacer"
+  },
+  "homepage": "https://tanstack.com/pacer",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "preact",
+    "debounce",
+    "throttle",
+    "rate-limit",
+    "queue",
+    "async"
+  ],
+  "type": "module",
+  "types": "./dist/index.d.cts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    },
+    "./async-batcher": {
+      "require": "./dist/async-batcher/index.cjs",
+      "import": "./dist/async-batcher/index.js"
+    },
+    "./async-debouncer": {
+      "require": "./dist/async-debouncer/index.cjs",
+      "import": "./dist/async-debouncer/index.js"
+    },
+    "./async-queuer": {
+      "require": "./dist/async-queuer/index.cjs",
+      "import": "./dist/async-queuer/index.js"
+    },
+    "./async-rate-limiter": {
+      "require": "./dist/async-rate-limiter/index.cjs",
+      "import": "./dist/async-rate-limiter/index.js"
+    },
+    "./async-retryer": {
+      "require": "./dist/async-retryer/index.cjs",
+      "import": "./dist/async-retryer/index.js"
+    },
+    "./async-throttler": {
+      "require": "./dist/async-throttler/index.cjs",
+      "import": "./dist/async-throttler/index.js"
+    },
+    "./batcher": {
+      "require": "./dist/batcher/index.cjs",
+      "import": "./dist/batcher/index.js"
+    },
+    "./debouncer": {
+      "require": "./dist/debouncer/index.cjs",
+      "import": "./dist/debouncer/index.js"
+    },
+    "./provider": {
+      "require": "./dist/provider/index.cjs",
+      "import": "./dist/provider/index.js"
+    },
+    "./queuer": {
+      "require": "./dist/queuer/index.cjs",
+      "import": "./dist/queuer/index.js"
+    },
+    "./rate-limiter": {
+      "require": "./dist/rate-limiter/index.cjs",
+      "import": "./dist/rate-limiter/index.js"
+    },
+    "./throttler": {
+      "require": "./dist/throttler/index.cjs",
+      "import": "./dist/throttler/index.js"
+    },
+    "./types": {
+      "require": "./dist/types/index.cjs",
+      "import": "./dist/types/index.js"
+    },
+    "./utils": {
+      "require": "./dist/utils/index.cjs",
+      "import": "./dist/utils/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@tanstack/preact-store": "^0.10.1",
+    "@tanstack/pacer": "0.17.0"
+  },
+  "devDependencies": {
+    "@preact/preset-vite": "^2.10.2",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "preact": "^10.28.0"
+  },
+  "peerDependencies": {
+    "preact": ">=10.0.0"
+  },
+  "scripts": {
+    "clean": "premove ./build ./dist",
+    "test:eslint": "eslint ./src",
+    "test:lib": "vitest --passWithNoTests",
+    "test:lib:dev": "pnpm test:lib --watch",
+    "test:types": "tsc",
+    "test:build": "publint --strict",
+    "build": "tsdown"
+  }
+}

package/src/async-batcher/index.ts

@@ -0,0 +1,4 @@
+export * from '@tanstack/pacer/async-batcher'
+
+export * from './useAsyncBatcher'
+export * from './useAsyncBatchedCallback'

package/src/async-batcher/useAsyncBatchedCallback.ts

@@ -0,0 +1,54 @@
+import { useCallback } from 'preact/hooks'
+import { useAsyncBatcher } from './useAsyncBatcher'
+import type { AsyncBatcherOptions } from '@tanstack/pacer/async-batcher'
+import type { AnyAsyncFunction } from '@tanstack/pacer/types'
+
+/**
+ * A Preact hook that creates a batched version of an async callback function.
+ * This hook is a convenient wrapper around the `useAsyncBatcher` hook,
+ * providing a stable, batched async function reference for use in Preact components.
+ *
+ * The batched async function will collect individual calls into batches and execute them
+ * when batch conditions are met (max size reached, wait time elapsed, or custom logic).
+ * The returned function always returns a promise that resolves with undefined (since the
+ * batch function processes multiple items together).
+ *
+ * This hook provides a simpler API compared to `useAsyncBatcher`, making it ideal for basic
+ * async batching needs. However, it does not expose the underlying AsyncBatcher instance.
+ *
+ * For advanced usage requiring features like:
+ * - Manual batch execution
+ * - Access to batch results and state
+ * - Custom useCallback dependencies
+ *
+ * Consider using the `useAsyncBatcher` hook instead.
+ *
+ * @example
+ * ```tsx
+ * // Batch API requests
+ * const batchApiCall = useAsyncBatchedCallback(async (requests: ApiRequest[]) => {
+ *   const results = await Promise.all(requests.map(req => fetch(req.url)));
+ *   return results.map(res => res.json());
+ * }, {
+ *   maxSize: 10,   // Process when 10 requests collected
+ *   wait: 1000     // Or after 1 second
+ * });
+ *
+ * // Use in event handlers
+ * <button onClick={() => batchApiCall({ url: '/api/analytics', data: eventData })}>
+ *   Track Event
+ * </button>
+ * ```
+ */
+export function useAsyncBatchedCallback<TFn extends AnyAsyncFunction>(
+  fn: (items: Array<Parameters<TFn>[0]>) => Promise<any>,
+  options: AsyncBatcherOptions<Parameters<TFn>[0]>,
+): (...args: Parameters<TFn>) => Promise<void> {
+  const asyncBatchedFn = useAsyncBatcher(fn, options).addItem
+  return useCallback(
+    async (...args: Parameters<TFn>) => {
+      asyncBatchedFn(args[0])
+    },
+    [asyncBatchedFn],
+  )
+}

package/src/async-batcher/useAsyncBatcher.ts

@@ -0,0 +1,249 @@
+import { useMemo, useState } from 'preact/hooks'
+import { AsyncBatcher } from '@tanstack/pacer/async-batcher'
+import { useStore } from '@tanstack/preact-store'
+import { useDefaultPacerOptions } from '../provider/PacerProvider'
+import type { Store } from '@tanstack/preact-store'
+import type {
+  AsyncBatcherOptions,
+  AsyncBatcherState,
+} from '@tanstack/pacer/async-batcher'
+import type { ComponentChildren } from 'preact'
+
+export interface PreactAsyncBatcher<TValue, TSelected = {}> extends Omit<
+  AsyncBatcher<TValue>,
+  'store'
+> {
+  /**
+   * A Preact HOC (Higher Order Component) that allows you to subscribe to the async batcher state.
+   *
+   * This is useful for opting into state re-renders for specific parts of the batcher state
+   * deep in your component tree without needing to pass a selector to the hook.
+   *
+   * @example
+   * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
+   *   {({ size }) => (
+   *     <div>Batch Size: {size}</div>
+   *   )}
+   * </batcher.Subscribe>
+   */
+  Subscribe: <TSelected>(props: {
+    selector: (state: AsyncBatcherState<TValue>) => TSelected
+    children: ((state: TSelected) => ComponentChildren) | ComponentChildren
+  }) => ComponentChildren
+  /**
+   * Reactive state that will be updated and re-rendered when the batcher state changes
+   *
+   * Use this instead of `batcher.store.state`
+   */
+  readonly state: Readonly<TSelected>
+  /**
+   * @deprecated Use `batcher.state` instead of `batcher.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<AsyncBatcherState<TValue>>>
+}
+
+/**
+ * A Preact hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items.
+ *
+ * This is the async version of the useBatcher hook. Unlike the sync version, this async batcher:
+ * - Handles promises and returns results from batch executions
+ * - Provides error handling with configurable error behavior
+ * - Tracks success, error, and settle counts separately
+ * - Has state tracking for when batches are executing
+ * - Returns the result of the batch function execution
+ *
+ * Features:
+ * - Configurable batch size and wait time
+ * - Custom batch processing logic via getShouldExecute
+ * - Event callbacks for monitoring batch operations
+ * - Error handling for failed batch operations
+ * - Automatic or manual batch processing
+ *
+ * The batcher collects items and processes them in batches based on:
+ * - Maximum batch size (number of items per batch)
+ * - Time-based batching (process after X milliseconds)
+ * - Custom batch processing logic via getShouldExecute
+ *
+ * Error Handling:
+ * - If an `onError` handler is provided, it will be called with the error and batcher instance
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
+ * - The error state can be checked using the underlying AsyncBatcher instance
+ *
+ * ## State Management and Selector
+ *
+ * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
+ * in two ways:
+ *
+ * **1. Using `batcher.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:
+ * - `errorCount`: Number of batch executions that have resulted in errors
+ * - `failedItems`: Array of items that failed during batch processing
+ * - `isEmpty`: Whether the batcher has no items to process
+ * - `isExecuting`: Whether a batch is currently being processed asynchronously
+ * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
+ * - `isRunning`: Whether the batcher is active and will process items automatically
+ * - `items`: Array of items currently queued for batch processing
+ * - `lastResult`: The result from the most recent batch execution
+ * - `settleCount`: Number of batch executions that have completed (success or error)
+ * - `size`: Number of items currently in the batch queue
+ * - `status`: Current processing status ('idle' | 'pending' | 'executing' | 'populated')
+ * - `successCount`: Number of batch executions that have completed successfully
+ * - `totalItemsProcessed`: Total number of items processed across all batches
+ * - `totalItemsFailed`: Total number of items that have failed processing
+ *
+ * @example
+ * ```tsx
+ * // Basic async batcher for API requests - no reactive state subscriptions
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   { maxSize: 10, wait: 2000 }
+ * );
+ *
+ * // Subscribe to state changes deep in component tree using Subscribe HOC
+ * <asyncBatcher.Subscribe selector={(state) => ({ size: state.size })}>
+ *   {({ size }) => (
+ *     <div>Batch Size: {size}</div>
+ *   )}
+ * </asyncBatcher.Subscribe>
+ *
+ * // Opt-in to re-render when execution state changes at hook level (optimized for loading indicators)
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   { maxSize: 10, wait: 2000 },
+ *   (state) => ({
+ *     isExecuting: state.isExecuting,
+ *     isPending: state.isPending,
+ *     status: state.status
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when results are available (optimized for data display)
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   { maxSize: 10, wait: 2000 },
+ *   (state) => ({
+ *     lastResult: state.lastResult,
+ *     successCount: state.successCount,
+ *     totalItemsProcessed: state.totalItemsProcessed
+ *   })
+ * );
+ *
+ * // Opt-in to re-render when error state changes (optimized for error handling)
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   {
+ *     maxSize: 10,
+ *     wait: 2000,
+ *     onError: (error) => console.error('Batch processing failed:', error)
+ *   },
+ *   (state) => ({
+ *     errorCount: state.errorCount,
+ *     failedItems: state.failedItems,
+ *     totalItemsFailed: state.totalItemsFailed
+ *   })
+ * );
+ *
+ * // Complete example with all callbacks
+ * const asyncBatcher = useAsyncBatcher(
+ *   async (items) => {
+ *     const results = await Promise.all(items.map(item => processItem(item)));
+ *     return results;
+ *   },
+ *   {
+ *     maxSize: 10,
+ *     wait: 2000,
+ *     onSuccess: (result) => {
+ *       console.log('Batch processed successfully:', result);
+ *     },
+ *     onError: (error) => {
+ *       console.error('Batch processing failed:', error);
+ *     }
+ *   }
+ * );
+ *
+ * // Add items to batch
+ * asyncBatcher.addItem(newItem);
+ *
+ * // Manually execute batch
+ * const result = await asyncBatcher.execute();
+ *
+ * // Access the selected state (will be empty object {} unless selector provided)
+ * const { isExecuting, lastResult, size } = asyncBatcher.state;
+ * ```
+ */
+export function useAsyncBatcher<TValue, TSelected = {}>(
+  fn: (items: Array<TValue>) => Promise<any>,
+  options: AsyncBatcherOptions<TValue> = {},
+  selector: (state: AsyncBatcherState<TValue>) => TSelected = () =>
+    ({}) as TSelected,
+): PreactAsyncBatcher<TValue, TSelected> {
+  const mergedOptions = {
+    ...useDefaultPacerOptions().asyncBatcher,
+    ...options,
+  } as AsyncBatcherOptions<TValue>
+
+  const [asyncBatcher] = useState(() => {
+    const batcherInstance = new AsyncBatcher<TValue>(
+      fn,
+      mergedOptions,
+    ) as unknown as PreactAsyncBatcher<TValue, TSelected>
+
+    batcherInstance.Subscribe = function Subscribe<TSelected>(props: {
+      selector: (state: AsyncBatcherState<TValue>) => TSelected
+      children: ((state: TSelected) => ComponentChildren) | ComponentChildren
+    }) {
+      const selected = useStore(batcherInstance.store, props.selector)
+
+      return typeof props.children === 'function'
+        ? props.children(selected)
+        : props.children
+    }
+
+    return batcherInstance
+  })
+
+  asyncBatcher.fn = fn
+  asyncBatcher.setOptions(mergedOptions)
+
+  const state = useStore(asyncBatcher.store, selector)
+
+  return useMemo(
+    () =>
+      ({
+        ...asyncBatcher,
+        state,
+      }) as PreactAsyncBatcher<TValue, TSelected>, // omit `store` in favor of `state`
+    [asyncBatcher, state],
+  )
+}

package/src/async-debouncer/index.ts

@@ -0,0 +1,5 @@
+// re-export everything from the core pacer package, BUT ONLY from the async-debouncer module
+export * from '@tanstack/pacer/async-debouncer'
+
+export * from './useAsyncDebouncer'
+export * from './useAsyncDebouncedCallback'