@tanstack/preact-pacer 0.22.1 → 0.24.0

package/src/batcher/useBatcher.ts

@@ -1,241 +0,0 @@
-import { useEffect, useMemo, useState } from 'preact/hooks'
-import { Batcher } from '@tanstack/pacer/batcher'
-import { shallow, useSelector } from '@tanstack/preact-store'
-import { useDefaultPacerOptions } from '../provider/PacerProvider'
-import type { Store } from '@tanstack/preact-store'
-import type { BatcherOptions, BatcherState } from '@tanstack/pacer/batcher'
-import type { ComponentChildren } from 'preact'
-
-export interface PreactBatcherOptions<
-  TValue,
-  TSelected = {},
-> extends BatcherOptions<TValue> {
-  /**
-   * Optional callback invoked when the component unmounts. Receives the batcher instance.
-   * When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.
-   */
-  onUnmount?: (batcher: PreactBatcher<TValue, TSelected>) => void
-}
-
-export interface PreactBatcher<TValue, TSelected = {}> extends Omit<
-  Batcher<TValue>,
-  'store'
-> {
-  /**
-   * A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state.
-   *
-   * This is useful for opting into state re-renders for 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 })}>
-   *   {({ size }) => (
-   *     <div>Batch Size: {size}</div>
-   *   )}
-   * </batcher.Subscribe>
-   */
-  Subscribe: <TSelected>(props: {
-    selector: (state: BatcherState<TValue>) => TSelected
-    children: ((state: TSelected) => ComponentChildren) | ComponentChildren
-  }) => ComponentChildren
-  /**
-   * Reactive state that will be updated and re-rendered when the batcher state changes
-   *
-   * Use this instead of `batcher.store.state`
-   */
-  readonly state: 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<BatcherState<TValue>>>
-}
-
-/**
- * A Preact hook that creates and manages a Batcher instance.
- *
- * This is a lower-level hook that provides direct access to the Batcher's functionality without
- * any built-in state management. This allows you to integrate it with any state management solution
- * you prefer (useState, Redux, Zustand, etc.) by utilizing the onItemsChange callback.
- *
- * The Batcher collects items and processes them in batches based on configurable conditions:
- * - Maximum batch size
- * - Time-based batching (process after X milliseconds)
- * - Custom batch processing logic via getShouldExecute
- *
- * ## 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` HOC (Recommended for component tree subscriptions)**
- *
- * Use the `Subscribe` HOC 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 a re-render
- * at the hook level, optimizing performance by preventing unnecessary re-renders 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` HOC. This prevents unnecessary
- * re-renders and gives you full control over when your component updates.
- *
- * Available state properties:
- * - `executionCount`: Number of batch executions that have been completed
- * - `isEmpty`: Whether the batcher has no items to process
- * - `isPending`: Whether the batcher is waiting for the timeout to trigger batch processing
- * - `isRunning`: Whether the batcher is active and will process items automatically
- * - `items`: Array of items currently queued for batch processing
- * - `size`: Number of items currently in the batch queue
- * - `status`: Current processing status ('idle' | 'pending')
- * - `totalItemsProcessed`: Total number of items processed across all batches
- *
- * ## Unmount behavior
- *
- * By default, the hook cancels any pending batch when the component unmounts.
- * Use the `onUnmount` option to customize this. For example, to flush pending work instead:
- *
- * ```tsx
- * const batcher = useBatcher(fn, {
- *   maxSize: 10,
- *   wait: 2000,
- *   onUnmount: (b) => b.flush()
- * });
- * ```
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const batcher = useBatcher<number>(
- *   (items) => console.log('Processing batch:', items),
- *   { maxSize: 5, wait: 2000 }
- * );
- *
- * // Subscribe to state changes deep in component tree using Subscribe HOC
- * <batcher.Subscribe selector={(state) => ({ size: state.size })}>
- *   {({ size }) => (
- *     <div>Batch Size: {size}</div>
- *   )}
- * </batcher.Subscribe>
- *
- * // Opt-in to re-render when batch size changes at hook level (optimized for displaying queue size)
- * const batcher = useBatcher<number>(
- *   (items) => console.log('Processing batch:', items),
- *   { maxSize: 5, wait: 2000 },
- *   (state) => ({
- *     size: state.size,
- *     isEmpty: state.isEmpty
- *   })
- * );
- *
- * // Opt-in to re-render when execution metrics change (optimized for stats display)
- * const batcher = useBatcher<number>(
- *   (items) => console.log('Processing batch:', items),
- *   { maxSize: 5, wait: 2000 },
- *   (state) => ({
- *     executionCount: state.executionCount,
- *     totalItemsProcessed: state.totalItemsProcessed
- *   })
- * );
- *
- * // Opt-in to re-render when processing state changes (optimized for loading indicators)
- * const batcher = useBatcher<number>(
- *   (items) => console.log('Processing batch:', items),
- *   { maxSize: 5, wait: 2000 },
- *   (state) => ({
- *     isPending: state.isPending,
- *     isRunning: state.isRunning,
- *     status: state.status
- *   })
- * );
- *
- * // Example with custom state management and batching
- * const [items, setItems] = useState([]);
- *
- * const batcher = useBatcher<number>(
- *   (items) => console.log('Processing batch:', items),
- *   {
- *     maxSize: 5,
- *     wait: 2000,
- *     onItemsChange: (batcher) => setItems(batcher.peekAllItems()),
- *     getShouldExecute: (items) => items.length >= 3
- *   }
- * );
- *
- * // Add items to batch - they'll be processed when conditions are met
- * batcher.addItem(1);
- * batcher.addItem(2);
- * batcher.addItem(3); // Triggers batch processing
- *
- * // Control the batcher
- * batcher.stop();  // Pause batching
- * batcher.start(); // Resume batching
- *
- * // Access the selected state (will be empty object {} unless selector provided)
- * const { size, isPending } = batcher.state;
- * ```
- */
-export function useBatcher<TValue, TSelected = {}>(
-  fn: (items: Array<TValue>) => void,
-  options: PreactBatcherOptions<TValue, TSelected> = {},
-  selector: (state: BatcherState<TValue>) => TSelected = () =>
-    ({}) as TSelected,
-): PreactBatcher<TValue, TSelected> {
-  const mergedOptions = {
-    ...useDefaultPacerOptions().batcher,
-    ...options,
-  } as PreactBatcherOptions<TValue, TSelected>
-
-  const [batcher] = useState(() => {
-    const batcherInstance = new Batcher<TValue>(
-      fn,
-      mergedOptions,
-    ) as unknown as PreactBatcher<TValue, TSelected>
-
-    batcherInstance.Subscribe = function Subscribe<TSelected>(props: {
-      selector: (state: BatcherState<TValue>) => TSelected
-      children: ((state: TSelected) => ComponentChildren) | ComponentChildren
-    }) {
-      const selected = useSelector(batcherInstance.store, props.selector, {
-        compare: shallow,
-      })
-
-      return typeof props.children === 'function'
-        ? props.children(selected)
-        : props.children
-    }
-
-    return batcherInstance
-  })
-
-  batcher.fn = fn
-  batcher.setOptions(mergedOptions)
-
-  /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */
-  useEffect(() => {
-    return () => {
-      if (mergedOptions.onUnmount) {
-        mergedOptions.onUnmount(batcher)
-      } else {
-        batcher.cancel()
-      }
-    }
-  }, [])
-  /* eslint-enable react-hooks/exhaustive-deps */
-
-  const state = useSelector(batcher.store, selector, { compare: shallow })
-
-  return useMemo(
-    () =>
-      ({
-        ...batcher,
-        state,
-      }) as PreactBatcher<TValue, TSelected>, // omit `store` in favor of `state`
-    [batcher, state],
-  )
-}

package/src/debouncer/index.ts

@@ -1,7 +0,0 @@
-// re-export everything from the core pacer package, BUT ONLY from the debouncer module
-export * from '@tanstack/pacer/debouncer'
-
-export * from './useDebouncedCallback'
-export * from './useDebouncedState'
-export * from './useDebouncedValue'
-export * from './useDebouncer'

package/src/debouncer/useDebouncedCallback.ts

@@ -1,51 +0,0 @@
-import { useCallback } from 'preact/hooks'
-import { useDebouncer } from './useDebouncer'
-import type { PreactDebouncerOptions } from './useDebouncer'
-import type { AnyFunction } from '@tanstack/pacer/types'
-
-/**
- * A Preact hook that creates a debounced version of a callback function.
- * This hook is essentially a wrapper around the basic `debounce` function
- * that is exported from `@tanstack/pacer`,
- * but optimized for Preact with reactive options and a stable function reference.
- *
- * 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 hook provides a simpler API compared to `useDebouncer`, making it ideal for basic
- * debouncing needs. However, it does not expose the underlying Debouncer instance.
- *
- * For advanced usage requiring features like:
- * - Manual cancellation
- * - Access to execution counts
- * - Custom useCallback dependencies
- *
- * Consider using the `useDebouncer` hook instead.
- *
- * @example
- * ```tsx
- * // Debounce a search handler
- * const handleSearch = useDebouncedCallback((query: string) => {
- *   fetchSearchResults(query);
- * }, {
- *   wait: 500 // Wait 500ms between executions
- * });
- *
- * // Use in an input
- * <input
- *   type="search"
- *   onChange={(e) => handleSearch(e.target.value)}
- * />
- * ```
- */
-export function useDebouncedCallback<TFn extends AnyFunction>(
-  fn: TFn,
-  options: PreactDebouncerOptions<TFn, {}>,
-): (...args: Parameters<TFn>) => void {
-  const debouncedFn = useDebouncer(fn, options).maybeExecute
-  return useCallback(
-    (...args: Parameters<TFn>) => debouncedFn(...args),
-    [debouncedFn],
-  )
-}

package/src/debouncer/useDebouncedState.ts

@@ -1,106 +0,0 @@
-import { useState } from 'preact/hooks'
-import { useDebouncer } from './useDebouncer'
-import type { PreactDebouncer, PreactDebouncerOptions } from './useDebouncer'
-import type { Dispatch, StateUpdater } from 'preact/hooks'
-import type { DebouncerState } from '@tanstack/pacer/debouncer'
-
-/**
- * A Preact hook that creates a debounced state value, combining Preact's useState with debouncing functionality.
- * This hook provides both the current debounced value and methods to update it.
- *
- * The state value is only updated after the specified wait time has elapsed since the last update attempt.
- * If another update is attempted before the wait time expires, the timer resets and starts waiting again.
- * This is useful for handling frequent state updates that should be throttled, like search input values
- * or window resize dimensions.
- *
- * The hook returns a tuple containing:
- * - The current debounced value
- * - A function to update the debounced value
- * - The debouncer instance with additional control methods
- *
- * ## State Management and Selector
- *
- * The hook uses TanStack Store for reactive state management via the underlying debouncer instance.
- * The `selector` parameter allows you to specify which debouncer state changes will trigger a re-render,
- * optimizing performance by preventing unnecessary re-renders 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 re-renders and gives you
- * full control over when your component updates. Only when you provide a selector will the
- * component re-render when the selected state values change.
- *
- * Available debouncer state properties:
- * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
- * - `executionCount`: Number of function executions that have been completed
- * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const [searchTerm, setSearchTerm, debouncer] = useDebouncedState('', {
- *   wait: 500 // Wait 500ms after last keystroke
- * });
- *
- * // Opt-in to re-render when pending state changes (optimized for loading indicators)
- * const [searchTerm, setSearchTerm, debouncer] = useDebouncedState(
- *   '',
- *   { wait: 500 },
- *   (state) => ({ isPending: state.isPending })
- * );
- *
- * // Opt-in to re-render when execution count changes (optimized for tracking executions)
- * const [searchTerm, setSearchTerm, debouncer] = useDebouncedState(
- *   '',
- *   { wait: 500 },
- *   (state) => ({ executionCount: state.executionCount })
- * );
- *
- * // Opt-in to re-render when debouncing status changes (optimized for status display)
- * const [searchTerm, setSearchTerm, debouncer] = useDebouncedState(
- *   '',
- *   { wait: 500 },
- *   (state) => ({
- *     status: state.status,
- *     canLeadingExecute: state.canLeadingExecute
- *   })
- * );
- *
- * // Update value - will be debounced
- * const handleChange = (e) => {
- *   setSearchTerm(e.target.value);
- * };
- *
- * // Access the selected debouncer state (will be empty object {} unless selector provided)
- * const { isPending, executionCount } = debouncer.state;
- * ```
- */
-export function useDebouncedState<
-  TValue,
-  TSelected = DebouncerState<Dispatch<StateUpdater<TValue>>>,
->(
-  value: TValue,
-  options: PreactDebouncerOptions<Dispatch<StateUpdater<TValue>>, TSelected>,
-  selector?: (
-    state: DebouncerState<Dispatch<StateUpdater<TValue>>>,
-  ) => TSelected,
-): [
-  TValue,
-  Dispatch<StateUpdater<TValue>>,
-  PreactDebouncer<Dispatch<StateUpdater<TValue>>, TSelected>,
-] {
-  const [debouncedValue, setDebouncedValue] = useState(value)
-  const debouncer = useDebouncer(
-    setDebouncedValue,
-    options,
-    selector as (
-      state: DebouncerState<Dispatch<StateUpdater<TValue>>>,
-    ) => TSelected,
-  )
-  return [
-    debouncedValue,
-    debouncer.maybeExecute as Dispatch<StateUpdater<TValue>>,
-    debouncer,
-  ]
-}

package/src/debouncer/useDebouncedValue.ts

@@ -1,109 +0,0 @@
-import { useEffect } from 'preact/hooks'
-import { useDebouncedState } from './useDebouncedState'
-import type { PreactDebouncer, PreactDebouncerOptions } from './useDebouncer'
-import type { Dispatch, StateUpdater } from 'preact/hooks'
-import type { DebouncerState } from '@tanstack/pacer/debouncer'
-
-/**
- * A Preact hook that creates a debounced value that updates only after a specified delay.
- * Unlike useDebouncedState, this hook automatically tracks changes to the input value
- * and updates the debounced value accordingly.
- *
- * The debounced value will only update after the specified wait time has elapsed since
- * the last change to the input value. If the input value changes again before the wait
- * time expires, the timer resets and starts waiting again.
- *
- * This is useful for deriving debounced values from props or state that change frequently,
- * like search queries or form inputs, where you want to limit how often downstream effects
- * or calculations occur.
- *
- * The hook returns the current debounced value and the underlying debouncer instance.
- * The debouncer instance can be used to access additional functionality like cancellation
- * and execution counts.
- *
- * ## State Management and Selector
- *
- * The hook uses TanStack Store for reactive state management via the underlying debouncer instance.
- * The `selector` parameter allows you to specify which debouncer state changes will trigger a re-render,
- * optimizing performance by preventing unnecessary re-renders 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 re-renders and gives you
- * full control over when your component updates. Only when you provide a selector will the
- * component re-render when the selected state values change.
- *
- * Available debouncer state properties:
- * - `canLeadingExecute`: Whether the debouncer can execute on the leading edge
- * - `executionCount`: Number of function executions that have been completed
- * - `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const [searchQuery, setSearchQuery] = useState('');
- * const [debouncedQuery, debouncer] = useDebouncedValue(searchQuery, {
- *   wait: 500 // Wait 500ms after last change
- * });
- *
- * // Opt-in to re-render when pending state changes (optimized for loading indicators)
- * const [debouncedQuery, debouncer] = useDebouncedValue(
- *   searchQuery,
- *   { wait: 500 },
- *   (state) => ({ isPending: state.isPending })
- * );
- *
- * // Opt-in to re-render when execution count changes (optimized for tracking executions)
- * const [debouncedQuery, debouncer] = useDebouncedValue(
- *   searchQuery,
- *   { wait: 500 },
- *   (state) => ({ executionCount: state.executionCount })
- * );
- *
- * // Opt-in to re-render when debouncing status changes (optimized for status display)
- * const [debouncedQuery, debouncer] = useDebouncedValue(
- *   searchQuery,
- *   { wait: 500 },
- *   (state) => ({
- *     status: state.status,
- *     canLeadingExecute: state.canLeadingExecute
- *   })
- * );
- *
- * // debouncedQuery will update 500ms after searchQuery stops changing
- * useEffect(() => {
- *   fetchSearchResults(debouncedQuery);
- * }, [debouncedQuery]);
- *
- * // Handle input changes
- * const handleChange = (e) => {
- *   setSearchQuery(e.target.value);
- * };
- *
- * // Access the selected debouncer state (will be empty object {} unless selector provided)
- * const { isPending, executionCount } = debouncer.state;
- * ```
- */
-export function useDebouncedValue<
-  TValue,
-  TSelected = DebouncerState<Dispatch<StateUpdater<TValue>>>,
->(
-  value: TValue,
-  options: PreactDebouncerOptions<Dispatch<StateUpdater<TValue>>, TSelected>,
-  selector?: (
-    state: DebouncerState<Dispatch<StateUpdater<TValue>>>,
-  ) => TSelected,
-): [TValue, PreactDebouncer<Dispatch<StateUpdater<TValue>>, TSelected>] {
-  const [debouncedValue, setDebouncedValue, debouncer] = useDebouncedState(
-    value,
-    options,
-    selector,
-  )
-
-  useEffect(() => {
-    ;(setDebouncedValue as (value: TValue) => void)(value)
-  }, [value, setDebouncedValue])
-
-  return [debouncedValue, debouncer]
-}