@oscarpalmer/timer 0.44.0 → 0.46.0

package/dist/index.mjs

@@ -1,21 +1,13 @@
 //#region src/constants.ts
 const DEFAULT_TIMEOUT = 3e4;
 /**
-* Message to show when a when-timer is destroyed
-*/
-const MESSAGE_DESTROYED = "Timer has already been destroyed";
-/**
 * Message to show when a when-timer is started
 */
 const MESSAGE_STARTED = "Timer has already been started";
-/**
-* A set of all active timers
-*/
-const TIMERS_ACTIVE = /* @__PURE__ */ new Set();
-/**
-* A set of timers that were paused due to the document being hidden
-*/
-const TIMERS_HIDDEN = /* @__PURE__ */ new Set();
+const STATES = {
+	active: /* @__PURE__ */ new Set(),
+	hidden: /* @__PURE__ */ new Set()
+};
 const TYPE_REPEAT = "repeat";
 const TYPE_WAIT = "wait";
 const TYPE_WHEN = "when";
@@ -25,110 +17,123 @@ const WORK_RESTART = "restart";
 const WORK_START = "start";
 const WORK_STOP = "stop";
 //#endregion
-//#region src/global.ts
-if (globalThis._oscarpalmer_timers == null) Object.defineProperty(globalThis, "_oscarpalmer_timers", { get() {
-	return globalThis._oscarpalmer_timer_debug ? [...TIMERS_ACTIVE] : [];
-} });
-/* istanbul ignore next */
-document.addEventListener("visibilitychange", () => {
-	const from = document.hidden ? TIMERS_ACTIVE : TIMERS_HIDDEN;
-	const method = document.hidden ? WORK_PAUSE : WORK_CONTINUE;
-	const to = document.hidden ? TIMERS_HIDDEN : TIMERS_ACTIVE;
-	for (const timer of from) {
-		timer[method]();
-		to.add(timer);
-	}
-	from.clear();
-});
+//#region node_modules/@oscarpalmer/atoms/dist/internal/function/misc.mjs
+/**
+* A function that does nothing, which can be useful, I guess…
+*/
+function noop() {}
 //#endregion
-//#region node_modules/@oscarpalmer/atoms/dist/internal/function/timer.mjs
-function getInterval(value) {
-	return typeof value === "number" && value > 0 ? value : 0;
+//#region src/work.ts
+function finish(state, success) {
+	updateStates(state);
+	cancelAnimationFrame(state.frame);
+	state.active = false;
+	state.elapsed = 0;
+	state.frame = void 0;
+	if (state.name === "wait") state.callback();
+	else state.options.onAfter?.(success);
 }
-function getTimer(type, callback, time) {
-	function run() {
-		const now = performance.now();
-		start ??= now;
-		if (interval === 0 || now - start >= interval - OFFSET) {
-			start = throttle ? now : void 0;
-			callback(...args);
-		} else id = startTimer(run);
-	}
-	const interval = getInterval(time);
-	const throttle = type === TIMER_THROTTLE;
-	let args;
-	let id;
-	let start;
-	const timer = (...parameters) => {
-		timer.cancel();
-		args = parameters;
-		if (throttle) run();
-		else id = startTimer(run);
-	};
-	timer.cancel = () => {
-		clearTimer(id);
+function ignore(type, state) {
+	if (state.paused) return type === "pause" || type === "start";
+	return state.active && (type === "continue" || type === "start");
+}
+function run(state) {
+	let last;
+	return function step(now) {
+		if (!state.active) return;
+		last ??= now;
+		const difference = now - last;
+		state.elapsed += difference;
+		state.total += difference;
+		last = now;
+		if (state.options.timeout > 0 && state.total >= state.options.timeout) {
+			state.options.onError?.();
+			finish(state, false);
+			return;
+		}
+		if (state.options.interval === 0 || state.elapsed >= state.options.interval - 5) {
+			if (state.options.count > -1) state.callback(state.index);
+			state.elapsed = 0;
+			state.index += 1;
+			if (state.options.count === -1 || state.options.count > 0 && state.index >= state.options.count) {
+				finish(state, true);
+				return;
+			}
+		}
+		state.frame = requestAnimationFrame(step);
 	};
-	return timer;
 }
-const OFFSET = 5;
-const TIMER_THROTTLE = "throttle";
-const TIMER_WAIT = "wait";
-// istanbul ignore next
-const clearTimer = typeof cancelAnimationFrame === "function" ? cancelAnimationFrame : clearTimeout;
-// istanbul ignore next
-const startTimer = typeof requestAnimationFrame === "function" ? requestAnimationFrame : setTimeout;
-//#endregion
-//#region node_modules/@oscarpalmer/atoms/dist/promise/models.mjs
-const PROMISE_ABORT_EVENT = "abort";
-const PROMISE_ABORT_OPTIONS = { once: true };
-//#endregion
-//#region node_modules/@oscarpalmer/atoms/dist/internal/number.mjs
-function getNumberOrDefault(value, defaultValue, minimum) {
-	return typeof value === "number" && !Number.isNaN(value) && value >= (minimum ?? 0) ? Math.floor(value) : defaultValue;
+function setState(type, state) {
+	const pausable = type === "continue" || type === "pause";
+	state.elapsed = pausable ? state.elapsed : 0;
+	state.index = pausable ? state.index : 0;
+	state.total = pausable ? state.total : 0;
 }
-//#endregion
-//#region node_modules/@oscarpalmer/atoms/dist/promise/helpers.mjs
-function getPromiseOptions(input) {
-	if (typeof input === "number") return { time: getNumberOrDefault(input, 0) };
-	if (input instanceof AbortSignal) return {
-		signal: input,
-		time: 0
-	};
-	const options = typeof input === "object" && input !== null ? input : {};
-	return {
-		signal: options.signal instanceof AbortSignal ? options.signal : void 0,
-		time: getNumberOrDefault(options.time, 0)
-	};
+function stop(state) {
+	updateStates(state);
+	cancelAnimationFrame(state.frame);
+	state.options.onAfter?.(false);
+	state.active = false;
+	state.frame = void 0;
+	state.paused = false;
+	return state.timer;
 }
-//#endregion
-//#region node_modules/@oscarpalmer/atoms/dist/promise/misc.mjs
-function settlePromise(aborter, settler, value, signal) {
-	signal?.removeEventListener(PROMISE_ABORT_EVENT, aborter);
-	settler(value);
+function work(type, state, hide) {
+	if (ignore(type, state)) return state.timer;
+	setState(type, state);
+	if (type === "stop") return stop(state);
+	if (type === "pause" || type === "restart") {
+		cancelAnimationFrame(state.frame);
+		state.frame = void 0;
+	}
+	state.active = true;
+	state.paused = type === WORK_PAUSE;
+	updateStates(state, state.paused ? hide : false);
+	if (state.paused) return state.timer;
+	const runner = run(state);
+	state.frame = requestAnimationFrame(runner);
+	return state.timer;
 }
 //#endregion
-//#region node_modules/@oscarpalmer/atoms/dist/promise/delay.mjs
-function delay(options) {
-	const { signal, time } = getPromiseOptions(options);
-	if (signal?.aborted ?? false) return Promise.reject(signal.reason);
-	function abort() {
-		timer.cancel();
-		rejector(signal.reason);
+//#region src/misc.ts
+function getCallback(value) {
+	return typeof value === "function" ? value : noop;
+}
+function getValidNumber(value, defaultValue) {
+	const actualDefault = defaultValue ?? 0;
+	return typeof value === "number" && value > actualDefault ? value : actualDefault;
+}
+function getValidTimeout(value) {
+	return typeof value === "number" && value > 0 ? value : DEFAULT_TIMEOUT;
+}
+/* istanbul ignore next */
+function onVisibilityChange() {
+	const from = document.hidden ? STATES.active : STATES.hidden;
+	const type = document.hidden ? WORK_PAUSE : WORK_CONTINUE;
+	for (const stored of from) {
+		const state = stored instanceof WeakRef ? stored.deref() : stored;
+		if (state == null) from.delete(stored);
+		else work(type, state, true);
 	}
-	const timer = getTimer(TIMER_WAIT, () => {
-		settlePromise(abort, resolver, void 0, signal);
-	}, time);
-	signal?.addEventListener(PROMISE_ABORT_EVENT, abort, PROMISE_ABORT_OPTIONS);
-	let rejector;
-	let resolver;
-	return new Promise((resolve, reject) => {
-		rejector = reject;
-		resolver = resolve;
-		if (time === 0) settlePromise(abort, resolve, void 0, signal);
-		else timer();
-	});
+}
+function updateStates(state, hide) {
+	STATES.active.delete(state);
+	/* istanbul ignore next */
+	STATES.hidden.delete(state.reference);
+	if (hide == null) return;
+	/* istanbul ignore if */
+	if (hide) {
+		state.reference ??= new WeakRef(state);
+		STATES.hidden.add(state.reference);
+	} else STATES.active.add(state);
 }
 //#endregion
+//#region src/global.ts
+Object.defineProperty(globalThis, "_oscarpalmer_timers", { get() {
+	return globalThis._oscarpalmer_timer_debug ? [...STATES.active].map((state) => state.timer) : [];
+} });
+document.addEventListener("visibilitychange", onVisibilityChange);
+//#endregion
 //#region src/is.ts
 function is(names, value) {
 	return names.includes(value?.$timer);
@@ -166,24 +171,6 @@ function isWhen(value) {
 	return is(["when"], value) && typeof value.start === "function";
 }
 //#endregion
-//#region node_modules/@oscarpalmer/atoms/dist/internal/function/misc.mjs
-/**
-* A function that does nothing, which can be useful, I guess…
-*/
-function noop() {}
-//#endregion
-//#region src/get.ts
-function getCallback(value) {
-	return typeof value === "function" ? value : noop;
-}
-function getValidTimeout(value) {
-	return typeof value === "number" && value > 0 ? value : DEFAULT_TIMEOUT;
-}
-function getValidNumber(value, defaultValue) {
-	const actualDefault = defaultValue ?? 0;
-	return typeof value === "number" && value > actualDefault ? value : actualDefault;
-}
-//#endregion
 //#region src/models.ts
 var TimerTrace = class extends Error {
 	constructor() {
@@ -192,112 +179,28 @@ var TimerTrace = class extends Error {
 	}
 };
 //#endregion
-//#region src/work.ts
-function finish(timer, state, options, success) {
-	cancelAnimationFrame(state.frame);
-	TIMERS_ACTIVE.delete(timer.instance);
-	state.active = false;
-	state.elapsed = 0;
-	state.frame = void 0;
-	if (timer.name === "wait") state.callback();
-	else options.onAfter?.(success);
-}
-function ignore(type, state) {
-	if (state.destroyed) return type !== WORK_STOP;
-	if (state.paused) return type === "pause" || type === "start";
-	return state.active && type === "start";
-}
-function pause(timer, state) {
-	cancelAnimationFrame(state.frame);
-	state.frame = void 0;
-	return timer.instance;
-}
-function run(timer, state, options) {
-	let last;
-	let start;
-	return function step(now) {
-		if (!state.active) return;
-		last ??= now;
-		start ??= now;
-		const difference = now - last;
-		state.elapsed += difference;
-		state.total += difference;
-		last = now;
-		if (options.timeout > 0 && state.total >= options.timeout) {
-			options.onError?.();
-			finish(timer, state, options, false);
-			return;
-		}
-		if (options.interval === 0 || state.elapsed >= options.interval - 5) {
-			if (options.count > -1) state.callback(state.index);
-			start = now;
-			state.elapsed = 0;
-			state.index += 1;
-			if (options.count === -1 || options.count > 0 && state.index >= options.count) {
-				finish(timer, state, options, true);
-				return;
-			}
-		}
-		state.frame = requestAnimationFrame(step);
-	};
-}
-function setState(type, state) {
-	const pausable = type === "continue" || type === "pause";
-	state.elapsed = pausable ? state.elapsed : 0;
-	state.index = pausable ? state.index : 0;
-	state.total = pausable ? state.total : 0;
-}
-function stop(timer, state, options) {
-	cancelAnimationFrame(state.frame);
-	TIMERS_ACTIVE.delete(timer.instance);
-	options.onAfter?.(false);
-	state.active = !stop;
-	state.frame = void 0;
-	state.paused = false;
-	return timer.instance;
-}
-function work(type, timer, state, options) {
-	if (ignore(type, state)) return timer.instance;
-	setState(type, state);
-	if (type === "stop") return stop(timer, state, options);
-	if (type === "pause" || type === "restart") {
-		cancelAnimationFrame(state.frame);
-		state.frame = void 0;
-	}
-	state.active = true;
-	state.paused = type === WORK_PAUSE;
-	if (state.paused) return pause(timer, state);
-	TIMERS_ACTIVE.add(timer.instance);
-	const runner = run(timer, state, options);
-	state.frame = requestAnimationFrame(runner);
-	return timer.instance;
-}
-//#endregion
 //#region src/timer.ts
 function createTimer(name, pick, options, start) {
-	function worker(type) {
-		return work(type, {
-			name,
-			instance
-		}, state, options);
-	}
 	const state = {
 		...pick,
+		name,
+		options,
 		active: false,
 		destroyed: false,
 		elapsed: 0,
 		frame: void 0,
 		index: 0,
 		paused: false,
+		timer: void 0,
 		total: 0
 	};
 	const instance = {
-		continue: () => worker(WORK_CONTINUE),
-		destroy: () => destroyTimer(name, instance, state, options),
-		pause: () => worker(WORK_PAUSE),
-		restart: () => worker(WORK_RESTART),
-		start: () => worker(WORK_START),
-		stop: () => worker(WORK_STOP)
+		continue: () => work(WORK_CONTINUE, state),
+		destroy: noop,
+		pause: () => work(WORK_PAUSE, state),
+		restart: () => work(WORK_RESTART, state),
+		start: () => work(WORK_START, state),
+		stop: () => work(WORK_STOP, state)
 	};
 	Object.defineProperties(instance, {
 		$timer: {
@@ -306,11 +209,11 @@ function createTimer(name, pick, options, start) {
 		},
 		active: {
 			enumerable: true,
-			get: () => state.active
+			get: () => state.active && !state.paused
 		},
 		destroyed: {
 			enumerable: true,
-			get: () => state.destroyed
+			value: false
 		},
 		paused: {
 			enumerable: true,
@@ -321,19 +224,9 @@ function createTimer(name, pick, options, start) {
 			get: () => globalThis._oscarpalmer_timer_debug ?? false ? state.trace : void 0
 		}
 	});
-	if (start) instance.start();
-	return Object.freeze(instance);
-}
-function destroyTimer(name, instance, state, options) {
-	state.destroyed = true;
-	options.onAfter = noop;
-	options.onError = noop;
-	state.callback = noop;
-	if (!globalThis._oscarpalmer_timer_debug) state.trace = void 0;
-	stop({
-		instance,
-		name
-	}, state, options);
+	state.timer = Object.freeze(instance);
+	if (start) state.timer.start();
+	return state.timer;
 }
 //#endregion
 //#region src/repeat.ts
@@ -378,17 +271,9 @@ function wait(callback, time) {
 }
 //#endregion
 //#region src/when.ts
-function destroyWhen(state) {
-	state.timer?.destroy();
-	state.promise = void 0;
-	state.resolver = noop;
-	state.rejecter = noop;
-	state.timer = void 0;
-}
-function onAfter(instance, state) {
+function onAfter(state) {
 	if (state.result) state.resolver?.();
 	else state.rejecter?.();
-	instance.destroy();
 }
 function onCallback(condition, state) {
 	try {
@@ -400,16 +285,11 @@ function onCallback(condition, state) {
 		state.timer.stop();
 	}
 }
-function onError(instance, state) {
-	state.rejecter?.();
-	instance.destroy();
-}
 function onWhen(type, instance, state) {
 	state.timer?.[type]?.();
 	return instance;
 }
 function startWhen(state, resolve) {
-	if (state.timer == null) throw new Error(MESSAGE_DESTROYED);
 	if (state.started) throw new Error(MESSAGE_STARTED);
 	state.started = true;
 	state.timer.start();
@@ -437,18 +317,18 @@ function when(condition, options) {
 		callback: () => onCallback(condition, state),
 		trace: new TimerTrace().stack
 	}, {
-		onAfter: () => onAfter(instance, state),
-		onError: () => onError(instance, state),
+		onAfter: () => onAfter(state),
+		onError: () => state.rejecter?.(),
 		count: getValidNumber(options?.count),
 		interval: getValidNumber(options?.interval),
 		timeout: getValidTimeout(options?.timeout)
 	}, false);
 	instance = {
 		continue: () => onWhen(WORK_CONTINUE, instance, state),
-		destroy: () => destroyWhen(state),
-		pause: () => onWhen("pause", instance, state),
+		destroy: noop,
+		pause: () => onWhen(WORK_PAUSE, instance, state),
 		start: (resolve) => startWhen(state, resolve),
-		stop: () => onWhen("stop", instance, state)
+		stop: () => onWhen(WORK_STOP, instance, state)
 	};
 	Object.defineProperties(instance, {
 		$timer: {
@@ -457,15 +337,15 @@ function when(condition, options) {
 		},
 		active: {
 			enumerable: true,
-			get: () => state.timer?.active ?? false
+			get: () => state.timer.active
 		},
 		destroyed: {
 			enumerable: true,
-			get: () => state.timer == null
+			value: false
 		},
 		paused: {
 			enumerable: true,
-			get: () => state.timer?.paused ?? false
+			get: () => state.timer.paused
 		},
 		trace: {
 			enumerable: true,
@@ -475,4 +355,4 @@ function when(condition, options) {
 	return Object.freeze(instance);
 }
 //#endregion
-export { delay, isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };
+export { isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };

package/dist/{get.d.mts → misc.d.mts}

@@ -1,7 +1,10 @@
+import { TimerState } from "./models.mjs";
 import { GenericCallback } from "@oscarpalmer/atoms/models";
-//#region src/get.d.ts
+//#region src/misc.d.ts
 declare function getCallback(value: unknown): GenericCallback;
-declare function getValidTimeout(value: unknown): number;
 declare function getValidNumber(value: unknown, defaultValue?: number): number;
+declare function getValidTimeout(value: unknown): number;
+declare function onVisibilityChange(): void;
+declare function updateStates(state: TimerState, hide?: boolean): void;
 //#endregion
-export { getCallback, getValidNumber, getValidTimeout };
+export { getCallback, getValidNumber, getValidTimeout, onVisibilityChange, updateStates };

package/dist/misc.mjs

@@ -0,0 +1,37 @@
+import { DEFAULT_TIMEOUT, STATES, WORK_CONTINUE, WORK_PAUSE } from "./constants.mjs";
+import { work } from "./work.mjs";
+import { noop } from "@oscarpalmer/atoms/function";
+//#region src/misc.ts
+function getCallback(value) {
+	return typeof value === "function" ? value : noop;
+}
+function getValidNumber(value, defaultValue) {
+	const actualDefault = defaultValue ?? 0;
+	return typeof value === "number" && value > actualDefault ? value : actualDefault;
+}
+function getValidTimeout(value) {
+	return typeof value === "number" && value > 0 ? value : DEFAULT_TIMEOUT;
+}
+/* istanbul ignore next */
+function onVisibilityChange() {
+	const from = document.hidden ? STATES.active : STATES.hidden;
+	const type = document.hidden ? WORK_PAUSE : WORK_CONTINUE;
+	for (const stored of from) {
+		const state = stored instanceof WeakRef ? stored.deref() : stored;
+		if (state == null) from.delete(stored);
+		else work(type, state, true);
+	}
+}
+function updateStates(state, hide) {
+	STATES.active.delete(state);
+	/* istanbul ignore next */
+	STATES.hidden.delete(state.reference);
+	if (hide == null) return;
+	/* istanbul ignore if */
+	if (hide) {
+		state.reference ??= new WeakRef(state);
+		STATES.hidden.add(state.reference);
+	} else STATES.active.add(state);
+}
+//#endregion
+export { getCallback, getValidNumber, getValidTimeout, onVisibilityChange, updateStates };

package/dist/models.d.mts

@@ -31,6 +31,8 @@ type Timer = {
   get active(): boolean;
   /**
    * Is the timer destroyed?
+   *
+   * @deprecated Timers take care of their own cleanup; this always returns `false`
    */
   get destroyed(): boolean;
   /**
@@ -47,6 +49,8 @@ type Timer = {
   continue(): Timer;
   /**
    * Destroy the timer
+   *
+   * @deprecated Timers take care of their own cleanup
    */
   destroy(): void;
   /**
@@ -79,11 +83,25 @@ type TimerState = {
   callback: () => void;
   destroyed: boolean;
   elapsed: number;
-  frame: number | undefined;
+  frame?: number;
   index: number;
+  name: TimerName;
+  options: TimerOptions;
   paused: boolean;
+  reference?: WeakRef<TimerState>;
+  timer: Timer;
   total: number;
-  trace: string | undefined;
+  trace?: string;
+};
+type TimerStates = {
+  /**
+   * A set of all active timers
+   */
+  active: Set<TimerState>;
+  /**
+   * A set of timers that were paused due to the document being hidden
+   */
+  hidden: Set<WeakRef<TimerState>>;
 };
 declare class TimerTrace extends Error {
   constructor();
@@ -95,6 +113,8 @@ type When = {
   get active(): boolean;
   /**
    * Is the timer destroyed?
+   *
+   * @deprecated Timers take care of their own cleanup; this always returns `false`
    */
   get destroyed(): boolean;
   /**
@@ -111,6 +131,8 @@ type When = {
   continue(): When;
   /**
    * Destroys the timer _(and stops it,if it was running)_
+   *
+   * @deprecated Timers take care of their own cleanup
    */
   destroy(): void;
   /**
@@ -161,4 +183,4 @@ type WorkHandlerTimer = {
 };
 type WorkHandlerType = 'continue' | 'pause' | 'restart' | 'start' | 'stop';
 //#endregion
-export { RepeatOptions, Timer, TimerName, TimerOptions, TimerState, TimerTrace, When, WhenOptions, WhenState, WorkHandler, WorkHandlerTimer, WorkHandlerType };
+export { RepeatOptions, Timer, TimerName, TimerOptions, TimerState, TimerStates, TimerTrace, When, WhenOptions, WhenState, WorkHandler, WorkHandlerTimer, WorkHandlerType };

package/dist/repeat.mjs

@@ -1,5 +1,5 @@
 import { TYPE_REPEAT } from "./constants.mjs";
-import { getCallback, getValidNumber } from "./get.mjs";
+import { getCallback, getValidNumber } from "./misc.mjs";
 import "./global.mjs";
 import { TimerTrace } from "./models.mjs";
 import { createTimer } from "./timer.mjs";