@tanstack/pacer 0.21.1 → 0.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/pacer",
-  "version": "0.21.1",
+  "version": "0.23.0",
   "description": "Utilities for debouncing, throttling, rate-limiting, queuing, and more.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -23,83 +23,35 @@
     "pacer"
   ],
   "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.cts",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    },
-    "./async-batcher": {
-      "import": "./dist/async-batcher.js",
-      "require": "./dist/async-batcher.cjs"
-    },
-    "./async-debouncer": {
-      "import": "./dist/async-debouncer.js",
-      "require": "./dist/async-debouncer.cjs"
-    },
-    "./async-queuer": {
-      "import": "./dist/async-queuer.js",
-      "require": "./dist/async-queuer.cjs"
-    },
-    "./async-rate-limiter": {
-      "import": "./dist/async-rate-limiter.js",
-      "require": "./dist/async-rate-limiter.cjs"
-    },
-    "./async-retryer": {
-      "import": "./dist/async-retryer.js",
-      "require": "./dist/async-retryer.cjs"
-    },
-    "./async-throttler": {
-      "import": "./dist/async-throttler.js",
-      "require": "./dist/async-throttler.cjs"
-    },
-    "./batcher": {
-      "import": "./dist/batcher.js",
-      "require": "./dist/batcher.cjs"
-    },
-    "./debouncer": {
-      "import": "./dist/debouncer.js",
-      "require": "./dist/debouncer.cjs"
-    },
-    "./event-client": {
-      "import": "./dist/event-client.js",
-      "require": "./dist/event-client.cjs"
-    },
-    "./queuer": {
-      "import": "./dist/queuer.js",
-      "require": "./dist/queuer.cjs"
-    },
-    "./rate-limiter": {
-      "import": "./dist/rate-limiter.js",
-      "require": "./dist/rate-limiter.cjs"
-    },
-    "./throttler": {
-      "import": "./dist/throttler.js",
-      "require": "./dist/throttler.cjs"
-    },
-    "./types": {
-      "import": "./dist/types.js",
-      "require": "./dist/types.cjs"
-    },
-    "./utils": {
-      "import": "./dist/utils.js",
-      "require": "./dist/utils.cjs"
-    },
+    ".": "./dist/index.js",
+    "./async-batcher": "./dist/async-batcher.js",
+    "./async-debouncer": "./dist/async-debouncer.js",
+    "./async-queuer": "./dist/async-queuer.js",
+    "./async-rate-limiter": "./dist/async-rate-limiter.js",
+    "./async-retryer": "./dist/async-retryer.js",
+    "./async-throttler": "./dist/async-throttler.js",
+    "./batcher": "./dist/batcher.js",
+    "./debouncer": "./dist/debouncer.js",
+    "./event-client": "./dist/event-client.js",
+    "./queuer": "./dist/queuer.js",
+    "./rate-limiter": "./dist/rate-limiter.js",
+    "./throttler": "./dist/throttler.js",
+    "./types": "./dist/types.js",
+    "./utils": "./dist/utils.js",
     "./package.json": "./package.json"
   },
   "sideEffects": false,
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "files": [
-    "dist/",
-    "src"
+    "dist"
   ],
   "dependencies": {
-    "@tanstack/devtools-event-client": "^0.4.3",
-    "@tanstack/store": "^0.11.0"
+    "@tanstack/devtools-event-client": "^0.5.0",
+    "@tanstack/store": "^0.11.1"
   },
   "scripts": {
     "clean": "premove ./build ./dist",
@@ -108,6 +60,7 @@
     "test:lib": "vitest",
     "test:lib:dev": "pnpm test:lib --watch",
     "test:types": "tsc",
-    "build": "tsdown"
+    "build": "tsdown",
+    "test:build": "publint --strict && node ../../scripts/verify-package.ts"
   }
 }

package/dist/async-batcher.cjs

@@ -1,337 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_utils = require('./utils.cjs');
-const require_event_client = require('./event-client.cjs');
-const require_async_retryer = require('./async-retryer.cjs');
-let _tanstack_store = require("@tanstack/store");
-
-//#region src/async-batcher.ts
-function getDefaultAsyncBatcherState() {
-	return {
-		errorCount: 0,
-		executeCount: 0,
-		failedItems: [],
-		isEmpty: true,
-		isExecuting: false,
-		isPending: false,
-		items: [],
-		lastResult: void 0,
-		settleCount: 0,
-		size: 0,
-		status: "idle",
-		successCount: 0,
-		totalItemsProcessed: 0,
-		totalItemsFailed: 0
-	};
-}
-/**
-* Utility function for sharing common `AsyncBatcherOptions` options between different `AsyncBatcher` instances.
-*
-*/
-function asyncBatcherOptions(options) {
-	return options;
-}
-const defaultOptions = {
-	asyncRetryerOptions: { maxAttempts: 1 },
-	getShouldExecute: () => false,
-	maxSize: Infinity,
-	started: true,
-	throwOnError: true,
-	wait: Infinity
-};
-/**
-* A class that collects items and processes them in batches asynchronously.
-*
-* Async vs Sync Versions:
-* The async version provides advanced features over the sync Batcher:
-* - Returns promises that can be awaited for batch results
-* - Built-in retry support via AsyncRetryer integration
-* - Abort support to cancel in-flight batch executions
-* - Cancel support to prevent pending batches from starting
-* - Comprehensive error handling with onError callbacks and throwOnError control
-* - Detailed execution tracking (success/error/settle counts)
-*
-* The sync Batcher is lighter weight and simpler when you don't need async features,
-* return values, or execution control.
-*
-* What is Batching?
-* Batching is a technique for grouping multiple operations together to be processed as a single unit.
-*
-* The AsyncBatcher provides a flexible way to implement async batching with configurable:
-* - Maximum batch size (number of items per batch)
-* - Time-based batching (process after X milliseconds)
-* - Custom batch processing logic via getShouldExecute
-* - Event callbacks for monitoring batch operations
-* - Error handling for failed batch operations
-*
-* Error Handling:
-* - If an `onError` handler is provided, it will be called with the error, the batch of items that failed, 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 AsyncBatcher instance
-*
-* State Management:
-* - Uses TanStack Store for reactive state management
-* - Use `initialState` to provide initial state values when creating the async batcher
-* - Use `onSuccess` callback to react to successful batch execution and implement custom logic
-* - Use `onError` callback to react to batch execution errors and implement custom error handling
-* - Use `onSettled` callback to react to batch execution completion (success or error) and implement custom logic
-* - Use `onExecute` callback to react to batch execution and implement custom logic
-* - Use `onItemsChange` callback to react to items being added or removed from the batcher
-* - The state includes total items processed, success/error counts, and execution status
-* - State can be accessed via `asyncBatcher.store.state` when using the class directly
-* - When using framework adapters (React/Solid), state is accessed from `asyncBatcher.state`
-*
-* @example
-* ```ts
-* const batcher = new AsyncBatcher<number>(
-*   async (items) => {
-*     const result = await processItems(items);
-*     console.log('Processing batch:', items);
-*     return result;
-*   },
-*   {
-*     maxSize: 5,
-*     wait: 2000,
-*     onSuccess: (result) => console.log('Batch succeeded:', result),
-*     onError: (error) => console.error('Batch failed:', error)
-*   }
-* );
-*
-* batcher.addItem(1);
-* batcher.addItem(2);
-* // After 2 seconds or when 5 items are added, whichever comes first,
-* // the batch will be processed and the result will be available
-* // batcher.execute() // manually trigger a batch
-* ```
-*/
-var AsyncBatcher = class {
-	#timeoutId;
-	constructor(fn, initialOptions) {
-		this.fn = fn;
-		this.store = new _tanstack_store.Store(getDefaultAsyncBatcherState());
-		this.asyncRetryers = /* @__PURE__ */ new Map();
-		this.#timeoutId = null;
-		this.setOptions = (newOptions) => {
-			this.options = {
-				...this.options,
-				...newOptions
-			};
-		};
-		this.#setState = (newState) => {
-			this.store.setState((state) => {
-				const combinedState = {
-					...state,
-					...newState
-				};
-				const { isExecuting, isPending, items } = combinedState;
-				const size = items.length;
-				const isEmpty = size === 0;
-				return {
-					...combinedState,
-					isEmpty,
-					size,
-					status: isExecuting ? "executing" : isPending ? "pending" : isEmpty ? "idle" : "populated"
-				};
-			});
-			require_event_client.emitChange("AsyncBatcher", this);
-		};
-		this.#getWait = () => {
-			return require_utils.parseFunctionOrValue(this.options.wait, this);
-		};
-		this.addItem = async (item) => {
-			this.#setState({
-				items: [...this.store.state.items, item],
-				isPending: this.options.wait !== Infinity
-			});
-			this.options.onItemsChange?.(this);
-			if (this.store.state.items.length >= this.options.maxSize || this.options.getShouldExecute(this.store.state.items, this)) return await this.#execute();
-			else if (this.options.wait !== Infinity) {
-				this.#clearTimeout();
-				this.#timeoutId = setTimeout(() => this.#execute(), this.#getWait());
-				await new Promise((resolve) => setTimeout(resolve, this.#getWait()));
-			}
-		};
-		this.#execute = async () => {
-			if (this.store.state.items.length === 0) return;
-			const currentExecuteCount = this.store.state.executeCount + 1;
-			const batch = this.peekAllItems();
-			this.clear();
-			this.options.onItemsChange?.(this);
-			this.#setState({
-				isExecuting: true,
-				executeCount: currentExecuteCount
-			});
-			try {
-				const currentAsyncRetryer = new require_async_retryer.AsyncRetryer(this.fn, this.options.asyncRetryerOptions);
-				this.asyncRetryers.set(currentExecuteCount, currentAsyncRetryer);
-				const result = await currentAsyncRetryer.execute(batch);
-				this.#setState({
-					totalItemsProcessed: this.store.state.totalItemsProcessed + batch.length,
-					lastResult: result,
-					successCount: this.store.state.successCount + 1
-				});
-				this.options.onSuccess?.(result, batch, this);
-				return result;
-			} catch (error) {
-				this.#setState({
-					errorCount: this.store.state.errorCount + 1,
-					failedItems: [...this.store.state.failedItems, ...batch],
-					totalItemsFailed: this.store.state.totalItemsFailed + batch.length
-				});
-				this.options.onError?.(error, batch, this);
-				if (this.options.throwOnError) throw error;
-				return;
-			} finally {
-				this.asyncRetryers.delete(currentExecuteCount);
-				this.#setState({
-					isExecuting: false,
-					settleCount: this.store.state.settleCount + 1
-				});
-				this.options.onSettled?.(batch, this);
-			}
-		};
-		this.flush = async () => {
-			this.#clearTimeout();
-			return await this.#execute();
-		};
-		this.peekAllItems = () => {
-			return [...this.store.state.items];
-		};
-		this.peekFailedItems = () => {
-			return [...this.store.state.failedItems];
-		};
-		this.#clearTimeout = () => {
-			if (this.#timeoutId) {
-				clearTimeout(this.#timeoutId);
-				this.#timeoutId = null;
-			}
-		};
-		this.clear = () => {
-			this.#setState({
-				items: [],
-				failedItems: [],
-				isPending: false
-			});
-		};
-		this.getAbortSignal = (executeCount) => {
-			const count = executeCount ?? this.store.state.executeCount;
-			return this.asyncRetryers.get(count)?.getAbortSignal() ?? null;
-		};
-		this.abort = () => {
-			this.asyncRetryers.forEach((retryer) => retryer.abort());
-			this.asyncRetryers.clear();
-			this.#setState({ isExecuting: false });
-		};
-		this.cancel = () => {
-			this.#clearTimeout();
-			this.#setState({ isPending: false });
-		};
-		this.reset = () => {
-			this.#setState(getDefaultAsyncBatcherState());
-			this.options.onItemsChange?.(this);
-			this.asyncRetryers.forEach((retryer) => retryer.reset());
-		};
-		this.key = initialOptions.key;
-		this.options = {
-			...defaultOptions,
-			...initialOptions,
-			throwOnError: initialOptions.throwOnError ?? !initialOptions.onError
-		};
-		this.#setState(this.options.initialState ?? {});
-		if (this.key) require_event_client.pacerEventClient.on("d-AsyncBatcher", (event) => {
-			if (event.payload.key !== this.key) return;
-			this.#setState(event.payload.store.state);
-			this.setOptions(event.payload.options);
-		});
-	}
-	#setState;
-	#getWait;
-	/**
-	* Processes the current batch of items asynchronously.
-	* This method will automatically be triggered if the batcher is running and any of these conditions are met:
-	* - The number of items reaches maxSize
-	* - The wait duration has elapsed
-	* - The getShouldExecute function returns true upon adding an item
-	*
-	* You can also call this method manually to process the current batch at any time.
-	*
-	* @returns A promise that resolves with the result of the batch function, or undefined if an error occurred and was handled by onError
-	* @throws The error from the batch function if no onError handler is configured or throwOnError is true
-	*/
-	#execute;
-	#clearTimeout;
-};
-/**
-* Creates an async batcher that processes items in batches.
-*
-* Async vs Sync Versions:
-* The async version provides advanced features over the sync batch function:
-* - Returns promises that can be awaited for batch results
-* - Built-in retry support via AsyncRetryer integration
-* - Abort support to cancel in-flight batch executions
-* - Cancel support to prevent pending batches from starting
-* - Comprehensive error handling with onError callbacks and throwOnError control
-* - Detailed execution tracking (success/error/settle counts)
-*
-* The sync batch function is lighter weight and simpler when you don't need async features,
-* return values, or execution control.
-*
-* What is Batching?
-* Batching is a technique for grouping multiple operations together to be processed as a single unit.
-*
-* Configuration Options:
-* - `maxSize`: Maximum number of items per batch (default: Infinity)
-* - `wait`: Time to wait before processing batch (default: Infinity)
-* - `getShouldExecute`: Custom logic to trigger batch processing
-* - `asyncRetryerOptions`: Configure retry behavior for batch executions
-* - `started`: Whether to start processing immediately (default: true)
-*
-* Error Handling:
-* - If an `onError` handler is provided, it will be called with the error, the batch of items that failed, 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:
-* - Uses TanStack Store for reactive state management
-* - Use `initialState` to provide initial state values when creating the async batcher
-* - Use `onSuccess` callback to react to successful batch execution and implement custom logic
-* - Use `onError` callback to react to batch execution errors and implement custom error handling
-* - Use `onSettled` callback to react to batch execution completion (success or error) and implement custom logic
-* - Use `onItemsChange` callback to react to items being added or removed from the batcher
-* - The state includes total items processed, success/error counts, and execution status
-* - State can be accessed via the underlying AsyncBatcher instance's `store.state` property
-* - When using framework adapters (React/Solid), state is accessed from the hook's state property
-*
-* @example
-* ```ts
-* const batchItems = asyncBatch<number>(
-*   async (items) => {
-*     const result = await processApiCall(items);
-*     console.log('Processing:', items);
-*     return result;
-*   },
-*   {
-*     maxSize: 3,
-*     wait: 1000,
-*     onSuccess: (result) => console.log('Batch succeeded:', result),
-*     onError: (error) => console.error('Batch failed:', error)
-*   }
-* );
-*
-* batchItems(1);
-* batchItems(2);
-* batchItems(3); // Triggers batch processing
-* ```
-*/
-function asyncBatch(fn, options) {
-	return new AsyncBatcher(fn, options).addItem;
-}
-
-//#endregion
-exports.AsyncBatcher = AsyncBatcher;
-exports.asyncBatch = asyncBatch;
-exports.asyncBatcherOptions = asyncBatcherOptions;
-//# sourceMappingURL=async-batcher.cjs.map

package/dist/async-batcher.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"async-batcher.cjs","names":["Store","parseFunctionOrValue","#setState","#execute","#clearTimeout","#timeoutId","#getWait","AsyncRetryer"],"sources":["../src/async-batcher.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { AsyncRetryer } from './async-retryer'\nimport { parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\nimport type { AsyncRetryerOptions } from './async-retryer'\nimport type { OptionalKeys } from './types'\n\nexport interface AsyncBatcherState<TValue> {\n  /**\n   * Number of batch executions that have resulted in errors\n   */\n  errorCount: number\n  /**\n   * Number of batch executions that have been executed\n   */\n  executeCount: number\n  /**\n   * Array of items that failed during batch processing\n   */\n  failedItems: Array<TValue>\n  /**\n   * Whether the batcher has no items to process (items array is empty)\n   */\n  isEmpty: boolean\n  /**\n   * Whether a batch is currently being processed asynchronously\n   */\n  isExecuting: boolean\n  /**\n   * Whether the batcher is waiting for the timeout to trigger batch processing\n   */\n  isPending: boolean\n  /**\n   * Array of items currently queued for batch processing\n   */\n  items: Array<TValue>\n  /**\n   * The result from the most recent batch execution\n   */\n  lastResult: any\n  /**\n   * Number of batch executions that have completed (either successfully or with errors)\n   */\n  settleCount: number\n  /**\n   * Number of items currently in the batch queue\n   */\n  size: number\n  /**\n   * Current processing status - 'idle' when not processing, 'pending' when waiting for timeout, 'executing' when processing, 'populated' when items are present, but no wait is configured\n   */\n  status: 'idle' | 'pending' | 'executing' | 'populated'\n  /**\n   * Number of batch executions that have completed successfully\n   */\n  successCount: number\n  /**\n   * Total number of items that have failed processing across all batches\n   */\n  totalItemsFailed: number\n  /**\n   * Total number of items that have been processed across all batches\n   */\n  totalItemsProcessed: number\n}\n\nfunction getDefaultAsyncBatcherState<TValue>(): AsyncBatcherState<TValue> {\n  return {\n    errorCount: 0,\n    executeCount: 0,\n    failedItems: [],\n    isEmpty: true,\n    isExecuting: false,\n    isPending: false,\n    items: [],\n    lastResult: undefined,\n    settleCount: 0,\n    size: 0,\n    status: 'idle',\n    successCount: 0,\n    totalItemsProcessed: 0,\n    totalItemsFailed: 0,\n  }\n}\n\n/**\n * Options for configuring an AsyncBatcher instance\n */\nexport interface AsyncBatcherOptions<TValue> {\n  /**\n   * Options for configuring the underlying async retryer\n   */\n  asyncRetryerOptions?: AsyncRetryerOptions<\n    (items: Array<TValue>) => Promise<any>\n  >\n  /**\n   * Custom function to determine if a batch should be processed\n   * Return true to process the batch immediately\n   */\n  getShouldExecute?: (\n    items: Array<TValue>,\n    batcher: AsyncBatcher<TValue>,\n  ) => boolean\n  /**\n   * Initial state for the async batcher\n   */\n  initialState?: Partial<AsyncBatcherState<TValue>>\n  /**\n   * Optional key to identify this async batcher instance.\n   * If provided, the async batcher will be identified by this key in the devtools and PacerProvider if applicable.\n   */\n  key?: string\n  /**\n   * Maximum number of items in a batch\n   * @default Infinity\n   */\n  maxSize?: number\n  /**\n   * Optional error handler for when the batch function throws.\n   * If provided, the handler will be called with the error, the batch of items that failed, and batcher instance.\n   * This can be used alongside throwOnError - the handler will be called before any error is thrown.\n   */\n  onError?: (\n    error: Error,\n    batch: Array<TValue>,\n    batcher: AsyncBatcher<TValue>,\n  ) => void\n  /**\n   * Callback fired after items are added to the batcher\n   */\n  onItemsChange?: (batcher: AsyncBatcher<TValue>) => void\n  /**\n   * Optional callback to call when a batch is settled (completed or failed)\n   */\n  onSettled?: (batch: Array<TValue>, batcher: AsyncBatcher<TValue>) => void\n  /**\n   * Optional callback to call when a batch succeeds\n   */\n  onSuccess?: (\n    result: any,\n    batch: Array<TValue>,\n    batcher: AsyncBatcher<TValue>,\n  ) => void\n  /**\n   * Whether the batcher should start processing immediately\n   * @default true\n   */\n  started?: boolean\n  /**\n   * Whether to throw errors when they occur.\n   * Defaults to true if no onError handler is provided, false if an onError handler is provided.\n   * Can be explicitly set to override these defaults.\n   */\n  throwOnError?: boolean\n  /**\n   * Maximum time in milliseconds to wait before processing a batch.\n   * If the wait duration has elapsed, the batch will be processed.\n   * If not provided, the batch will not be triggered by a timeout.\n   * @default Infinity\n   */\n  wait?: number | ((asyncBatcher: AsyncBatcher<TValue>) => number)\n}\n\n/**\n * Utility function for sharing common `AsyncBatcherOptions` options between different `AsyncBatcher` instances.\n *\n */\nexport function asyncBatcherOptions<\n  TValue = any,\n  TOptions extends Partial<AsyncBatcherOptions<TValue>> = Partial<\n    AsyncBatcherOptions<TValue>\n  >,\n>(options: TOptions): TOptions {\n  return options\n}\n\ntype AsyncBatcherOptionsWithOptionalCallbacks<TValue> = OptionalKeys<\n  Required<AsyncBatcherOptions<TValue>>,\n  | 'initialState'\n  | 'onError'\n  | 'onItemsChange'\n  | 'onSettled'\n  | 'onSuccess'\n  | 'key'\n>\n\nconst defaultOptions: AsyncBatcherOptionsWithOptionalCallbacks<any> = {\n  asyncRetryerOptions: {\n    maxAttempts: 1,\n  },\n  getShouldExecute: () => false,\n  maxSize: Infinity,\n  started: true,\n  throwOnError: true,\n  wait: Infinity,\n}\n\n/**\n * A class that collects items and processes them in batches asynchronously.\n *\n * Async vs Sync Versions:\n * The async version provides advanced features over the sync Batcher:\n * - Returns promises that can be awaited for batch results\n * - Built-in retry support via AsyncRetryer integration\n * - Abort support to cancel in-flight batch executions\n * - Cancel support to prevent pending batches from starting\n * - Comprehensive error handling with onError callbacks and throwOnError control\n * - Detailed execution tracking (success/error/settle counts)\n *\n * The sync Batcher is lighter weight and simpler when you don't need async features,\n * return values, or execution control.\n *\n * What is Batching?\n * Batching is a technique for grouping multiple operations together to be processed as a single unit.\n *\n * The AsyncBatcher provides a flexible way to implement async batching with configurable:\n * - Maximum batch size (number of items per batch)\n * - Time-based batching (process after X milliseconds)\n * - Custom batch processing logic via getShouldExecute\n * - Event callbacks for monitoring batch operations\n * - Error handling for failed batch operations\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error, the batch of items that failed, and batcher instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the AsyncBatcher instance\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the async batcher\n * - Use `onSuccess` callback to react to successful batch execution and implement custom logic\n * - Use `onError` callback to react to batch execution errors and implement custom error handling\n * - Use `onSettled` callback to react to batch execution completion (success or error) and implement custom logic\n * - Use `onExecute` callback to react to batch execution and implement custom logic\n * - Use `onItemsChange` callback to react to items being added or removed from the batcher\n * - The state includes total items processed, success/error counts, and execution status\n * - State can be accessed via `asyncBatcher.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `asyncBatcher.state`\n *\n * @example\n * ```ts\n * const batcher = new AsyncBatcher<number>(\n *   async (items) => {\n *     const result = await processItems(items);\n *     console.log('Processing batch:', items);\n *     return result;\n *   },\n *   {\n *     maxSize: 5,\n *     wait: 2000,\n *     onSuccess: (result) => console.log('Batch succeeded:', result),\n *     onError: (error) => console.error('Batch failed:', error)\n *   }\n * );\n *\n * batcher.addItem(1);\n * batcher.addItem(2);\n * // After 2 seconds or when 5 items are added, whichever comes first,\n * // the batch will be processed and the result will be available\n * // batcher.execute() // manually trigger a batch\n * ```\n */\nexport class AsyncBatcher<TValue> {\n  readonly store: Store<Readonly<AsyncBatcherState<TValue>>> = new Store(\n    getDefaultAsyncBatcherState<TValue>(),\n  )\n  key: string | undefined\n  options: AsyncBatcherOptionsWithOptionalCallbacks<TValue>\n  asyncRetryers = new Map<\n    number,\n    AsyncRetryer<(items: Array<TValue>) => Promise<any>>\n  >()\n  #timeoutId: ReturnType<typeof setTimeout> | null = null\n\n  constructor(\n    public fn: (items: Array<TValue>) => Promise<any>,\n    initialOptions: AsyncBatcherOptions<TValue>,\n  ) {\n    this.key = initialOptions.key\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n      throwOnError: initialOptions.throwOnError ?? !initialOptions.onError,\n    }\n    this.#setState(this.options.initialState ?? {})\n\n    if (this.key) {\n      pacerEventClient.on('d-AsyncBatcher', (event) => {\n        if (event.payload.key !== this.key) return\n        this.#setState(\n          event.payload.store.state as Partial<AsyncBatcherState<TValue>>,\n        )\n        this.setOptions(\n          event.payload.options as Partial<AsyncBatcherOptions<TValue>>,\n        )\n      })\n    }\n  }\n\n  /**\n   * Updates the async batcher options\n   */\n  setOptions = (newOptions: Partial<AsyncBatcherOptions<TValue>>): void => {\n    this.options = { ...this.options, ...newOptions }\n  }\n\n  #setState = (newState: Partial<AsyncBatcherState<TValue>>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      const { isExecuting, isPending, items } = combinedState\n      const size = items.length\n      const isEmpty = size === 0\n      return {\n        ...combinedState,\n        isEmpty,\n        size,\n        status: isExecuting\n          ? 'executing'\n          : isPending\n            ? 'pending'\n            : isEmpty\n              ? 'idle'\n              : 'populated',\n      }\n    })\n    emitChange('AsyncBatcher', this)\n  }\n\n  #getWait = (): number => {\n    return parseFunctionOrValue(this.options.wait, this)\n  }\n\n  /**\n   * Adds an item to the async batcher\n   * If the batch size is reached, timeout occurs, or shouldProcess returns true, the batch will be processed\n   *\n   * @returns The result from the batch function, or undefined if an error occurred and was handled by onError\n   *\n   * @throws The error from the batch function if no onError handler is configured or throwOnError is true\n   */\n  addItem = async (item: TValue): Promise<any> => {\n    this.#setState({\n      items: [...this.store.state.items, item],\n      isPending: this.options.wait !== Infinity,\n    })\n    this.options.onItemsChange?.(this)\n\n    const shouldProcess =\n      this.store.state.items.length >= this.options.maxSize ||\n      this.options.getShouldExecute(this.store.state.items, this)\n\n    if (shouldProcess) {\n      return await this.#execute()\n    } else if (this.options.wait !== Infinity) {\n      this.#clearTimeout() // clear any pending timeout to replace it with a new one\n      this.#timeoutId = setTimeout(() => this.#execute(), this.#getWait())\n      await new Promise((resolve) => setTimeout(resolve, this.#getWait()))\n    }\n  }\n\n  /**\n   * Processes the current batch of items asynchronously.\n   * This method will automatically be triggered if the batcher is running and any of these conditions are met:\n   * - The number of items reaches maxSize\n   * - The wait duration has elapsed\n   * - The getShouldExecute function returns true upon adding an item\n   *\n   * You can also call this method manually to process the current batch at any time.\n   *\n   * @returns A promise that resolves with the result of the batch function, or undefined if an error occurred and was handled by onError\n   * @throws The error from the batch function if no onError handler is configured or throwOnError is true\n   */\n  #execute = async (): Promise<any> => {\n    if (this.store.state.items.length === 0) {\n      return undefined\n    }\n\n    const currentExecuteCount = this.store.state.executeCount + 1\n    const batch = this.peekAllItems() // copy of the items to be processed (to prevent race conditions)\n    this.clear() // Clear items before processing to prevent race conditions\n    this.options.onItemsChange?.(this)\n\n    this.#setState({ isExecuting: true, executeCount: currentExecuteCount })\n\n    try {\n      const currentAsyncRetryer = new AsyncRetryer(\n        this.fn,\n        this.options.asyncRetryerOptions,\n      )\n      this.asyncRetryers.set(currentExecuteCount, currentAsyncRetryer)\n      const result = await currentAsyncRetryer.execute(batch) // EXECUTE\n      this.#setState({\n        totalItemsProcessed:\n          this.store.state.totalItemsProcessed + batch.length,\n        lastResult: result,\n        successCount: this.store.state.successCount + 1,\n      })\n      this.options.onSuccess?.(result, batch, this)\n      return result\n    } catch (error) {\n      this.#setState({\n        errorCount: this.store.state.errorCount + 1,\n        failedItems: [...this.store.state.failedItems, ...batch],\n        totalItemsFailed: this.store.state.totalItemsFailed + batch.length,\n      })\n      this.options.onError?.(error as Error, batch, this)\n      if (this.options.throwOnError) {\n        throw error\n      }\n      return undefined\n    } finally {\n      this.asyncRetryers.delete(currentExecuteCount) // dispose retryer\n      this.#setState({\n        isExecuting: false,\n        settleCount: this.store.state.settleCount + 1,\n      })\n      this.options.onSettled?.(batch, this)\n    }\n  }\n\n  /**\n   * Processes the current batch of items immediately\n   */\n  flush = async (): Promise<any> => {\n    this.#clearTimeout() // clear any pending timeout\n    return await this.#execute()\n  }\n\n  /**\n   * Returns a copy of all items in the async batcher\n   */\n  peekAllItems = (): Array<TValue> => {\n    return [...this.store.state.items]\n  }\n\n  peekFailedItems = (): Array<TValue> => {\n    return [...this.store.state.failedItems]\n  }\n\n  #clearTimeout = (): void => {\n    if (this.#timeoutId) {\n      clearTimeout(this.#timeoutId)\n      this.#timeoutId = null\n    }\n  }\n\n  /**\n   * Removes all items from the async batcher\n   */\n  clear = (): void => {\n    this.#setState({ items: [], failedItems: [], isPending: false })\n  }\n\n  /**\n   * Returns the AbortSignal for a specific execution.\n   * If no executeCount is provided, returns the signal for the most recent execution.\n   * Returns null if no execution is found or not currently executing.\n   *\n   * @param executeCount - Optional specific execution to get signal for\n   * @example\n   * ```typescript\n   * const batcher = new AsyncBatcher(\n   *   async (items: string[]) => {\n   *     const signal = batcher.getAbortSignal()\n   *     if (signal) {\n   *       const response = await fetch('/api/batch', {\n   *         method: 'POST',\n   *         body: JSON.stringify(items),\n   *         signal\n   *       })\n   *       return response.json()\n   *     }\n   *   },\n   *   { maxSize: 10, wait: 100 }\n   * )\n   * ```\n   */\n  getAbortSignal = (executeCount?: number): AbortSignal | null => {\n    const count = executeCount ?? this.store.state.executeCount\n    const retryer = this.asyncRetryers.get(count)\n    return retryer?.getAbortSignal() ?? null\n  }\n\n  /**\n   * Aborts all ongoing executions with the internal abort controllers.\n   * Does NOT cancel any pending execution that have not started yet.\n   * Does NOT clear out the items.\n   */\n  abort = (): void => {\n    this.asyncRetryers.forEach((retryer) => retryer.abort())\n    this.asyncRetryers.clear()\n    this.#setState({\n      isExecuting: false,\n    })\n  }\n\n  /**\n   * Cancels any pending execution that have not started yet.\n   * Does NOT abort any execution already in progress.\n   * Does NOT clear out the items.\n   */\n  cancel = (): void => {\n    this.#clearTimeout()\n    this.#setState({\n      isPending: false,\n    })\n  }\n\n  /**\n   * Resets the async batcher state to its default values\n   */\n  reset = (): void => {\n    this.#setState(getDefaultAsyncBatcherState<TValue>())\n    this.options.onItemsChange?.(this)\n    this.asyncRetryers.forEach((retryer) => retryer.reset())\n  }\n}\n\n/**\n * Creates an async batcher that processes items in batches.\n *\n * Async vs Sync Versions:\n * The async version provides advanced features over the sync batch function:\n * - Returns promises that can be awaited for batch results\n * - Built-in retry support via AsyncRetryer integration\n * - Abort support to cancel in-flight batch executions\n * - Cancel support to prevent pending batches from starting\n * - Comprehensive error handling with onError callbacks and throwOnError control\n * - Detailed execution tracking (success/error/settle counts)\n *\n * The sync batch function is lighter weight and simpler when you don't need async features,\n * return values, or execution control.\n *\n * What is Batching?\n * Batching is a technique for grouping multiple operations together to be processed as a single unit.\n *\n * Configuration Options:\n * - `maxSize`: Maximum number of items per batch (default: Infinity)\n * - `wait`: Time to wait before processing batch (default: Infinity)\n * - `getShouldExecute`: Custom logic to trigger batch processing\n * - `asyncRetryerOptions`: Configure retry behavior for batch executions\n * - `started`: Whether to start processing immediately (default: true)\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error, the batch of items that failed, and batcher instance\n * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown\n * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed\n * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown\n * - The error state can be checked using the underlying AsyncBatcher instance\n *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the async batcher\n * - Use `onSuccess` callback to react to successful batch execution and implement custom logic\n * - Use `onError` callback to react to batch execution errors and implement custom error handling\n * - Use `onSettled` callback to react to batch execution completion (success or error) and implement custom logic\n * - Use `onItemsChange` callback to react to items being added or removed from the batcher\n * - The state includes total items processed, success/error counts, and execution status\n * - State can be accessed via the underlying AsyncBatcher instance's `store.state` property\n * - When using framework adapters (React/Solid), state is accessed from the hook's state property\n *\n * @example\n * ```ts\n * const batchItems = asyncBatch<number>(\n *   async (items) => {\n *     const result = await processApiCall(items);\n *     console.log('Processing:', items);\n *     return result;\n *   },\n *   {\n *     maxSize: 3,\n *     wait: 1000,\n *     onSuccess: (result) => console.log('Batch succeeded:', result),\n *     onError: (error) => console.error('Batch failed:', error)\n *   }\n * );\n *\n * batchItems(1);\n * batchItems(2);\n * batchItems(3); // Triggers batch processing\n * ```\n */\nexport function asyncBatch<TValue>(\n  fn: (items: Array<TValue>) => Promise<any>,\n  options: AsyncBatcherOptions<TValue>,\n) {\n  const batcher = new AsyncBatcher<TValue>(fn, options)\n  return batcher.addItem\n}\n"],"mappings":";;;;;;;AAkEA,SAAS,8BAAiE;CACxE,OAAO;EACL,YAAY;EACZ,cAAc;EACd,aAAa,EAAE;EACf,SAAS;EACT,aAAa;EACb,WAAW;EACX,OAAO,EAAE;EACT,YAAY;EACZ,aAAa;EACb,MAAM;EACN,QAAQ;EACR,cAAc;EACd,qBAAqB;EACrB,kBAAkB;EACnB;;;;;;AAqFH,SAAgB,oBAKd,SAA6B;CAC7B,OAAO;;AAaT,MAAM,iBAAgE;CACpE,qBAAqB,EACnB,aAAa,GACd;CACD,wBAAwB;CACxB,SAAS;CACT,SAAS;CACT,cAAc;CACd,MAAM;CACP;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqED,IAAa,eAAb,MAAkC;CAUhC;CAEA,YACE,AAAO,IACP,gBACA;EAFO;eAZoD,IAAIA,sBAC/D,6BAAqC,CACtC;uCAGe,IAAI,KAGjB;oBACgD;qBA8BrC,eAA2D;GACvE,KAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;IAAY;;oBAGtC,aAAuD;GAClE,KAAK,MAAM,UAAU,UAAU;IAC7B,MAAM,gBAAgB;KACpB,GAAG;KACH,GAAG;KACJ;IACD,MAAM,EAAE,aAAa,WAAW,UAAU;IAC1C,MAAM,OAAO,MAAM;IACnB,MAAM,UAAU,SAAS;IACzB,OAAO;KACL,GAAG;KACH;KACA;KACA,QAAQ,cACJ,cACA,YACE,YACA,UACE,SACA;KACT;KACD;GACF,gCAAW,gBAAgB,KAAK;;wBAGT;GACvB,OAAOC,mCAAqB,KAAK,QAAQ,MAAM,KAAK;;iBAW5C,OAAO,SAA+B;GAC9C,KAAKC,UAAU;IACb,OAAO,CAAC,GAAG,KAAK,MAAM,MAAM,OAAO,KAAK;IACxC,WAAW,KAAK,QAAQ,SAAS;IAClC,CAAC;GACF,KAAK,QAAQ,gBAAgB,KAAK;GAMlC,IAHE,KAAK,MAAM,MAAM,MAAM,UAAU,KAAK,QAAQ,WAC9C,KAAK,QAAQ,iBAAiB,KAAK,MAAM,MAAM,OAAO,KAAK,EAG3D,OAAO,MAAM,KAAKC,UAAU;QACvB,IAAI,KAAK,QAAQ,SAAS,UAAU;IACzC,KAAKC,eAAe;IACpB,KAAKC,aAAa,iBAAiB,KAAKF,UAAU,EAAE,KAAKG,UAAU,CAAC;IACpE,MAAM,IAAI,SAAS,YAAY,WAAW,SAAS,KAAKA,UAAU,CAAC,CAAC;;;kBAgB7D,YAA0B;GACnC,IAAI,KAAK,MAAM,MAAM,MAAM,WAAW,GACpC;GAGF,MAAM,sBAAsB,KAAK,MAAM,MAAM,eAAe;GAC5D,MAAM,QAAQ,KAAK,cAAc;GACjC,KAAK,OAAO;GACZ,KAAK,QAAQ,gBAAgB,KAAK;GAElC,KAAKJ,UAAU;IAAE,aAAa;IAAM,cAAc;IAAqB,CAAC;GAExE,IAAI;IACF,MAAM,sBAAsB,IAAIK,mCAC9B,KAAK,IACL,KAAK,QAAQ,oBACd;IACD,KAAK,cAAc,IAAI,qBAAqB,oBAAoB;IAChE,MAAM,SAAS,MAAM,oBAAoB,QAAQ,MAAM;IACvD,KAAKL,UAAU;KACb,qBACE,KAAK,MAAM,MAAM,sBAAsB,MAAM;KAC/C,YAAY;KACZ,cAAc,KAAK,MAAM,MAAM,eAAe;KAC/C,CAAC;IACF,KAAK,QAAQ,YAAY,QAAQ,OAAO,KAAK;IAC7C,OAAO;YACA,OAAO;IACd,KAAKA,UAAU;KACb,YAAY,KAAK,MAAM,MAAM,aAAa;KAC1C,aAAa,CAAC,GAAG,KAAK,MAAM,MAAM,aAAa,GAAG,MAAM;KACxD,kBAAkB,KAAK,MAAM,MAAM,mBAAmB,MAAM;KAC7D,CAAC;IACF,KAAK,QAAQ,UAAU,OAAgB,OAAO,KAAK;IACnD,IAAI,KAAK,QAAQ,cACf,MAAM;IAER;aACQ;IACR,KAAK,cAAc,OAAO,oBAAoB;IAC9C,KAAKA,UAAU;KACb,aAAa;KACb,aAAa,KAAK,MAAM,MAAM,cAAc;KAC7C,CAAC;IACF,KAAK,QAAQ,YAAY,OAAO,KAAK;;;eAOjC,YAA0B;GAChC,KAAKE,eAAe;GACpB,OAAO,MAAM,KAAKD,UAAU;;4BAMM;GAClC,OAAO,CAAC,GAAG,KAAK,MAAM,MAAM,MAAM;;+BAGG;GACrC,OAAO,CAAC,GAAG,KAAK,MAAM,MAAM,YAAY;;6BAGd;GAC1B,IAAI,KAAKE,YAAY;IACnB,aAAa,KAAKA,WAAW;IAC7B,KAAKA,aAAa;;;qBAOF;GAClB,KAAKH,UAAU;IAAE,OAAO,EAAE;IAAE,aAAa,EAAE;IAAE,WAAW;IAAO,CAAC;;yBA2BhD,iBAA8C;GAC9D,MAAM,QAAQ,gBAAgB,KAAK,MAAM,MAAM;GAE/C,OADgB,KAAK,cAAc,IAAI,MACzB,EAAE,gBAAgB,IAAI;;qBAQlB;GAClB,KAAK,cAAc,SAAS,YAAY,QAAQ,OAAO,CAAC;GACxD,KAAK,cAAc,OAAO;GAC1B,KAAKA,UAAU,EACb,aAAa,OACd,CAAC;;sBAQiB;GACnB,KAAKE,eAAe;GACpB,KAAKF,UAAU,EACb,WAAW,OACZ,CAAC;;qBAMgB;GAClB,KAAKA,UAAU,6BAAqC,CAAC;GACrD,KAAK,QAAQ,gBAAgB,KAAK;GAClC,KAAK,cAAc,SAAS,YAAY,QAAQ,OAAO,CAAC;;EA/OxD,KAAK,MAAM,eAAe;EAC1B,KAAK,UAAU;GACb,GAAG;GACH,GAAG;GACH,cAAc,eAAe,gBAAgB,CAAC,eAAe;GAC9D;EACD,KAAKA,UAAU,KAAK,QAAQ,gBAAgB,EAAE,CAAC;EAE/C,IAAI,KAAK,KACP,sCAAiB,GAAG,mBAAmB,UAAU;GAC/C,IAAI,MAAM,QAAQ,QAAQ,KAAK,KAAK;GACpC,KAAKA,UACH,MAAM,QAAQ,MAAM,MACrB;GACD,KAAK,WACH,MAAM,QAAQ,QACf;IACD;;CAWN;CAyBA;;;;;;;;;;;;;CA4CA;CAmEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+IF,SAAgB,WACd,IACA,SACA;CAEA,OAAO,IADa,aAAqB,IAAI,QAC/B,CAAC"}