@tanstack/angular-pacer 0.24.0 → 0.25.0

package/src/async-batcher/injectAsyncBatcher.ts

@@ -1,126 +0,0 @@
-import { DestroyRef, inject } from '@angular/core'
-import { injectSelector } from '@tanstack/angular-store'
-import { AsyncBatcher } from '@tanstack/pacer/async-batcher'
-import { injectPacerOptions } from '../provider/pacer-context'
-import type { Signal } from '@angular/core'
-import type { Store } from '@tanstack/angular-store'
-import type {
-  AsyncBatcherOptions,
-  AsyncBatcherState,
-} from '@tanstack/pacer/async-batcher'
-
-export interface AngularAsyncBatcherOptions<
-  TValue,
-  TSelected = {},
-> extends AsyncBatcherOptions<TValue> {
-  /**
-   * Optional callback invoked when the component is destroyed. Receives the batcher instance.
-   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), cancel(), add logging, etc.
-   * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.
-   */
-  onUnmount?: (batcher: AngularAsyncBatcher<TValue, TSelected>) => void
-}
-
-export interface AngularAsyncBatcher<TValue, TSelected = {}> extends Omit<
-  AsyncBatcher<TValue>,
-  'store'
-> {
-  /**
-   * Reactive state signal that will be updated when the async batcher state changes
-   *
-   * Use this instead of `batcher.store.state`
-   */
-  readonly state: Signal<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 in Angular signals.
-   */
-  readonly store: Store<Readonly<AsyncBatcherState<TValue>>>
-}
-
-/**
- * An Angular function that creates and manages an AsyncBatcher instance.
- *
- * This is a lower-level function that provides direct access to the AsyncBatcher's functionality.
- * This allows you to integrate it with any state management solution you prefer.
- *
- * The AsyncBatcher collects items and processes them in batches asynchronously with support for
- * promise-based processing, error handling, retry capabilities, and abort support.
- *
- * ## State Management and Selector
- *
- * The function uses TanStack Store for state management and wraps it with Angular signals.
- * The `selector` parameter allows you to specify which state changes will trigger signal updates,
- * 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. This prevents unnecessary updates and gives you
- * full control over when your component tracks state changes.
- *
- * ## Cleanup on Destroy
- *
- * By default, the function cancels any pending batch and aborts in-flight work when the component is destroyed.
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
- *
- * ```ts
- * const batcher = injectAsyncBatcher(fn, {
- *   maxSize: 10,
- *   onUnmount: (b) => b.flush()
- * });
- * ```
- *
- * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.
- *
- * @example
- * ```ts
- * // Default behavior - no reactive state subscriptions
- * const batcher = injectAsyncBatcher(
- *   async (items: Array<Data>) => {
- *     const response = await fetch('/api/batch', {
- *       method: 'POST',
- *       body: JSON.stringify(items)
- *     });
- *     return response.json();
- *   },
- *   { maxSize: 10, wait: 2000 }
- * );
- *
- * // Add items
- * batcher.addItem(data1);
- * batcher.addItem(data2);
- *
- * // Access the selected state
- * const { items, isExecuting } = batcher.state();
- * ```
- */
-export function injectAsyncBatcher<TValue, TSelected = {}>(
-  fn: (items: Array<TValue>) => Promise<any>,
-  options: AngularAsyncBatcherOptions<TValue, TSelected> = {},
-  selector: (state: AsyncBatcherState<TValue>) => TSelected = () =>
-    ({}) as TSelected,
-): AngularAsyncBatcher<TValue, TSelected> {
-  const mergedOptions = {
-    ...injectPacerOptions().asyncBatcher,
-    ...options,
-  } as AngularAsyncBatcherOptions<TValue, TSelected>
-
-  const batcher = new AsyncBatcher<TValue>(fn, mergedOptions)
-  const state = injectSelector(batcher.store, selector)
-
-  const result = {
-    ...batcher,
-    state,
-  } as AngularAsyncBatcher<TValue, TSelected>
-
-  const destroyRef = inject(DestroyRef, { optional: true })
-  destroyRef?.onDestroy(() => {
-    if (mergedOptions.onUnmount) {
-      mergedOptions.onUnmount(result)
-    } else {
-      batcher.cancel()
-      batcher.abort()
-    }
-  })
-
-  return result
-}

package/src/async-debouncer/index.ts

@@ -1,4 +0,0 @@
-export * from '@tanstack/pacer/async-debouncer'
-
-export * from './injectAsyncDebouncedCallback'
-export * from './injectAsyncDebouncer'

package/src/async-debouncer/injectAsyncDebouncedCallback.ts

@@ -1,50 +0,0 @@
-import { injectAsyncDebouncer } from './injectAsyncDebouncer'
-import type { AsyncDebouncerOptions } from '@tanstack/pacer/async-debouncer'
-import type { AnyAsyncFunction } from '@tanstack/pacer/types'
-
-/**
- * An Angular function that creates an async debounced version of a callback function.
- * This function is essentially a wrapper around `injectAsyncDebouncer` that provides
- * a simplified API for basic async debouncing needs.
- *
- * The debounced function will only execute after the specified wait time has elapsed
- * since its last invocation. If called again before the wait time expires, the timer
- * resets and starts waiting again.
- *
- * This function provides a simpler API compared to `injectAsyncDebouncer`, making it ideal for basic
- * async debouncing needs. However, it does not expose the underlying AsyncDebouncer instance.
- *
- * For advanced usage requiring features like:
- * - Manual cancellation
- * - Access to execution counts
- * - Error handling callbacks
- * - Retry support
- *
- * Consider using the `injectAsyncDebouncer` function instead.
- *
- * @example
- * ```ts
- * // Debounce an async search handler
- * const handleSearch = injectAsyncDebouncedCallback(
- *   async (query: string) => {
- *     const response = await fetch(`/api/search?q=${query}`);
- *     return response.json();
- *   },
- *   { wait: 500 }
- * );
- *
- * // Use in an input
- * const results = await handleSearch(searchQuery);
- * ```
- */
-export function injectAsyncDebouncedCallback<TFn extends AnyAsyncFunction>(
-  fn: TFn,
-  options: AsyncDebouncerOptions<TFn>,
-): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined> {
-  const debouncer = injectAsyncDebouncer(fn, options)
-  return async (...args: Parameters<TFn>) => {
-    const result = await debouncer.maybeExecute(...args)
-    // Not sure if this is the best way to handle this,
-    return result !== undefined ? await result : undefined
-  }
-}

package/src/async-debouncer/injectAsyncDebouncer.ts

@@ -1,152 +0,0 @@
-import { DestroyRef, inject } from '@angular/core'
-import { injectSelector } from '@tanstack/angular-store'
-import { AsyncDebouncer } from '@tanstack/pacer/async-debouncer'
-import { injectPacerOptions } from '../provider/pacer-context'
-import type { Signal } from '@angular/core'
-import type { Store } from '@tanstack/angular-store'
-import type { AnyAsyncFunction } from '@tanstack/pacer/types'
-import type {
-  AsyncDebouncerOptions,
-  AsyncDebouncerState,
-} from '@tanstack/pacer/async-debouncer'
-
-export interface AngularAsyncDebouncerOptions<
-  TFn extends AnyAsyncFunction,
-  TSelected = {},
-> extends AsyncDebouncerOptions<TFn> {
-  /**
-   * Optional callback invoked when the component is destroyed. Receives the debouncer instance.
-   * When provided, replaces the default cleanup (cancel + abort); use it to call flush(), cancel(), add logging, etc.
-   * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.
-   */
-  onUnmount?: (debouncer: AngularAsyncDebouncer<TFn, TSelected>) => void
-}
-
-export interface AngularAsyncDebouncer<
-  TFn extends AnyAsyncFunction,
-  TSelected = {},
-> extends Omit<AsyncDebouncer<TFn>, 'store'> {
-  /**
-   * Reactive state signal that will be updated when the async debouncer state changes
-   *
-   * Use this instead of `debouncer.store.state`
-   */
-  readonly state: Signal<Readonly<TSelected>>
-  /**
-   * @deprecated Use `debouncer.state` instead of `debouncer.store.state` if you want to read reactive state.
-   * The state on the store object is not reactive in Angular signals.
-   */
-  readonly store: Store<Readonly<AsyncDebouncerState<TFn>>>
-}
-
-/**
- * An Angular function that creates and manages an AsyncDebouncer instance.
- *
- * This is a lower-level function that provides direct access to the AsyncDebouncer's functionality.
- * This allows you to integrate it with any state management solution you prefer.
- *
- * This function provides async debouncing functionality with promise support, error handling,
- * retry capabilities, and abort support.
- *
- * The debouncer will only execute the function after the specified wait time has elapsed
- * since the last call. If the function is called again before the wait time expires, the
- * timer resets and starts waiting again.
- *
- * ## State Management and Selector
- *
- * The function uses TanStack Store for state management and wraps it with Angular signals.
- * The `selector` parameter allows you to specify which state changes will trigger signal updates,
- * 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. This prevents unnecessary updates and gives you
- * full control over when your component tracks state changes.
- *
- * Available state properties:
- * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
- * - `errorCount`: Number of function executions that have resulted in errors
- * - `isExecuting`: Whether the debounced function is currently executing asynchronously
- * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
- * - `lastResult`: The result from the most recent successful function execution
- * - `settleCount`: Number of function executions that have completed (either successfully or with errors)
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
- * - `successCount`: Number of function executions that have completed successfully
- *
- * ## Cleanup on Destroy
- *
- * By default, the function cancels any pending execution and aborts in-flight work when the component is destroyed.
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
- *
- * ```ts
- * const debouncer = injectAsyncDebouncer(fn, {
- *   wait: 500,
- *   onUnmount: (d) => d.flush()
- * });
- * ```
- *
- * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.
- *
- * @example
- * ```ts
- * // Default behavior - no reactive state subscriptions
- * const debouncer = injectAsyncDebouncer(
- *   async (query: string) => {
- *     const response = await fetch(`/api/search?q=${query}`);
- *     return response.json();
- *   },
- *   { wait: 500 }
- * );
- *
- * // Opt-in to track isExecuting changes (optimized for loading states)
- * const debouncer = injectAsyncDebouncer(
- *   async (query: string) => fetchSearchResults(query),
- *   { wait: 500 },
- *   (state) => ({ isExecuting: state.isExecuting, isPending: state.isPending })
- * );
- *
- * // In an event handler
- * const handleChange = async (e: Event) => {
- *   const target = e.target as HTMLInputElement;
- *   const result = await debouncer.maybeExecute(target.value);
- *   console.log('Search results:', result);
- * };
- *
- * // Access the selected state
- * const { isExecuting, errorCount } = debouncer.state();
- * ```
- */
-export function injectAsyncDebouncer<
-  TFn extends AnyAsyncFunction,
-  TSelected = {},
->(
-  fn: TFn,
-  options: AngularAsyncDebouncerOptions<TFn, TSelected>,
-  selector: (state: AsyncDebouncerState<TFn>) => TSelected = () =>
-    ({}) as TSelected,
-): AngularAsyncDebouncer<TFn, TSelected> {
-  const mergedOptions = {
-    ...injectPacerOptions().asyncDebouncer,
-    ...options,
-  } as AngularAsyncDebouncerOptions<TFn, TSelected>
-
-  const debouncer = new AsyncDebouncer<TFn>(fn, mergedOptions)
-  const state = injectSelector(debouncer.store, selector)
-
-  const result = {
-    ...debouncer,
-    state,
-  } as AngularAsyncDebouncer<TFn, TSelected>
-
-  const destroyRef = inject(DestroyRef, { optional: true })
-  destroyRef?.onDestroy(() => {
-    if (mergedOptions.onUnmount) {
-      mergedOptions.onUnmount(result)
-    } else {
-      debouncer.cancel()
-      debouncer.abort()
-    }
-  })
-
-  return result
-}

package/src/async-queuer/index.ts

@@ -1,4 +0,0 @@
-export * from '@tanstack/pacer/async-queuer'
-
-export * from './injectAsyncQueuedSignal'
-export * from './injectAsyncQueuer'

package/src/async-queuer/injectAsyncQueuedSignal.ts

@@ -1,74 +0,0 @@
-import { computed } from '@angular/core'
-import { injectAsyncQueuer } from './injectAsyncQueuer'
-import type { AngularAsyncQueuer } from './injectAsyncQueuer'
-import type {
-  AsyncQueuerOptions,
-  AsyncQueuerState,
-} from '@tanstack/pacer/async-queuer'
-
-export interface AsyncQueuedSignal<TValue, TSelected = {}> {
-  (): Array<TValue>
-  addItem: AngularAsyncQueuer<TValue, TSelected>['addItem']
-  queuer: AngularAsyncQueuer<TValue, TSelected>
-}
-
-/**
- * An Angular function that creates an async queuer with managed state, combining Angular's signals with async queuing functionality.
- * This function provides both the current queue state and queue control methods.
- *
- * The queue state is automatically updated whenever items are added, removed, or processed in the queue.
- * All queue operations are reflected in the state array returned by the function.
- *
- * The function returns a callable object:
- * - `queued()`: Get the current queue items as an array
- * - `queued.addItem(...)`: Add an item to the queue
- * - `queued.queue`: The queuer instance with additional control methods
- *
- * @example
- * ```ts
- * // Default behavior - track items
- * const queued = injectAsyncQueuedSignal(
- *   async (item) => {
- *     const response = await fetch('/api/process', {
- *       method: 'POST',
- *       body: JSON.stringify(item)
- *     });
- *     return response.json();
- *   },
- *   { concurrency: 2, wait: 1000 }
- * );
- *
- * // Add items
- * queued.addItem(data1);
- *
- * // Access items
- * console.log(queued()); // [data1, ...]
- *
- * // Control the queue
- * queued.queuer.start();
- * queued.queuer.stop();
- * ```
- */
-export function injectAsyncQueuedSignal<
-  TValue,
-  TSelected extends Pick<AsyncQueuerState<TValue>, 'items'> = Pick<
-    AsyncQueuerState<TValue>,
-    'items'
-  >,
->(
-  fn: (value: TValue) => Promise<any>,
-  options: AsyncQueuerOptions<TValue> = {},
-  selector: (state: AsyncQueuerState<TValue>) => TSelected = (state) =>
-    ({ items: state.items }) as TSelected,
-): AsyncQueuedSignal<TValue, TSelected> {
-  const queuer = injectAsyncQueuer(fn, options, selector)
-
-  const items = computed(() => queuer.state().items as Array<TValue>)
-
-  const queued = Object.assign(items, {
-    addItem: queuer.addItem.bind(queuer),
-    queuer,
-  }) as AsyncQueuedSignal<TValue, TSelected>
-
-  return queued
-}

package/src/async-queuer/injectAsyncQueuer.ts

@@ -1,126 +0,0 @@
-import { DestroyRef, inject } from '@angular/core'
-import { injectSelector } from '@tanstack/angular-store'
-import { AsyncQueuer } from '@tanstack/pacer/async-queuer'
-import { injectPacerOptions } from '../provider/pacer-context'
-import type { Signal } from '@angular/core'
-import type { Store } from '@tanstack/angular-store'
-import type {
-  AsyncQueuerOptions,
-  AsyncQueuerState,
-} from '@tanstack/pacer/async-queuer'
-
-export interface AngularAsyncQueuerOptions<
-  TValue,
-  TSelected = {},
-> extends AsyncQueuerOptions<TValue> {
-  /**
-   * Optional callback invoked when the component is destroyed. Receives the queuer instance.
-   * When provided, replaces the default cleanup (stop + abort); use it to call flush(), stop(), add logging, etc.
-   * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.
-   */
-  onUnmount?: (queuer: AngularAsyncQueuer<TValue, TSelected>) => void
-}
-
-export interface AngularAsyncQueuer<TValue, TSelected = {}> extends Omit<
-  AsyncQueuer<TValue>,
-  'store'
-> {
-  /**
-   * Reactive state signal that will be updated when the async queuer state changes
-   *
-   * Use this instead of `queuer.store.state`
-   */
-  readonly state: Signal<Readonly<TSelected>>
-  /**
-   * @deprecated Use `queuer.state` instead of `queuer.store.state` if you want to read reactive state.
-   * The state on the store object is not reactive in Angular signals.
-   */
-  readonly store: Store<Readonly<AsyncQueuerState<TValue>>>
-}
-
-/**
- * An Angular function that creates and manages an AsyncQueuer instance.
- *
- * This is a lower-level function that provides direct access to the AsyncQueuer's functionality.
- * This allows you to integrate it with any state management solution you prefer.
- *
- * The AsyncQueuer processes items asynchronously with support for concurrent execution,
- * promise-based processing, error handling, retry capabilities, and abort support.
- *
- * ## State Management and Selector
- *
- * The function uses TanStack Store for state management and wraps it with Angular signals.
- * The `selector` parameter allows you to specify which state changes will trigger signal updates,
- * 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. This prevents unnecessary updates and gives you
- * full control over when your component tracks state changes.
- *
- * ## Cleanup on Destroy
- *
- * By default, the function stops the queuer and aborts in-flight work when the component is destroyed.
- * Use the `onUnmount` option to customize this. For example, to flush pending items instead:
- *
- * ```ts
- * const queuer = injectAsyncQueuer(fn, {
- *   concurrency: 2,
- *   onUnmount: (q) => q.flush()
- * });
- * ```
- *
- * When using onUnmount with flush, guard your callbacks since the component may already be destroyed.
- *
- * @example
- * ```ts
- * // Default behavior - no reactive state subscriptions
- * const queuer = injectAsyncQueuer(
- *   async (item: Data) => {
- *     const response = await fetch('/api/process', {
- *       method: 'POST',
- *       body: JSON.stringify(item)
- *     });
- *     return response.json();
- *   },
- *   { concurrency: 2, wait: 1000 }
- * );
- *
- * // Add items
- * queuer.addItem(data1);
- * queuer.addItem(data2);
- *
- * // Access the selected state
- * const { items, isExecuting } = queuer.state();
- * ```
- */
-export function injectAsyncQueuer<TValue, TSelected = {}>(
-  fn: (value: TValue) => Promise<any>,
-  options: AngularAsyncQueuerOptions<TValue, TSelected> = {},
-  selector: (state: AsyncQueuerState<TValue>) => TSelected = () =>
-    ({}) as TSelected,
-): AngularAsyncQueuer<TValue, TSelected> {
-  const mergedOptions = {
-    ...injectPacerOptions().asyncQueuer,
-    ...options,
-  } as AngularAsyncQueuerOptions<TValue, TSelected>
-
-  const queuer = new AsyncQueuer<TValue>(fn, mergedOptions)
-  const state = injectSelector(queuer.store, selector)
-
-  const result = {
-    ...queuer,
-    state,
-  } as AngularAsyncQueuer<TValue, TSelected>
-
-  const destroyRef = inject(DestroyRef, { optional: true })
-  destroyRef?.onDestroy(() => {
-    if (mergedOptions.onUnmount) {
-      mergedOptions.onUnmount(result)
-    } else {
-      queuer.stop()
-      queuer.abort()
-    }
-  })
-
-  return result
-}

package/src/async-rate-limiter/index.ts

@@ -1,4 +0,0 @@
-export * from '@tanstack/pacer/async-rate-limiter'
-
-export * from './injectAsyncRateLimitedCallback'
-export * from './injectAsyncRateLimiter'

package/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts

@@ -1,52 +0,0 @@
-import { injectAsyncRateLimiter } from './injectAsyncRateLimiter'
-import type { AsyncRateLimiterOptions } from '@tanstack/pacer/async-rate-limiter'
-import type { AnyAsyncFunction } from '@tanstack/pacer/types'
-
-/**
- * An Angular function that creates an async rate-limited version of a callback function.
- * This function is essentially a wrapper around `injectAsyncRateLimiter` that provides
- * a simplified API for basic async rate limiting needs.
- *
- * This function provides a simpler API compared to `injectAsyncRateLimiter`, making it ideal for basic
- * async rate limiting needs. However, it does not expose the underlying AsyncRateLimiter instance.
- *
- * For advanced usage requiring features like:
- * - Manual cancellation/reset
- * - Access to execution counts
- * - Error handling callbacks
- * - Retry support
- *
- * Consider using the `injectAsyncRateLimiter` function instead.
- *
- * @example
- * ```ts
- * // Rate limit API calls
- * const makeApiCall = injectAsyncRateLimitedCallback(
- *   async (data: ApiData) => {
- *     const response = await fetch('/api/endpoint', {
- *       method: 'POST',
- *       body: JSON.stringify(data)
- *     });
- *     return response.json();
- *   },
- *   {
- *     limit: 5,
- *     window: 60000,
- *     windowType: 'sliding',
- *   }
- * );
- *
- * // Use in event handler
- * const result = await makeApiCall(apiData);
- * ```
- */
-export function injectAsyncRateLimitedCallback<TFn extends AnyAsyncFunction>(
-  fn: TFn,
-  options: AsyncRateLimiterOptions<TFn>,
-): (...args: Parameters<TFn>) => Promise<Awaited<ReturnType<TFn>> | undefined> {
-  const rateLimiter = injectAsyncRateLimiter(fn, options)
-  return async (...args: Parameters<TFn>) => {
-    const result = await rateLimiter.maybeExecute(...args)
-    return result !== undefined ? await result : undefined
-  }
-}