@tanstack/preact-pacer 0.22.1 → 0.24.0

package/src/rate-limiter/useRateLimiter.ts

@@ -1,244 +0,0 @@
-import { useEffect, useMemo, useState } from 'preact/hooks'
-import { RateLimiter } from '@tanstack/pacer/rate-limiter'
-import { shallow, useSelector } from '@tanstack/preact-store'
-import { useDefaultPacerOptions } from '../provider/PacerProvider'
-import type { Store } from '@tanstack/preact-store'
-import type {
-  RateLimiterOptions,
-  RateLimiterState,
-} from '@tanstack/pacer/rate-limiter'
-import type { AnyFunction } from '@tanstack/pacer/types'
-import type { ComponentChildren } from 'preact'
-
-export interface PreactRateLimiterOptions<
-  TFn extends AnyFunction,
-  TSelected = {},
-> extends RateLimiterOptions<TFn> {
-  /**
-   * Optional callback invoked when the component unmounts. Receives the rate limiter instance.
-   * When provided, replaces the default cleanup; use it to call reset(), add logging, etc.
-   */
-  onUnmount?: (rateLimiter: PreactRateLimiter<TFn, TSelected>) => void
-}
-
-export interface PreactRateLimiter<
-  TFn extends AnyFunction,
-  TSelected = {},
-> extends Omit<RateLimiter<TFn>, 'store'> {
-  /**
-   * A Preact HOC (Higher Order Component) that allows you to subscribe to the rate limiter state.
-   *
-   * This is useful for opting into state re-renders for specific parts of the rate limiter state
-   * deep in your component tree without needing to pass a selector to the hook.
-   *
-   * @example
-   * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
-   *   {({ rejectionCount }) => (
-   *     <div>Rejections: {rejectionCount}</div>
-   *   )}
-   * </rateLimiter.Subscribe>
-   */
-  Subscribe: <TSelected>(props: {
-    selector: (state: RateLimiterState) => TSelected
-    children: ((state: TSelected) => ComponentChildren) | ComponentChildren
-  }) => ComponentChildren
-  /**
-   * Reactive state that will be updated and re-rendered when the rate limiter state changes
-   *
-   * Use this instead of `rateLimiter.store.state`
-   */
-  readonly state: Readonly<TSelected>
-  /**
-   * @deprecated Use `rateLimiter.state` instead of `rateLimiter.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<RateLimiterState>>
-}
-
-/**
- * A low-level Preact hook that creates a `RateLimiter` instance to enforce rate limits on function execution.
- *
- * This hook is designed to be flexible and state-management agnostic - it simply returns a rate limiter instance that
- * you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
- *
- * Rate limiting is a simple "hard limit" approach that allows executions until a maximum count is reached within
- * a time window, then blocks all subsequent calls until the window resets. Unlike throttling or debouncing,
- * it does not attempt to space out or collapse executions intelligently.
- *
- * The rate limiter supports two types of windows:
- * - 'fixed': A strict window that resets after the window period. All executions within the window count
- *   towards the limit, and the window resets completely after the period.
- * - 'sliding': A rolling window that allows executions as old ones expire. This provides a more
- *   consistent rate of execution over time.
- *
- * For smoother execution patterns:
- * - Use throttling when you want consistent spacing between executions (e.g. UI updates)
- * - Use debouncing when you want to collapse rapid-fire events (e.g. search input)
- * - Use rate limiting only when you need to enforce hard limits (e.g. API rate limits)
- *
- * ## State Management and Selector
- *
- * The hook uses TanStack Store for reactive state management. You can subscribe to state changes
- * in two ways:
- *
- * **1. Using `rateLimiter.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 function executions that have been completed
- * - `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
- * - `rejectionCount`: Number of function executions that have been rejected due to rate limiting
- *
- * The hook returns an object containing:
- * - maybeExecute: The rate-limited function that respects the configured limits
- * - getExecutionCount: Returns the number of successful executions
- * - getRejectionCount: Returns the number of rejected executions due to rate limiting
- * - getRemainingInWindow: Returns how many more executions are allowed in the current window
- * - reset: Resets the execution counts and window timing
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const rateLimiter = useRateLimiter(apiCall, {
- *   limit: 5,
- *   window: 60000,
- *   windowType: 'sliding',
- * });
- *
- * // Subscribe to state changes deep in component tree using Subscribe HOC
- * <rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
- *   {({ rejectionCount }) => (
- *     <div>Rejections: {rejectionCount}</div>
- *   )}
- * </rateLimiter.Subscribe>
- *
- * // Opt-in to re-render when execution count changes at hook level (optimized for tracking successful executions)
- * const rateLimiter = useRateLimiter(
- *   apiCall,
- *   {
- *     limit: 5,
- *     window: 60000,
- *     windowType: 'sliding',
- *   },
- *   (state) => ({ executionCount: state.executionCount })
- * );
- *
- * // Opt-in to re-render when rejection count changes (optimized for tracking rate limit violations)
- * const rateLimiter = useRateLimiter(
- *   apiCall,
- *   {
- *     limit: 5,
- *     window: 60000,
- *     windowType: 'sliding',
- *   },
- *   (state) => ({ rejectionCount: state.rejectionCount })
- * );
- *
- * // Opt-in to re-render when execution times change (optimized for window calculations)
- * const rateLimiter = useRateLimiter(
- *   apiCall,
- *   {
- *     limit: 5,
- *     window: 60000,
- *     windowType: 'sliding',
- *   },
- *   (state) => ({ executionTimes: state.executionTimes })
- * );
- *
- * // Multiple state properties - re-render when any of these change
- * const rateLimiter = useRateLimiter(
- *   apiCall,
- *   {
- *     limit: 5,
- *     window: 60000,
- *     windowType: 'sliding',
- *   },
- *   (state) => ({
- *     executionCount: state.executionCount,
- *     rejectionCount: state.rejectionCount
- *   })
- * );
- *
- * // Monitor rate limit status
- * const handleClick = () => {
- *   const remaining = rateLimiter.getRemainingInWindow();
- *   if (remaining > 0) {
- *     rateLimiter.maybeExecute(data);
- *   } else {
- *     showRateLimitWarning();
- *   }
- * };
- *
- * // Access the selected state (will be empty object {} unless selector provided)
- * const { executionCount, rejectionCount } = rateLimiter.state;
- * ```
- */
-export function useRateLimiter<TFn extends AnyFunction, TSelected = {}>(
-  fn: TFn,
-  options: PreactRateLimiterOptions<TFn, TSelected>,
-  selector: (state: RateLimiterState) => TSelected = () => ({}) as TSelected,
-): PreactRateLimiter<TFn, TSelected> {
-  const mergedOptions = {
-    ...useDefaultPacerOptions().rateLimiter,
-    ...options,
-  } as PreactRateLimiterOptions<TFn, TSelected>
-  const [rateLimiter] = useState(() => {
-    const rateLimiterInstance = new RateLimiter<TFn>(
-      fn,
-      mergedOptions,
-    ) as unknown as PreactRateLimiter<TFn, TSelected>
-
-    rateLimiterInstance.Subscribe = function Subscribe<TSelected>(props: {
-      selector: (state: RateLimiterState) => TSelected
-      children: ((state: TSelected) => ComponentChildren) | ComponentChildren
-    }) {
-      const selected = useSelector(rateLimiterInstance.store, props.selector, {
-        compare: shallow,
-      })
-
-      return typeof props.children === 'function'
-        ? props.children(selected)
-        : props.children
-    }
-
-    return rateLimiterInstance
-  })
-
-  rateLimiter.fn = fn
-  rateLimiter.setOptions(mergedOptions)
-
-  /* eslint-disable react-hooks/exhaustive-deps -- cleanup only; runs on unmount */
-  useEffect(() => {
-    return () => {
-      if (mergedOptions.onUnmount) {
-        mergedOptions.onUnmount(rateLimiter)
-      }
-    }
-  }, [])
-  /* eslint-enable react-hooks/exhaustive-deps */
-
-  const state = useSelector(rateLimiter.store, selector, { compare: shallow })
-
-  return useMemo(
-    () =>
-      ({
-        ...rateLimiter,
-        state,
-      }) as PreactRateLimiter<TFn, TSelected>, // omit `store` in favor of `state`
-    [rateLimiter, state],
-  )
-}

package/src/throttler/index.ts

@@ -1,7 +0,0 @@
-// re-export everything from the core pacer package, BUT ONLY from the throttler module
-export * from '@tanstack/pacer/throttler'
-
-export * from './useThrottledCallback'
-export * from './useThrottledState'
-export * from './useThrottledValue'
-export * from './useThrottler'

package/src/throttler/useThrottledCallback.ts

@@ -1,52 +0,0 @@
-import { useCallback } from 'preact/hooks'
-import { useThrottler } from './useThrottler'
-import type { PreactThrottlerOptions } from './useThrottler'
-import type { AnyFunction } from '@tanstack/pacer/types'
-
-/**
- * A Preact hook that creates a throttled version of a callback function.
- * This hook is essentially a wrapper around the basic `throttle` function
- * that is exported from `@tanstack/pacer`,
- * but optimized for Preact with reactive options and a stable function reference.
- *
- * The throttled function will execute at most once within the specified wait time period,
- * regardless of how many times it is called. If called multiple times during the wait period,
- * only the first invocation will execute, and subsequent calls will be ignored until
- * the wait period has elapsed.
- *
- * This hook provides a simpler API compared to `useThrottler`, making it ideal for basic
- * throttling needs. However, it does not expose the underlying Throttler instance.
- *
- * For advanced usage requiring features like:
- * - Manual cancellation
- * - Access to execution counts
- * - Custom useCallback dependencies
- *
- * Consider using the `useThrottler` hook instead.
- *
- * @example
- * ```tsx
- * // Throttle a window resize handler
- * const handleResize = useThrottledCallback(() => {
- *   updateLayoutMeasurements();
- * }, {
- *   wait: 100 // Execute at most once every 100ms
- * });
- *
- * // Use in an event listener
- * useEffect(() => {
- *   window.addEventListener('resize', handleResize);
- *   return () => window.removeEventListener('resize', handleResize);
- * }, [handleResize]);
- * ```
- */
-export function useThrottledCallback<TFn extends AnyFunction>(
-  fn: TFn,
-  options: PreactThrottlerOptions<TFn, {}>,
-): (...args: Parameters<TFn>) => void {
-  const throttledFn = useThrottler(fn, options).maybeExecute
-  return useCallback(
-    (...args: Parameters<TFn>) => throttledFn(...args),
-    [throttledFn],
-  )
-}

package/src/throttler/useThrottledState.ts

@@ -1,118 +0,0 @@
-import { useState } from 'preact/hooks'
-import { useThrottler } from './useThrottler'
-import type { Dispatch, StateUpdater } from 'preact/hooks'
-import type { PreactThrottler, PreactThrottlerOptions } from './useThrottler'
-import type { ThrottlerState } from '@tanstack/pacer/throttler'
-
-/**
- * A Preact hook that creates a throttled state value that updates at most once within a specified time window.
- * This hook combines Preact's useState with throttling functionality to provide controlled state updates.
- *
- * Throttling ensures state updates occur at a controlled rate regardless of how frequently the setter is called.
- * This is useful for rate-limiting expensive re-renders or operations that depend on rapidly changing state.
- *
- * The hook returns a tuple containing:
- * - The throttled state value
- * - A throttled setter function that respects the configured wait time
- * - The throttler instance for additional control
- *
- * For more direct control over throttling without state management,
- * consider using the lower-level useThrottler hook instead.
- *
- * ## State Management and Selector
- *
- * The hook uses TanStack Store for reactive state management via the underlying throttler instance.
- * The `selector` parameter allows you to specify which throttler 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 throttler state properties:
- * - `executionCount`: Number of function executions that have been completed
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
- * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
- * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const [value, setValue, throttler] = useThrottledState(0, { wait: 1000 });
- *
- * // Opt-in to re-render when execution count changes (optimized for tracking executions)
- * const [value, setValue, throttler] = useThrottledState(
- *   0,
- *   { wait: 1000 },
- *   (state) => ({ executionCount: state.executionCount })
- * );
- *
- * // Opt-in to re-render when throttling state changes (optimized for loading indicators)
- * const [value, setValue, throttler] = useThrottledState(
- *   0,
- *   { wait: 1000 },
- *   (state) => ({
- *     isPending: state.isPending,
- *     status: state.status
- *   })
- * );
- *
- * // Opt-in to re-render when timing information changes (optimized for timing displays)
- * const [value, setValue, throttler] = useThrottledState(
- *   0,
- *   { wait: 1000 },
- *   (state) => ({
- *     lastExecutionTime: state.lastExecutionTime,
- *     nextExecutionTime: state.nextExecutionTime
- *   })
- * );
- *
- * // With custom leading/trailing behavior
- * const [value, setValue] = useThrottledState(0, {
- *   wait: 1000,
- *   leading: true,   // Update immediately on first change
- *   trailing: false  // Skip trailing edge updates
- * });
- *
- * // Access throttler methods if needed
- * const handleReset = () => {
- *   setValue(0);
- *   throttler.cancel(); // Cancel any pending updates
- * };
- *
- * // Access the selected throttler state (will be empty object {} unless selector provided)
- * const { executionCount, isPending } = throttler.state;
- * ```
- */
-
-export function useThrottledState<
-  TValue,
-  TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>,
->(
-  value: TValue,
-  options: PreactThrottlerOptions<Dispatch<StateUpdater<TValue>>, TSelected>,
-  selector?: (
-    state: ThrottlerState<Dispatch<StateUpdater<TValue>>>,
-  ) => TSelected,
-): [
-  TValue,
-  Dispatch<StateUpdater<TValue>>,
-  PreactThrottler<Dispatch<StateUpdater<TValue>>, TSelected>,
-] {
-  const [throttledValue, setThrottledValue] = useState<TValue>(value)
-  const throttler = useThrottler(
-    setThrottledValue,
-    options,
-    selector as (
-      state: ThrottlerState<Dispatch<StateUpdater<TValue>>>,
-    ) => TSelected,
-  )
-  return [
-    throttledValue,
-    throttler.maybeExecute as Dispatch<StateUpdater<TValue>>,
-    throttler,
-  ]
-}

package/src/throttler/useThrottledValue.ts

@@ -1,104 +0,0 @@
-import { useEffect } from 'preact/hooks'
-import { useThrottledState } from './useThrottledState'
-import type { Dispatch, StateUpdater } from 'preact/hooks'
-import type { PreactThrottler, PreactThrottlerOptions } from './useThrottler'
-import type { ThrottlerState } from '@tanstack/pacer/throttler'
-
-/**
- * A high-level Preact hook that creates a throttled version of a value that updates at most once within a specified time window.
- * This hook uses Preact's useState internally to manage the throttled state.
- *
- * Throttling ensures the value updates occur at a controlled rate regardless of how frequently the input value changes.
- * This is useful for rate-limiting expensive re-renders or API calls that depend on rapidly changing values.
- *
- * The hook returns a tuple containing:
- * - The throttled value that updates according to the leading/trailing edge behavior specified in the options
- * - The throttler instance with control methods
- *
- * For more direct control over throttling behavior without Preact state management,
- * consider using the lower-level useThrottler hook instead.
- *
- * ## State Management and Selector
- *
- * The hook uses TanStack Store for reactive state management via the underlying throttler instance.
- * The `selector` parameter allows you to specify which throttler 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 throttler state properties:
- * - `executionCount`: Number of function executions that have been completed
- * - `lastArgs`: The arguments from the most recent call to maybeExecute
- * - `lastExecutionTime`: Timestamp of the last function execution in milliseconds
- * - `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
- * - `isPending`: Whether the throttler is waiting for the timeout to trigger execution
- * - `status`: Current execution status ('disabled' | 'idle' | 'pending')
- *
- * @example
- * ```tsx
- * // Default behavior - no reactive state subscriptions
- * const [throttledValue, throttler] = useThrottledValue(rawValue, { wait: 1000 });
- *
- * // Opt-in to re-render when execution count changes (optimized for tracking executions)
- * const [throttledValue, throttler] = useThrottledValue(
- *   rawValue,
- *   { wait: 1000 },
- *   (state) => ({ executionCount: state.executionCount })
- * );
- *
- * // Opt-in to re-render when throttling state changes (optimized for loading indicators)
- * const [throttledValue, throttler] = useThrottledValue(
- *   rawValue,
- *   { wait: 1000 },
- *   (state) => ({
- *     isPending: state.isPending,
- *     status: state.status
- *   })
- * );
- *
- * // Opt-in to re-render when timing information changes (optimized for timing displays)
- * const [throttledValue, throttler] = useThrottledValue(
- *   rawValue,
- *   { wait: 1000 },
- *   (state) => ({
- *     lastExecutionTime: state.lastExecutionTime,
- *     nextExecutionTime: state.nextExecutionTime
- *   })
- * );
- *
- * // With custom leading/trailing behavior
- * const [throttledValue, throttler] = useThrottledValue(rawValue, {
- *   wait: 1000,
- *   leading: true,   // Update immediately on first change
- *   trailing: false  // Skip trailing edge updates
- * });
- *
- * // Access the selected throttler state (will be empty object {} unless selector provided)
- * const { executionCount, isPending } = throttler.state;
- * ```
- */
-export function useThrottledValue<
-  TValue,
-  TSelected = ThrottlerState<Dispatch<StateUpdater<TValue>>>,
->(
-  value: TValue,
-  options: PreactThrottlerOptions<Dispatch<StateUpdater<TValue>>, TSelected>,
-  selector?: (
-    state: ThrottlerState<Dispatch<StateUpdater<TValue>>>,
-  ) => TSelected,
-): [TValue, PreactThrottler<Dispatch<StateUpdater<TValue>>, TSelected>] {
-  const [throttledValue, setThrottledValue, throttler] = useThrottledState(
-    value,
-    options,
-    selector,
-  )
-
-  useEffect(() => {
-    ;(setThrottledValue as (value: TValue) => void)(value)
-  }, [value, setThrottledValue])
-
-  return [throttledValue, throttler]
-}