feat: Add built-in retry util into into async utils (#54)

* start on retry feature

* add retry example

* aborts through async-retryer only

* add an optional pacer provider

* add providers to main examples

* feat: add initial setup for devtools

* ci: apply automated fixes

* chore: fix test issues

* ci: apply automated fixes

* chore:fix render issue

* ci: apply automated fixes

* ci: apply automated fixes

* feat: drastically improve the pacer devtools UI

* ci: apply automated fixes

* chore: remove built-in tree in favor of devtools/ui

* ci: apply automated fixes

* refactor to key

* ci: apply automated fixes

* rename devtool packages to be consistent with query devtool package names

* fix sherif

* separate left and right panels of devtools

* denser ui

* better right panel, emit entire instance

* add some action buttons to devtools that kind of work

* event bus goes both ways

* all utils listen to devtools

* remove console log

* ci: apply automated fixes

* sync package versions

* ci: apply automated fixes

* break up devtools components

* default options

* ci: apply automated fixes

* ci: apply automated fixes

* package upgrades

* update lock file

* delete

* package upgrades

* merge main

* clean up retry error tests

* ci: apply automated fixes

* fix async-throttler stuff

* fix retryers with per instance per execution

* ci: apply automated fixes

* add maxExecutionTime to retryer

* add getAbortController apis

* add changeset and add retry stuff to guides

* generate docs

* ci: apply automated fixes

* rewrite guides around retries

* fix some edge cases on retry error and timeouts

* update changelogs and guides

* ci: apply automated fixes

---------

Co-authored-by: Alem Tuzlak <t.zlak@hotmail.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: 3 people

.changeset/chubby-laws-smile copy.md

@@ -0,0 +1,5 @@
+---
+'@tanstack/react-pacer': minor
+---
+
+feat: Added `PacerProvider` component and related hooks (`usePacerContext`, `useDefaultPacerOptions`) for React applications to set default configurations for all pacer utilities within a component tree

.changeset/chubby-laws-smile.md

@@ -0,0 +1,14 @@
+---
+'@tanstack/react-pacer-devtools': minor
+'@tanstack/solid-pacer-devtools': minor
+'@tanstack/pacer-devtools': minor
+'@tanstack/react-pacer': minor
+'@tanstack/solid-pacer': minor
+'@tanstack/pacer': minor
+---
+
+- feat:Added `AsyncRetryer` class and `asyncRetry` function with exponential/linear/fixed backoff strategies, jitter support, timeout controls (`maxExecutionTime`, `maxTotalExecutionTime`), lifecycle callbacks (`onRetry`, `onSuccess`, `onError`, `onLastError`, `onSettled`, `onAbort`, `onExecutionTimeout`, `onTotalExecutionTimeout`), dynamic options, and built-in retry integration via `asyncRetryerOptions` for all async utilities (`AsyncBatcher`, `AsyncDebouncer`, `AsyncQueuer`, `AsyncRateLimiter`, `AsyncThrottler`)
+- feat: Added `getAbortSignal()` method to all async utilities (`AsyncRetryer`, `AsyncBatcher`, `AsyncDebouncer`, `AsyncQueuer`, `AsyncRateLimiter`, `AsyncThrottler`) to enable true cancellation of underlying async operations (like fetch requests) when `abort()` is called
+- feat: Added `asyncBatcherOptions`, `asyncDebouncerOptions`, `asyncQueuerOptions`, `asyncRateLimiterOptions`, `asyncRetryerOptions`, `asyncThrottlerOptions`, `debouncerOptions`, `queuerOptions`, `rateLimiterOptions`, `throttlerOptions` utility functions for sharing common options between different pacer utilities
+- fix: Fixed async-throtter trailing edge behavior when long executions were awaited.
+- breaking: standardized `reset`, `cancel` and `abort` API behaviors with consistent naming and behavior across all async utilities. Canceling no longer aborts, new dedicated `abort` method is provided for aborting ongoing executions.

docs/config.json

@@ -89,6 +89,10 @@
         {
           "label": "Async Batching Guide",
           "to": "guides/async-batching"
+        },
+        {
+          "label": "Async Retrying Guide",
+          "to": "guides/async-retrying"
         }
       ]
     },

docs/framework/react/reference/functions/pacerprovider.md

@@ -0,0 +1,24 @@
+---
+id: PacerProvider
+title: PacerProvider
+---
+
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
+# Function: PacerProvider()
+
+```ts
+function PacerProvider(__namedParameters): Element
+```
+
+Defined in: [react-pacer/src/provider/PacerProvider.tsx:44](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L44)
+
+## Parameters
+
+### \_\_namedParameters
+
+[`PacerProviderProps`](../../interfaces/pacerproviderprops.md)
+
+## Returns
+
+`Element`

docs/framework/react/reference/functions/useasyncbatcher.md

@@ -14,7 +14,7 @@ function useAsyncBatcher<TValue, TSelected>(
 selector): ReactAsyncBatcher<TValue, TSelected>
 ```
 
-Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:167](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L167)
+Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:168](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L168)
 
 A React hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items.
 

docs/framework/react/reference/functions/useasyncdebouncer.md

@@ -14,7 +14,7 @@ function useAsyncDebouncer<TFn, TSelected>(
 selector): ReactAsyncDebouncer<TFn, TSelected>
 ```
 
-Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:149](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L149)
+Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:150](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L150)
 
 A low-level React hook that creates an `AsyncDebouncer` instance to delay execution of an async function.
 

docs/framework/react/reference/functions/useasyncqueuer.md

@@ -14,7 +14,7 @@ function useAsyncQueuer<TValue, TSelected>(
 selector): ReactAsyncQueuer<TValue, TSelected>
 ```
 
-Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:167](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L167)
+Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:168](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L168)
 
 A lower-level React hook that creates an `AsyncQueuer` instance for managing an async queue of items.
 

docs/framework/react/reference/functions/useasyncratelimiter.md

@@ -14,7 +14,7 @@ function useAsyncRateLimiter<TFn, TSelected>(
 selector): ReactAsyncRateLimiter<TFn, TSelected>
 ```
 
-Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:178](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L178)
+Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:179](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L179)
 
 A low-level React hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window.
 

docs/framework/react/reference/functions/useasyncthrottler.md

@@ -14,7 +14,7 @@ function useAsyncThrottler<TFn, TSelected>(
 selector): ReactAsyncThrottler<TFn, TSelected>
 ```
 
-Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:160](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L160)
+Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:161](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L161)
 
 A low-level React hook that creates an `AsyncThrottler` instance to limit how often an async function can execute.
 

docs/framework/react/reference/functions/usebatcher.md

@@ -14,7 +14,7 @@ function useBatcher<TValue, TSelected>(
 selector): ReactBatcher<TValue, TSelected>
 ```
 
-Defined in: [react-pacer/src/batcher/useBatcher.ts:121](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L121)
+Defined in: [react-pacer/src/batcher/useBatcher.ts:122](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L122)
 
 A React hook that creates and manages a Batcher instance.