@zag-js/utils 1.24.2 → 1.26.0

package/dist/index.d.mts

@@ -90,7 +90,7 @@ declare const getValueTransformer: (va: number[], vb: number[]) => (v: number) =
 declare const toFixedNumber: (v: number, d?: number, b?: number) => number;
 declare const incrementValue: (v: number, s: number) => number;
 declare const decrementValue: (v: number, s: number) => number;
-declare const toPx: (v: number | undefined) => string | undefined;
+declare const toPx: (v: number | string | undefined) => string | undefined;
 
 declare function compact<T extends Record<string, unknown> | undefined>(obj: T): T;
 declare const json: (v: any) => any;
@@ -111,12 +111,30 @@ interface Store<T extends Record<string, any>> {
     snapshot: () => T;
 }
 
-interface RafIntervalOptions {
+interface TimerBaseContext {
     startMs: number;
     deltaMs: number;
 }
-declare function setRafInterval(callback: (options: RafIntervalOptions) => void, interval: number): () => void;
-declare function setRafTimeout(callback: () => void, delay: number): () => void;
+interface TimerContext extends TimerBaseContext {
+    now: number;
+}
+type TimerContextFn = (ctx: TimerContext) => boolean | void;
+declare class Timer {
+    #private;
+    private readonly onTick;
+    private frameId;
+    private pausedAtMs;
+    private context;
+    constructor(onTick: TimerContextFn);
+    private cancelFrame;
+    setStartMs: (startMs: number) => void;
+    get elapsedMs(): number;
+    start: () => void;
+    pause: () => void;
+    stop: () => void;
+}
+declare function setRafInterval(fn: (ctx: TimerBaseContext) => void, intervalMs: number): () => void;
+declare function setRafTimeout(fn: () => void, delayMs: number): () => void;
 
 declare function warn(m: string): void;
 declare function warn(c: boolean, m: string): void;
@@ -126,4 +144,4 @@ declare function ensure<T>(c: T | null | undefined, m: () => string): asserts c
 type RequiredBy<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
 declare function ensureProps<T, K extends keyof T>(props: T, keys: K[], scope?: string): asserts props is T & RequiredBy<T, K>;
 
-export { type IndexOptions, type MaybeFunction, type Nullable, type RafIntervalOptions, type Store, type StoreCompareFn, type StoreListener, add, addOrRemove, callAll, cast, chunk, clampPercent, clampValue, clear, compact, createSplitProps, createStore, debounce, decrementValue, diff, ensure, ensureProps, first, flatArray, fromLength, getClosestValue, getClosestValueIndex, getMaxValueAtIndex, getMinValueAtIndex, getNextStepValue, getPercentValue, getPreviousStepValue, getValuePercent, getValueRanges, getValueSetterAtIndex, getValueTransformer, has, hasProp, identity, incrementValue, insertAt, invariant, isArray, isBoolean, isDev, isEmpty, isEqual, isFunction, isNaN, isNull, isNumber, isObject, isObjectLike, isPlainObject, isString, isValueAtMax, isValueAtMin, isValueWithinRange, json, last, match, mod, nan, next, nextIndex, noop, omit, partition, pick, prev, prevIndex, remove, removeAt, roundToDpr, roundToStepPrecision, roundValue, runIfFn, setRafInterval, setRafTimeout, setValueAtIndex, snapValueToStep, splitProps, throttle, toArray, toFixedNumber, toPx, tryCatch, uniq, uuid, warn, wrap };
+export { type IndexOptions, type MaybeFunction, type Nullable, type Store, type StoreCompareFn, type StoreListener, Timer, type TimerBaseContext, type TimerContextFn, add, addOrRemove, callAll, cast, chunk, clampPercent, clampValue, clear, compact, createSplitProps, createStore, debounce, decrementValue, diff, ensure, ensureProps, first, flatArray, fromLength, getClosestValue, getClosestValueIndex, getMaxValueAtIndex, getMinValueAtIndex, getNextStepValue, getPercentValue, getPreviousStepValue, getValuePercent, getValueRanges, getValueSetterAtIndex, getValueTransformer, has, hasProp, identity, incrementValue, insertAt, invariant, isArray, isBoolean, isDev, isEmpty, isEqual, isFunction, isNaN, isNull, isNumber, isObject, isObjectLike, isPlainObject, isString, isValueAtMax, isValueAtMin, isValueWithinRange, json, last, match, mod, nan, next, nextIndex, noop, omit, partition, pick, prev, prevIndex, remove, removeAt, roundToDpr, roundToStepPrecision, roundValue, runIfFn, setRafInterval, setRafTimeout, setValueAtIndex, snapValueToStep, splitProps, throttle, toArray, toFixedNumber, toPx, tryCatch, uniq, uuid, warn, wrap };

package/dist/index.d.ts

@@ -90,7 +90,7 @@ declare const getValueTransformer: (va: number[], vb: number[]) => (v: number) =
 declare const toFixedNumber: (v: number, d?: number, b?: number) => number;
 declare const incrementValue: (v: number, s: number) => number;
 declare const decrementValue: (v: number, s: number) => number;
-declare const toPx: (v: number | undefined) => string | undefined;
+declare const toPx: (v: number | string | undefined) => string | undefined;
 
 declare function compact<T extends Record<string, unknown> | undefined>(obj: T): T;
 declare const json: (v: any) => any;
@@ -111,12 +111,30 @@ interface Store<T extends Record<string, any>> {
     snapshot: () => T;
 }
 
-interface RafIntervalOptions {
+interface TimerBaseContext {
     startMs: number;
     deltaMs: number;
 }
-declare function setRafInterval(callback: (options: RafIntervalOptions) => void, interval: number): () => void;
-declare function setRafTimeout(callback: () => void, delay: number): () => void;
+interface TimerContext extends TimerBaseContext {
+    now: number;
+}
+type TimerContextFn = (ctx: TimerContext) => boolean | void;
+declare class Timer {
+    #private;
+    private readonly onTick;
+    private frameId;
+    private pausedAtMs;
+    private context;
+    constructor(onTick: TimerContextFn);
+    private cancelFrame;
+    setStartMs: (startMs: number) => void;
+    get elapsedMs(): number;
+    start: () => void;
+    pause: () => void;
+    stop: () => void;
+}
+declare function setRafInterval(fn: (ctx: TimerBaseContext) => void, intervalMs: number): () => void;
+declare function setRafTimeout(fn: () => void, delayMs: number): () => void;
 
 declare function warn(m: string): void;
 declare function warn(c: boolean, m: string): void;
@@ -126,4 +144,4 @@ declare function ensure<T>(c: T | null | undefined, m: () => string): asserts c
 type RequiredBy<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
 declare function ensureProps<T, K extends keyof T>(props: T, keys: K[], scope?: string): asserts props is T & RequiredBy<T, K>;
 
-export { type IndexOptions, type MaybeFunction, type Nullable, type RafIntervalOptions, type Store, type StoreCompareFn, type StoreListener, add, addOrRemove, callAll, cast, chunk, clampPercent, clampValue, clear, compact, createSplitProps, createStore, debounce, decrementValue, diff, ensure, ensureProps, first, flatArray, fromLength, getClosestValue, getClosestValueIndex, getMaxValueAtIndex, getMinValueAtIndex, getNextStepValue, getPercentValue, getPreviousStepValue, getValuePercent, getValueRanges, getValueSetterAtIndex, getValueTransformer, has, hasProp, identity, incrementValue, insertAt, invariant, isArray, isBoolean, isDev, isEmpty, isEqual, isFunction, isNaN, isNull, isNumber, isObject, isObjectLike, isPlainObject, isString, isValueAtMax, isValueAtMin, isValueWithinRange, json, last, match, mod, nan, next, nextIndex, noop, omit, partition, pick, prev, prevIndex, remove, removeAt, roundToDpr, roundToStepPrecision, roundValue, runIfFn, setRafInterval, setRafTimeout, setValueAtIndex, snapValueToStep, splitProps, throttle, toArray, toFixedNumber, toPx, tryCatch, uniq, uuid, warn, wrap };
+export { type IndexOptions, type MaybeFunction, type Nullable, type Store, type StoreCompareFn, type StoreListener, Timer, type TimerBaseContext, type TimerContextFn, add, addOrRemove, callAll, cast, chunk, clampPercent, clampValue, clear, compact, createSplitProps, createStore, debounce, decrementValue, diff, ensure, ensureProps, first, flatArray, fromLength, getClosestValue, getClosestValueIndex, getMaxValueAtIndex, getMinValueAtIndex, getNextStepValue, getPercentValue, getPreviousStepValue, getValuePercent, getValueRanges, getValueSetterAtIndex, getValueTransformer, has, hasProp, identity, incrementValue, insertAt, invariant, isArray, isBoolean, isDev, isEmpty, isEqual, isFunction, isNaN, isNull, isNumber, isObject, isObjectLike, isPlainObject, isString, isValueAtMax, isValueAtMin, isValueWithinRange, json, last, match, mod, nan, next, nextIndex, noop, omit, partition, pick, prev, prevIndex, remove, removeAt, roundToDpr, roundToStepPrecision, roundValue, runIfFn, setRafInterval, setRafTimeout, setValueAtIndex, snapValueToStep, splitProps, throttle, toArray, toFixedNumber, toPx, tryCatch, uniq, uuid, warn, wrap };

package/dist/index.js

@@ -1,5 +1,15 @@
 'use strict';
 
+var __defProp = Object.defineProperty;
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+
 // src/array.ts
 function toArray(v) {
   if (v == null) return [];
@@ -322,7 +332,7 @@ var decimalOp = (a, op, b) => {
 };
 var incrementValue = (v, s) => decimalOp(nan(v), "+", s);
 var decrementValue = (v, s) => decimalOp(nan(v), "-", s);
-var toPx = (v) => v != null ? `${v}px` : void 0;
+var toPx = (v) => typeof v === "number" ? `${v}px` : v;
 
 // src/object.ts
 function compact(obj) {
@@ -414,33 +424,83 @@ function createStore(initialState, compare = Object.is) {
 }
 
 // src/timers.ts
-function setRafInterval(callback, interval) {
-  let start = performance.now();
-  let handle;
-  function loop(now) {
-    const delta = now - start;
-    if (delta >= interval) {
-      start = interval > 0 ? now - delta % interval : now;
-      callback({ startMs: start, deltaMs: delta });
+var currentTime = () => performance.now();
+var _tick;
+var Timer = class {
+  constructor(onTick) {
+    this.onTick = onTick;
+    __publicField(this, "frameId", null);
+    __publicField(this, "pausedAtMs", null);
+    __publicField(this, "context");
+    __publicField(this, "cancelFrame", () => {
+      if (this.frameId === null) return;
+      cancelAnimationFrame(this.frameId);
+      this.frameId = null;
+    });
+    __publicField(this, "setStartMs", (startMs) => {
+      this.context.startMs = startMs;
+    });
+    __publicField(this, "start", () => {
+      if (this.frameId !== null) return;
+      const now = currentTime();
+      if (this.pausedAtMs !== null) {
+        this.context.startMs += now - this.pausedAtMs;
+        this.pausedAtMs = null;
+      } else {
+        this.context.startMs = now;
+      }
+      this.frameId = requestAnimationFrame(__privateGet(this, _tick));
+    });
+    __publicField(this, "pause", () => {
+      if (this.frameId === null) return;
+      this.cancelFrame();
+      this.pausedAtMs = currentTime();
+    });
+    __publicField(this, "stop", () => {
+      if (this.frameId === null) return;
+      this.cancelFrame();
+      this.pausedAtMs = null;
+    });
+    __privateAdd(this, _tick, (now) => {
+      this.context.now = now;
+      this.context.deltaMs = now - this.context.startMs;
+      const shouldContinue = this.onTick(this.context);
+      if (shouldContinue === false) {
+        this.stop();
+        return;
+      }
+      this.frameId = requestAnimationFrame(__privateGet(this, _tick));
+    });
+    this.context = { now: 0, startMs: currentTime(), deltaMs: 0 };
+  }
+  get elapsedMs() {
+    if (this.pausedAtMs !== null) {
+      return this.pausedAtMs - this.context.startMs;
     }
-    handle = requestAnimationFrame(loop);
+    return currentTime() - this.context.startMs;
   }
-  handle = requestAnimationFrame(loop);
-  return () => cancelAnimationFrame(handle);
+};
+_tick = new WeakMap();
+function setRafInterval(fn, intervalMs) {
+  const timer = new Timer(({ now, deltaMs }) => {
+    if (deltaMs >= intervalMs) {
+      const startMs = intervalMs > 0 ? now - deltaMs % intervalMs : now;
+      timer.setStartMs(startMs);
+      fn({ startMs, deltaMs });
+    }
+  });
+  timer.start();
+  return () => timer.stop();
 }
-function setRafTimeout(callback, delay) {
-  const start = performance.now();
-  let handle;
-  function loop(now) {
-    const delta = now - start;
-    if (delta >= delay) {
-      callback();
-      return;
+function setRafTimeout(fn, delayMs) {
+  const timer = new Timer(({ deltaMs }) => {
+    if (deltaMs >= delayMs) {
+      fn();
+      return false;
     }
-    handle = requestAnimationFrame(loop);
-  }
-  handle = requestAnimationFrame(loop);
-  return () => cancelAnimationFrame(handle);
+  });
+  timer.start();
+  return () => timer.stop();
 }
 
 // src/warning.ts
@@ -470,6 +530,7 @@ function ensureProps(props, keys, scope) {
     throw new Error(`[zag-js${scope ? ` > ${scope}` : ""}] missing required props: ${missingKeys.join(", ")}`);
 }
 
+exports.Timer = Timer;
 exports.add = add;
 exports.addOrRemove = addOrRemove;
 exports.callAll = callAll;

package/dist/index.mjs

@@ -1,3 +1,13 @@
+var __defProp = Object.defineProperty;
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+
 // src/array.ts
 function toArray(v) {
   if (v == null) return [];
@@ -320,7 +330,7 @@ var decimalOp = (a, op, b) => {
 };
 var incrementValue = (v, s) => decimalOp(nan(v), "+", s);
 var decrementValue = (v, s) => decimalOp(nan(v), "-", s);
-var toPx = (v) => v != null ? `${v}px` : void 0;
+var toPx = (v) => typeof v === "number" ? `${v}px` : v;
 
 // src/object.ts
 function compact(obj) {
@@ -412,33 +422,83 @@ function createStore(initialState, compare = Object.is) {
 }
 
 // src/timers.ts
-function setRafInterval(callback, interval) {
-  let start = performance.now();
-  let handle;
-  function loop(now) {
-    const delta = now - start;
-    if (delta >= interval) {
-      start = interval > 0 ? now - delta % interval : now;
-      callback({ startMs: start, deltaMs: delta });
+var currentTime = () => performance.now();
+var _tick;
+var Timer = class {
+  constructor(onTick) {
+    this.onTick = onTick;
+    __publicField(this, "frameId", null);
+    __publicField(this, "pausedAtMs", null);
+    __publicField(this, "context");
+    __publicField(this, "cancelFrame", () => {
+      if (this.frameId === null) return;
+      cancelAnimationFrame(this.frameId);
+      this.frameId = null;
+    });
+    __publicField(this, "setStartMs", (startMs) => {
+      this.context.startMs = startMs;
+    });
+    __publicField(this, "start", () => {
+      if (this.frameId !== null) return;
+      const now = currentTime();
+      if (this.pausedAtMs !== null) {
+        this.context.startMs += now - this.pausedAtMs;
+        this.pausedAtMs = null;
+      } else {
+        this.context.startMs = now;
+      }
+      this.frameId = requestAnimationFrame(__privateGet(this, _tick));
+    });
+    __publicField(this, "pause", () => {
+      if (this.frameId === null) return;
+      this.cancelFrame();
+      this.pausedAtMs = currentTime();
+    });
+    __publicField(this, "stop", () => {
+      if (this.frameId === null) return;
+      this.cancelFrame();
+      this.pausedAtMs = null;
+    });
+    __privateAdd(this, _tick, (now) => {
+      this.context.now = now;
+      this.context.deltaMs = now - this.context.startMs;
+      const shouldContinue = this.onTick(this.context);
+      if (shouldContinue === false) {
+        this.stop();
+        return;
+      }
+      this.frameId = requestAnimationFrame(__privateGet(this, _tick));
+    });
+    this.context = { now: 0, startMs: currentTime(), deltaMs: 0 };
+  }
+  get elapsedMs() {
+    if (this.pausedAtMs !== null) {
+      return this.pausedAtMs - this.context.startMs;
     }
-    handle = requestAnimationFrame(loop);
+    return currentTime() - this.context.startMs;
   }
-  handle = requestAnimationFrame(loop);
-  return () => cancelAnimationFrame(handle);
+};
+_tick = new WeakMap();
+function setRafInterval(fn, intervalMs) {
+  const timer = new Timer(({ now, deltaMs }) => {
+    if (deltaMs >= intervalMs) {
+      const startMs = intervalMs > 0 ? now - deltaMs % intervalMs : now;
+      timer.setStartMs(startMs);
+      fn({ startMs, deltaMs });
+    }
+  });
+  timer.start();
+  return () => timer.stop();
 }
-function setRafTimeout(callback, delay) {
-  const start = performance.now();
-  let handle;
-  function loop(now) {
-    const delta = now - start;
-    if (delta >= delay) {
-      callback();
-      return;
+function setRafTimeout(fn, delayMs) {
+  const timer = new Timer(({ deltaMs }) => {
+    if (deltaMs >= delayMs) {
+      fn();
+      return false;
     }
-    handle = requestAnimationFrame(loop);
-  }
-  handle = requestAnimationFrame(loop);
-  return () => cancelAnimationFrame(handle);
+  });
+  timer.start();
+  return () => timer.stop();
 }
 
 // src/warning.ts
@@ -468,4 +528,4 @@ function ensureProps(props, keys, scope) {
     throw new Error(`[zag-js${scope ? ` > ${scope}` : ""}] missing required props: ${missingKeys.join(", ")}`);
 }
 
-export { add, addOrRemove, callAll, cast, chunk, clampPercent, clampValue, clear, compact, createSplitProps, createStore, debounce, decrementValue, diff, ensure, ensureProps, first, flatArray, fromLength, getClosestValue, getClosestValueIndex, getMaxValueAtIndex, getMinValueAtIndex, getNextStepValue, getPercentValue, getPreviousStepValue, getValuePercent, getValueRanges, getValueSetterAtIndex, getValueTransformer, has, hasProp, identity, incrementValue, insertAt, invariant, isArray, isBoolean, isDev, isEmpty, isEqual, isFunction, isNaN, isNull, isNumber, isObject, isObjectLike, isPlainObject, isString, isValueAtMax, isValueAtMin, isValueWithinRange, json, last, match, mod, nan, next, nextIndex, noop, omit, partition, pick, prev, prevIndex, remove, removeAt, roundToDpr, roundToStepPrecision, roundValue, runIfFn, setRafInterval, setRafTimeout, setValueAtIndex, snapValueToStep, splitProps, throttle, toArray, toFixedNumber, toPx, tryCatch, uniq, uuid, warn, wrap };
+export { Timer, add, addOrRemove, callAll, cast, chunk, clampPercent, clampValue, clear, compact, createSplitProps, createStore, debounce, decrementValue, diff, ensure, ensureProps, first, flatArray, fromLength, getClosestValue, getClosestValueIndex, getMaxValueAtIndex, getMinValueAtIndex, getNextStepValue, getPercentValue, getPreviousStepValue, getValuePercent, getValueRanges, getValueSetterAtIndex, getValueTransformer, has, hasProp, identity, incrementValue, insertAt, invariant, isArray, isBoolean, isDev, isEmpty, isEqual, isFunction, isNaN, isNull, isNumber, isObject, isObjectLike, isPlainObject, isString, isValueAtMax, isValueAtMin, isValueWithinRange, json, last, match, mod, nan, next, nextIndex, noop, omit, partition, pick, prev, prevIndex, remove, removeAt, roundToDpr, roundToStepPrecision, roundValue, runIfFn, setRafInterval, setRafTimeout, setValueAtIndex, snapValueToStep, splitProps, throttle, toArray, toFixedNumber, toPx, tryCatch, uniq, uuid, warn, wrap };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zag-js/utils",
-  "version": "1.24.2",
+  "version": "1.26.0",
   "description": "",
   "keywords": [
     "js",