@tanstack/solid-pacer 0.16.0 → 0.16.1

package/dist/{esm/queuer → queuer}/createQueuedSignal.d.ts

@@ -1,5 +1,8 @@
-import { SolidQueuer } from './createQueuer.js';
-import { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer';
+import { SolidQueuer } from "./createQueuer.js";
+import { QueuerOptions, QueuerState } from "@tanstack/pacer/queuer";
+
+//#region src/queuer/createQueuedSignal.d.ts
+
 /**
  * A Solid primitive that creates a queuer with managed state, combining Solid's signals with queuing functionality.
  * This primitive provides both the current queue state and queue control methods.
@@ -114,8 +117,7 @@ import { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer';
  * const { size, isRunning, executionCount } = queue.state;
  * ```
  */
-export declare function createQueuedSignal<TValue, TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<QueuerState<TValue>, 'items'>>(fn: (item: TValue) => void, options?: QueuerOptions<TValue>, selector?: (state: QueuerState<TValue>) => TSelected): [
-    () => Array<TValue>,
-    SolidQueuer<TValue, TSelected>['addItem'],
-    SolidQueuer<TValue, TSelected>
-];
+declare function createQueuedSignal<TValue, TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<QueuerState<TValue>, 'items'>>(fn: (item: TValue) => void, options?: QueuerOptions<TValue>, selector?: (state: QueuerState<TValue>) => TSelected): [() => Array<TValue>, SolidQueuer<TValue, TSelected>['addItem'], SolidQueuer<TValue, TSelected>];
+//#endregion
+export { createQueuedSignal };
+//# sourceMappingURL=createQueuedSignal.d.ts.map

package/dist/queuer/createQueuedSignal.js

@@ -0,0 +1,129 @@
+import { createQueuer } from "./createQueuer.js";
+
+//#region src/queuer/createQueuedSignal.ts
+/**
+* A Solid primitive that creates a queuer with managed state, combining Solid's signals with queuing functionality.
+* This primitive provides both the current queue state and queue control methods.
+*
+* The queue state is automatically updated whenever items are added, removed, or reordered in the queue.
+* All queue operations are reflected in the state array returned by the primitive.
+*
+* The queue can be started and stopped to automatically process items at a specified interval,
+* making it useful as a scheduler. When started, it will process one item per tick, with an
+* optional wait time between ticks.
+*
+* The primitive returns a tuple containing:
+* - The current queue state as an array
+* - The queue instance with methods for queue manipulation
+*
+* ## State Management and Selector
+*
+* The primitive uses Solid's reactive state management via the underlying queuer instance.
+* The `selector` parameter allows you to specify which queuer 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 queuer state properties:
+* - `executionCount`: Number of items that have been processed by the queuer
+* - `expirationCount`: Number of items that have been removed due to expiration
+* - `isEmpty`: Whether the queuer has no items to process
+* - `isFull`: Whether the queuer has reached its maximum capacity
+* - `isIdle`: Whether the queuer is not currently processing any items
+* - `isRunning`: Whether the queuer is active and will process items automatically
+* - `items`: Array of items currently waiting to be processed
+* - `itemTimestamps`: Timestamps when items were added for expiration tracking
+* - `pendingTick`: Whether the queuer has a pending timeout for processing the next item
+* - `rejectionCount`: Number of items that have been rejected from being added
+* - `size`: Number of items currently in the queue
+* - `status`: Current processing status ('idle' | 'running' | 'stopped')
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const [items, addItem, queue] = createQueuedSignal(
+*   (item) => console.log('Processing:', item),
+*   {
+*     initialItems: ['item1', 'item2'],
+*     started: true,
+*     wait: 1000,
+*     getPriority: (item) => item.priority
+*   }
+* );
+*
+* // Opt-in to re-render when queue contents change (optimized for displaying queue items)
+* const [items, addItem, queue] = createQueuedSignal(
+*   (item) => console.log('Processing:', item),
+*   { started: true, wait: 1000 },
+*   (state) => ({
+*     items: state.items,
+*     size: state.size,
+*     isEmpty: state.isEmpty
+*   })
+* );
+*
+* // Opt-in to re-render when processing state changes (optimized for loading indicators)
+* const [items, addItem, queue] = createQueuedSignal(
+*   (item) => console.log('Processing:', item),
+*   { started: true, wait: 1000 },
+*   (state) => ({
+*     isRunning: state.isRunning,
+*     isIdle: state.isIdle,
+*     status: state.status,
+*     pendingTick: state.pendingTick
+*   })
+* );
+*
+* // Opt-in to re-render when execution metrics change (optimized for stats display)
+* const [items, addItem, queue] = createQueuedSignal(
+*   (item) => console.log('Processing:', item),
+*   { started: true, wait: 1000 },
+*   (state) => ({
+*     executionCount: state.executionCount,
+*     expirationCount: state.expirationCount,
+*     rejectionCount: state.rejectionCount
+*   })
+* );
+*
+* // Add items to queue
+* const handleAdd = (item) => {
+*   addItem(item);
+* };
+*
+* // Start automatic processing
+* const startProcessing = () => {
+*   queue.start();
+* };
+*
+* // Stop automatic processing
+* const stopProcessing = () => {
+*   queue.stop();
+* };
+*
+* // Manual processing still available
+* const handleProcess = () => {
+*   const nextItem = queue.getNextItem();
+*   if (nextItem) {
+*     processItem(nextItem);
+*   }
+* };
+*
+* // Access the selected queuer state (will be empty object {} unless selector provided)
+* const { size, isRunning, executionCount } = queue.state;
+* ```
+*/
+function createQueuedSignal(fn, options = {}, selector = (state) => ({ items: state.items })) {
+	const queue = createQueuer(fn, options, selector);
+	return [
+		() => queue.state().items,
+		queue.addItem,
+		queue
+	];
+}
+
+//#endregion
+export { createQueuedSignal };
+//# sourceMappingURL=createQueuedSignal.js.map

package/dist/queuer/createQueuedSignal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createQueuedSignal.js","names":[],"sources":["../../src/queuer/createQueuedSignal.ts"],"sourcesContent":["import { createQueuer } from './createQueuer'\nimport type { SolidQueuer } from './createQueuer'\nimport type { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'\n\n/**\n * A Solid primitive that creates a queuer with managed state, combining Solid's signals with queuing functionality.\n * This primitive provides both the current queue state and queue control methods.\n *\n * The queue state is automatically updated whenever items are added, removed, or reordered in the queue.\n * All queue operations are reflected in the state array returned by the primitive.\n *\n * The queue can be started and stopped to automatically process items at a specified interval,\n * making it useful as a scheduler. When started, it will process one item per tick, with an\n * optional wait time between ticks.\n *\n * The primitive returns a tuple containing:\n * - The current queue state as an array\n * - The queue instance with methods for queue manipulation\n *\n * ## State Management and Selector\n *\n * The primitive uses Solid's reactive state management via the underlying queuer instance.\n * The `selector` parameter allows you to specify which queuer state changes will trigger a re-render,\n * optimizing performance by preventing unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available queuer state properties:\n * - `executionCount`: Number of items that have been processed by the queuer\n * - `expirationCount`: Number of items that have been removed due to expiration\n * - `isEmpty`: Whether the queuer has no items to process\n * - `isFull`: Whether the queuer has reached its maximum capacity\n * - `isIdle`: Whether the queuer is not currently processing any items\n * - `isRunning`: Whether the queuer is active and will process items automatically\n * - `items`: Array of items currently waiting to be processed\n * - `itemTimestamps`: Timestamps when items were added for expiration tracking\n * - `pendingTick`: Whether the queuer has a pending timeout for processing the next item\n * - `rejectionCount`: Number of items that have been rejected from being added\n * - `size`: Number of items currently in the queue\n * - `status`: Current processing status ('idle' | 'running' | 'stopped')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [items, addItem, queue] = createQueuedSignal(\n *   (item) => console.log('Processing:', item),\n *   {\n *     initialItems: ['item1', 'item2'],\n *     started: true,\n *     wait: 1000,\n *     getPriority: (item) => item.priority\n *   }\n * );\n *\n * // Opt-in to re-render when queue contents change (optimized for displaying queue items)\n * const [items, addItem, queue] = createQueuedSignal(\n *   (item) => console.log('Processing:', item),\n *   { started: true, wait: 1000 },\n *   (state) => ({\n *     items: state.items,\n *     size: state.size,\n *     isEmpty: state.isEmpty\n *   })\n * );\n *\n * // Opt-in to re-render when processing state changes (optimized for loading indicators)\n * const [items, addItem, queue] = createQueuedSignal(\n *   (item) => console.log('Processing:', item),\n *   { started: true, wait: 1000 },\n *   (state) => ({\n *     isRunning: state.isRunning,\n *     isIdle: state.isIdle,\n *     status: state.status,\n *     pendingTick: state.pendingTick\n *   })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for stats display)\n * const [items, addItem, queue] = createQueuedSignal(\n *   (item) => console.log('Processing:', item),\n *   { started: true, wait: 1000 },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     expirationCount: state.expirationCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Add items to queue\n * const handleAdd = (item) => {\n *   addItem(item);\n * };\n *\n * // Start automatic processing\n * const startProcessing = () => {\n *   queue.start();\n * };\n *\n * // Stop automatic processing\n * const stopProcessing = () => {\n *   queue.stop();\n * };\n *\n * // Manual processing still available\n * const handleProcess = () => {\n *   const nextItem = queue.getNextItem();\n *   if (nextItem) {\n *     processItem(nextItem);\n *   }\n * };\n *\n * // Access the selected queuer state (will be empty object {} unless selector provided)\n * const { size, isRunning, executionCount } = queue.state;\n * ```\n */\nexport function createQueuedSignal<\n  TValue,\n  TSelected extends Pick<QueuerState<TValue>, 'items'> = Pick<\n    QueuerState<TValue>,\n    'items'\n  >,\n>(\n  fn: (item: TValue) => void,\n  options: QueuerOptions<TValue> = {},\n  selector: (state: QueuerState<TValue>) => TSelected = (state) =>\n    ({ items: state.items }) as TSelected,\n): [\n  () => Array<TValue>,\n  SolidQueuer<TValue, TSelected>['addItem'],\n  SolidQueuer<TValue, TSelected>,\n] {\n  const queue = createQueuer(fn, options, selector)\n\n  return [() => queue.state().items, queue.addItem, queue]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsHA,SAAgB,mBAOd,IACA,UAAiC,EAAE,EACnC,YAAuD,WACpD,EAAE,OAAO,MAAM,OAAO,GAKzB;CACA,MAAM,QAAQ,aAAa,IAAI,SAAS,SAAS;AAEjD,QAAO;QAAO,MAAM,OAAO,CAAC;EAAO,MAAM;EAAS;EAAM"}

package/dist/queuer/createQueuer.cjs

@@ -0,0 +1,98 @@
+const require_PacerProvider = require('../provider/PacerProvider.cjs');
+let __tanstack_solid_store = require("@tanstack/solid-store");
+let __tanstack_pacer_queuer = require("@tanstack/pacer/queuer");
+
+//#region src/queuer/createQueuer.ts
+/**
+* Creates a Solid-compatible Queuer instance for managing a synchronous queue of items, exposing Solid signals for all stateful properties.
+*
+* Features:
+* - Synchronous processing of items using the provided `fn` function
+* - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior
+* - Priority queueing via `getPriority` or item `priority` property
+* - Item expiration and removal of stale items
+* - Configurable wait time between processing items
+* - Pause/resume processing
+* - Callbacks for queue state changes, execution, rejection, and expiration
+* - All stateful properties (items, counts, etc.) are exposed as Solid signals for reactivity
+*
+* The queue processes items synchronously in order, with optional delays between each item. When started, it will process one item per tick, with an optional wait time between ticks. You can pause and resume processing with `stop()` and `start()`.
+*
+* By default, the queue uses FIFO behavior, but you can configure LIFO or double-ended queueing by specifying the position when adding or removing items.
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
+* to specify which 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 state properties:
+* - `executionCount`: Number of items that have been processed
+* - `isRunning`: Whether the queuer is currently running (not stopped)
+* - `items`: Array of items currently queued for processing
+* - `rejectionCount`: Number of items that were rejected (expired or failed validation)
+*
+* Example usage:
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const queue = createQueuer(
+*   (item) => {
+*     // process item synchronously
+*     console.log('Processing', item);
+*   },
+*   {
+*     started: true, // Start processing immediately
+*     wait: 1000,    // Process one item every second
+*     getPriority: (item) => item.priority // Process higher priority items first
+*   }
+* );
+*
+* // Opt-in to re-render when items or isRunning changes (optimized for UI updates)
+* const queue = createQueuer(
+*   (item) => console.log('Processing', item),
+*   { started: true, wait: 1000 },
+*   (state) => ({ items: state.items, isRunning: state.isRunning })
+* );
+*
+* // Opt-in to re-render when execution metrics change (optimized for tracking progress)
+* const queue = createQueuer(
+*   (item) => console.log('Processing', item),
+*   { started: true, wait: 1000 },
+*   (state) => ({
+*     executionCount: state.executionCount,
+*     rejectionCount: state.rejectionCount
+*   })
+* );
+*
+* // Add items to process - they'll be handled automatically
+* queue.addItem('task1');
+* queue.addItem('task2');
+*
+* // Control the scheduler
+* queue.stop();  // Pause processing
+* queue.start(); // Resume processing
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { items, isRunning } = queue.state();
+* ```
+*/
+function createQueuer(fn, options = {}, selector = () => ({})) {
+	const queuer = new __tanstack_pacer_queuer.Queuer(fn, {
+		...require_PacerProvider.useDefaultPacerOptions().queuer,
+		...options
+	});
+	const state = (0, __tanstack_solid_store.useStore)(queuer.store, selector);
+	return {
+		...queuer,
+		state
+	};
+}
+
+//#endregion
+exports.createQueuer = createQueuer;
+//# sourceMappingURL=createQueuer.cjs.map

package/dist/queuer/createQueuer.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"createQueuer.cjs","names":["Queuer","useDefaultPacerOptions"],"sources":["../../src/queuer/createQueuer.ts"],"sourcesContent":["import { Queuer } from '@tanstack/pacer/queuer'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor } from 'solid-js'\nimport type { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'\n\nexport interface SolidQueuer<TValue, TSelected = {}> extends Omit<\n  Queuer<TValue>,\n  'store'\n> {\n  /**\n   * Reactive state that will be updated when the queuer state changes\n   *\n   * Use this instead of `queuer.store.state`\n   */\n  readonly state: Accessor<Readonly<TSelected>>\n  /**\n   * @deprecated Use `queuer.state` instead of `queuer.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 `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<QueuerState<TValue>>>\n}\n\n/**\n * Creates a Solid-compatible Queuer instance for managing a synchronous queue of items, exposing Solid signals for all stateful properties.\n *\n * Features:\n * - Synchronous processing of items using the provided `fn` function\n * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior\n * - Priority queueing via `getPriority` or item `priority` property\n * - Item expiration and removal of stale items\n * - Configurable wait time between processing items\n * - Pause/resume processing\n * - Callbacks for queue state changes, execution, rejection, and expiration\n * - All stateful properties (items, counts, etc.) are exposed as Solid signals for reactivity\n *\n * The queue processes items synchronously in order, with optional delays between each item. When started, it will process one item per tick, with an optional wait time between ticks. You can pause and resume processing with `stop()` and `start()`.\n *\n * By default, the queue uses FIFO behavior, but you can configure LIFO or double-ended queueing by specifying the position when adding or removing items.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available state properties:\n * - `executionCount`: Number of items that have been processed\n * - `isRunning`: Whether the queuer is currently running (not stopped)\n * - `items`: Array of items currently queued for processing\n * - `rejectionCount`: Number of items that were rejected (expired or failed validation)\n *\n * Example usage:\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const queue = createQueuer(\n *   (item) => {\n *     // process item synchronously\n *     console.log('Processing', item);\n *   },\n *   {\n *     started: true, // Start processing immediately\n *     wait: 1000,    // Process one item every second\n *     getPriority: (item) => item.priority // Process higher priority items first\n *   }\n * );\n *\n * // Opt-in to re-render when items or isRunning changes (optimized for UI updates)\n * const queue = createQueuer(\n *   (item) => console.log('Processing', item),\n *   { started: true, wait: 1000 },\n *   (state) => ({ items: state.items, isRunning: state.isRunning })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for tracking progress)\n * const queue = createQueuer(\n *   (item) => console.log('Processing', item),\n *   { started: true, wait: 1000 },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Add items to process - they'll be handled automatically\n * queue.addItem('task1');\n * queue.addItem('task2');\n *\n * // Control the scheduler\n * queue.stop();  // Pause processing\n * queue.start(); // Resume processing\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { items, isRunning } = queue.state();\n * ```\n */\nexport function createQueuer<TValue, TSelected = {}>(\n  fn: (item: TValue) => void,\n  options: QueuerOptions<TValue> = {},\n  selector: (state: QueuerState<TValue>) => TSelected = () => ({}) as TSelected,\n): SolidQueuer<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().queuer,\n    ...options,\n  } as QueuerOptions<TValue>\n\n  const queuer = new Queuer(fn, mergedOptions)\n\n  const state = useStore(queuer.store, selector)\n\n  return {\n    ...queuer,\n    state,\n  } as SolidQueuer<TValue, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuGA,SAAgB,aACd,IACA,UAAiC,EAAE,EACnC,kBAA6D,EAAE,GAC/B;CAMhC,MAAM,SAAS,IAAIA,+BAAO,IALJ;EACpB,GAAGC,8CAAwB,CAAC;EAC5B,GAAG;EACJ,CAE2C;CAE5C,MAAM,6CAAiB,OAAO,OAAO,SAAS;AAE9C,QAAO;EACL,GAAG;EACH;EACD"}

package/dist/{cjs/queuer → queuer}/createQueuer.d.cts

@@ -1,19 +1,21 @@
-import { Queuer, QueuerOptions, QueuerState } from '@tanstack/pacer/queuer';
-import { Store } from '@tanstack/solid-store';
-import { Accessor } from 'solid-js';
-export interface SolidQueuer<TValue, TSelected = {}> extends Omit<Queuer<TValue>, 'store'> {
-    /**
-     * Reactive state that will be updated when the queuer state changes
-     *
-     * Use this instead of `queuer.store.state`
-     */
-    readonly state: Accessor<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, as it has not been wrapped in a `useStore` hook internally.
-     * Although, you can make the state reactive by using the `useStore` in your own usage.
-     */
-    readonly store: Store<Readonly<QueuerState<TValue>>>;
+import { Store } from "@tanstack/solid-store";
+import { Accessor } from "solid-js";
+import { Queuer, QueuerOptions, QueuerState } from "@tanstack/pacer/queuer";
+
+//#region src/queuer/createQueuer.d.ts
+interface SolidQueuer<TValue, TSelected = {}> extends Omit<Queuer<TValue>, 'store'> {
+  /**
+   * Reactive state that will be updated when the queuer state changes
+   *
+   * Use this instead of `queuer.store.state`
+   */
+  readonly state: Accessor<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, as it has not been wrapped in a `useStore` hook internally.
+   * Although, you can make the state reactive by using the `useStore` in your own usage.
+   */
+  readonly store: Store<Readonly<QueuerState<TValue>>>;
 }
 /**
  * Creates a Solid-compatible Queuer instance for managing a synchronous queue of items, exposing Solid signals for all stateful properties.
@@ -93,4 +95,7 @@ export interface SolidQueuer<TValue, TSelected = {}> extends Omit<Queuer<TValue>
  * const { items, isRunning } = queue.state();
  * ```
  */
-export declare function createQueuer<TValue, TSelected = {}>(fn: (item: TValue) => void, options?: QueuerOptions<TValue>, selector?: (state: QueuerState<TValue>) => TSelected): SolidQueuer<TValue, TSelected>;
+declare function createQueuer<TValue, TSelected = {}>(fn: (item: TValue) => void, options?: QueuerOptions<TValue>, selector?: (state: QueuerState<TValue>) => TSelected): SolidQueuer<TValue, TSelected>;
+//#endregion
+export { SolidQueuer, createQueuer };
+//# sourceMappingURL=createQueuer.d.cts.map

package/dist/{esm/queuer → queuer}/createQueuer.d.ts

@@ -1,19 +1,21 @@
-import { Queuer, QueuerOptions, QueuerState } from '@tanstack/pacer/queuer';
-import { Store } from '@tanstack/solid-store';
-import { Accessor } from 'solid-js';
-export interface SolidQueuer<TValue, TSelected = {}> extends Omit<Queuer<TValue>, 'store'> {
-    /**
-     * Reactive state that will be updated when the queuer state changes
-     *
-     * Use this instead of `queuer.store.state`
-     */
-    readonly state: Accessor<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, as it has not been wrapped in a `useStore` hook internally.
-     * Although, you can make the state reactive by using the `useStore` in your own usage.
-     */
-    readonly store: Store<Readonly<QueuerState<TValue>>>;
+import { Accessor } from "solid-js";
+import { Store } from "@tanstack/solid-store";
+import { Queuer, QueuerOptions, QueuerState } from "@tanstack/pacer/queuer";
+
+//#region src/queuer/createQueuer.d.ts
+interface SolidQueuer<TValue, TSelected = {}> extends Omit<Queuer<TValue>, 'store'> {
+  /**
+   * Reactive state that will be updated when the queuer state changes
+   *
+   * Use this instead of `queuer.store.state`
+   */
+  readonly state: Accessor<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, as it has not been wrapped in a `useStore` hook internally.
+   * Although, you can make the state reactive by using the `useStore` in your own usage.
+   */
+  readonly store: Store<Readonly<QueuerState<TValue>>>;
 }
 /**
  * Creates a Solid-compatible Queuer instance for managing a synchronous queue of items, exposing Solid signals for all stateful properties.
@@ -93,4 +95,7 @@ export interface SolidQueuer<TValue, TSelected = {}> extends Omit<Queuer<TValue>
  * const { items, isRunning } = queue.state();
  * ```
  */
-export declare function createQueuer<TValue, TSelected = {}>(fn: (item: TValue) => void, options?: QueuerOptions<TValue>, selector?: (state: QueuerState<TValue>) => TSelected): SolidQueuer<TValue, TSelected>;
+declare function createQueuer<TValue, TSelected = {}>(fn: (item: TValue) => void, options?: QueuerOptions<TValue>, selector?: (state: QueuerState<TValue>) => TSelected): SolidQueuer<TValue, TSelected>;
+//#endregion
+export { SolidQueuer, createQueuer };
+//# sourceMappingURL=createQueuer.d.ts.map

package/dist/queuer/createQueuer.js

@@ -0,0 +1,98 @@
+import { useDefaultPacerOptions } from "../provider/PacerProvider.js";
+import { useStore } from "@tanstack/solid-store";
+import { Queuer } from "@tanstack/pacer/queuer";
+
+//#region src/queuer/createQueuer.ts
+/**
+* Creates a Solid-compatible Queuer instance for managing a synchronous queue of items, exposing Solid signals for all stateful properties.
+*
+* Features:
+* - Synchronous processing of items using the provided `fn` function
+* - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior
+* - Priority queueing via `getPriority` or item `priority` property
+* - Item expiration and removal of stale items
+* - Configurable wait time between processing items
+* - Pause/resume processing
+* - Callbacks for queue state changes, execution, rejection, and expiration
+* - All stateful properties (items, counts, etc.) are exposed as Solid signals for reactivity
+*
+* The queue processes items synchronously in order, with optional delays between each item. When started, it will process one item per tick, with an optional wait time between ticks. You can pause and resume processing with `stop()` and `start()`.
+*
+* By default, the queue uses FIFO behavior, but you can configure LIFO or double-ended queueing by specifying the position when adding or removing items.
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management. The `selector` parameter allows you
+* to specify which 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 state properties:
+* - `executionCount`: Number of items that have been processed
+* - `isRunning`: Whether the queuer is currently running (not stopped)
+* - `items`: Array of items currently queued for processing
+* - `rejectionCount`: Number of items that were rejected (expired or failed validation)
+*
+* Example usage:
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const queue = createQueuer(
+*   (item) => {
+*     // process item synchronously
+*     console.log('Processing', item);
+*   },
+*   {
+*     started: true, // Start processing immediately
+*     wait: 1000,    // Process one item every second
+*     getPriority: (item) => item.priority // Process higher priority items first
+*   }
+* );
+*
+* // Opt-in to re-render when items or isRunning changes (optimized for UI updates)
+* const queue = createQueuer(
+*   (item) => console.log('Processing', item),
+*   { started: true, wait: 1000 },
+*   (state) => ({ items: state.items, isRunning: state.isRunning })
+* );
+*
+* // Opt-in to re-render when execution metrics change (optimized for tracking progress)
+* const queue = createQueuer(
+*   (item) => console.log('Processing', item),
+*   { started: true, wait: 1000 },
+*   (state) => ({
+*     executionCount: state.executionCount,
+*     rejectionCount: state.rejectionCount
+*   })
+* );
+*
+* // Add items to process - they'll be handled automatically
+* queue.addItem('task1');
+* queue.addItem('task2');
+*
+* // Control the scheduler
+* queue.stop();  // Pause processing
+* queue.start(); // Resume processing
+*
+* // Access the selected state (will be empty object {} unless selector provided)
+* const { items, isRunning } = queue.state();
+* ```
+*/
+function createQueuer(fn, options = {}, selector = () => ({})) {
+	const queuer = new Queuer(fn, {
+		...useDefaultPacerOptions().queuer,
+		...options
+	});
+	const state = useStore(queuer.store, selector);
+	return {
+		...queuer,
+		state
+	};
+}
+
+//#endregion
+export { createQueuer };
+//# sourceMappingURL=createQueuer.js.map

package/dist/queuer/createQueuer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createQueuer.js","names":[],"sources":["../../src/queuer/createQueuer.ts"],"sourcesContent":["import { Queuer } from '@tanstack/pacer/queuer'\nimport { useStore } from '@tanstack/solid-store'\nimport { useDefaultPacerOptions } from '../provider/PacerProvider'\nimport type { Store } from '@tanstack/solid-store'\nimport type { Accessor } from 'solid-js'\nimport type { QueuerOptions, QueuerState } from '@tanstack/pacer/queuer'\n\nexport interface SolidQueuer<TValue, TSelected = {}> extends Omit<\n  Queuer<TValue>,\n  'store'\n> {\n  /**\n   * Reactive state that will be updated when the queuer state changes\n   *\n   * Use this instead of `queuer.store.state`\n   */\n  readonly state: Accessor<Readonly<TSelected>>\n  /**\n   * @deprecated Use `queuer.state` instead of `queuer.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 `useStore` hook internally.\n   * Although, you can make the state reactive by using the `useStore` in your own usage.\n   */\n  readonly store: Store<Readonly<QueuerState<TValue>>>\n}\n\n/**\n * Creates a Solid-compatible Queuer instance for managing a synchronous queue of items, exposing Solid signals for all stateful properties.\n *\n * Features:\n * - Synchronous processing of items using the provided `fn` function\n * - FIFO (First In First Out) or LIFO (Last In First Out) queue behavior\n * - Priority queueing via `getPriority` or item `priority` property\n * - Item expiration and removal of stale items\n * - Configurable wait time between processing items\n * - Pause/resume processing\n * - Callbacks for queue state changes, execution, rejection, and expiration\n * - All stateful properties (items, counts, etc.) are exposed as Solid signals for reactivity\n *\n * The queue processes items synchronously in order, with optional delays between each item. When started, it will process one item per tick, with an optional wait time between ticks. You can pause and resume processing with `stop()` and `start()`.\n *\n * By default, the queue uses FIFO behavior, but you can configure LIFO or double-ended queueing by specifying the position when adding or removing items.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management. The `selector` parameter allows you\n * to specify which state changes will trigger a re-render, optimizing performance by preventing\n * unnecessary re-renders when irrelevant 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. This prevents unnecessary re-renders and gives you\n * full control over when your component updates. Only when you provide a selector will the\n * component re-render when the selected state values change.\n *\n * Available state properties:\n * - `executionCount`: Number of items that have been processed\n * - `isRunning`: Whether the queuer is currently running (not stopped)\n * - `items`: Array of items currently queued for processing\n * - `rejectionCount`: Number of items that were rejected (expired or failed validation)\n *\n * Example usage:\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const queue = createQueuer(\n *   (item) => {\n *     // process item synchronously\n *     console.log('Processing', item);\n *   },\n *   {\n *     started: true, // Start processing immediately\n *     wait: 1000,    // Process one item every second\n *     getPriority: (item) => item.priority // Process higher priority items first\n *   }\n * );\n *\n * // Opt-in to re-render when items or isRunning changes (optimized for UI updates)\n * const queue = createQueuer(\n *   (item) => console.log('Processing', item),\n *   { started: true, wait: 1000 },\n *   (state) => ({ items: state.items, isRunning: state.isRunning })\n * );\n *\n * // Opt-in to re-render when execution metrics change (optimized for tracking progress)\n * const queue = createQueuer(\n *   (item) => console.log('Processing', item),\n *   { started: true, wait: 1000 },\n *   (state) => ({\n *     executionCount: state.executionCount,\n *     rejectionCount: state.rejectionCount\n *   })\n * );\n *\n * // Add items to process - they'll be handled automatically\n * queue.addItem('task1');\n * queue.addItem('task2');\n *\n * // Control the scheduler\n * queue.stop();  // Pause processing\n * queue.start(); // Resume processing\n *\n * // Access the selected state (will be empty object {} unless selector provided)\n * const { items, isRunning } = queue.state();\n * ```\n */\nexport function createQueuer<TValue, TSelected = {}>(\n  fn: (item: TValue) => void,\n  options: QueuerOptions<TValue> = {},\n  selector: (state: QueuerState<TValue>) => TSelected = () => ({}) as TSelected,\n): SolidQueuer<TValue, TSelected> {\n  const mergedOptions = {\n    ...useDefaultPacerOptions().queuer,\n    ...options,\n  } as QueuerOptions<TValue>\n\n  const queuer = new Queuer(fn, mergedOptions)\n\n  const state = useStore(queuer.store, selector)\n\n  return {\n    ...queuer,\n    state,\n  } as SolidQueuer<TValue, TSelected> // omit `store` in favor of `state`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuGA,SAAgB,aACd,IACA,UAAiC,EAAE,EACnC,kBAA6D,EAAE,GAC/B;CAMhC,MAAM,SAAS,IAAI,OAAO,IALJ;EACpB,GAAG,wBAAwB,CAAC;EAC5B,GAAG;EACJ,CAE2C;CAE5C,MAAM,QAAQ,SAAS,OAAO,OAAO,SAAS;AAE9C,QAAO;EACL,GAAG;EACH;EACD"}

package/dist/queuer/index.cjs

@@ -0,0 +1,12 @@
+const require_createQueuer = require('./createQueuer.cjs');
+const require_createQueuedSignal = require('./createQueuedSignal.cjs');
+
+exports.createQueuedSignal = require_createQueuedSignal.createQueuedSignal;
+exports.createQueuer = require_createQueuer.createQueuer;
+var __tanstack_pacer_queuer = require("@tanstack/pacer/queuer");
+Object.keys(__tanstack_pacer_queuer).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return __tanstack_pacer_queuer[k]; }
+  });
+});

package/dist/queuer/index.d.cts

@@ -0,0 +1,4 @@
+import { SolidQueuer, createQueuer } from "./createQueuer.cjs";
+import { createQueuedSignal } from "./createQueuedSignal.cjs";
+export * from "@tanstack/pacer/queuer";
+export { SolidQueuer, createQueuedSignal, createQueuer };

package/dist/queuer/index.d.ts

@@ -0,0 +1,4 @@
+import { SolidQueuer, createQueuer } from "./createQueuer.js";
+import { createQueuedSignal } from "./createQueuedSignal.js";
+export * from "@tanstack/pacer/queuer";
+export { SolidQueuer, createQueuedSignal, createQueuer };

package/dist/queuer/index.js

@@ -0,0 +1,6 @@
+import { createQueuer } from "./createQueuer.js";
+import { createQueuedSignal } from "./createQueuedSignal.js";
+
+export * from "@tanstack/pacer/queuer"
+
+export { createQueuedSignal, createQueuer };

package/dist/rate-limiter/createRateLimitedSignal.cjs

@@ -0,0 +1,102 @@
+const require_createRateLimiter = require('./createRateLimiter.cjs');
+let solid_js = require("solid-js");
+
+//#region src/rate-limiter/createRateLimitedSignal.ts
+/**
+* A Solid hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.
+* This hook combines Solid's createSignal with rate limiting functionality to provide controlled state updates.
+*
+* Rate limiting is a simple "hard limit" approach - it allows all updates until the limit is reached, then blocks
+* subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out
+* or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.
+*
+* The rate limiter supports two types of windows:
+* - 'fixed': A strict window that resets after the window period. All updates within the window count
+*   towards the limit, and the window resets completely after the period.
+* - 'sliding': A rolling window that allows updates as old ones expire. This provides a more
+*   consistent rate of updates over time.
+*
+* For smoother update patterns, consider:
+* - createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)
+* - createDebouncedSignal: When you want to collapse rapid updates into a single update (e.g. search input)
+*
+* Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.
+*
+* The hook returns a tuple containing:
+* - The rate-limited state value accessor
+* - A rate-limited setter function that respects the configured limits
+* - The rateLimiter instance for additional control
+*
+* For more direct control over rate limiting without state management,
+* consider using the lower-level createRateLimiter hook instead.
+*
+* ## State Management and Selector
+*
+* The hook uses TanStack Store for reactive state management via the underlying rate limiter instance.
+* The `selector` parameter allows you to specify which rate limiter state changes will trigger reactive updates,
+* optimizing performance by preventing unnecessary subscriptions 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 reactive updates and gives you
+* full control over when your component subscribes to state changes. Only when you provide a selector will
+* the reactive system track the selected state values.
+*
+* Available rate limiter state properties:
+* - `callsInWindow`: Number of calls made in the current window
+* - `remainingInWindow`: Number of calls remaining in the current window
+* - `windowStart`: Unix timestamp when the current window started
+* - `nextWindowStart`: Unix timestamp when the next window will start
+* - `msUntilNextWindow`: Milliseconds until the next window starts
+* - `isAtLimit`: Whether the call limit for the current window has been reached
+* - `status`: Current status ('disabled' | 'idle' | 'at-limit')
+*
+* @example
+* ```tsx
+* // Default behavior - no reactive state subscriptions
+* const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {
+*   limit: 5,
+*   window: 60000,
+*   windowType: 'sliding'
+* });
+*
+* // Opt-in to reactive updates when limit state changes (optimized for UI feedback)
+* const [value, setValue, rateLimiter] = createRateLimitedSignal(
+*   0,
+*   { limit: 5, window: 60000 },
+*   (state) => ({ isAtLimit: state.isAtLimit, remainingInWindow: state.remainingInWindow })
+* );
+*
+* // With rejection callback and fixed window
+* const [value, setValue] = createRateLimitedSignal(0, {
+*   limit: 3,
+*   window: 5000,
+*   windowType: 'fixed',
+*   onReject: (rateLimiter) => {
+*     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
+*   }
+* });
+*
+* // Access rateLimiter state via signals
+* const handleSubmit = () => {
+*   const remaining = rateLimiter.state().remainingInWindow;
+*   if (remaining > 0) {
+*     setValue(newValue);
+*   } else {
+*     showRateLimitWarning();
+*   }
+* };
+* ```
+*/
+function createRateLimitedSignal(value, initialOptions, selector) {
+	const [rateLimitedValue, setRateLimitedValue] = (0, solid_js.createSignal)(value);
+	const rateLimiter = require_createRateLimiter.createRateLimiter(setRateLimitedValue, initialOptions, selector);
+	return [
+		rateLimitedValue,
+		rateLimiter.maybeExecute,
+		rateLimiter
+	];
+}
+
+//#endregion
+exports.createRateLimitedSignal = createRateLimitedSignal;
+//# sourceMappingURL=createRateLimitedSignal.cjs.map

package/dist/rate-limiter/createRateLimitedSignal.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"createRateLimitedSignal.cjs","names":["createRateLimiter"],"sources":["../../src/rate-limiter/createRateLimitedSignal.ts"],"sourcesContent":["import { createSignal } from 'solid-js'\nimport { createRateLimiter } from './createRateLimiter'\nimport type { SolidRateLimiter } from './createRateLimiter'\nimport type { Accessor, Setter } from 'solid-js'\nimport type {\n  RateLimiterOptions,\n  RateLimiterState,\n} from '@tanstack/pacer/rate-limiter'\n\n/**\n * A Solid hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window.\n * This hook combines Solid's createSignal with rate limiting functionality to provide controlled state updates.\n *\n * Rate limiting is a simple \"hard limit\" approach - it allows all updates until the limit is reached, then blocks\n * subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out\n * or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.\n *\n * The rate limiter supports two types of windows:\n * - 'fixed': A strict window that resets after the window period. All updates within the window count\n *   towards the limit, and the window resets completely after the period.\n * - 'sliding': A rolling window that allows updates as old ones expire. This provides a more\n *   consistent rate of updates over time.\n *\n * For smoother update patterns, consider:\n * - createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)\n * - createDebouncedSignal: When you want to collapse rapid updates into a single update (e.g. search input)\n *\n * Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.\n *\n * The hook returns a tuple containing:\n * - The rate-limited state value accessor\n * - A rate-limited setter function that respects the configured limits\n * - The rateLimiter instance for additional control\n *\n * For more direct control over rate limiting without state management,\n * consider using the lower-level createRateLimiter hook instead.\n *\n * ## State Management and Selector\n *\n * The hook uses TanStack Store for reactive state management via the underlying rate limiter instance.\n * The `selector` parameter allows you to specify which rate limiter state changes will trigger reactive updates,\n * optimizing performance by preventing unnecessary subscriptions when irrelevant 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. This prevents unnecessary reactive updates and gives you\n * full control over when your component subscribes to state changes. Only when you provide a selector will\n * the reactive system track the selected state values.\n *\n * Available rate limiter state properties:\n * - `callsInWindow`: Number of calls made in the current window\n * - `remainingInWindow`: Number of calls remaining in the current window\n * - `windowStart`: Unix timestamp when the current window started\n * - `nextWindowStart`: Unix timestamp when the next window will start\n * - `msUntilNextWindow`: Milliseconds until the next window starts\n * - `isAtLimit`: Whether the call limit for the current window has been reached\n * - `status`: Current status ('disabled' | 'idle' | 'at-limit')\n *\n * @example\n * ```tsx\n * // Default behavior - no reactive state subscriptions\n * const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {\n *   limit: 5,\n *   window: 60000,\n *   windowType: 'sliding'\n * });\n *\n * // Opt-in to reactive updates when limit state changes (optimized for UI feedback)\n * const [value, setValue, rateLimiter] = createRateLimitedSignal(\n *   0,\n *   { limit: 5, window: 60000 },\n *   (state) => ({ isAtLimit: state.isAtLimit, remainingInWindow: state.remainingInWindow })\n * );\n *\n * // With rejection callback and fixed window\n * const [value, setValue] = createRateLimitedSignal(0, {\n *   limit: 3,\n *   window: 5000,\n *   windowType: 'fixed',\n *   onReject: (rateLimiter) => {\n *     alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);\n *   }\n * });\n *\n * // Access rateLimiter state via signals\n * const handleSubmit = () => {\n *   const remaining = rateLimiter.state().remainingInWindow;\n *   if (remaining > 0) {\n *     setValue(newValue);\n *   } else {\n *     showRateLimitWarning();\n *   }\n * };\n * ```\n */\nexport function createRateLimitedSignal<TValue, TSelected = {}>(\n  value: TValue,\n  initialOptions: RateLimiterOptions<Setter<TValue>>,\n  selector?: (state: RateLimiterState) => TSelected,\n): [\n  Accessor<TValue>,\n  Setter<TValue>,\n  SolidRateLimiter<Setter<TValue>, TSelected>,\n] {\n  const [rateLimitedValue, setRateLimitedValue] = createSignal<TValue>(value)\n\n  const rateLimiter = createRateLimiter(\n    setRateLimitedValue,\n    initialOptions,\n    selector,\n  )\n\n  return [\n    rateLimitedValue,\n    rateLimiter.maybeExecute as Setter<TValue>,\n    rateLimiter,\n  ]\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8FA,SAAgB,wBACd,OACA,gBACA,UAKA;CACA,MAAM,CAAC,kBAAkB,kDAA4C,MAAM;CAE3E,MAAM,cAAcA,4CAClB,qBACA,gBACA,SACD;AAED,QAAO;EACL;EACA,YAAY;EACZ;EACD"}