@oscarpalmer/timer 0.43.0 → 0.45.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,194 +17,27 @@ 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();
-});
-//#endregion
-//#region node_modules/@oscarpalmer/atoms/dist/internal/function/timer.mjs
-function getInterval(value) {
-	return typeof value === "number" && value > 0 ? value : 0;
-}
-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);
-	};
-	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;
-}
-//#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)
-	};
-}
-//#endregion
-//#region node_modules/@oscarpalmer/atoms/dist/promise/misc.mjs
-function settlePromise(aborter, settler, value, signal) {
-	signal?.removeEventListener(PROMISE_ABORT_EVENT, aborter);
-	settler(value);
-}
-//#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);
-	}
-	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();
-	});
-}
-//#endregion
-//#region src/is.ts
-function is(names, value) {
-	return names.includes(value?.$timer);
-}
-/**
-* Is the value a repeating timer?
-* @param value Value to check
-* @returns `true` if the value is a repeating timer
-*/
-function isRepeated(value) {
-	return is([TYPE_REPEAT], value);
-}
-/**
-* Is the value a timer?
-* @param value Value to check
-* @returns `true` if the value is a timer
-*/
-function isTimer(value) {
-	return is([TYPE_REPEAT, TYPE_WAIT], value);
-}
-/**
-* Is the value a waiting timer?
-* @param value Value to check
-* @returns `true` if the value is a waiting timer
-*/
-function isWaited(value) {
-	return is([TYPE_WAIT], value);
-}
-/**
-* Is the value a conditional timer?
-* @param value Value to check
-* @returns `true` if the value is a conditional timer
-*/
-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() {
-		super();
-		this.name = "TimerTrace";
-	}
-};
-//#endregion
 //#region src/work.ts
-function finish(timer, state, options, success) {
+function finish(state, success) {
+	updateStates(state);
 	cancelAnimationFrame(state.frame);
-	TIMERS_ACTIVE.delete(timer.instance);
 	state.active = false;
 	state.elapsed = 0;
 	state.frame = void 0;
-	if (timer.type === "wait") state.callback();
-	else options.onAfter?.(success);
+	if (state.name === "wait") state.callback();
+	else state.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) {
+function run(state) {
 	let last;
 	let start;
 	return function step(now) {
@@ -223,18 +48,18 @@ function run(timer, state, options) {
 		state.elapsed += difference;
 		state.total += difference;
 		last = now;
-		if (options.timeout > 0 && state.total >= options.timeout) {
-			options.onError?.();
-			finish(timer, state, options, false);
+		if (state.options.timeout > 0 && state.total >= state.options.timeout) {
+			state.options.onError?.();
+			finish(state, false);
 			return;
 		}
-		if (options.interval === 0 || state.elapsed >= options.interval - 5) {
-			if (options.count > -1) state.callback(state.index);
+		if (state.options.interval === 0 || state.elapsed >= state.options.interval - 5) {
+			if (state.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);
+			if (state.options.count === -1 || state.options.count > 0 && state.index >= state.options.count) {
+				finish(state, true);
 				return;
 			}
 		}
@@ -247,127 +72,163 @@ function setState(type, state) {
 	state.index = pausable ? state.index : 0;
 	state.total = pausable ? state.total : 0;
 }
-function stop(timer, state, options) {
+function stop(state) {
+	updateStates(state);
 	cancelAnimationFrame(state.frame);
-	TIMERS_ACTIVE.delete(timer.instance);
-	options.onAfter?.(false);
-	state.active = !stop;
+	state.options.onAfter?.(false);
+	state.active = false;
 	state.frame = void 0;
 	state.paused = false;
-	return timer.instance;
+	return state.timer;
 }
-function work(type, timer, state, options) {
-	if (ignore(type, state)) return timer.instance;
+function work(type, state, hide) {
+	if (ignore(type, state)) return state.timer;
 	setState(type, state);
-	if (type === "stop") return stop(timer, state, options);
+	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;
-	if (state.paused) return pause(timer, state);
-	TIMERS_ACTIVE.add(timer.instance);
-	const runner = run(timer, state, options);
+	updateStates(state, state.paused ? hide ?? false ? "hidden" : void 0 : "active");
+	if (state.paused) return state.timer;
+	const runner = run(state);
 	state.frame = requestAnimationFrame(runner);
-	return timer.instance;
+	return state.timer;
 }
 //#endregion
-//#region src/timer.ts
-var Timer = class {
-	options;
-	state;
-	/**
-	* Is the timer active?
-	*/
-	get active() {
-		return this.state.active;
-	}
-	/**
-	* Is the timer destroyed?
-	*/
-	get destroyed() {
-		return this.state.destroyed;
-	}
-	/**
-	* Is the timer paused?
-	*/
-	get paused() {
-		return this.state.paused;
-	}
-	/**
-	* Get the timer's origin _(if debugging is enabled)_
-	*/
-	get trace() {
-		return globalThis._oscarpalmer_timer_debug ?? false ? this.state.trace : void 0;
-	}
-	constructor(type, state, options, start) {
-		this.options = options;
-		Object.defineProperty(this, "$timer", { value: type });
-		this.state = {
-			...state,
-			active: false,
-			destroyed: false,
-			elapsed: 0,
-			frame: void 0,
-			index: 0,
-			paused: false,
-			total: 0
-		};
-		if (start) this.start();
-	}
-	/**
-	* Continue running the timer _(if it's paused)_
-	*/
-	continue() {
-		return this.#work(WORK_CONTINUE);
-	}
-	/**
-	* Destroy the timer
-	*/
-	destroy() {
-		this.state.destroyed = true;
-		this.options.onAfter = noop;
-		this.options.onError = noop;
-		this.state.callback = noop;
-		if (!globalThis._oscarpalmer_timer_debug) this.state.trace = void 0;
-		stop({
-			instance: this,
-			type: this.$timer
-		}, this.state, this.options);
-	}
-	/**
-	* Pause the timer _(if it's running)_
-	*/
-	pause() {
-		return this.#work(WORK_PAUSE);
-	}
-	/**
-	* Restart the timer _(or start it, if it's not running)_
-	*/
-	restart() {
-		return this.#work(WORK_RESTART);
-	}
-	/**
-	* Start the timer _(if it's not running)_
-	*/
-	start() {
-		return this.#work(WORK_START);
-	}
-	/**
-	* Stop the timer _(if it's running)_
-	*/
-	stop() {
-		return this.#work(WORK_STOP);
+//#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) work(type, state, true);
 	}
-	#work(type) {
-		return work(type, {
-			instance: this,
-			type: this.$timer
-		}, this.state, this.options);
+}
+function updateStates(state, key) {
+	STATES.active.delete(state);
+	const hidden = [...STATES.hidden].find((stored) => stored.deref() === state);
+	/* istanbul ignore next */
+	if (hidden != null) STATES.hidden.delete(hidden);
+	if (key != null)
+ /* istanbul ignore next */
+	STATES[key].add(key === "hidden" ? new WeakRef(state) : 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);
+}
+/**
+* Is the value a repeating timer?
+* @param value Value to check
+* @returns `true` if the value is a repeating timer
+*/
+function isRepeated(value) {
+	return is([TYPE_REPEAT], value);
+}
+/**
+* Is the value a timer?
+* @param value Value to check
+* @returns `true` if the value is a timer
+*/
+function isTimer(value) {
+	return is([TYPE_REPEAT, TYPE_WAIT], value);
+}
+/**
+* Is the value a waiting timer?
+* @param value Value to check
+* @returns `true` if the value is a waiting timer
+*/
+function isWaited(value) {
+	return is([TYPE_WAIT], value);
+}
+/**
+* Is the value a conditional timer?
+* @param value Value to check
+* @returns `true` if the value is a conditional timer
+*/
+function isWhen(value) {
+	return is(["when"], value) && typeof value.start === "function";
+}
+//#endregion
+//#region src/models.ts
+var TimerTrace = class extends Error {
+	constructor() {
+		super();
+		this.name = "TimerTrace";
 	}
 };
 //#endregion
+//#region src/timer.ts
+function createTimer(name, pick, options, start) {
+	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: () => 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: {
+			enumerable: false,
+			value: name
+		},
+		active: {
+			enumerable: true,
+			get: () => state.active
+		},
+		destroyed: {
+			enumerable: true,
+			value: false
+		},
+		paused: {
+			enumerable: true,
+			get: () => state.paused
+		},
+		trace: {
+			enumerable: true,
+			get: () => globalThis._oscarpalmer_timer_debug ?? false ? state.trace : void 0
+		}
+	});
+	state.timer = Object.freeze(instance);
+	if (start) state.timer.start();
+	return state.timer;
+}
+//#endregion
 //#region src/repeat.ts
 /**
 * Create a repeating timer
@@ -377,7 +238,7 @@ var Timer = class {
 * @returns Timer instance
 */
 function repeat(callback, options) {
-	return new Timer(TYPE_REPEAT, {
+	return createTimer(TYPE_REPEAT, {
 		callback: getCallback(callback),
 		trace: new TimerTrace().stack
 	}, {
@@ -397,7 +258,7 @@ function repeat(callback, options) {
 * @param time How long to wait for _(in milliseconds; defaults to screen refresh rate)_
 */
 function wait(callback, time) {
-	return new Timer(TYPE_WAIT, {
+	return createTimer(TYPE_WAIT, {
 		callback: getCallback(callback),
 		trace: new TimerTrace().stack
 	}, {
@@ -410,120 +271,30 @@ function wait(callback, time) {
 }
 //#endregion
 //#region src/when.ts
-var When = class {
-	state = {
-		promise: void 0,
-		rejecter: void 0,
-		resolver: void 0,
-		started: false,
-		timer: void 0
-	};
-	/**
-	* Is the timer active?
-	*/
-	get active() {
-		return this.state.timer?.active ?? false;
-	}
-	/**
-	* Is the timer destroyed?
-	*/
-	get destroyed() {
-		return this.state.timer == null;
-	}
-	/**
-	* Is the timer paused?
-	*/
-	get paused() {
-		return this.state.timer?.paused ?? false;
-	}
-	/**
-	* Get the timer's origin _(if debugging is enabled)_
-	*/
-	get trace() {
-		return globalThis._oscarpalmer_timer_debug ?? false ? this.state.timer?.trace : void 0;
-	}
-	constructor(condition, options) {
-		Object.defineProperty(this, "$timer", { value: TYPE_WHEN });
-		const { state } = this;
-		state.promise = new Promise((resolve, reject) => {
-			state.resolver = resolve;
-			state.rejecter = reject;
-		});
-		let result = false;
-		this.state.timer = new Timer(TYPE_WHEN, {
-			callback() {
-				try {
-					if (condition()) {
-						result = true;
-						state.timer.stop();
-					}
-				} catch {
-					state.timer.stop();
-				}
-			},
-			trace: new TimerTrace().stack
-		}, {
-			onAfter: () => {
-				if (result) state.resolver?.();
-				else state.rejecter?.();
-				this.destroy();
-			},
-			onError: () => {
-				state.rejecter?.();
-				this.destroy();
-			},
-			count: getValidNumber(options?.count),
-			interval: getValidNumber(options?.interval),
-			timeout: getValidTimeout(options?.timeout)
-		}, false);
-	}
-	/**
-	* Continues the timer _(if it was paused)_
-	*/
-	continue() {
-		this.state.timer?.continue();
-		return this;
-	}
-	/**
-	* Destroys the timer _(and stops it,if it was running)_
-	*/
-	destroy() {
-		const { state } = this;
-		state.timer?.destroy();
-		state.promise = void 0;
-		state.resolver = noop;
-		state.rejecter = noop;
-		state.timer = void 0;
-	}
-	/**
-	* Pauses the timer _(if it was running)_
-	*/
-	pause() {
-		this.state.timer?.pause();
-		return this;
-	}
-	/**
-	* Start the timer
-	*
-	* @param resolve Optional resolve callback
-	* @returns Promise that resolves when the condition is met
-	*/
-	start(resolve) {
-		const { state } = this;
-		if (state.timer == null) throw new Error(MESSAGE_DESTROYED);
-		if (state.started) throw new Error(MESSAGE_STARTED);
-		state.started = true;
-		state.timer.start();
-		return state.promise.then(resolve);
-	}
-	/**
-	* Stops the timer _(if it was running)_
-	*/
-	stop() {
-		this.state.timer?.stop();
-		return this;
+function onAfter(state) {
+	if (state.result) state.resolver?.();
+	else state.rejecter?.();
+}
+function onCallback(condition, state) {
+	try {
+		if (condition()) {
+			state.result = true;
+			state.timer.stop();
+		}
+	} catch {
+		state.timer.stop();
 	}
-};
+}
+function onWhen(type, instance, state) {
+	state.timer?.[type]?.();
+	return instance;
+}
+function startWhen(state, resolve) {
+	if (state.started) throw new Error(MESSAGE_STARTED);
+	state.started = true;
+	state.timer.start();
+	return state.promise.then(resolve);
+}
 /**
 * Create a conditional timer
 * @param condition Condition to check
@@ -531,7 +302,57 @@ var When = class {
 * @returns Timer instance
 */
 function when(condition, options) {
-	return new When(condition, options);
+	const state = {
+		promise: void 0,
+		result: false,
+		started: false,
+		timer: void 0
+	};
+	let instance;
+	state.promise = new Promise((resolve, reject) => {
+		state.resolver = resolve;
+		state.rejecter = reject;
+	});
+	state.timer = createTimer(TYPE_WHEN, {
+		callback: () => onCallback(condition, state),
+		trace: new TimerTrace().stack
+	}, {
+		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: noop,
+		pause: () => onWhen(WORK_PAUSE, instance, state),
+		start: (resolve) => startWhen(state, resolve),
+		stop: () => onWhen(WORK_STOP, instance, state)
+	};
+	Object.defineProperties(instance, {
+		$timer: {
+			enumerable: false,
+			value: TYPE_WHEN
+		},
+		active: {
+			enumerable: true,
+			get: () => state.timer.active
+		},
+		destroyed: {
+			enumerable: true,
+			value: false
+		},
+		paused: {
+			enumerable: true,
+			get: () => state.timer.paused
+		},
+		trace: {
+			enumerable: true,
+			get: () => globalThis._oscarpalmer_timer_debug ?? false ? state.timer?.trace : void 0
+		}
+	});
+	return Object.freeze(instance);
 }
 //#endregion
-export { delay, isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };
+export { isRepeated, isTimer, isWaited, isWhen, repeat, wait, when };