@kikiutils/shared 13.0.1 → 13.2.0

package/README.md

@@ -28,7 +28,7 @@ A lightweight and modular utility library for modern JavaScript and TypeScript
 
 ## Requirements
 
-- **Node.js** `>= 22.0.0`
+- **Node.js** `>=22.12.0`
 
 ## Installation
 

package/dist/event-awaiter.d.ts

@@ -0,0 +1,70 @@
+//#region src/event-awaiter.d.ts
+/**
+ * EventAwaiter provides a mechanism to wait for events (by key) asynchronously.
+ *
+ * This class allows multiple consumers to `wait` for a specific key
+ * and be resolved when `trigger` is called for that key, or automatically
+ * resolved with `undefined` if a timeout occurs.
+ *
+ * Typical use cases include long-polling, request coordination,
+ * or implementing event-driven primitives in applications or services.
+ *
+ * @template T - The type of value that will be resolved when the event is triggered
+ */
+declare class EventAwaiter<T> {
+  #private;
+  /**
+   * Triggers all pending promises waiting for the given key.
+   * Each promise will be resolved with the provided value.
+   *
+   * @param {string} [key] - Identifier for the awaited event
+   * @param {T | undefined} value - The value to resolve the awaiting promises with.
+   * May be `undefined` to indicate no result or a timeout-like behavior.
+   */
+  trigger(key: string, value: T | undefined): void;
+  /**
+   * Waits for an event associated with the given key.
+   *
+   * The returned promise will resolve when:
+   *  - `trigger(key)` is called, in which case it resolves with the provided value.
+   *  - The optional timeout is reached, in which case it resolves with `undefined`.
+   *
+   * Behavior when multiple waiters exist for the same key:
+   *  - Default (no mode): multiple waiters are allowed, all will be resolved when triggered.
+   *  - `strict` mode: throws an error if a waiter already exists for the given key.
+   *  - `override` mode: cancels all existing waiters (resolving them with `undefined`)
+   *    and only keeps the latest one.
+   *
+   * @param {string} key - Identifier for the awaited event
+   * @param {number} [timeoutMs] - Optional timeout (in milliseconds).
+   * If reached, the promise resolves with `undefined`.
+   * @param {'override' | 'strict'} [mode] - Optional behavior mode for handling multiple waiters.
+   *
+   * @returns {Promise<T | undefined>} A promise that resolves with the triggered value
+   * or `undefined` if timeout occurs
+   */
+  wait(key: string, timeoutMs?: number, mode?: 'override' | 'strict'): Promise<T | undefined>;
+  /**
+   * Waits for an event in strict mode.
+   * Only one waiter is allowed per key. If another waiter already exists,
+   * this method will throw an error.
+   *
+   * @param {string} key - Identifier for the awaited event
+   * @param {number} [timeoutMs] - Optional timeout (in milliseconds).
+   * If reached, the promise resolves with `undefined`.
+   */
+  waitExclusive(key: string, timeoutMs?: number): Promise<T | undefined>;
+  /**
+   * Waits for an event in override mode.
+   * If another waiter already exists for the given key, it will be canceled
+   * (resolved with `undefined`) and replaced by the new waiter.
+   *
+   * @param {string} key - Identifier for the awaited event
+   * @param {number} [timeoutMs] - Optional timeout (in milliseconds).
+   * If reached, the promise resolves with `undefined`.
+   */
+  waitLatest(key: string, timeoutMs?: number): Promise<T | undefined>;
+}
+//#endregion
+export { EventAwaiter };
+//# sourceMappingURL=event-awaiter.d.ts.map

package/dist/event-awaiter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-awaiter.d.ts","names":[],"sources":["../src/event-awaiter.ts"],"sourcesContent":[],"mappings":";;AAYA;;;;;;;;;;;cAAa;;;;;;;;;;8BAWmB;;;;;;;;;;;;;;;;;;;;;;uEA6BsC,QAAA;;;;;;;;;;kDA0CrB,QAAA;;;;;;;;;;+CAaH,QAAA"}

package/dist/event-awaiter.js

@@ -0,0 +1,103 @@
+//#region src/event-awaiter.ts
+/**
+* EventAwaiter provides a mechanism to wait for events (by key) asynchronously.
+*
+* This class allows multiple consumers to `wait` for a specific key
+* and be resolved when `trigger` is called for that key, or automatically
+* resolved with `undefined` if a timeout occurs.
+*
+* Typical use cases include long-polling, request coordination,
+* or implementing event-driven primitives in applications or services.
+*
+* @template T - The type of value that will be resolved when the event is triggered
+*/
+var EventAwaiter = class {
+	#promiseResolvers = /* @__PURE__ */ new Map();
+	/**
+	* Triggers all pending promises waiting for the given key.
+	* Each promise will be resolved with the provided value.
+	*
+	* @param {string} [key] - Identifier for the awaited event
+	* @param {T | undefined} value - The value to resolve the awaiting promises with.
+	* May be `undefined` to indicate no result or a timeout-like behavior.
+	*/
+	trigger(key, value) {
+		const resolvers = this.#promiseResolvers.get(key);
+		if (resolvers) {
+			this.#promiseResolvers.delete(key);
+			resolvers?.forEach((resolve) => resolve(value));
+		}
+	}
+	/**
+	* Waits for an event associated with the given key.
+	*
+	* The returned promise will resolve when:
+	*  - `trigger(key)` is called, in which case it resolves with the provided value.
+	*  - The optional timeout is reached, in which case it resolves with `undefined`.
+	*
+	* Behavior when multiple waiters exist for the same key:
+	*  - Default (no mode): multiple waiters are allowed, all will be resolved when triggered.
+	*  - `strict` mode: throws an error if a waiter already exists for the given key.
+	*  - `override` mode: cancels all existing waiters (resolving them with `undefined`)
+	*    and only keeps the latest one.
+	*
+	* @param {string} key - Identifier for the awaited event
+	* @param {number} [timeoutMs] - Optional timeout (in milliseconds).
+	* If reached, the promise resolves with `undefined`.
+	* @param {'override' | 'strict'} [mode] - Optional behavior mode for handling multiple waiters.
+	*
+	* @returns {Promise<T | undefined>} A promise that resolves with the triggered value
+	* or `undefined` if timeout occurs
+	*/
+	wait(key, timeoutMs, mode) {
+		return new Promise((resolve) => {
+			const resolvers = this.#promiseResolvers.get(key) || [];
+			if (resolvers.length) switch (mode) {
+				case "override":
+					resolvers.forEach((r) => r(void 0));
+					resolvers.length = 0;
+					break;
+				case "strict": throw new Error(`Duplicate wait detected for key: ${key}`);
+			}
+			resolvers.push(resolve);
+			this.#promiseResolvers.set(key, resolvers);
+			if (timeoutMs) setTimeout(() => {
+				const resolvers$1 = this.#promiseResolvers.get(key);
+				if (resolvers$1?.includes(resolve)) {
+					resolve(void 0);
+					const newResolvers = resolvers$1.filter((r) => r !== resolve);
+					if (newResolvers.length) this.#promiseResolvers.set(key, newResolvers);
+					else this.#promiseResolvers.delete(key);
+				}
+			}, timeoutMs);
+		});
+	}
+	/**
+	* Waits for an event in strict mode.
+	* Only one waiter is allowed per key. If another waiter already exists,
+	* this method will throw an error.
+	*
+	* @param {string} key - Identifier for the awaited event
+	* @param {number} [timeoutMs] - Optional timeout (in milliseconds).
+	* If reached, the promise resolves with `undefined`.
+	*/
+	waitExclusive(key, timeoutMs) {
+		return this.wait(key, timeoutMs, "strict");
+	}
+	/**
+	* Waits for an event in override mode.
+	* If another waiter already exists for the given key, it will be canceled
+	* (resolved with `undefined`) and replaced by the new waiter.
+	*
+	* @param {string} key - Identifier for the awaited event
+	* @param {number} [timeoutMs] - Optional timeout (in milliseconds).
+	* If reached, the promise resolves with `undefined`.
+	*/
+	waitLatest(key, timeoutMs) {
+		return this.wait(key, timeoutMs, "override");
+	}
+};
+
+//#endregion
+export { EventAwaiter };
+//# sourceMappingURL=event-awaiter.js.map

package/dist/event-awaiter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-awaiter.js","names":["#promiseResolvers","resolvers"],"sources":["../src/event-awaiter.ts"],"sourcesContent":["/**\n * EventAwaiter provides a mechanism to wait for events (by key) asynchronously.\n *\n * This class allows multiple consumers to `wait` for a specific key\n * and be resolved when `trigger` is called for that key, or automatically\n * resolved with `undefined` if a timeout occurs.\n *\n * Typical use cases include long-polling, request coordination,\n * or implementing event-driven primitives in applications or services.\n *\n * @template T - The type of value that will be resolved when the event is triggered\n */\nexport class EventAwaiter<T> {\n    #promiseResolvers = new Map<string, ((value: PromiseLike<T | undefined> | T | undefined) => void)[]>();\n\n    /**\n     * Triggers all pending promises waiting for the given key.\n     * Each promise will be resolved with the provided value.\n     *\n     * @param {string} [key] - Identifier for the awaited event\n     * @param {T | undefined} value - The value to resolve the awaiting promises with.\n     * May be `undefined` to indicate no result or a timeout-like behavior.\n     */\n    trigger(key: string, value: T | undefined) {\n        const resolvers = this.#promiseResolvers.get(key);\n        if (resolvers) {\n            this.#promiseResolvers.delete(key);\n            resolvers?.forEach((resolve) => resolve(value));\n        }\n    }\n\n    /**\n     * Waits for an event associated with the given key.\n     *\n     * The returned promise will resolve when:\n     *  - `trigger(key)` is called, in which case it resolves with the provided value.\n     *  - The optional timeout is reached, in which case it resolves with `undefined`.\n     *\n     * Behavior when multiple waiters exist for the same key:\n     *  - Default (no mode): multiple waiters are allowed, all will be resolved when triggered.\n     *  - `strict` mode: throws an error if a waiter already exists for the given key.\n     *  - `override` mode: cancels all existing waiters (resolving them with `undefined`)\n     *    and only keeps the latest one.\n     *\n     * @param {string} key - Identifier for the awaited event\n     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).\n     * If reached, the promise resolves with `undefined`.\n     * @param {'override' | 'strict'} [mode] - Optional behavior mode for handling multiple waiters.\n     *\n     * @returns {Promise<T | undefined>} A promise that resolves with the triggered value\n     * or `undefined` if timeout occurs\n     */\n    wait(key: string, timeoutMs?: number, mode?: 'override' | 'strict') {\n        return new Promise<T | undefined>((resolve) => {\n            const resolvers = this.#promiseResolvers.get(key) || [];\n            if (resolvers.length) {\n                switch (mode) {\n                    case 'override':\n                        resolvers.forEach((r) => r(undefined));\n                        resolvers.length = 0;\n                        break;\n                    case 'strict':\n                        throw new Error(`Duplicate wait detected for key: ${key}`);\n                }\n            }\n\n            resolvers.push(resolve);\n            this.#promiseResolvers.set(key, resolvers);\n            if (timeoutMs) {\n                setTimeout(\n                    () => {\n                        const resolvers = this.#promiseResolvers.get(key);\n                        if (resolvers?.includes(resolve)) {\n                            resolve(undefined);\n                            const newResolvers = resolvers.filter((r) => r !== resolve);\n                            if (newResolvers.length) this.#promiseResolvers.set(key, newResolvers);\n                            else this.#promiseResolvers.delete(key);\n                        }\n                    },\n                    timeoutMs,\n                );\n            }\n        });\n    }\n\n    /**\n     * Waits for an event in strict mode.\n     * Only one waiter is allowed per key. If another waiter already exists,\n     * this method will throw an error.\n     *\n     * @param {string} key - Identifier for the awaited event\n     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).\n     * If reached, the promise resolves with `undefined`.\n     */\n    waitExclusive(key: string, timeoutMs?: number) {\n        return this.wait(key, timeoutMs, 'strict');\n    }\n\n    /**\n     * Waits for an event in override mode.\n     * If another waiter already exists for the given key, it will be canceled\n     * (resolved with `undefined`) and replaced by the new waiter.\n     *\n     * @param {string} key - Identifier for the awaited event\n     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).\n     * If reached, the promise resolves with `undefined`.\n     */\n    waitLatest(key: string, timeoutMs?: number) {\n        return this.wait(key, timeoutMs, 'override');\n    }\n}\n"],"mappings":";;;;;;;;;;;;;AAYA,IAAa,eAAb,MAA6B;CACzB,oCAAoB,IAAI,KAA8E;;;;;;;;;CAUtG,QAAQ,KAAa,OAAsB;EACvC,MAAM,YAAY,MAAKA,iBAAkB,IAAI,IAAI;AACjD,MAAI,WAAW;AACX,SAAKA,iBAAkB,OAAO,IAAI;AAClC,cAAW,SAAS,YAAY,QAAQ,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;CAyBvD,KAAK,KAAa,WAAoB,MAA8B;AAChE,SAAO,IAAI,SAAwB,YAAY;GAC3C,MAAM,YAAY,MAAKA,iBAAkB,IAAI,IAAI,IAAI,EAAE;AACvD,OAAI,UAAU,OACV,SAAQ,MAAR;IACI,KAAK;AACD,eAAU,SAAS,MAAM,EAAE,OAAU,CAAC;AACtC,eAAU,SAAS;AACnB;IACJ,KAAK,SACD,OAAM,IAAI,MAAM,oCAAoC,MAAM;;AAItE,aAAU,KAAK,QAAQ;AACvB,SAAKA,iBAAkB,IAAI,KAAK,UAAU;AAC1C,OAAI,UACA,kBACU;IACF,MAAMC,cAAY,MAAKD,iBAAkB,IAAI,IAAI;AACjD,QAAIC,aAAW,SAAS,QAAQ,EAAE;AAC9B,aAAQ,OAAU;KAClB,MAAM,eAAeA,YAAU,QAAQ,MAAM,MAAM,QAAQ;AAC3D,SAAI,aAAa,OAAQ,OAAKD,iBAAkB,IAAI,KAAK,aAAa;SACjE,OAAKA,iBAAkB,OAAO,IAAI;;MAG/C,UACH;IAEP;;;;;;;;;;;CAYN,cAAc,KAAa,WAAoB;AAC3C,SAAO,KAAK,KAAK,KAAK,WAAW,SAAS;;;;;;;;;;;CAY9C,WAAW,KAAa,WAAoB;AACxC,SAAO,KAAK,KAAK,KAAK,WAAW,WAAW"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kikiutils/shared",
   "type": "module",
-  "version": "13.0.1",
+  "version": "13.2.0",
   "description": "A lightweight and modular utility library for modern JavaScript and TypeScript — includes secure hashing, flexible logging, datetime tools, Vue/web helpers, storage abstraction, and more.",
   "author": "kiki-kanri",
   "license": "MIT",
@@ -41,6 +41,7 @@
     "./element-plus": "./dist/element-plus.js",
     "./enum": "./dist/enum.js",
     "./env": "./dist/env.js",
+    "./event-awaiter": "./dist/event-awaiter.js",
     "./general": "./dist/general.js",
     "./hash": "./dist/hash.js",
     "./math": "./dist/math.js",
@@ -66,7 +67,7 @@
     "./src"
   ],
   "engines": {
-    "node": ">=22.0.0"
+    "node": ">=22.12.0"
   },
   "scripts": {
     "build": "tsdown",
@@ -78,7 +79,7 @@
     "release": "pnpm run lint && pnpm run typecheck && pnpm run test && pnpm run build && changelogen --hideAuthorEmail --push --release && npm publish",
     "test": "cross-env TZ=UTC vitest run --coverage",
     "test:watch": "cross-env TZ=UTC vitest watch --coverage",
-    "typecheck": "tsc --noEmit",
+    "typecheck": "tsc -b --noEmit",
     "unused-exports": "ts-unused-exports ./tsconfig.json"
   },
   "peerDependencies": {
@@ -146,7 +147,7 @@
     "@kikiutils/eslint-config": "^3.0.1",
     "@kikiutils/tsconfigs": "^5.0.5",
     "@noble/hashes": "^2.0.0",
-    "@types/node": "^24.3.3",
+    "@types/node": "^24.5.0",
     "@vitest/coverage-v8": "^3.2.4",
     "async-validator": "^4.2.5",
     "consola": "^3.4.2",

package/src/event-awaiter.ts

@@ -0,0 +1,111 @@
+/**
+ * EventAwaiter provides a mechanism to wait for events (by key) asynchronously.
+ *
+ * This class allows multiple consumers to `wait` for a specific key
+ * and be resolved when `trigger` is called for that key, or automatically
+ * resolved with `undefined` if a timeout occurs.
+ *
+ * Typical use cases include long-polling, request coordination,
+ * or implementing event-driven primitives in applications or services.
+ *
+ * @template T - The type of value that will be resolved when the event is triggered
+ */
+export class EventAwaiter<T> {
+    #promiseResolvers = new Map<string, ((value: PromiseLike<T | undefined> | T | undefined) => void)[]>();
+
+    /**
+     * Triggers all pending promises waiting for the given key.
+     * Each promise will be resolved with the provided value.
+     *
+     * @param {string} [key] - Identifier for the awaited event
+     * @param {T | undefined} value - The value to resolve the awaiting promises with.
+     * May be `undefined` to indicate no result or a timeout-like behavior.
+     */
+    trigger(key: string, value: T | undefined) {
+        const resolvers = this.#promiseResolvers.get(key);
+        if (resolvers) {
+            this.#promiseResolvers.delete(key);
+            resolvers?.forEach((resolve) => resolve(value));
+        }
+    }
+
+    /**
+     * Waits for an event associated with the given key.
+     *
+     * The returned promise will resolve when:
+     *  - `trigger(key)` is called, in which case it resolves with the provided value.
+     *  - The optional timeout is reached, in which case it resolves with `undefined`.
+     *
+     * Behavior when multiple waiters exist for the same key:
+     *  - Default (no mode): multiple waiters are allowed, all will be resolved when triggered.
+     *  - `strict` mode: throws an error if a waiter already exists for the given key.
+     *  - `override` mode: cancels all existing waiters (resolving them with `undefined`)
+     *    and only keeps the latest one.
+     *
+     * @param {string} key - Identifier for the awaited event
+     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).
+     * If reached, the promise resolves with `undefined`.
+     * @param {'override' | 'strict'} [mode] - Optional behavior mode for handling multiple waiters.
+     *
+     * @returns {Promise<T | undefined>} A promise that resolves with the triggered value
+     * or `undefined` if timeout occurs
+     */
+    wait(key: string, timeoutMs?: number, mode?: 'override' | 'strict') {
+        return new Promise<T | undefined>((resolve) => {
+            const resolvers = this.#promiseResolvers.get(key) || [];
+            if (resolvers.length) {
+                switch (mode) {
+                    case 'override':
+                        resolvers.forEach((r) => r(undefined));
+                        resolvers.length = 0;
+                        break;
+                    case 'strict':
+                        throw new Error(`Duplicate wait detected for key: ${key}`);
+                }
+            }
+
+            resolvers.push(resolve);
+            this.#promiseResolvers.set(key, resolvers);
+            if (timeoutMs) {
+                setTimeout(
+                    () => {
+                        const resolvers = this.#promiseResolvers.get(key);
+                        if (resolvers?.includes(resolve)) {
+                            resolve(undefined);
+                            const newResolvers = resolvers.filter((r) => r !== resolve);
+                            if (newResolvers.length) this.#promiseResolvers.set(key, newResolvers);
+                            else this.#promiseResolvers.delete(key);
+                        }
+                    },
+                    timeoutMs,
+                );
+            }
+        });
+    }
+
+    /**
+     * Waits for an event in strict mode.
+     * Only one waiter is allowed per key. If another waiter already exists,
+     * this method will throw an error.
+     *
+     * @param {string} key - Identifier for the awaited event
+     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).
+     * If reached, the promise resolves with `undefined`.
+     */
+    waitExclusive(key: string, timeoutMs?: number) {
+        return this.wait(key, timeoutMs, 'strict');
+    }
+
+    /**
+     * Waits for an event in override mode.
+     * If another waiter already exists for the given key, it will be canceled
+     * (resolved with `undefined`) and replaced by the new waiter.
+     *
+     * @param {string} key - Identifier for the awaited event
+     * @param {number} [timeoutMs] - Optional timeout (in milliseconds).
+     * If reached, the promise resolves with `undefined`.
+     */
+    waitLatest(key: string, timeoutMs?: number) {
+        return this.wait(key, timeoutMs, 'override');
+    }
+}