@tanstack/pacer 0.16.2 → 0.16.4

package/dist/async-throttler.js

@@ -0,0 +1,360 @@
+import { parseFunctionOrValue } from "./utils.js";
+import { emitChange, pacerEventClient } from "./event-client.js";
+import { AsyncRetryer } from "./async-retryer.js";
+import { Store } from "@tanstack/store";
+
+//#region src/async-throttler.ts
+function getDefaultAsyncThrottlerState() {
+	return {
+		errorCount: 0,
+		isExecuting: false,
+		isPending: false,
+		lastArgs: void 0,
+		lastExecutionTime: 0,
+		lastResult: void 0,
+		maybeExecuteCount: 0,
+		nextExecutionTime: void 0,
+		settleCount: 0,
+		status: "idle",
+		successCount: 0
+	};
+}
+/**
+* Utility function for sharing common `AsyncThrottlerOptions` options between different `AsyncThrottler` instances.
+*/
+function asyncThrottlerOptions(options) {
+	return options;
+}
+const defaultOptions = {
+	asyncRetryerOptions: { maxAttempts: 1 },
+	enabled: true,
+	leading: true,
+	trailing: true,
+	wait: 0
+};
+/**
+* A class that creates an async throttled function.
+*
+* Async vs Sync Versions:
+* The async version provides advanced features over the sync Throttler:
+* - Returns promises that can be awaited for throttled function results
+* - Built-in retry support via AsyncRetryer integration
+* - Abort support to cancel in-flight executions
+* - Cancel support to prevent pending executions from starting
+* - Comprehensive error handling with onError callbacks and throwOnError control
+* - Detailed execution tracking (success/error/settle counts)
+* - Waits for ongoing executions to complete before scheduling the next one
+*
+* The sync Throttler is lighter weight and simpler when you don't need async features,
+* return values, or execution control.
+*
+* What is Throttling?
+* Throttling limits how often a function can be executed, allowing only one execution within a specified time window.
+* Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a
+* regular interval regardless of how often it's called.
+*
+* This is useful for rate-limiting API calls, handling scroll/resize events, or any scenario where you want to
+* ensure a maximum execution frequency.
+*
+* Error Handling:
+* - If an `onError` handler is provided, it will be called with the error and throttler 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 AsyncThrottler instance
+*
+* State Management:
+* - Uses TanStack Store for reactive state management
+* - Use `initialState` to provide initial state values when creating the async throttler
+* - Use `onSuccess` callback to react to successful function execution and implement custom logic
+* - Use `onError` callback to react to function execution errors and implement custom error handling
+* - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic
+* - The state includes error count, execution status, last execution time, and success/settle counts
+* - State can be accessed via `asyncThrottler.store.state` when using the class directly
+* - When using framework adapters (React/Solid), state is accessed from `asyncThrottler.state`
+*
+* @example
+* ```ts
+* const throttler = new AsyncThrottler(async (value: string) => {
+*   const result = await saveToAPI(value);
+*   return result; // Return value is preserved
+* }, {
+*   wait: 1000,
+*   onError: (error) => {
+*     console.error('API call failed:', error);
+*   }
+* });
+*
+* // Will only execute once per second no matter how often called
+* // Returns the API response directly
+* const result = await throttler.maybeExecute(inputElement.value);
+* ```
+*/
+var AsyncThrottler = class {
+	#timeoutId = null;
+	#resolvePreviousPromise = null;
+	constructor(fn, initialOptions) {
+		this.fn = fn;
+		this.store = new Store(getDefaultAsyncThrottlerState());
+		this.asyncRetryers = /* @__PURE__ */ new Map();
+		this.setOptions = (newOptions) => {
+			this.options = {
+				...this.options,
+				...newOptions
+			};
+			if (!this.#getEnabled()) this.cancel();
+		};
+		this.maybeExecute = async (...args) => {
+			if (!this.#getEnabled()) return void 0;
+			this.#resolvePreviousPromiseInternal();
+			this.#setState({
+				maybeExecuteCount: this.store.state.maybeExecuteCount + 1,
+				lastArgs: args
+			});
+			const wait = this.#getWait();
+			const thisMaybeExecuteNumber = this.store.state.maybeExecuteCount;
+			for (let maxNumIterations = wait / 10; this.store.state.isExecuting && maxNumIterations > 0; maxNumIterations--) {
+				await new Promise((resolve) => setTimeout(resolve, 10));
+				if (this.store.state.maybeExecuteCount !== thisMaybeExecuteNumber) return this.store.state.lastResult;
+			}
+			const now = Date.now();
+			const timeSinceLastExecution = now - this.store.state.lastExecutionTime;
+			if (this.options.leading && !this.store.state.isPending && timeSinceLastExecution >= wait) await this.#execute(...args);
+			else if (this.options.trailing) {
+				this.cancel();
+				this.#setState({ isPending: true });
+				return new Promise((resolve, reject) => {
+					this.#resolvePreviousPromise = resolve;
+					const newTimeSinceLastExecution = this.store.state.lastExecutionTime ? now - this.store.state.lastExecutionTime : 0;
+					const timeoutDuration = Math.max(0, wait - newTimeSinceLastExecution);
+					this.#timeoutId = setTimeout(async () => {
+						this.#clearTimeout();
+						if (this.store.state.lastArgs !== void 0) try {
+							await this.#execute(...this.store.state.lastArgs);
+						} catch (error) {
+							reject(error);
+						}
+						this.#resolvePreviousPromise = null;
+						resolve(this.store.state.lastResult);
+					}, timeoutDuration);
+				});
+			}
+			return this.store.state.lastResult;
+		};
+		this.flush = async () => {
+			if (this.store.state.isPending && this.store.state.lastArgs) {
+				const resolvePromise = this.#resolvePreviousPromise;
+				this.#clearTimeout();
+				this.#setState({ isPending: false });
+				const result = await this.#execute(...this.store.state.lastArgs);
+				if (resolvePromise) resolvePromise(result);
+				return result;
+			}
+		};
+		this.abort = () => {
+			this.asyncRetryers.forEach((retryer) => retryer.abort());
+			this.asyncRetryers.clear();
+			this.#setState({ isExecuting: false });
+		};
+		this.cancel = () => {
+			this.#clearTimeout();
+			if (this.#resolvePreviousPromise) {
+				this.#resolvePreviousPromiseInternal();
+				this.#resolvePreviousPromise = null;
+			}
+			this.#setState({ isPending: false });
+		};
+		this.reset = () => {
+			this.#setState(getDefaultAsyncThrottlerState());
+			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) pacerEventClient.on("d-AsyncThrottler", (event) => {
+			if (event.payload.key !== this.key) return;
+			this.#setState(event.payload.store.state);
+			this.setOptions(event.payload.options);
+		});
+	}
+	#setState = (newState) => {
+		this.store.setState((state) => {
+			const combinedState = {
+				...state,
+				...newState
+			};
+			const { isPending, isExecuting, settleCount } = combinedState;
+			return {
+				...combinedState,
+				status: !this.#getEnabled() ? "disabled" : isPending ? "pending" : isExecuting ? "executing" : settleCount > 0 ? "settled" : "idle"
+			};
+		});
+		emitChange("AsyncThrottler", this);
+	};
+	/**
+	* Returns the current enabled state of the async throttler
+	*/
+	#getEnabled = () => {
+		return !!parseFunctionOrValue(this.options.enabled, this);
+	};
+	/**
+	* Returns the current wait time in milliseconds
+	*/
+	#getWait = () => {
+		return parseFunctionOrValue(this.options.wait, this);
+	};
+	#execute = async (...args) => {
+		if (!this.#getEnabled()) return void 0;
+		const currentMaybeExecute = this.store.state.maybeExecuteCount;
+		try {
+			this.#setState({ isExecuting: true });
+			const currentAsyncRetryer = new AsyncRetryer(this.fn, {
+				...this.options.asyncRetryerOptions,
+				key: `${this.key}-retryer-${currentMaybeExecute}`
+			});
+			this.asyncRetryers.set(currentMaybeExecute, currentAsyncRetryer);
+			const result = await currentAsyncRetryer.execute(...args);
+			this.#setState({
+				lastResult: result,
+				successCount: this.store.state.successCount + 1
+			});
+			this.options.onSuccess?.(result, args, this);
+		} catch (error) {
+			this.#setState({ errorCount: this.store.state.errorCount + 1 });
+			this.options.onError?.(error, args, this);
+			if (this.options.throwOnError) throw error;
+		} finally {
+			this.asyncRetryers.delete(currentMaybeExecute);
+			const lastExecutionTime = Date.now();
+			const wait = this.#getWait();
+			const nextExecutionTime = lastExecutionTime + wait;
+			this.#setState({
+				isExecuting: false,
+				isPending: !!this.#timeoutId,
+				settleCount: this.store.state.settleCount + 1,
+				lastExecutionTime,
+				nextExecutionTime
+			});
+			this.options.onSettled?.(args, this);
+			setTimeout(() => {
+				if (!this.store.state.isPending) this.#setState({ nextExecutionTime: void 0 });
+			}, wait);
+		}
+		return this.store.state.lastResult;
+	};
+	#resolvePreviousPromiseInternal = () => {
+		if (this.#resolvePreviousPromise) {
+			this.#resolvePreviousPromise(this.store.state.lastResult);
+			this.#resolvePreviousPromise = null;
+		}
+	};
+	#clearTimeout = () => {
+		if (this.#timeoutId) {
+			clearTimeout(this.#timeoutId);
+			this.#timeoutId = null;
+		}
+	};
+	/**
+	* Returns the AbortSignal for a specific execution.
+	* If no maybeExecuteCount is provided, returns the signal for the most recent execution.
+	* Returns null if no execution is found or not currently executing.
+	*
+	* @param maybeExecuteCount - Optional specific execution to get signal for
+	* @example
+	* ```typescript
+	* const throttler = new AsyncThrottler(
+	*   async (data: string) => {
+	*     const signal = throttler.getAbortSignal()
+	*     if (signal) {
+	*       const response = await fetch('/api/save', {
+	*         method: 'POST',
+	*         body: data,
+	*         signal
+	*       })
+	*       return response.json()
+	*     }
+	*   },
+	*   { wait: 1000 }
+	* )
+	* ```
+	*/
+	getAbortSignal(maybeExecuteCount) {
+		const count = maybeExecuteCount ?? this.store.state.maybeExecuteCount;
+		return this.asyncRetryers.get(count)?.getAbortSignal() ?? null;
+	}
+};
+/**
+* Creates an async throttled function that limits how often the function can execute.
+* The throttled function will execute at most once per wait period, even if called multiple times.
+* If called while executing, it will wait until execution completes before scheduling the next call.
+*
+* Async vs Sync Versions:
+* The async version provides advanced features over the sync throttle function:
+* - Returns promises that can be awaited for throttled function results
+* - Built-in retry support via AsyncRetryer integration
+* - Abort support to cancel in-flight executions
+* - Cancel support to prevent pending executions from starting
+* - Comprehensive error handling with onError callbacks and throwOnError control
+* - Detailed execution tracking (success/error/settle counts)
+* - Waits for ongoing executions to complete before scheduling the next one
+*
+* The sync throttle function is lighter weight and simpler when you don't need async features,
+* return values, or execution control.
+*
+* What is Throttling?
+* Throttling limits how often a function can be executed, allowing only one execution within a specified time window.
+* Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a
+* regular interval regardless of how often it's called.
+*
+* Configuration Options:
+* - `wait`: Time window in milliseconds during which the function can only execute once (required)
+* - `leading`: Execute immediately when called (default: true)
+* - `trailing`: Execute on the trailing edge of the wait period (default: true)
+* - `enabled`: Whether the throttler is enabled (default: true)
+* - `asyncRetryerOptions`: Configure retry behavior for executions
+*
+* Error Handling:
+* - If an `onError` handler is provided, it will be called with the error and throttler 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 AsyncThrottler instance
+*
+* State Management:
+* - Uses TanStack Store for reactive state management
+* - Use `initialState` to provide initial state values when creating the async throttler
+* - Use `onSuccess` callback to react to successful function execution and implement custom logic
+* - Use `onError` callback to react to function execution errors and implement custom error handling
+* - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic
+* - The state includes error count, execution status, last execution time, and success/settle counts
+* - State can be accessed via the underlying AsyncThrottler instance's `store.state` property
+* - When using framework adapters (React/Solid), state is accessed from the hook's state property
+*
+* @example
+* ```ts
+* const throttled = asyncThrottle(async (value: string) => {
+*   const result = await saveToAPI(value);
+*   return result; // Return value is preserved
+* }, {
+*   wait: 1000,
+*   onError: (error) => {
+*     console.error('API call failed:', error);
+*   }
+* });
+*
+* // This will execute at most once per second
+* // Returns the API response directly
+* const result = await throttled(inputElement.value);
+* ```
+*/
+function asyncThrottle(fn, initialOptions) {
+	return new AsyncThrottler(fn, initialOptions).maybeExecute;
+}
+
+//#endregion
+export { AsyncThrottler, asyncThrottle, asyncThrottlerOptions };
+//# sourceMappingURL=async-throttler.js.map

package/dist/async-throttler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-throttler.js","names":["defaultOptions: AsyncThrottlerOptionsWithOptionalCallbacks","fn: TFn","#getEnabled","#resolvePreviousPromiseInternal","#setState","#getWait","#execute","#resolvePreviousPromise","#timeoutId","#clearTimeout"],"sources":["../src/async-throttler.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 { AnyAsyncFunction, OptionalKeys } from './types'\n\nexport interface AsyncThrottlerState<TFn extends AnyAsyncFunction> {\n  /**\n   * Number of function executions that have resulted in errors\n   */\n  errorCount: number\n  /**\n   * Whether the throttled function is currently executing asynchronously\n   */\n  isExecuting: boolean\n  /**\n   * Whether the throttler is waiting for the timeout to trigger execution\n   */\n  isPending: boolean\n  /**\n   * The arguments from the most recent call to maybeExecute\n   */\n  lastArgs: Parameters<TFn> | undefined\n  /**\n   * Timestamp of the last function execution in milliseconds\n   */\n  lastExecutionTime: number\n  /**\n   * The result from the most recent successful function execution\n   */\n  lastResult: ReturnType<TFn> | undefined\n  /**\n   * Number of times maybeExecute has been called (for reduction calculations)\n   */\n  maybeExecuteCount: number\n  /**\n   * Timestamp when the next execution can occur in milliseconds\n   */\n  nextExecutionTime: number | undefined\n  /**\n   * Number of function executions that have completed (either successfully or with errors)\n   */\n  settleCount: number\n  /**\n   * Current execution status - 'idle' when not active, 'pending' when waiting, 'executing' when running, 'settled' when completed\n   */\n  status: 'disabled' | 'idle' | 'pending' | 'executing' | 'settled'\n  /**\n   * Number of function executions that have completed successfully\n   */\n  successCount: number\n}\n\nfunction getDefaultAsyncThrottlerState<\n  TFn extends AnyAsyncFunction,\n>(): AsyncThrottlerState<TFn> {\n  return {\n    errorCount: 0,\n    isExecuting: false,\n    isPending: false,\n    lastArgs: undefined,\n    lastExecutionTime: 0,\n    lastResult: undefined,\n    maybeExecuteCount: 0,\n    nextExecutionTime: undefined,\n    settleCount: 0,\n    status: 'idle',\n    successCount: 0,\n  }\n}\n\n/**\n * Options for configuring an async throttled function\n */\nexport interface AsyncThrottlerOptions<TFn extends AnyAsyncFunction> {\n  /**\n   * Options for configuring the underlying async retryer\n   */\n  asyncRetryerOptions?: AsyncRetryerOptions<TFn>\n  /**\n   * Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions.\n   * Can be a boolean or a function that returns a boolean.\n   * Defaults to true.\n   */\n  enabled?: boolean | ((throttler: AsyncThrottler<TFn>) => boolean)\n  /**\n   * Initial state for the async throttler\n   */\n  initialState?: Partial<AsyncThrottlerState<TFn>>\n  /**\n   * Optional key to identify this async throttler instance.\n   * If provided, the async throttler will be identified by this key in the devtools and PacerProvider if applicable.\n   */\n  key?: string\n  /**\n   * Whether to execute the function immediately when called\n   * Defaults to true\n   */\n  leading?: boolean\n  /**\n   * Optional error handler for when the throttled function throws.\n   * If provided, the handler will be called with the error and throttler 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    args: Parameters<TFn>,\n    asyncThrottler: AsyncThrottler<TFn>,\n  ) => void\n  /**\n   * Optional function to call when the throttled function is executed\n   */\n  onSettled?: (\n    args: Parameters<TFn>,\n    asyncThrottler: AsyncThrottler<TFn>,\n  ) => void\n  /**\n   * Optional function to call when the throttled function is executed\n   */\n  onSuccess?: (\n    result: ReturnType<TFn>,\n    args: Parameters<TFn>,\n    asyncThrottler: AsyncThrottler<TFn>,\n  ) => void\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   * Whether to execute the function on the trailing edge of the wait period\n   * Defaults to true\n   */\n  trailing?: boolean\n  /**\n   * Time window in milliseconds during which the function can only be executed once.\n   * Can be a number or a function that returns a number.\n   * Defaults to 0ms\n   */\n  wait: number | ((throttler: AsyncThrottler<TFn>) => number)\n}\n\n/**\n * Utility function for sharing common `AsyncThrottlerOptions` options between different `AsyncThrottler` instances.\n */\nexport function asyncThrottlerOptions<\n  TFn extends AnyAsyncFunction = AnyAsyncFunction,\n  TOptions extends Partial<AsyncThrottlerOptions<TFn>> = Partial<\n    AsyncThrottlerOptions<TFn>\n  >,\n>(options: TOptions): TOptions {\n  return options\n}\n\ntype AsyncThrottlerOptionsWithOptionalCallbacks = OptionalKeys<\n  AsyncThrottlerOptions<any>,\n  'initialState' | 'onError' | 'onSettled' | 'onSuccess'\n>\n\nconst defaultOptions: AsyncThrottlerOptionsWithOptionalCallbacks = {\n  asyncRetryerOptions: {\n    maxAttempts: 1,\n  },\n  enabled: true,\n  leading: true,\n  trailing: true,\n  wait: 0,\n}\n\n/**\n * A class that creates an async throttled function.\n *\n * Async vs Sync Versions:\n * The async version provides advanced features over the sync Throttler:\n * - Returns promises that can be awaited for throttled function results\n * - Built-in retry support via AsyncRetryer integration\n * - Abort support to cancel in-flight executions\n * - Cancel support to prevent pending executions from starting\n * - Comprehensive error handling with onError callbacks and throwOnError control\n * - Detailed execution tracking (success/error/settle counts)\n * - Waits for ongoing executions to complete before scheduling the next one\n *\n * The sync Throttler is lighter weight and simpler when you don't need async features,\n * return values, or execution control.\n *\n * What is Throttling?\n * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.\n * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a\n * regular interval regardless of how often it's called.\n *\n * This is useful for rate-limiting API calls, handling scroll/resize events, or any scenario where you want to\n * ensure a maximum execution frequency.\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and throttler 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 AsyncThrottler 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 throttler\n * - Use `onSuccess` callback to react to successful function execution and implement custom logic\n * - Use `onError` callback to react to function execution errors and implement custom error handling\n * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic\n * - The state includes error count, execution status, last execution time, and success/settle counts\n * - State can be accessed via `asyncThrottler.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `asyncThrottler.state`\n *\n * @example\n * ```ts\n * const throttler = new AsyncThrottler(async (value: string) => {\n *   const result = await saveToAPI(value);\n *   return result; // Return value is preserved\n * }, {\n *   wait: 1000,\n *   onError: (error) => {\n *     console.error('API call failed:', error);\n *   }\n * });\n *\n * // Will only execute once per second no matter how often called\n * // Returns the API response directly\n * const result = await throttler.maybeExecute(inputElement.value);\n * ```\n */\nexport class AsyncThrottler<TFn extends AnyAsyncFunction> {\n  readonly store: Store<Readonly<AsyncThrottlerState<TFn>>> = new Store<\n    AsyncThrottlerState<TFn>\n  >(getDefaultAsyncThrottlerState<TFn>())\n  key: string | undefined\n  options: AsyncThrottlerOptions<TFn>\n  asyncRetryers = new Map<number, AsyncRetryer<TFn>>()\n  #timeoutId: NodeJS.Timeout | null = null\n  #resolvePreviousPromise:\n    | ((value?: ReturnType<TFn> | undefined) => void)\n    | null = null\n\n  constructor(\n    public fn: TFn,\n    initialOptions: AsyncThrottlerOptions<TFn>,\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-AsyncThrottler', (event) => {\n        if (event.payload.key !== this.key) return\n        this.#setState(event.payload.store.state as AsyncThrottlerState<TFn>)\n        this.setOptions(event.payload.options)\n      })\n    }\n  }\n\n  /**\n   * Updates the async throttler options\n   */\n  setOptions = (newOptions: Partial<AsyncThrottlerOptions<TFn>>): void => {\n    this.options = { ...this.options, ...newOptions }\n\n    // End the pending state if the throttler is disabled\n    if (!this.#getEnabled()) {\n      this.cancel()\n    }\n  }\n\n  #setState = (newState: Partial<AsyncThrottlerState<TFn>>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      const { isPending, isExecuting, settleCount } = combinedState\n      return {\n        ...combinedState,\n        status: !this.#getEnabled()\n          ? 'disabled'\n          : isPending\n            ? 'pending'\n            : isExecuting\n              ? 'executing'\n              : settleCount > 0\n                ? 'settled'\n                : 'idle',\n      }\n    })\n    emitChange('AsyncThrottler', this)\n  }\n\n  /**\n   * Returns the current enabled state of the async throttler\n   */\n  #getEnabled = (): boolean => {\n    return !!parseFunctionOrValue(this.options.enabled, this)\n  }\n\n  /**\n   * Returns the current wait time in milliseconds\n   */\n  #getWait = (): number => {\n    return parseFunctionOrValue(this.options.wait, this)\n  }\n\n  /**\n   * Attempts to execute the throttled function. The execution behavior depends on the throttler options:\n   *\n   * - If enough time has passed since the last execution (>= wait period):\n   *   - With leading=true: Executes immediately\n   *   - With leading=false: Waits for the next trailing execution\n   *\n   * - If within the wait period:\n   *   - With trailing=true: Schedules execution for end of wait period\n   *   - With trailing=false: Drops the execution\n   *\n   * @example\n   * ```ts\n   * const throttled = new AsyncThrottler(fn, { wait: 1000 });\n   *\n   * // First call executes immediately\n   * await throttled.maybeExecute('a', 'b');\n   *\n   * // Call during wait period - gets throttled\n   * await throttled.maybeExecute('c', 'd');\n   * ```\n   */\n  maybeExecute = async (\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> => {\n    if (!this.#getEnabled()) return undefined\n\n    this.#resolvePreviousPromiseInternal()\n\n    this.#setState({\n      maybeExecuteCount: this.store.state.maybeExecuteCount + 1,\n      lastArgs: args, // store the arguments for potential trailing execution\n    })\n\n    const wait = this.#getWait()\n    const thisMaybeExecuteNumber = this.store.state.maybeExecuteCount\n\n    // Wait for the wait period for the previous execution to complete if it's still running\n    for (\n      let maxNumIterations = wait / 10;\n      this.store.state.isExecuting && maxNumIterations > 0;\n      maxNumIterations--\n    ) {\n      await new Promise((resolve) => setTimeout(resolve, 10))\n      if (this.store.state.maybeExecuteCount !== thisMaybeExecuteNumber) {\n        // cancel the current maybeExecute loop because a new maybeExecute call was made\n        return this.store.state.lastResult\n      }\n    }\n\n    const now = Date.now()\n    const timeSinceLastExecution = now - this.store.state.lastExecutionTime\n\n    if (\n      this.options.leading &&\n      !this.store.state.isPending &&\n      timeSinceLastExecution >= wait\n    ) {\n      await this.#execute(...args) // Leading EXECUTE!\n    } else if (this.options.trailing) {\n      // replace old pending execution with a new one\n      this.cancel()\n      this.#setState({\n        isPending: true,\n      })\n\n      // Set up new trailing execution\n      return new Promise((resolve, reject) => {\n        this.#resolvePreviousPromise = resolve\n\n        const newTimeSinceLastExecution = this.store.state.lastExecutionTime\n          ? now - this.store.state.lastExecutionTime\n          : 0\n        const timeoutDuration = Math.max(0, wait - newTimeSinceLastExecution)\n\n        this.#timeoutId = setTimeout(async () => {\n          this.#clearTimeout()\n          if (this.store.state.lastArgs !== undefined) {\n            try {\n              await this.#execute(...this.store.state.lastArgs) // Trailing EXECUTE!\n            } catch (error) {\n              reject(error)\n            }\n          }\n          this.#resolvePreviousPromise = null\n          resolve(this.store.state.lastResult)\n        }, timeoutDuration)\n      })\n    }\n    return this.store.state.lastResult\n  }\n\n  #execute = async (\n    ...args: Parameters<TFn>\n  ): Promise<ReturnType<TFn> | undefined> => {\n    if (!this.#getEnabled()) return undefined\n\n    const currentMaybeExecute = this.store.state.maybeExecuteCount\n\n    try {\n      this.#setState({ isExecuting: true })\n      const currentAsyncRetryer = new AsyncRetryer(this.fn, {\n        ...this.options.asyncRetryerOptions,\n        key: `${this.key}-retryer-${currentMaybeExecute}`,\n      })\n      this.asyncRetryers.set(currentMaybeExecute, currentAsyncRetryer)\n      const result = await currentAsyncRetryer.execute(...args) // EXECUTE!\n      this.#setState({\n        lastResult: result,\n        successCount: this.store.state.successCount + 1,\n      })\n      this.options.onSuccess?.(result as ReturnType<TFn>, args, this)\n    } catch (error) {\n      this.#setState({\n        errorCount: this.store.state.errorCount + 1,\n      })\n      this.options.onError?.(error as Error, args, this)\n      if (this.options.throwOnError) {\n        throw error\n      }\n    } finally {\n      this.asyncRetryers.delete(currentMaybeExecute) // dispose retryer\n      const lastExecutionTime = Date.now()\n      const wait = this.#getWait()\n      const nextExecutionTime = lastExecutionTime + wait\n      this.#setState({\n        isExecuting: false,\n        isPending: !!this.#timeoutId,\n        settleCount: this.store.state.settleCount + 1,\n        lastExecutionTime,\n        nextExecutionTime,\n      })\n      this.options.onSettled?.(args, this)\n      setTimeout(() => {\n        if (!this.store.state.isPending) {\n          // clear nextExecutionTime if there is no pending execution\n          this.#setState({ nextExecutionTime: undefined })\n        }\n      }, wait)\n    }\n    return this.store.state.lastResult\n  }\n\n  /**\n   * Processes the current pending execution immediately\n   */\n  flush = async (): Promise<ReturnType<TFn> | undefined> => {\n    if (this.store.state.isPending && this.store.state.lastArgs) {\n      // Store the pending promise resolver before clearing timeout\n      const resolvePromise = this.#resolvePreviousPromise\n\n      // Clear timeout and state without resolving the promise\n      this.#clearTimeout()\n      this.#setState({\n        isPending: false,\n      })\n\n      const result = await this.#execute(...this.store.state.lastArgs)\n\n      // Resolve the pending promise with the result\n      if (resolvePromise) {\n        resolvePromise(result)\n      }\n\n      return result\n    }\n    return undefined\n  }\n\n  #resolvePreviousPromiseInternal = (): void => {\n    if (this.#resolvePreviousPromise) {\n      this.#resolvePreviousPromise(this.store.state.lastResult)\n      this.#resolvePreviousPromise = null\n    }\n  }\n\n  #clearTimeout = (): void => {\n    if (this.#timeoutId) {\n      clearTimeout(this.#timeoutId)\n      this.#timeoutId = null\n    }\n  }\n\n  /**\n   * Returns the AbortSignal for a specific execution.\n   * If no maybeExecuteCount 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 maybeExecuteCount - Optional specific execution to get signal for\n   * @example\n   * ```typescript\n   * const throttler = new AsyncThrottler(\n   *   async (data: string) => {\n   *     const signal = throttler.getAbortSignal()\n   *     if (signal) {\n   *       const response = await fetch('/api/save', {\n   *         method: 'POST',\n   *         body: data,\n   *         signal\n   *       })\n   *       return response.json()\n   *     }\n   *   },\n   *   { wait: 1000 }\n   * )\n   * ```\n   */\n  getAbortSignal(maybeExecuteCount?: number): AbortSignal | null {\n    const count = maybeExecuteCount ?? this.store.state.maybeExecuteCount\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   */\n  abort = (): void => {\n    this.asyncRetryers.forEach((retryer) => retryer.abort())\n    this.asyncRetryers.clear()\n    this.#setState({ isExecuting: false })\n  }\n\n  /**\n   * Cancels any pending execution that have not started yet.\n   * Does NOT abort any execution already in progress.\n   */\n  cancel = (): void => {\n    this.#clearTimeout()\n    if (this.#resolvePreviousPromise) {\n      this.#resolvePreviousPromiseInternal()\n      this.#resolvePreviousPromise = null\n    }\n    this.#setState({\n      isPending: false,\n    })\n  }\n\n  /**\n   * Resets the debouncer state to its default values\n   */\n  reset = (): void => {\n    this.#setState(getDefaultAsyncThrottlerState<TFn>())\n    this.asyncRetryers.forEach((retryer) => retryer.reset())\n  }\n}\n\n/**\n * Creates an async throttled function that limits how often the function can execute.\n * The throttled function will execute at most once per wait period, even if called multiple times.\n * If called while executing, it will wait until execution completes before scheduling the next call.\n *\n * Async vs Sync Versions:\n * The async version provides advanced features over the sync throttle function:\n * - Returns promises that can be awaited for throttled function results\n * - Built-in retry support via AsyncRetryer integration\n * - Abort support to cancel in-flight executions\n * - Cancel support to prevent pending executions from starting\n * - Comprehensive error handling with onError callbacks and throwOnError control\n * - Detailed execution tracking (success/error/settle counts)\n * - Waits for ongoing executions to complete before scheduling the next one\n *\n * The sync throttle function is lighter weight and simpler when you don't need async features,\n * return values, or execution control.\n *\n * What is Throttling?\n * Throttling limits how often a function can be executed, allowing only one execution within a specified time window.\n * Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a\n * regular interval regardless of how often it's called.\n *\n * Configuration Options:\n * - `wait`: Time window in milliseconds during which the function can only execute once (required)\n * - `leading`: Execute immediately when called (default: true)\n * - `trailing`: Execute on the trailing edge of the wait period (default: true)\n * - `enabled`: Whether the throttler is enabled (default: true)\n * - `asyncRetryerOptions`: Configure retry behavior for executions\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error and throttler 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 AsyncThrottler 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 throttler\n * - Use `onSuccess` callback to react to successful function execution and implement custom logic\n * - Use `onError` callback to react to function execution errors and implement custom error handling\n * - Use `onSettled` callback to react to function execution completion (success or error) and implement custom logic\n * - The state includes error count, execution status, last execution time, and success/settle counts\n * - State can be accessed via the underlying AsyncThrottler 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 throttled = asyncThrottle(async (value: string) => {\n *   const result = await saveToAPI(value);\n *   return result; // Return value is preserved\n * }, {\n *   wait: 1000,\n *   onError: (error) => {\n *     console.error('API call failed:', error);\n *   }\n * });\n *\n * // This will execute at most once per second\n * // Returns the API response directly\n * const result = await throttled(inputElement.value);\n * ```\n */\nexport function asyncThrottle<TFn extends AnyAsyncFunction>(\n  fn: TFn,\n  initialOptions: AsyncThrottlerOptions<TFn>,\n) {\n  const asyncThrottler = new AsyncThrottler(fn, initialOptions)\n  return asyncThrottler.maybeExecute\n}\n"],"mappings":";;;;;;AAsDA,SAAS,gCAEqB;AAC5B,QAAO;EACL,YAAY;EACZ,aAAa;EACb,WAAW;EACX,UAAU;EACV,mBAAmB;EACnB,YAAY;EACZ,mBAAmB;EACnB,mBAAmB;EACnB,aAAa;EACb,QAAQ;EACR,cAAc;EACf;;;;;AA8EH,SAAgB,sBAKd,SAA6B;AAC7B,QAAO;;AAQT,MAAMA,iBAA6D;CACjE,qBAAqB,EACnB,aAAa,GACd;CACD,SAAS;CACT,SAAS;CACT,UAAU;CACV,MAAM;CACP;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4DD,IAAa,iBAAb,MAA0D;CAOxD,aAAoC;CACpC,0BAEW;CAEX,YACE,AAAOC,IACP,gBACA;EAFO;eAZmD,IAAI,MAE9D,+BAAoC,CAAC;uCAGvB,IAAI,KAAgC;qBA8BtC,eAA0D;AACtE,QAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;IAAY;AAGjD,OAAI,CAAC,MAAKC,YAAa,CACrB,MAAK,QAAQ;;sBA+DF,OACb,GAAG,SACsC;AACzC,OAAI,CAAC,MAAKA,YAAa,CAAE,QAAO;AAEhC,SAAKC,gCAAiC;AAEtC,SAAKC,SAAU;IACb,mBAAmB,KAAK,MAAM,MAAM,oBAAoB;IACxD,UAAU;IACX,CAAC;GAEF,MAAM,OAAO,MAAKC,SAAU;GAC5B,MAAM,yBAAyB,KAAK,MAAM,MAAM;AAGhD,QACE,IAAI,mBAAmB,OAAO,IAC9B,KAAK,MAAM,MAAM,eAAe,mBAAmB,GACnD,oBACA;AACA,UAAM,IAAI,SAAS,YAAY,WAAW,SAAS,GAAG,CAAC;AACvD,QAAI,KAAK,MAAM,MAAM,sBAAsB,uBAEzC,QAAO,KAAK,MAAM,MAAM;;GAI5B,MAAM,MAAM,KAAK,KAAK;GACtB,MAAM,yBAAyB,MAAM,KAAK,MAAM,MAAM;AAEtD,OACE,KAAK,QAAQ,WACb,CAAC,KAAK,MAAM,MAAM,aAClB,0BAA0B,KAE1B,OAAM,MAAKC,QAAS,GAAG,KAAK;YACnB,KAAK,QAAQ,UAAU;AAEhC,SAAK,QAAQ;AACb,UAAKF,SAAU,EACb,WAAW,MACZ,CAAC;AAGF,WAAO,IAAI,SAAS,SAAS,WAAW;AACtC,WAAKG,yBAA0B;KAE/B,MAAM,4BAA4B,KAAK,MAAM,MAAM,oBAC/C,MAAM,KAAK,MAAM,MAAM,oBACvB;KACJ,MAAM,kBAAkB,KAAK,IAAI,GAAG,OAAO,0BAA0B;AAErE,WAAKC,YAAa,WAAW,YAAY;AACvC,YAAKC,cAAe;AACpB,UAAI,KAAK,MAAM,MAAM,aAAa,OAChC,KAAI;AACF,aAAM,MAAKH,QAAS,GAAG,KAAK,MAAM,MAAM,SAAS;eAC1C,OAAO;AACd,cAAO,MAAM;;AAGjB,YAAKC,yBAA0B;AAC/B,cAAQ,KAAK,MAAM,MAAM,WAAW;QACnC,gBAAgB;MACnB;;AAEJ,UAAO,KAAK,MAAM,MAAM;;eAyDlB,YAAkD;AACxD,OAAI,KAAK,MAAM,MAAM,aAAa,KAAK,MAAM,MAAM,UAAU;IAE3D,MAAM,iBAAiB,MAAKA;AAG5B,UAAKE,cAAe;AACpB,UAAKL,SAAU,EACb,WAAW,OACZ,CAAC;IAEF,MAAM,SAAS,MAAM,MAAKE,QAAS,GAAG,KAAK,MAAM,MAAM,SAAS;AAGhE,QAAI,eACF,gBAAe,OAAO;AAGxB,WAAO;;;qBAqDS;AAClB,QAAK,cAAc,SAAS,YAAY,QAAQ,OAAO,CAAC;AACxD,QAAK,cAAc,OAAO;AAC1B,SAAKF,SAAU,EAAE,aAAa,OAAO,CAAC;;sBAOnB;AACnB,SAAKK,cAAe;AACpB,OAAI,MAAKF,wBAAyB;AAChC,UAAKJ,gCAAiC;AACtC,UAAKI,yBAA0B;;AAEjC,SAAKH,SAAU,EACb,WAAW,OACZ,CAAC;;qBAMgB;AAClB,SAAKA,SAAU,+BAAoC,CAAC;AACpD,QAAK,cAAc,SAAS,YAAY,QAAQ,OAAO,CAAC;;AArTxD,OAAK,MAAM,eAAe;AAC1B,OAAK,UAAU;GACb,GAAG;GACH,GAAG;GACH,cAAc,eAAe,gBAAgB,CAAC,eAAe;GAC9D;AACD,QAAKA,SAAU,KAAK,QAAQ,gBAAgB,EAAE,CAAC;AAE/C,MAAI,KAAK,IACP,kBAAiB,GAAG,qBAAqB,UAAU;AACjD,OAAI,MAAM,QAAQ,QAAQ,KAAK,IAAK;AACpC,SAAKA,SAAU,MAAM,QAAQ,MAAM,MAAkC;AACrE,QAAK,WAAW,MAAM,QAAQ,QAAQ;IACtC;;CAgBN,aAAa,aAAsD;AACjE,OAAK,MAAM,UAAU,UAAU;GAC7B,MAAM,gBAAgB;IACpB,GAAG;IACH,GAAG;IACJ;GACD,MAAM,EAAE,WAAW,aAAa,gBAAgB;AAChD,UAAO;IACL,GAAG;IACH,QAAQ,CAAC,MAAKF,YAAa,GACvB,aACA,YACE,YACA,cACE,cACA,cAAc,IACZ,YACA;IACX;IACD;AACF,aAAW,kBAAkB,KAAK;;;;;CAMpC,oBAA6B;AAC3B,SAAO,CAAC,CAAC,qBAAqB,KAAK,QAAQ,SAAS,KAAK;;;;;CAM3D,iBAAyB;AACvB,SAAO,qBAAqB,KAAK,QAAQ,MAAM,KAAK;;CA+FtD,WAAW,OACT,GAAG,SACsC;AACzC,MAAI,CAAC,MAAKA,YAAa,CAAE,QAAO;EAEhC,MAAM,sBAAsB,KAAK,MAAM,MAAM;AAE7C,MAAI;AACF,SAAKE,SAAU,EAAE,aAAa,MAAM,CAAC;GACrC,MAAM,sBAAsB,IAAI,aAAa,KAAK,IAAI;IACpD,GAAG,KAAK,QAAQ;IAChB,KAAK,GAAG,KAAK,IAAI,WAAW;IAC7B,CAAC;AACF,QAAK,cAAc,IAAI,qBAAqB,oBAAoB;GAChE,MAAM,SAAS,MAAM,oBAAoB,QAAQ,GAAG,KAAK;AACzD,SAAKA,SAAU;IACb,YAAY;IACZ,cAAc,KAAK,MAAM,MAAM,eAAe;IAC/C,CAAC;AACF,QAAK,QAAQ,YAAY,QAA2B,MAAM,KAAK;WACxD,OAAO;AACd,SAAKA,SAAU,EACb,YAAY,KAAK,MAAM,MAAM,aAAa,GAC3C,CAAC;AACF,QAAK,QAAQ,UAAU,OAAgB,MAAM,KAAK;AAClD,OAAI,KAAK,QAAQ,aACf,OAAM;YAEA;AACR,QAAK,cAAc,OAAO,oBAAoB;GAC9C,MAAM,oBAAoB,KAAK,KAAK;GACpC,MAAM,OAAO,MAAKC,SAAU;GAC5B,MAAM,oBAAoB,oBAAoB;AAC9C,SAAKD,SAAU;IACb,aAAa;IACb,WAAW,CAAC,CAAC,MAAKI;IAClB,aAAa,KAAK,MAAM,MAAM,cAAc;IAC5C;IACA;IACD,CAAC;AACF,QAAK,QAAQ,YAAY,MAAM,KAAK;AACpC,oBAAiB;AACf,QAAI,CAAC,KAAK,MAAM,MAAM,UAEpB,OAAKJ,SAAU,EAAE,mBAAmB,QAAW,CAAC;MAEjD,KAAK;;AAEV,SAAO,KAAK,MAAM,MAAM;;CA6B1B,wCAA8C;AAC5C,MAAI,MAAKG,wBAAyB;AAChC,SAAKA,uBAAwB,KAAK,MAAM,MAAM,WAAW;AACzD,SAAKA,yBAA0B;;;CAInC,sBAA4B;AAC1B,MAAI,MAAKC,WAAY;AACnB,gBAAa,MAAKA,UAAW;AAC7B,SAAKA,YAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BtB,eAAe,mBAAgD;EAC7D,MAAM,QAAQ,qBAAqB,KAAK,MAAM,MAAM;AAEpD,SADgB,KAAK,cAAc,IAAI,MAAM,EAC7B,gBAAgB,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqGxC,SAAgB,cACd,IACA,gBACA;AAEA,QADuB,IAAI,eAAe,IAAI,eAAe,CACvC"}

package/dist/batcher.cjs

@@ -0,0 +1,194 @@
+const require_utils = require('./utils.cjs');
+const require_event_client = require('./event-client.cjs');
+let __tanstack_store = require("@tanstack/store");
+
+//#region src/batcher.ts
+function getDefaultBatcherState() {
+	return {
+		executionCount: 0,
+		isEmpty: true,
+		isPending: false,
+		totalItemsProcessed: 0,
+		items: [],
+		size: 0,
+		status: "idle"
+	};
+}
+const defaultOptions = {
+	getShouldExecute: () => false,
+	maxSize: Infinity,
+	started: true,
+	wait: Infinity
+};
+/**
+* A class that collects items and processes them in batches.
+*
+* Batching is a technique for grouping multiple operations together to be processed as a single unit.
+* This synchronous version is lighter weight and often all you need - upgrade to AsyncBatcher when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+*
+* The Batcher provides a flexible way to implement 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
+*
+* State Management:
+* - Uses TanStack Store for reactive state management
+* - Use `initialState` to provide initial state values when creating the batcher
+* - 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 batch execution count, total items processed, items, and running status
+* - State can be accessed via `batcher.store.state` when using the class directly
+* - When using framework adapters (React/Solid), state is accessed from `batcher.state`
+*
+* @example
+* ```ts
+* const batcher = new Batcher<number>(
+*   (items) => console.log('Processing batch:', items),
+*   {
+*     maxSize: 5,
+*     wait: 2000,
+*     onExecute: (batch, batcher) => console.log('Batch executed:', batch)
+*   }
+* );
+*
+* batcher.addItem(1);
+* batcher.addItem(2);
+* // After 2 seconds or when 5 items are added, whichever comes first,
+* // the batch will be processed
+* // batcher.flush() // manually trigger a batch
+* ```
+*/
+var Batcher = class {
+	#timeoutId = null;
+	constructor(fn, initialOptions) {
+		this.fn = fn;
+		this.store = new __tanstack_store.Store(getDefaultBatcherState());
+		this.setOptions = (newOptions) => {
+			this.options = {
+				...this.options,
+				...newOptions
+			};
+		};
+		this.addItem = (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)) this.#execute();
+			else if (this.options.wait !== Infinity) {
+				this.#clearTimeout();
+				this.#timeoutId = setTimeout(() => this.#execute(), this.#getWait());
+			}
+		};
+		this.flush = () => {
+			this.#clearTimeout();
+			this.#execute();
+		};
+		this.peekAllItems = () => {
+			return [...this.store.state.items];
+		};
+		this.clear = () => {
+			this.#setState({
+				items: [],
+				isPending: false
+			});
+		};
+		this.cancel = () => {
+			this.#clearTimeout();
+			this.#setState({ isPending: false });
+		};
+		this.reset = () => {
+			this.#setState(getDefaultBatcherState());
+			this.options.onItemsChange?.(this);
+		};
+		this.key = initialOptions.key;
+		this.options = {
+			...defaultOptions,
+			...initialOptions
+		};
+		this.#setState(this.options.initialState ?? {});
+		if (this.key) require_event_client.pacerEventClient.on("d-Batcher", (event) => {
+			if (event.payload.key !== this.key) return;
+			this.#setState(event.payload.store.state);
+			this.setOptions(event.payload.options);
+		});
+	}
+	#setState = (newState) => {
+		this.store.setState((state) => {
+			const combinedState = {
+				...state,
+				...newState
+			};
+			const { isPending, items } = combinedState;
+			const size = items.length;
+			const isEmpty = size === 0;
+			return {
+				...combinedState,
+				isEmpty,
+				size,
+				status: isPending ? "pending" : "idle"
+			};
+		});
+		require_event_client.emitChange("Batcher", this);
+	};
+	#getWait = () => {
+		return require_utils.parseFunctionOrValue(this.options.wait, this);
+	};
+	/**
+	* Processes the current batch of items.
+	* This method will automatically be triggered if the batcher is running and any of these conditions are met:
+	* - The number of items reaches batchSize
+	* - 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.
+	*/
+	#execute = () => {
+		if (this.store.state.items.length === 0) return;
+		const batch$1 = this.peekAllItems();
+		this.clear();
+		this.options.onItemsChange?.(this);
+		this.fn(batch$1);
+		this.#setState({
+			executionCount: this.store.state.executionCount + 1,
+			totalItemsProcessed: this.store.state.totalItemsProcessed + batch$1.length
+		});
+		this.options.onExecute?.(batch$1, this);
+	};
+	#clearTimeout = () => {
+		if (this.#timeoutId) {
+			clearTimeout(this.#timeoutId);
+			this.#timeoutId = null;
+		}
+	};
+};
+/**
+* Creates a batcher that processes items in batches.
+*
+* This synchronous version is lighter weight and often all you need - upgrade to asyncBatch when you need promises, retry support, abort/cancel capabilities, or advanced error handling.
+*
+* @example
+* ```ts
+* const batchItems = batch<number>(
+*   (items) => console.log('Processing:', items),
+*   {
+*     maxSize: 3,
+*     onExecute: (batch, batcher) => console.log('Batch executed:', batch)
+*   }
+* );
+*
+* batchItems(1);
+* batchItems(2);
+* batchItems(3); // Triggers batch processing
+* ```
+*/
+function batch(fn, options) {
+	return new Batcher(fn, options).addItem;
+}
+
+//#endregion
+exports.Batcher = Batcher;
+exports.batch = batch;
+//# sourceMappingURL=batcher.cjs.map

package/dist/batcher.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"batcher.cjs","names":["defaultOptions: BatcherOptionsWithOptionalCallbacks<any>","fn: (items: Array<TValue>) => void","Store","#setState","#execute","#clearTimeout","#timeoutId","#getWait","parseFunctionOrValue","batch"],"sources":["../src/batcher.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\nimport { emitChange, pacerEventClient } from './event-client'\nimport type { OptionalKeys } from './types'\n\nexport interface BatcherState<TValue> {\n  /**\n   * Number of batch executions that have been completed\n   */\n  executionCount: number\n  /**\n   * Whether the batcher has no items to process (items array is empty)\n   */\n  isEmpty: 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   * 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\n   */\n  status: 'idle' | 'pending'\n  /**\n   * Total number of items that have been processed across all batches\n   */\n  totalItemsProcessed: number\n}\n\nfunction getDefaultBatcherState<TValue>(): BatcherState<TValue> {\n  return {\n    executionCount: 0,\n    isEmpty: true,\n    isPending: false,\n    totalItemsProcessed: 0,\n    items: [],\n    size: 0,\n    status: 'idle',\n  }\n}\n\n/**\n * Options for configuring a Batcher instance\n */\nexport interface BatcherOptions<TValue> {\n  /**\n   * Custom function to determine if a batch should be processed\n   * Return true to process the batch immediately\n   */\n  getShouldExecute?: (items: Array<TValue>, batcher: Batcher<TValue>) => boolean\n  /**\n   * Initial state for the batcher\n   */\n  initialState?: Partial<BatcherState<TValue>>\n  /**\n   * Optional key to identify this batcher instance.\n   * If provided, the 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   * Callback fired after a batch is processed\n   */\n  onExecute?: (batch: Array<TValue>, batcher: Batcher<TValue>) => void\n  /**\n   * Callback fired after items are added to the batcher\n   */\n  onItemsChange?: (batcher: Batcher<TValue>) => void\n  /**\n   * Whether the batcher should start processing immediately\n   * @default true\n   */\n  started?: 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 | ((batcher: Batcher<TValue>) => number)\n}\n\ntype BatcherOptionsWithOptionalCallbacks<TValue> = OptionalKeys<\n  Required<BatcherOptions<TValue>>,\n  'initialState' | 'onExecute' | 'onItemsChange' | 'key'\n>\n\nconst defaultOptions: BatcherOptionsWithOptionalCallbacks<any> = {\n  getShouldExecute: () => false,\n  maxSize: Infinity,\n  started: true,\n  wait: Infinity,\n}\n\n/**\n * A class that collects items and processes them in batches.\n *\n * Batching is a technique for grouping multiple operations together to be processed as a single unit.\n * This synchronous version is lighter weight and often all you need - upgrade to AsyncBatcher when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\n *\n * The Batcher provides a flexible way to implement 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 *\n * State Management:\n * - Uses TanStack Store for reactive state management\n * - Use `initialState` to provide initial state values when creating the batcher\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 batch execution count, total items processed, items, and running status\n * - State can be accessed via `batcher.store.state` when using the class directly\n * - When using framework adapters (React/Solid), state is accessed from `batcher.state`\n *\n * @example\n * ```ts\n * const batcher = new Batcher<number>(\n *   (items) => console.log('Processing batch:', items),\n *   {\n *     maxSize: 5,\n *     wait: 2000,\n *     onExecute: (batch, batcher) => console.log('Batch executed:', batch)\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\n * // batcher.flush() // manually trigger a batch\n * ```\n */\nexport class Batcher<TValue> {\n  readonly store: Store<Readonly<BatcherState<TValue>>> = new Store(\n    getDefaultBatcherState<TValue>(),\n  )\n  key: string | undefined\n  options: BatcherOptionsWithOptionalCallbacks<TValue>\n  #timeoutId: NodeJS.Timeout | null = null\n\n  constructor(\n    public fn: (items: Array<TValue>) => void,\n    initialOptions: BatcherOptions<TValue>,\n  ) {\n    this.key = initialOptions.key\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n    }\n    this.#setState(this.options.initialState ?? {})\n\n    if (this.key) {\n      pacerEventClient.on('d-Batcher', (event) => {\n        if (event.payload.key !== this.key) return\n        this.#setState(event.payload.store.state)\n        this.setOptions(event.payload.options)\n      })\n    }\n  }\n\n  /**\n   * Updates the batcher options\n   */\n  setOptions = (newOptions: Partial<BatcherOptions<TValue>>): void => {\n    this.options = { ...this.options, ...newOptions }\n  }\n\n  #setState = (newState: Partial<BatcherState<TValue>>): void => {\n    this.store.setState((state) => {\n      const combinedState = {\n        ...state,\n        ...newState,\n      }\n      const { isPending, items } = combinedState\n      const size = items.length\n      const isEmpty = size === 0\n      return {\n        ...combinedState,\n        isEmpty,\n        size,\n        status: isPending ? 'pending' : 'idle',\n      }\n    })\n    emitChange('Batcher', this)\n  }\n\n  #getWait = (): number => {\n    return parseFunctionOrValue(this.options.wait, this)\n  }\n\n  /**\n   * Adds an item to the batcher\n   * If the batch size is reached, timeout occurs, or shouldProcess returns true, the batch will be processed\n   */\n  addItem = (item: TValue): void => {\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      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    }\n  }\n\n  /**\n   * Processes the current batch of items.\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 batchSize\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  #execute = (): void => {\n    if (this.store.state.items.length === 0) {\n      return\n    }\n\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) // Call onItemsChange to notify listeners that the items have changed\n\n    this.fn(batch) // EXECUTE\n    this.#setState({\n      executionCount: this.store.state.executionCount + 1,\n      totalItemsProcessed: this.store.state.totalItemsProcessed + batch.length,\n    })\n    this.options.onExecute?.(batch, this)\n  }\n\n  /**\n   * Processes the current batch of items immediately\n   */\n  flush = (): void => {\n    this.#clearTimeout() // clear any pending timeout\n    this.#execute() // execute immediately\n  }\n\n  /**\n   * Returns a copy of all items in the batcher\n   */\n  peekAllItems = (): Array<TValue> => {\n    return [...this.store.state.items]\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 batcher\n   */\n  clear = (): void => {\n    this.#setState({ items: [], isPending: false })\n  }\n\n  /**\n   * Cancels any pending execution that was scheduled.\n   * Does NOT clear out the items.\n   */\n  cancel = (): void => {\n    this.#clearTimeout()\n    this.#setState({ isPending: false })\n  }\n\n  /**\n   * Resets the batcher state to its default values\n   */\n  reset = (): void => {\n    this.#setState(getDefaultBatcherState<TValue>())\n    this.options.onItemsChange?.(this)\n  }\n}\n\n/**\n * Creates a batcher that processes items in batches.\n *\n * This synchronous version is lighter weight and often all you need - upgrade to asyncBatch when you need promises, retry support, abort/cancel capabilities, or advanced error handling.\n *\n * @example\n * ```ts\n * const batchItems = batch<number>(\n *   (items) => console.log('Processing:', items),\n *   {\n *     maxSize: 3,\n *     onExecute: (batch, batcher) => console.log('Batch executed:', batch)\n *   }\n * );\n *\n * batchItems(1);\n * batchItems(2);\n * batchItems(3); // Triggers batch processing\n * ```\n */\nexport function batch<TValue>(\n  fn: (items: Array<TValue>) => void,\n  options: BatcherOptions<TValue>,\n) {\n  const batcher = new Batcher<TValue>(fn, options)\n  return batcher.addItem\n}\n"],"mappings":";;;;;AAoCA,SAAS,yBAAuD;AAC9D,QAAO;EACL,gBAAgB;EAChB,SAAS;EACT,WAAW;EACX,qBAAqB;EACrB,OAAO,EAAE;EACT,MAAM;EACN,QAAQ;EACT;;AAqDH,MAAMA,iBAA2D;CAC/D,wBAAwB;CACxB,SAAS;CACT,SAAS;CACT,MAAM;CACP;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCD,IAAa,UAAb,MAA6B;CAM3B,aAAoC;CAEpC,YACE,AAAOC,IACP,gBACA;EAFO;eAR+C,IAAIC,uBAC1D,wBAAgC,CACjC;qBA4Ba,eAAsD;AAClE,QAAK,UAAU;IAAE,GAAG,KAAK;IAAS,GAAG;IAAY;;kBA8BxC,SAAuB;AAChC,SAAKC,SAAU;IACb,OAAO,CAAC,GAAG,KAAK,MAAM,MAAM,OAAO,KAAK;IACxC,WAAW,KAAK,QAAQ,SAAS;IAClC,CAAC;AACF,QAAK,QAAQ,gBAAgB,KAAK;AAMlC,OAHE,KAAK,MAAM,MAAM,MAAM,UAAU,KAAK,QAAQ,WAC9C,KAAK,QAAQ,iBAAiB,KAAK,MAAM,MAAM,OAAO,KAAK,CAG3D,OAAKC,SAAU;YACN,KAAK,QAAQ,SAAS,UAAU;AACzC,UAAKC,cAAe;AACpB,UAAKC,YAAa,iBAAiB,MAAKF,SAAU,EAAE,MAAKG,SAAU,CAAC;;;qBAiCpD;AAClB,SAAKF,cAAe;AACpB,SAAKD,SAAU;;4BAMmB;AAClC,UAAO,CAAC,GAAG,KAAK,MAAM,MAAM,MAAM;;qBAahB;AAClB,SAAKD,SAAU;IAAE,OAAO,EAAE;IAAE,WAAW;IAAO,CAAC;;sBAO5B;AACnB,SAAKE,cAAe;AACpB,SAAKF,SAAU,EAAE,WAAW,OAAO,CAAC;;qBAMlB;AAClB,SAAKA,SAAU,wBAAgC,CAAC;AAChD,QAAK,QAAQ,gBAAgB,KAAK;;AA1IlC,OAAK,MAAM,eAAe;AAC1B,OAAK,UAAU;GACb,GAAG;GACH,GAAG;GACJ;AACD,QAAKA,SAAU,KAAK,QAAQ,gBAAgB,EAAE,CAAC;AAE/C,MAAI,KAAK,IACP,uCAAiB,GAAG,cAAc,UAAU;AAC1C,OAAI,MAAM,QAAQ,QAAQ,KAAK,IAAK;AACpC,SAAKA,SAAU,MAAM,QAAQ,MAAM,MAAM;AACzC,QAAK,WAAW,MAAM,QAAQ,QAAQ;IACtC;;CAWN,aAAa,aAAkD;AAC7D,OAAK,MAAM,UAAU,UAAU;GAC7B,MAAM,gBAAgB;IACpB,GAAG;IACH,GAAG;IACJ;GACD,MAAM,EAAE,WAAW,UAAU;GAC7B,MAAM,OAAO,MAAM;GACnB,MAAM,UAAU,SAAS;AACzB,UAAO;IACL,GAAG;IACH;IACA;IACA,QAAQ,YAAY,YAAY;IACjC;IACD;AACF,kCAAW,WAAW,KAAK;;CAG7B,iBAAyB;AACvB,SAAOK,mCAAqB,KAAK,QAAQ,MAAM,KAAK;;;;;;;;;;;CAmCtD,iBAAuB;AACrB,MAAI,KAAK,MAAM,MAAM,MAAM,WAAW,EACpC;EAGF,MAAMC,UAAQ,KAAK,cAAc;AACjC,OAAK,OAAO;AACZ,OAAK,QAAQ,gBAAgB,KAAK;AAElC,OAAK,GAAGA,QAAM;AACd,QAAKN,SAAU;GACb,gBAAgB,KAAK,MAAM,MAAM,iBAAiB;GAClD,qBAAqB,KAAK,MAAM,MAAM,sBAAsBM,QAAM;GACnE,CAAC;AACF,OAAK,QAAQ,YAAYA,SAAO,KAAK;;CAkBvC,sBAA4B;AAC1B,MAAI,MAAKH,WAAY;AACnB,gBAAa,MAAKA,UAAW;AAC7B,SAAKA,YAAa;;;;;;;;;;;;;;;;;;;;;;;;AAiDxB,SAAgB,MACd,IACA,SACA;AAEA,QADgB,IAAI,QAAgB,IAAI,QAAQ,CACjC"}