@tanstack/pacer 0.8.0 → 0.9.1

package/dist/cjs/async-batcher.cjs

@@ -0,0 +1,163 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const store = require("@tanstack/store");
+const utils = require("./utils.cjs");
+function getDefaultAsyncBatcherState() {
+  return {
+    errorCount: 0,
+    failedItems: [],
+    isEmpty: true,
+    isExecuting: false,
+    isPending: false,
+    isRunning: true,
+    items: [],
+    lastResult: void 0,
+    settleCount: 0,
+    size: 0,
+    status: "idle",
+    successCount: 0,
+    totalItemsProcessed: 0,
+    totalItemsFailed: 0
+  };
+}
+const defaultOptions = {
+  getShouldExecute: () => false,
+  maxSize: Infinity,
+  started: true,
+  throwOnError: true,
+  wait: Infinity
+};
+class AsyncBatcher {
+  constructor(fn, initialOptions) {
+    this.fn = fn;
+    this.store = new store.Store(
+      getDefaultAsyncBatcherState()
+    );
+    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"
+        };
+      });
+    };
+    this.#getWait = () => {
+      return utils.parseFunctionOrValue(this.options.wait, this);
+    };
+    this.addItem = (item) => {
+      this.#setState({
+        items: [...this.store.state.items, item],
+        isPending: this.options.wait !== Infinity
+      });
+      this.options.onItemsChange?.(this);
+      const shouldProcess = this.store.state.items.length >= this.options.maxSize || this.options.getShouldExecute(this.store.state.items, this);
+      if (shouldProcess) {
+        this.#execute();
+      } else if (this.store.state.isRunning && this.options.wait !== Infinity) {
+        this.#clearTimeout();
+        this.#timeoutId = setTimeout(() => this.#execute(), this.#getWait());
+      }
+    };
+    this.#execute = async () => {
+      if (this.store.state.items.length === 0) {
+        return void 0;
+      }
+      const batch = this.peekAllItems();
+      this.clear();
+      this.options.onItemsChange?.(this);
+      this.#setState({ isExecuting: true });
+      try {
+        const result = await this.fn(batch);
+        this.#setState({
+          totalItemsProcessed: this.store.state.totalItemsProcessed + batch.length,
+          lastResult: result,
+          successCount: this.store.state.successCount + 1
+        });
+        this.options.onSuccess?.(result, 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 void 0;
+      } finally {
+        this.#setState({
+          isExecuting: false,
+          settleCount: this.store.state.settleCount + 1
+        });
+        this.options.onSettled?.(this);
+        this.options.onExecute?.(this);
+      }
+    };
+    this.flush = async () => {
+      this.#clearTimeout();
+      return await this.#execute();
+    };
+    this.stop = () => {
+      this.#setState({ isRunning: false });
+      this.#clearTimeout();
+    };
+    this.start = () => {
+      this.#setState({ isRunning: true });
+      if (this.store.state.items.length > 0 && !this.#timeoutId) {
+        this.#timeoutId = setTimeout(() => this.#execute(), this.#getWait());
+      }
+    };
+    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.reset = () => {
+      this.#setState(getDefaultAsyncBatcherState());
+      this.options.onItemsChange?.(this);
+    };
+    this.options = {
+      ...defaultOptions,
+      ...initialOptions,
+      throwOnError: initialOptions.throwOnError ?? !initialOptions.onError
+    };
+    this.#setState(this.options.initialState ?? {});
+  }
+  #timeoutId;
+  #setState;
+  #getWait;
+  #execute;
+  #clearTimeout;
+}
+function asyncBatch(fn, options) {
+  const batcher = new AsyncBatcher(fn, options);
+  return batcher.addItem;
+}
+exports.AsyncBatcher = AsyncBatcher;
+exports.asyncBatch = asyncBatch;
+//# sourceMappingURL=async-batcher.cjs.map

package/dist/cjs/async-batcher.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"async-batcher.cjs","sources":["../../src/async-batcher.ts"],"sourcesContent":["import { Store } from '@tanstack/store'\nimport { parseFunctionOrValue } from './utils'\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   * 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   * Whether the batcher is active and will process items automatically\n   */\n  isRunning: 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 been processed across all batches\n   */\n  totalItemsProcessed: number\n  /**\n   * Total number of items that have failed processing across all batches\n   */\n  totalItemsFailed: number\n}\n\nfunction getDefaultAsyncBatcherState<TValue>(): AsyncBatcherState<TValue> {\n  return {\n    errorCount: 0,\n    failedItems: [],\n    isEmpty: true,\n    isExecuting: false,\n    isPending: false,\n    isRunning: true,\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   * 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   * 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 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: unknown,\n    failedItems: Array<TValue>,\n    batcher: AsyncBatcher<TValue>,\n  ) => void\n  /**\n   * Callback fired after a batch is processed\n   */\n  onExecute?: (batcher: AsyncBatcher<TValue>) => 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?: (batcher: AsyncBatcher<TValue>) => void\n  /**\n   * Optional callback to call when a batch succeeds\n   */\n  onSuccess?: (result: any, batcher: AsyncBatcher<TValue>) => 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\ntype AsyncBatcherOptionsWithOptionalCallbacks<TValue> = OptionalKeys<\n  Required<AsyncBatcherOptions<TValue>>,\n  | 'initialState'\n  | 'onError'\n  | 'onExecute'\n  | 'onItemsChange'\n  | 'onSettled'\n  | 'onSuccess'\n>\n\nconst defaultOptions: AsyncBatcherOptionsWithOptionalCallbacks<any> = {\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 * This is the async version of the Batcher class. Unlike the sync version, this async batcher:\n * - Handles promises and returns results from batch executions\n * - Provides error handling with configurable error behavior\n * - Tracks success, error, and settle counts separately\n * - Has state tracking for when batches are executing\n * - Returns the result of the batch function execution\n *\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 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  options: AsyncBatcherOptionsWithOptionalCallbacks<TValue>\n  #timeoutId: NodeJS.Timeout | null = null\n\n  constructor(\n    private fn: (items: Array<TValue>) => Promise<any>,\n    initialOptions: AsyncBatcherOptions<TValue>,\n  ) {\n    this.options = {\n      ...defaultOptions,\n      ...initialOptions,\n      throwOnError: initialOptions.throwOnError ?? !initialOptions.onError,\n    }\n    this.#setState(this.options.initialState ?? {})\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  }\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  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.store.state.isRunning && 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 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\n   */\n  #execute = async (): Promise<any> => {\n    if (this.store.state.items.length === 0) {\n      return undefined\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.#setState({ isExecuting: true })\n\n    try {\n      const result = await this.fn(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, 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, batch, this)\n      if (this.options.throwOnError) {\n        throw error\n      }\n      return undefined\n    } finally {\n      this.#setState({\n        isExecuting: false,\n        settleCount: this.store.state.settleCount + 1,\n      })\n      this.options.onSettled?.(this)\n      this.options.onExecute?.(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   * Stops the async batcher from processing batches\n   */\n  stop = (): void => {\n    this.#setState({ isRunning: false })\n    this.#clearTimeout()\n  }\n\n  /**\n   * Starts the async batcher and processes any pending items\n   */\n  start = (): void => {\n    this.#setState({ isRunning: true })\n    if (this.store.state.items.length > 0 && !this.#timeoutId) {\n      this.#timeoutId = setTimeout(() => this.#execute(), this.#getWait())\n    }\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   * Resets the async batcher state to its default values\n   */\n  reset = (): void => {\n    this.#setState(getDefaultAsyncBatcherState<TValue>())\n    this.options.onItemsChange?.(this)\n  }\n}\n\n/**\n * Creates an async batcher that processes items in batches\n *\n * Unlike the sync batcher, this async version:\n * - Handles promises and returns results from batch executions\n * - Provides error handling with configurable error behavior\n * - Tracks success, error, and settle counts separately\n * - Has state tracking for when batches are executing\n *\n * Error Handling:\n * - If an `onError` handler is provided, it will be called with the error 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 `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 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"],"names":["Store","parseFunctionOrValue"],"mappings":";;;;AA+DA,SAAS,8BAAiE;AACxE,SAAO;AAAA,IACL,YAAY;AAAA,IACZ,aAAa,CAAA;AAAA,IACb,SAAS;AAAA,IACT,aAAa;AAAA,IACb,WAAW;AAAA,IACX,WAAW;AAAA,IACX,OAAO,CAAA;AAAA,IACP,YAAY;AAAA,IACZ,aAAa;AAAA,IACb,MAAM;AAAA,IACN,QAAQ;AAAA,IACR,cAAc;AAAA,IACd,qBAAqB;AAAA,IACrB,kBAAkB;AAAA,EAAA;AAEtB;AA+EA,MAAM,iBAAgE;AAAA,EACpE,kBAAkB,MAAM;AAAA,EACxB,SAAS;AAAA,EACT,SAAS;AAAA,EACT,cAAc;AAAA,EACd,MAAM;AACR;AA+DO,MAAM,aAAqB;AAAA,EAOhC,YACU,IACR,gBACA;AAFQ,SAAA,KAAA;AAPV,SAAS,QAAoD,IAAIA,MAAAA;AAAAA,MAC/D,4BAAA;AAAA,IAAoC;AAGtC,SAAA,aAAoC;AAiBpC,SAAA,aAAa,CAAC,eAA2D;AACvE,WAAK,UAAU,EAAE,GAAG,KAAK,SAAS,GAAG,WAAA;AAAA,IAAW;AAGlD,SAAA,YAAY,CAAC,aAAuD;AAClE,WAAK,MAAM,SAAS,CAAC,UAAU;AAC7B,cAAM,gBAAgB;AAAA,UACpB,GAAG;AAAA,UACH,GAAG;AAAA,QAAA;AAEL,cAAM,EAAE,aAAa,WAAW,MAAA,IAAU;AAC1C,cAAM,OAAO,MAAM;AACnB,cAAM,UAAU,SAAS;AACzB,eAAO;AAAA,UACL,GAAG;AAAA,UACH;AAAA,UACA;AAAA,UACA,QAAQ,cACJ,cACA,YACE,YACA,UACE,SACA;AAAA,QAAA;AAAA,MACV,CACD;AAAA,IAAA;AAGH,SAAA,WAAW,MAAc;AACvB,aAAOC,MAAAA,qBAAqB,KAAK,QAAQ,MAAM,IAAI;AAAA,IAAA;AAOrD,SAAA,UAAU,CAAC,SAAuB;AAChC,WAAK,UAAU;AAAA,QACb,OAAO,CAAC,GAAG,KAAK,MAAM,MAAM,OAAO,IAAI;AAAA,QACvC,WAAW,KAAK,QAAQ,SAAS;AAAA,MAAA,CAClC;AACD,WAAK,QAAQ,gBAAgB,IAAI;AAEjC,YAAM,gBACJ,KAAK,MAAM,MAAM,MAAM,UAAU,KAAK,QAAQ,WAC9C,KAAK,QAAQ,iBAAiB,KAAK,MAAM,MAAM,OAAO,IAAI;AAE5D,UAAI,eAAe;AACjB,aAAK,SAAA;AAAA,MAAS,WACL,KAAK,MAAM,MAAM,aAAa,KAAK,QAAQ,SAAS,UAAU;AACvE,aAAK,cAAA;AACL,aAAK,aAAa,WAAW,MAAM,KAAK,YAAY,KAAK,UAAU;AAAA,MAAA;AAAA,IACrE;AAeF,SAAA,WAAW,YAA0B;AACnC,UAAI,KAAK,MAAM,MAAM,MAAM,WAAW,GAAG;AACvC,eAAO;AAAA,MAAA;AAGT,YAAM,QAAQ,KAAK,aAAA;AACnB,WAAK,MAAA;AACL,WAAK,QAAQ,gBAAgB,IAAI;AAEjC,WAAK,UAAU,EAAE,aAAa,KAAA,CAAM;AAEpC,UAAI;AACF,cAAM,SAAS,MAAM,KAAK,GAAG,KAAK;AAClC,aAAK,UAAU;AAAA,UACb,qBACE,KAAK,MAAM,MAAM,sBAAsB,MAAM;AAAA,UAC/C,YAAY;AAAA,UACZ,cAAc,KAAK,MAAM,MAAM,eAAe;AAAA,QAAA,CAC/C;AACD,aAAK,QAAQ,YAAY,QAAQ,IAAI;AACrC,eAAO;AAAA,MAAA,SACA,OAAO;AACd,aAAK,UAAU;AAAA,UACb,YAAY,KAAK,MAAM,MAAM,aAAa;AAAA,UAC1C,aAAa,CAAC,GAAG,KAAK,MAAM,MAAM,aAAa,GAAG,KAAK;AAAA,UACvD,kBAAkB,KAAK,MAAM,MAAM,mBAAmB,MAAM;AAAA,QAAA,CAC7D;AACD,aAAK,QAAQ,UAAU,OAAO,OAAO,IAAI;AACzC,YAAI,KAAK,QAAQ,cAAc;AAC7B,gBAAM;AAAA,QAAA;AAER,eAAO;AAAA,MAAA,UACT;AACE,aAAK,UAAU;AAAA,UACb,aAAa;AAAA,UACb,aAAa,KAAK,MAAM,MAAM,cAAc;AAAA,QAAA,CAC7C;AACD,aAAK,QAAQ,YAAY,IAAI;AAC7B,aAAK,QAAQ,YAAY,IAAI;AAAA,MAAA;AAAA,IAC/B;AAMF,SAAA,QAAQ,YAA0B;AAChC,WAAK,cAAA;AACL,aAAO,MAAM,KAAK,SAAA;AAAA,IAAS;AAM7B,SAAA,OAAO,MAAY;AACjB,WAAK,UAAU,EAAE,WAAW,MAAA,CAAO;AACnC,WAAK,cAAA;AAAA,IAAc;AAMrB,SAAA,QAAQ,MAAY;AAClB,WAAK,UAAU,EAAE,WAAW,KAAA,CAAM;AAClC,UAAI,KAAK,MAAM,MAAM,MAAM,SAAS,KAAK,CAAC,KAAK,YAAY;AACzD,aAAK,aAAa,WAAW,MAAM,KAAK,YAAY,KAAK,UAAU;AAAA,MAAA;AAAA,IACrE;AAMF,SAAA,eAAe,MAAqB;AAClC,aAAO,CAAC,GAAG,KAAK,MAAM,MAAM,KAAK;AAAA,IAAA;AAGnC,SAAA,kBAAkB,MAAqB;AACrC,aAAO,CAAC,GAAG,KAAK,MAAM,MAAM,WAAW;AAAA,IAAA;AAGzC,SAAA,gBAAgB,MAAY;AAC1B,UAAI,KAAK,YAAY;AACnB,qBAAa,KAAK,UAAU;AAC5B,aAAK,aAAa;AAAA,MAAA;AAAA,IACpB;AAMF,SAAA,QAAQ,MAAY;AAClB,WAAK,UAAU,EAAE,OAAO,CAAA,GAAI,aAAa,CAAA,GAAI,WAAW,OAAO;AAAA,IAAA;AAMjE,SAAA,QAAQ,MAAY;AAClB,WAAK,UAAU,6BAAqC;AACpD,WAAK,QAAQ,gBAAgB,IAAI;AAAA,IAAA;AAhLjC,SAAK,UAAU;AAAA,MACb,GAAG;AAAA,MACH,GAAG;AAAA,MACH,cAAc,eAAe,gBAAgB,CAAC,eAAe;AAAA,IAAA;AAE/D,SAAK,UAAU,KAAK,QAAQ,gBAAgB,CAAA,CAAE;AAAA,EAAA;AAAA,EAXhD;AAAA,EAqBA;AAAA,EAwBA;AAAA,EAuCA;AAAA,EA+EA;AAqBF;AAmDO,SAAS,WACd,IACA,SACA;AACA,QAAM,UAAU,IAAI,aAAqB,IAAI,OAAO;AACpD,SAAO,QAAQ;AACjB;;;"}

package/dist/cjs/async-batcher.d.cts

@@ -0,0 +1,273 @@
+import { Store } from '@tanstack/store';
+import { OptionalKeys } from './types.cjs';
+export interface AsyncBatcherState<TValue> {
+    /**
+     * Number of batch executions that have resulted in errors
+     */
+    errorCount: number;
+    /**
+     * Array of items that failed during batch processing
+     */
+    failedItems: Array<TValue>;
+    /**
+     * Whether the batcher has no items to process (items array is empty)
+     */
+    isEmpty: boolean;
+    /**
+     * Whether a batch is currently being processed asynchronously
+     */
+    isExecuting: boolean;
+    /**
+     * Whether the batcher is waiting for the timeout to trigger batch processing
+     */
+    isPending: boolean;
+    /**
+     * Whether the batcher is active and will process items automatically
+     */
+    isRunning: boolean;
+    /**
+     * Array of items currently queued for batch processing
+     */
+    items: Array<TValue>;
+    /**
+     * The result from the most recent batch execution
+     */
+    lastResult: any;
+    /**
+     * Number of batch executions that have completed (either successfully or with errors)
+     */
+    settleCount: number;
+    /**
+     * Number of items currently in the batch queue
+     */
+    size: number;
+    /**
+     * 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
+     */
+    status: 'idle' | 'pending' | 'executing' | 'populated';
+    /**
+     * Number of batch executions that have completed successfully
+     */
+    successCount: number;
+    /**
+     * Total number of items that have been processed across all batches
+     */
+    totalItemsProcessed: number;
+    /**
+     * Total number of items that have failed processing across all batches
+     */
+    totalItemsFailed: number;
+}
+/**
+ * Options for configuring an AsyncBatcher instance
+ */
+export interface AsyncBatcherOptions<TValue> {
+    /**
+     * Custom function to determine if a batch should be processed
+     * Return true to process the batch immediately
+     */
+    getShouldExecute?: (items: Array<TValue>, batcher: AsyncBatcher<TValue>) => boolean;
+    /**
+     * Initial state for the async batcher
+     */
+    initialState?: Partial<AsyncBatcherState<TValue>>;
+    /**
+     * Maximum number of items in a batch
+     * @default Infinity
+     */
+    maxSize?: number;
+    /**
+     * Optional error handler for when the batch function throws.
+     * If provided, the handler will be called with the error and batcher instance.
+     * This can be used alongside throwOnError - the handler will be called before any error is thrown.
+     */
+    onError?: (error: unknown, failedItems: Array<TValue>, batcher: AsyncBatcher<TValue>) => void;
+    /**
+     * Callback fired after a batch is processed
+     */
+    onExecute?: (batcher: AsyncBatcher<TValue>) => void;
+    /**
+     * Callback fired after items are added to the batcher
+     */
+    onItemsChange?: (batcher: AsyncBatcher<TValue>) => void;
+    /**
+     * Optional callback to call when a batch is settled (completed or failed)
+     */
+    onSettled?: (batcher: AsyncBatcher<TValue>) => void;
+    /**
+     * Optional callback to call when a batch succeeds
+     */
+    onSuccess?: (result: any, batcher: AsyncBatcher<TValue>) => void;
+    /**
+     * Whether the batcher should start processing immediately
+     * @default true
+     */
+    started?: boolean;
+    /**
+     * Whether to throw errors when they occur.
+     * Defaults to true if no onError handler is provided, false if an onError handler is provided.
+     * Can be explicitly set to override these defaults.
+     */
+    throwOnError?: boolean;
+    /**
+     * Maximum time in milliseconds to wait before processing a batch.
+     * If the wait duration has elapsed, the batch will be processed.
+     * If not provided, the batch will not be triggered by a timeout.
+     * @default Infinity
+     */
+    wait?: number | ((asyncBatcher: AsyncBatcher<TValue>) => number);
+}
+type AsyncBatcherOptionsWithOptionalCallbacks<TValue> = OptionalKeys<Required<AsyncBatcherOptions<TValue>>, 'initialState' | 'onError' | 'onExecute' | 'onItemsChange' | 'onSettled' | 'onSuccess'>;
+/**
+ * A class that collects items and processes them in batches asynchronously.
+ *
+ * This is the async version of the Batcher class. Unlike the sync version, this async batcher:
+ * - Handles promises and returns results from batch executions
+ * - Provides error handling with configurable error behavior
+ * - Tracks success, error, and settle counts separately
+ * - Has state tracking for when batches are executing
+ * - Returns the result of the batch function execution
+ *
+ * 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 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
+ * ```
+ */
+export declare class AsyncBatcher<TValue> {
+    #private;
+    private fn;
+    readonly store: Store<Readonly<AsyncBatcherState<TValue>>>;
+    options: AsyncBatcherOptionsWithOptionalCallbacks<TValue>;
+    constructor(fn: (items: Array<TValue>) => Promise<any>, initialOptions: AsyncBatcherOptions<TValue>);
+    /**
+     * Updates the async batcher options
+     */
+    setOptions: (newOptions: Partial<AsyncBatcherOptions<TValue>>) => void;
+    /**
+     * Adds an item to the async batcher
+     * If the batch size is reached, timeout occurs, or shouldProcess returns true, the batch will be processed
+     */
+    addItem: (item: TValue) => void;
+    /**
+     * Processes the current batch of items immediately
+     */
+    flush: () => Promise<any>;
+    /**
+     * Stops the async batcher from processing batches
+     */
+    stop: () => void;
+    /**
+     * Starts the async batcher and processes any pending items
+     */
+    start: () => void;
+    /**
+     * Returns a copy of all items in the async batcher
+     */
+    peekAllItems: () => Array<TValue>;
+    peekFailedItems: () => Array<TValue>;
+    /**
+     * Removes all items from the async batcher
+     */
+    clear: () => void;
+    /**
+     * Resets the async batcher state to its default values
+     */
+    reset: () => void;
+}
+/**
+ * Creates an async batcher that processes items in batches
+ *
+ * Unlike the sync batcher, this async version:
+ * - Handles promises and returns results from batch executions
+ * - Provides error handling with configurable error behavior
+ * - Tracks success, error, and settle counts separately
+ * - Has state tracking for when batches are executing
+ *
+ * Error Handling:
+ * - If an `onError` handler is provided, it will be called with the error and batcher instance
+ * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
+ * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
+ * - Both onError and throwOnError can be used together - the handler will be called before any error is thrown
+ * - The error state can be checked using the underlying AsyncBatcher instance
+ *
+ * State Management:
+ * - 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 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
+ * ```
+ */
+export declare function asyncBatch<TValue>(fn: (items: Array<TValue>) => Promise<any>, options: AsyncBatcherOptions<TValue>): (item: TValue) => void;
+export {};