@tanstack/solid-pacer 0.21.1 → 0.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/solid-pacer",
-  "version": "0.21.1",
+  "version": "0.23.0",
   "description": "Utilities for debouncing and throttling functions in Solid.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -23,83 +23,38 @@
     "async"
   ],
   "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.cts",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    },
-    "./async-batcher": {
-      "import": "./dist/async-batcher/index.js",
-      "require": "./dist/async-batcher/index.cjs"
-    },
-    "./async-debouncer": {
-      "import": "./dist/async-debouncer/index.js",
-      "require": "./dist/async-debouncer/index.cjs"
-    },
-    "./async-queuer": {
-      "import": "./dist/async-queuer/index.js",
-      "require": "./dist/async-queuer/index.cjs"
-    },
-    "./async-rate-limiter": {
-      "import": "./dist/async-rate-limiter/index.js",
-      "require": "./dist/async-rate-limiter/index.cjs"
-    },
-    "./async-throttler": {
-      "import": "./dist/async-throttler/index.js",
-      "require": "./dist/async-throttler/index.cjs"
-    },
-    "./batcher": {
-      "import": "./dist/batcher/index.js",
-      "require": "./dist/batcher/index.cjs"
-    },
-    "./debouncer": {
-      "import": "./dist/debouncer/index.js",
-      "require": "./dist/debouncer/index.cjs"
-    },
-    "./provider": {
-      "import": "./dist/provider/index.js",
-      "require": "./dist/provider/index.cjs"
-    },
-    "./queuer": {
-      "import": "./dist/queuer/index.js",
-      "require": "./dist/queuer/index.cjs"
-    },
-    "./rate-limiter": {
-      "import": "./dist/rate-limiter/index.js",
-      "require": "./dist/rate-limiter/index.cjs"
-    },
-    "./throttler": {
-      "import": "./dist/throttler/index.js",
-      "require": "./dist/throttler/index.cjs"
-    },
-    "./types": {
-      "import": "./dist/types/index.js",
-      "require": "./dist/types/index.cjs"
-    },
-    "./utils": {
-      "import": "./dist/utils/index.js",
-      "require": "./dist/utils/index.cjs"
-    },
+    ".": "./dist/index.js",
+    "./async-batcher": "./dist/async-batcher/index.js",
+    "./async-debouncer": "./dist/async-debouncer/index.js",
+    "./async-queuer": "./dist/async-queuer/index.js",
+    "./async-rate-limiter": "./dist/async-rate-limiter/index.js",
+    "./async-throttler": "./dist/async-throttler/index.js",
+    "./batcher": "./dist/batcher/index.js",
+    "./debouncer": "./dist/debouncer/index.js",
+    "./provider": "./dist/provider/index.js",
+    "./queuer": "./dist/queuer/index.js",
+    "./rate-limiter": "./dist/rate-limiter/index.js",
+    "./throttler": "./dist/throttler/index.js",
+    "./types": "./dist/types/index.js",
+    "./utils": "./dist/utils/index.js",
     "./package.json": "./package.json"
   },
   "sideEffects": false,
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "dependencies": {
-    "@tanstack/solid-store": "^0.11.0",
-    "@tanstack/pacer": "0.21.1"
+    "@tanstack/pacer": "0.23.0",
+    "@tanstack/solid-store": "^0.11.1"
   },
   "devDependencies": {
-    "solid-js": "^1.9.12",
-    "vite-plugin-solid": "^2.11.12"
+    "solid-js": "^1.9.15",
+    "vite-plugin-solid": "^2.11.14"
   },
   "peerDependencies": {
     "solid-js": ">=1.9.5"
@@ -111,6 +66,7 @@
     "test:lib": "vitest --passWithNoTests",
     "test:lib:dev": "pnpm test:lib --watch",
     "test:types": "tsc",
-    "build": "tsdown"
+    "build": "tsdown",
+    "test:build": "publint --strict && node ../../scripts/verify-package.ts"
   }
 }

package/dist/async-batcher/createAsyncBatcher.cjs

@@ -1,166 +0,0 @@
-const require_PacerProvider = require('../provider/PacerProvider.cjs');
-let solid_js = require("solid-js");
-let _tanstack_pacer_async_batcher = require("@tanstack/pacer/async-batcher");
-let _tanstack_solid_store = require("@tanstack/solid-store");
-
-//#region src/async-batcher/createAsyncBatcher.ts
-/**
-* Creates a Solid-compatible AsyncBatcher instance for managing asynchronous batches of items, exposing Solid signals for all stateful properties.
-*
-* This is the async version of the createBatcher hook. Unlike the sync version, this async batcher:
-* - Handles promises and returns results from batch executions
-* - Provides error handling with configurable error behavior
-* - Tracks success, error, and settle counts separately
-* - Has state tracking for when batches are executing
-* - Returns the result of the batch function execution
-*
-* Features:
-* - Configurable batch size and wait time
-* - Custom batch processing logic via getShouldExecute
-* - Event callbacks for monitoring batch operations
-* - Error handling for failed batch operations
-* - Automatic or manual batch processing
-* - All stateful properties (items, counts, etc.) are exposed as Solid signals for reactivity
-*
-* The batcher collects items and processes them in batches based on:
-* - Maximum batch size (number of items per batch)
-* - Time-based batching (process after X milliseconds)
-* - Custom batch processing logic via getShouldExecute
-*
-* Error Handling:
-* - If an `onError` handler is provided, it will be called with the error and batcher instance
-* - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
-* - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
-* - Both onError and throwOnError can be used together; the handler will be called before any error is thrown
-* - The error state can be checked using the underlying AsyncBatcher instance
-*
-* ## State Management and Selector
-*
-* The hook uses TanStack Store for reactive state management. You can subscribe to state changes
-* in two ways:
-*
-* **1. Using `batcher.Subscribe` component (Recommended for component tree subscriptions)**
-*
-* Use the `Subscribe` component to subscribe to state changes deep in your component tree without
-* needing to pass a selector to the hook. This is ideal when you want to subscribe to state
-* in child components.
-*
-* **2. Using the `selector` parameter (For hook-level subscriptions)**
-*
-* The `selector` parameter allows you to specify which state changes will trigger reactive updates
-* at the hook level, optimizing performance by preventing unnecessary updates when irrelevant
-* state changes occur.
-*
-* **By default, there will be no reactive state subscriptions** and you must opt-in to state
-* tracking by providing a selector function or using the `Subscribe` component. This prevents unnecessary
-* updates and gives you full control over when your component tracks state changes.
-*
-* Available state properties:
-* - `errorCount`: Number of failed batch executions
-* - `executionCount`: Total number of batch execution attempts (successful + failed)
-* - `hasError`: Whether the last batch execution resulted in an error
-* - `isExecuting`: Whether a batch execution is currently in progress
-* - `items`: Array of items currently queued for batching
-* - `lastError`: The error from the most recent failed batch execution (if any)
-* - `lastResult`: The result from the most recent successful batch execution
-* - `settleCount`: Number of batch executions that have completed (successful or failed)
-* - `successCount`: Number of successful batch executions
-*
-* ## Unmount behavior
-*
-* By default, the primitive cancels any pending batch and aborts any in-flight execution when the owning component unmounts.
-* Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
-* Use the `onUnmount` option to customize this. For example, to flush pending work instead:
-*
-* ```tsx
-* const batcher = createAsyncBatcher(fn, {
-*   maxSize: 10,
-*   wait: 2000,
-*   onUnmount: (b) => b.flush()
-* });
-* ```
-*
-* Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
-* If your batch function updates Solid signals, those updates may run after the component has
-* unmounted, which can cause unexpected reactive updates. Guard your callbacks accordingly when
-* using onUnmount with flush.
-*
-* Example usage:
-* ```tsx
-* // Default behavior - no reactive state subscriptions
-* const asyncBatcher = createAsyncBatcher(
-*   async (items) => {
-*     const results = await Promise.all(items.map(item => processItem(item)));
-*     return results;
-*   },
-*   {
-*     maxSize: 10,
-*     wait: 2000,
-*     onSuccess: (result) => {
-*       console.log('Batch processed successfully:', result);
-*     },
-*     onError: (error) => {
-*       console.error('Batch processing failed:', error);
-*     }
-*   }
-* );
-*
-* // Opt-in to track items or isExecuting changes (optimized for UI updates)
-* const asyncBatcher = createAsyncBatcher(
-*   async (items) => {
-*     const results = await Promise.all(items.map(item => processItem(item)));
-*     return results;
-*   },
-*   { maxSize: 10, wait: 2000 },
-*   (state) => ({ items: state.items, isExecuting: state.isExecuting })
-* );
-*
-* // Opt-in to track error state changes (optimized for error handling)
-* const asyncBatcher = createAsyncBatcher(
-*   async (items) => {
-*     const results = await Promise.all(items.map(item => processItem(item)));
-*     return results;
-*   },
-*   { maxSize: 10, wait: 2000 },
-*   (state) => ({ hasError: state.hasError, lastError: state.lastError })
-* );
-*
-* // Add items to batch
-* asyncBatcher.addItem(newItem);
-*
-* // Manually execute batch
-* const result = await asyncBatcher.execute();
-*
-* // Access the selected state (will be empty object {} unless selector provided)
-* const { items, isExecuting } = asyncBatcher.state();
-* ```
-*/
-function createAsyncBatcher(fn, options = {}, selector = () => ({})) {
-	const mergedOptions = {
-		...require_PacerProvider.useDefaultPacerOptions().asyncBatcher,
-		...options
-	};
-	const asyncBatcher = new _tanstack_pacer_async_batcher.AsyncBatcher(fn, mergedOptions);
-	asyncBatcher.Subscribe = function Subscribe(props) {
-		const selected = (0, _tanstack_solid_store.useSelector)(asyncBatcher.store, props.selector, { compare: _tanstack_solid_store.shallow });
-		return typeof props.children === "function" ? props.children(selected) : props.children;
-	};
-	const state = (0, _tanstack_solid_store.useSelector)(asyncBatcher.store, selector, { compare: _tanstack_solid_store.shallow });
-	(0, solid_js.createEffect)(() => {
-		(0, solid_js.onCleanup)(() => {
-			if (mergedOptions.onUnmount) mergedOptions.onUnmount(asyncBatcher);
-			else {
-				asyncBatcher.cancel();
-				asyncBatcher.abort();
-			}
-		});
-	});
-	return {
-		...asyncBatcher,
-		state
-	};
-}
-
-//#endregion
-exports.createAsyncBatcher = createAsyncBatcher;
-//# sourceMappingURL=createAsyncBatcher.cjs.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"createAsyncBatcher.cjs","names":["useDefaultPacerOptions","AsyncBatcher","shallow"],"sources":["../../src/async-batcher/createAsyncBatcher.ts"],"sourcesContent":["import { AsyncBatcher } from '@tanstack/pacer/async-batcher'\nimport { shallow, useSelector } from '@tanstack/solid-store'\nimport { createEffect, onCleanup } from 'solid-js'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor, JSX } from 'solid-js'\nimport type {\n  AsyncBatcherOptions,\n  AsyncBatcherState,\n} from '@tanstack/pacer/async-batcher'\n\nexport interface SolidAsyncBatcherOptions<\n  TValue,\n  TSelected = {},\n> extends AsyncBatcherOptions<TValue> {\n  /**\n   * Optional callback invoked when the owning component unmounts. Receives the batcher instance.\n   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.\n   */\n  onUnmount?: (batcher: SolidAsyncBatcher<TValue, TSelected>) => void\n}\n\nexport interface SolidAsyncBatcher<TValue, TSelected = {}> extends Omit<\n  AsyncBatcher<TValue>,\n  'store'\n> {\n  /**\n   * A Solid component that allows you to subscribe to the batcher state.\n   *\n   * This is useful for tracking specific parts of the batcher state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <batcher.Subscribe selector={(state) => ({ size: state.size, isExecuting: state.isExecuting })}>\n   *   {(state) => (\n   *     <div>Batch: {state().size} items, {state().isExecuting ? 'Executing...' : 'Idle'}</div>\n   *   )}\n   * </batcher.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncBatcherState<TValue>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) => JSX.Element\n  /**\n   * Reactive state that will be updated when the batcher state changes\n   *\n   * Use this instead of `batcher.store.state`\n   */\n  readonly state: Accessor<Readonly<TSelected>>\n  /**\n   * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.\n   * Although, you can make the state reactive by using the `useSelector` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncBatcherState<TValue>>>\n}\n\n/**\n * Creates a Solid-compatible AsyncBatcher instance for managing asynchronous batches of items, exposing Solid signals for all stateful properties.\n *\n * This is the async version of the createBatcher hook. 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 * Features:\n * - Configurable batch size and wait time\n * - Custom batch processing logic via getShouldExecute\n * - Event callbacks for monitoring batch operations\n * - Error handling for failed batch operations\n * - Automatic or manual batch processing\n * - All stateful properties (items, counts, etc.) are exposed as Solid signals for reactivity\n *\n * The batcher collects items and processes them in batches based on:\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 *\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 and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `batcher.Subscribe` component (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` component to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger reactive updates\n * at the hook level, optimizing performance by preventing unnecessary updates when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` component. This prevents unnecessary\n * updates and gives you full control over when your component tracks state changes.\n *\n * Available state properties:\n * - `errorCount`: Number of failed batch executions\n * - `executionCount`: Total number of batch execution attempts (successful + failed)\n * - `hasError`: Whether the last batch execution resulted in an error\n * - `isExecuting`: Whether a batch execution is currently in progress\n * - `items`: Array of items currently queued for batching\n * - `lastError`: The error from the most recent failed batch execution (if any)\n * - `lastResult`: The result from the most recent successful batch execution\n * - `settleCount`: Number of batch executions that have completed (successful or failed)\n * - `successCount`: Number of successful batch executions\n *\n * ## Unmount behavior\n *\n * By default, the primitive cancels any pending batch and aborts any in-flight execution when the owning component unmounts.\n * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```tsx\n * const batcher = createAsyncBatcher(fn, {\n *   maxSize: 10,\n *   wait: 2000,\n *   onUnmount: (b) => b.flush()\n * });\n * ```\n *\n * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.\n * If your batch function updates Solid signals, those updates may run after the component has\n * unmounted, which can cause unexpected reactive updates. Guard your callbacks accordingly when\n * using onUnmount with flush.\n *\n * Example usage:\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncBatcher = createAsyncBatcher(\n *   async (items) => {\n *     const results = await Promise.all(items.map(item => processItem(item)));\n *     return results;\n *   },\n *   {\n *     maxSize: 10,\n *     wait: 2000,\n *     onSuccess: (result) => {\n *       console.log('Batch processed successfully:', result);\n *     },\n *     onError: (error) => {\n *       console.error('Batch processing failed:', error);\n *     }\n *   }\n * );\n *\n * // Opt-in to track items or isExecuting changes (optimized for UI updates)\n * const asyncBatcher = createAsyncBatcher(\n *   async (items) => {\n *     const results = await Promise.all(items.map(item => processItem(item)));\n *     return results;\n *   },\n *   { maxSize: 10, wait: 2000 },\n *   (state) => ({ items: state.items, isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to track error state changes (optimized for error handling)\n * const asyncBatcher = createAsyncBatcher(\n *   async (items) => {\n *     const results = await Promise.all(items.map(item => processItem(item)));\n *     return results;\n *   },\n *   { maxSize: 10, wait: 2000 },\n *   (state) => ({ hasError: state.hasError, lastError: state.lastError })\n * );\n *\n * // Add items to batch\n * asyncBatcher.addItem(newItem);\n *\n * // Manually execute batch\n * const result = await asyncBatcher.execute();\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { items, isExecuting } = asyncBatcher.state();\n * ```\n */\nexport function createAsyncBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => Promise<any>,\n  options: SolidAsyncBatcherOptions<TValue, TSelected> = {},\n  selector: (state: AsyncBatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): SolidAsyncBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncBatcher,\n    ...options,\n  } as SolidAsyncBatcherOptions<TValue, TSelected>\n  const asyncBatcher = new AsyncBatcher<TValue>(\n    fn,\n    mergedOptions,\n  ) as unknown as SolidAsyncBatcher<TValue, TSelected>\n\n  asyncBatcher.Subscribe = function Subscribe<TSelected>(props: {\n    selector: (state: AsyncBatcherState<TValue>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) {\n    const selected = useSelector(asyncBatcher.store, props.selector, {\n      compare: shallow,\n    })\n\n    return typeof props.children === 'function'\n      ? props.children(selected)\n      : props.children\n  }\n\n  const state = useSelector(asyncBatcher.store, selector, { compare: shallow })\n\n  createEffect(() => {\n    onCleanup(() => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(asyncBatcher)\n      } else {\n        asyncBatcher.cancel()\n        asyncBatcher.abort()\n      }\n    })\n  })\n\n  return {\n    ...asyncBatcher,\n    state,\n  } as SolidAsyncBatcher<TValue, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4LA,SAAgB,mBACd,IACA,UAAuD,EAAE,EACzD,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAGA,8CAAwB,CAAC;EAC5B,GAAG;EACJ;CACD,MAAM,eAAe,IAAIC,2CACvB,IACA,cACD;CAED,aAAa,YAAY,SAAS,UAAqB,OAGpD;EACD,MAAM,kDAAuB,aAAa,OAAO,MAAM,UAAU,EAC/D,SAASC,+BACV,CAAC;EAEF,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;CAGZ,MAAM,+CAAoB,aAAa,OAAO,UAAU,EAAE,SAASA,+BAAS,CAAC;CAE7E,iCAAmB;EACjB,8BAAgB;GACd,IAAI,cAAc,WAChB,cAAc,UAAU,aAAa;QAChC;IACL,aAAa,QAAQ;IACrB,aAAa,OAAO;;IAEtB;GACF;CAEF,OAAO;EACL,GAAG;EACH;EACD"}

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

@@ -1,178 +0,0 @@
-import { AsyncBatcher, AsyncBatcherOptions, AsyncBatcherState } from "@tanstack/pacer/async-batcher";
-import { Store } from "@tanstack/solid-store";
-import { Accessor, JSX } from "solid-js";
-
-//#region src/async-batcher/createAsyncBatcher.d.ts
-interface SolidAsyncBatcherOptions<TValue, TSelected = {}> extends AsyncBatcherOptions<TValue> {
-  /**
-   * Optional callback invoked when the owning component unmounts. Receives the batcher instance.
-   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.
-   */
-  onUnmount?: (batcher: SolidAsyncBatcher<TValue, TSelected>) => void;
-}
-interface SolidAsyncBatcher<TValue, TSelected = {}> extends Omit<AsyncBatcher<TValue>, 'store'> {
-  /**
-   * A Solid component that allows you to subscribe to the batcher state.
-   *
-   * This is useful for tracking specific parts of the batcher state
-   * deep in your component tree without needing to pass a selector to the hook.
-   *
-   * @example
-   * <batcher.Subscribe selector={(state) => ({ size: state.size, isExecuting: state.isExecuting })}>
-   *   {(state) => (
-   *     <div>Batch: {state().size} items, {state().isExecuting ? 'Executing...' : 'Idle'}</div>
-   *   )}
-   * </batcher.Subscribe>
-   */
-  Subscribe: <TSelected>(props: {
-    selector: (state: AsyncBatcherState<TValue>) => TSelected;
-    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element;
-  }) => JSX.Element;
-  /**
-   * Reactive state that will be updated when the batcher state changes
-   *
-   * Use this instead of `batcher.store.state`
-   */
-  readonly state: Accessor<Readonly<TSelected>>;
-  /**
-   * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.
-   * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.
-   * Although, you can make the state reactive by using the `useSelector` in your own usage.
-   */
-  readonly store: Store<Readonly<AsyncBatcherState<TValue>>>;
-}
-/**
- * Creates a Solid-compatible AsyncBatcher instance for managing asynchronous batches of items, exposing Solid signals for all stateful properties.
- *
- * This is the async version of the createBatcher hook. Unlike the sync version, this async batcher:
- * - Handles promises and returns results from batch executions
- * - Provides error handling with configurable error behavior
- * - Tracks success, error, and settle counts separately
- * - Has state tracking for when batches are executing
- * - Returns the result of the batch function execution
- *
- * Features:
- * - Configurable batch size and wait time
- * - Custom batch processing logic via getShouldExecute
- * - Event callbacks for monitoring batch operations
- * - Error handling for failed batch operations
- * - Automatic or manual batch processing
- * - All stateful properties (items, counts, etc.) are exposed as Solid signals for reactivity
- *
- * The batcher collects items and processes them in batches based on:
- * - Maximum batch size (number of items per batch)
- * - Time-based batching (process after X milliseconds)
- * - Custom batch processing logic via getShouldExecute
- *
- * Error Handling:
- * - If an `onError` handler is provided, it will be called with the error and batcher instance
- * - If `throwOnError` is true (default when no onError handler is provided), the error will be thrown
- * - If `throwOnError` is false (default when onError handler is provided), the error will be swallowed
- * - Both onError and throwOnError can be used together; the handler will be called before any error is thrown
- * - The error state can be checked using the underlying AsyncBatcher instance
- *
- * ## State Management and Selector
- *
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
- * in two ways:
- *
- * **1. Using `batcher.Subscribe` component (Recommended for component tree subscriptions)**
- *
- * Use the `Subscribe` component to subscribe to state changes deep in your component tree without
- * needing to pass a selector to the hook. This is ideal when you want to subscribe to state
- * in child components.
- *
- * **2. Using the `selector` parameter (For hook-level subscriptions)**
- *
- * The `selector` parameter allows you to specify which state changes will trigger reactive updates
- * at the hook level, optimizing performance by preventing unnecessary updates when irrelevant
- * state changes occur.
- *
- * **By default, there will be no reactive state subscriptions** and you must opt-in to state
- * tracking by providing a selector function or using the `Subscribe` component. This prevents unnecessary
- * updates and gives you full control over when your component tracks state changes.
- *
- * Available state properties:
- * - `errorCount`: Number of failed batch executions
- * - `executionCount`: Total number of batch execution attempts (successful + failed)
- * - `hasError`: Whether the last batch execution resulted in an error
- * - `isExecuting`: Whether a batch execution is currently in progress
- * - `items`: Array of items currently queued for batching
- * - `lastError`: The error from the most recent failed batch execution (if any)
- * - `lastResult`: The result from the most recent successful batch execution
- * - `settleCount`: Number of batch executions that have completed (successful or failed)
- * - `successCount`: Number of successful batch executions
- *
- * ## Unmount behavior
- *
- * By default, the primitive cancels any pending batch and aborts any in-flight execution when the owning component unmounts.
- * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
- *
- * ```tsx
- * const batcher = createAsyncBatcher(fn, {
- *   maxSize: 10,
- *   wait: 2000,
- *   onUnmount: (b) => b.flush()
- * });
- * ```
- *
- * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.
- * If your batch function updates Solid signals, those updates may run after the component has
- * unmounted, which can cause unexpected reactive updates. Guard your callbacks accordingly when
- * using onUnmount with flush.
- *
- * Example usage:
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const asyncBatcher = createAsyncBatcher(
- *   async (items) => {
- *     const results = await Promise.all(items.map(item => processItem(item)));
- *     return results;
- *   },
- *   {
- *     maxSize: 10,
- *     wait: 2000,
- *     onSuccess: (result) => {
- *       console.log('Batch processed successfully:', result);
- *     },
- *     onError: (error) => {
- *       console.error('Batch processing failed:', error);
- *     }
- *   }
- * );
- *
- * // Opt-in to track items or isExecuting changes (optimized for UI updates)
- * const asyncBatcher = createAsyncBatcher(
- *   async (items) => {
- *     const results = await Promise.all(items.map(item => processItem(item)));
- *     return results;
- *   },
- *   { maxSize: 10, wait: 2000 },
- *   (state) => ({ items: state.items, isExecuting: state.isExecuting })
- * );
- *
- * // Opt-in to track error state changes (optimized for error handling)
- * const asyncBatcher = createAsyncBatcher(
- *   async (items) => {
- *     const results = await Promise.all(items.map(item => processItem(item)));
- *     return results;
- *   },
- *   { maxSize: 10, wait: 2000 },
- *   (state) => ({ hasError: state.hasError, lastError: state.lastError })
- * );
- *
- * // Add items to batch
- * asyncBatcher.addItem(newItem);
- *
- * // Manually execute batch
- * const result = await asyncBatcher.execute();
- *
- * // Access the selected state (will be empty object {} unless selector provided)
- * const { items, isExecuting } = asyncBatcher.state();
- * ```
- */
-declare function createAsyncBatcher<TValue, TSelected = {}>(fn: (items: Array<TValue>) => Promise<any>, options?: SolidAsyncBatcherOptions<TValue, TSelected>, selector?: (state: AsyncBatcherState<TValue>) => TSelected): SolidAsyncBatcher<TValue, TSelected>;
-//#endregion
-export { SolidAsyncBatcher, SolidAsyncBatcherOptions, createAsyncBatcher };
-//# sourceMappingURL=createAsyncBatcher.d.cts.map

package/dist/async-batcher/createAsyncBatcher.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createAsyncBatcher.js","names":[],"sources":["../../src/async-batcher/createAsyncBatcher.ts"],"sourcesContent":["import { AsyncBatcher } from '@tanstack/pacer/async-batcher'\nimport { shallow, useSelector } from '@tanstack/solid-store'\nimport { createEffect, onCleanup } from 'solid-js'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor, JSX } from 'solid-js'\nimport type {\n  AsyncBatcherOptions,\n  AsyncBatcherState,\n} from '@tanstack/pacer/async-batcher'\n\nexport interface SolidAsyncBatcherOptions<\n  TValue,\n  TSelected = {},\n> extends AsyncBatcherOptions<TValue> {\n  /**\n   * Optional callback invoked when the owning component unmounts. Receives the batcher instance.\n   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.\n   */\n  onUnmount?: (batcher: SolidAsyncBatcher<TValue, TSelected>) => void\n}\n\nexport interface SolidAsyncBatcher<TValue, TSelected = {}> extends Omit<\n  AsyncBatcher<TValue>,\n  'store'\n> {\n  /**\n   * A Solid component that allows you to subscribe to the batcher state.\n   *\n   * This is useful for tracking specific parts of the batcher state\n   * deep in your component tree without needing to pass a selector to the hook.\n   *\n   * @example\n   * <batcher.Subscribe selector={(state) => ({ size: state.size, isExecuting: state.isExecuting })}>\n   *   {(state) => (\n   *     <div>Batch: {state().size} items, {state().isExecuting ? 'Executing...' : 'Idle'}</div>\n   *   )}\n   * </batcher.Subscribe>\n   */\n  Subscribe: <TSelected>(props: {\n    selector: (state: AsyncBatcherState<TValue>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) => JSX.Element\n  /**\n   * Reactive state that will be updated when the batcher state changes\n   *\n   * Use this instead of `batcher.store.state`\n   */\n  readonly state: Accessor<Readonly<TSelected>>\n  /**\n   * @deprecated Use `batcher.state` instead of `batcher.store.state` if you want to read reactive state.\n   * The state on the store object is not reactive, as it has not been wrapped in a `useSelector` hook internally.\n   * Although, you can make the state reactive by using the `useSelector` in your own usage.\n   */\n  readonly store: Store<Readonly<AsyncBatcherState<TValue>>>\n}\n\n/**\n * Creates a Solid-compatible AsyncBatcher instance for managing asynchronous batches of items, exposing Solid signals for all stateful properties.\n *\n * This is the async version of the createBatcher hook. 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 * Features:\n * - Configurable batch size and wait time\n * - Custom batch processing logic via getShouldExecute\n * - Event callbacks for monitoring batch operations\n * - Error handling for failed batch operations\n * - Automatic or manual batch processing\n * - All stateful properties (items, counts, etc.) are exposed as Solid signals for reactivity\n *\n * The batcher collects items and processes them in batches based on:\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 *\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 and Selector\n *\n * The hook uses TanStack Store for reactive state management. You can subscribe to state changes\n * in two ways:\n *\n * **1. Using `batcher.Subscribe` component (Recommended for component tree subscriptions)**\n *\n * Use the `Subscribe` component to subscribe to state changes deep in your component tree without\n * needing to pass a selector to the hook. This is ideal when you want to subscribe to state\n * in child components.\n *\n * **2. Using the `selector` parameter (For hook-level subscriptions)**\n *\n * The `selector` parameter allows you to specify which state changes will trigger reactive updates\n * at the hook level, optimizing performance by preventing unnecessary updates when irrelevant\n * state changes occur.\n *\n * **By default, there will be no reactive state subscriptions** and you must opt-in to state\n * tracking by providing a selector function or using the `Subscribe` component. This prevents unnecessary\n * updates and gives you full control over when your component tracks state changes.\n *\n * Available state properties:\n * - `errorCount`: Number of failed batch executions\n * - `executionCount`: Total number of batch execution attempts (successful + failed)\n * - `hasError`: Whether the last batch execution resulted in an error\n * - `isExecuting`: Whether a batch execution is currently in progress\n * - `items`: Array of items currently queued for batching\n * - `lastError`: The error from the most recent failed batch execution (if any)\n * - `lastResult`: The result from the most recent successful batch execution\n * - `settleCount`: Number of batch executions that have completed (successful or failed)\n * - `successCount`: Number of successful batch executions\n *\n * ## Unmount behavior\n *\n * By default, the primitive cancels any pending batch and aborts any in-flight execution when the owning component unmounts.\n * Abort only cancels underlying operations (e.g. fetch) when the abort signal from `getAbortSignal()` is passed to them.\n * Use the `onUnmount` option to customize this. For example, to flush pending work instead:\n *\n * ```tsx\n * const batcher = createAsyncBatcher(fn, {\n *   maxSize: 10,\n *   wait: 2000,\n *   onUnmount: (b) => b.flush()\n * });\n * ```\n *\n * Note: For async utils, `flush()` returns a Promise and runs fire-and-forget in the cleanup.\n * If your batch function updates Solid signals, those updates may run after the component has\n * unmounted, which can cause unexpected reactive updates. Guard your callbacks accordingly when\n * using onUnmount with flush.\n *\n * Example usage:\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const asyncBatcher = createAsyncBatcher(\n *   async (items) => {\n *     const results = await Promise.all(items.map(item => processItem(item)));\n *     return results;\n *   },\n *   {\n *     maxSize: 10,\n *     wait: 2000,\n *     onSuccess: (result) => {\n *       console.log('Batch processed successfully:', result);\n *     },\n *     onError: (error) => {\n *       console.error('Batch processing failed:', error);\n *     }\n *   }\n * );\n *\n * // Opt-in to track items or isExecuting changes (optimized for UI updates)\n * const asyncBatcher = createAsyncBatcher(\n *   async (items) => {\n *     const results = await Promise.all(items.map(item => processItem(item)));\n *     return results;\n *   },\n *   { maxSize: 10, wait: 2000 },\n *   (state) => ({ items: state.items, isExecuting: state.isExecuting })\n * );\n *\n * // Opt-in to track error state changes (optimized for error handling)\n * const asyncBatcher = createAsyncBatcher(\n *   async (items) => {\n *     const results = await Promise.all(items.map(item => processItem(item)));\n *     return results;\n *   },\n *   { maxSize: 10, wait: 2000 },\n *   (state) => ({ hasError: state.hasError, lastError: state.lastError })\n * );\n *\n * // Add items to batch\n * asyncBatcher.addItem(newItem);\n *\n * // Manually execute batch\n * const result = await asyncBatcher.execute();\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { items, isExecuting } = asyncBatcher.state();\n * ```\n */\nexport function createAsyncBatcher<TValue, TSelected = {}>(\n  fn: (items: Array<TValue>) => Promise<any>,\n  options: SolidAsyncBatcherOptions<TValue, TSelected> = {},\n  selector: (state: AsyncBatcherState<TValue>) => TSelected = () =>\n    ({}) as TSelected,\n): SolidAsyncBatcher<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().asyncBatcher,\n    ...options,\n  } as SolidAsyncBatcherOptions<TValue, TSelected>\n  const asyncBatcher = new AsyncBatcher<TValue>(\n    fn,\n    mergedOptions,\n  ) as unknown as SolidAsyncBatcher<TValue, TSelected>\n\n  asyncBatcher.Subscribe = function Subscribe<TSelected>(props: {\n    selector: (state: AsyncBatcherState<TValue>) => TSelected\n    children: ((state: Accessor<TSelected>) => JSX.Element) | JSX.Element\n  }) {\n    const selected = useSelector(asyncBatcher.store, props.selector, {\n      compare: shallow,\n    })\n\n    return typeof props.children === 'function'\n      ? props.children(selected)\n      : props.children\n  }\n\n  const state = useSelector(asyncBatcher.store, selector, { compare: shallow })\n\n  createEffect(() => {\n    onCleanup(() => {\n      if (mergedOptions.onUnmount) {\n        mergedOptions.onUnmount(asyncBatcher)\n      } else {\n        asyncBatcher.cancel()\n        asyncBatcher.abort()\n      }\n    })\n  })\n\n  return {\n    ...asyncBatcher,\n    state,\n  } as SolidAsyncBatcher<TValue, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4LA,SAAgB,mBACd,IACA,UAAuD,EAAE,EACzD,kBACG,EAAE,GACiC;CACtC,MAAM,gBAAgB;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ;CACD,MAAM,eAAe,IAAI,aACvB,IACA,cACD;CAED,aAAa,YAAY,SAAS,UAAqB,OAGpD;EACD,MAAM,WAAW,YAAY,aAAa,OAAO,MAAM,UAAU,EAC/D,SAAS,SACV,CAAC;EAEF,OAAO,OAAO,MAAM,aAAa,aAC7B,MAAM,SAAS,SAAS,GACxB,MAAM;;CAGZ,MAAM,QAAQ,YAAY,aAAa,OAAO,UAAU,EAAE,SAAS,SAAS,CAAC;CAE7E,mBAAmB;EACjB,gBAAgB;GACd,IAAI,cAAc,WAChB,cAAc,UAAU,aAAa;QAChC;IACL,aAAa,QAAQ;IACrB,aAAa,OAAO;;IAEtB;GACF;CAEF,OAAO;EACL,GAAG;EACH;EACD"}

package/dist/async-batcher/index.cjs

@@ -1,11 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_createAsyncBatcher = require('./createAsyncBatcher.cjs');
-
-exports.createAsyncBatcher = require_createAsyncBatcher.createAsyncBatcher;
-var _tanstack_pacer_async_batcher = require("@tanstack/pacer/async-batcher");
-Object.keys(_tanstack_pacer_async_batcher).forEach(function (k) {
-  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
-    enumerable: true,
-    get: function () { return _tanstack_pacer_async_batcher[k]; }
-  });
-});

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

@@ -1,3 +0,0 @@
-import { SolidAsyncBatcher, SolidAsyncBatcherOptions, createAsyncBatcher } from "./createAsyncBatcher.cjs";
-export * from "@tanstack/pacer/async-batcher";
-export { SolidAsyncBatcher, SolidAsyncBatcherOptions, createAsyncBatcher };