@alessiofrittoli/type-utils 2.0.0 → 2.1.0

package/dist/globals/index.d.cts

@@ -1,4 +1,3 @@
-//#region src/globals/extenders/json.d.ts
 declare class Stringified<T> extends String {
   private ___stringified;
 }
@@ -15,5 +14,4 @@ declare global {
     json<T = any>(): Promise<T>;
   }
 }
-//#endregion
 export {};

package/dist/globals/index.d.mts

@@ -1,4 +1,3 @@
-//#region src/globals/extenders/json.d.ts
 declare class Stringified<T> extends String {
   private ___stringified;
 }
@@ -15,5 +14,4 @@ declare global {
     json<T = any>(): Promise<T>;
   }
 }
-//#endregion
 export {};

package/dist/index.d.cts

@@ -1,4 +1,3 @@
-//#region src/unflat-dot-keys.d.ts
 type RequiredKey<T> = { [K in keyof T]-?: object extends Pick<T, K> ? never : K; }[keyof T];
 type Head<K> = K extends `${infer H}.${string}` ? H : never;
 /**
@@ -33,8 +32,6 @@ type UnflatDotKeys<T, K extends string = never> = Unflat<PickDotKeys<T, K>, fals
  * @template K The object interface specific key to work with (`${K}.*`).
  */
 type RecursivelyUnflatDotKeys<T, K extends string = never> = Unflat<PickDotKeys<T, K>, true>;
-//#endregion
-//#region src/index.d.ts
 /**
  * Get the Type of the Value of a object/array property.
  *
@@ -146,5 +143,62 @@ export type NonNullableFields<T> = { [P in keyof T]: NonNullable<T[P]>; };
  * ```
  */
 export type MergedEnumValue<T> = { [K in keyof T]: { [K2 in keyof T[K]]: T[K][K2]; }[keyof T[K]]; }[keyof T];
-//#endregion
+/**
+ * Builds a discriminated union of `[event, args]` tuples from an event map.
+ *
+ * Each key of the given map becomes a tuple whose first element is the event name
+ * and whose second element is its payload type. Since the tuples are discriminated
+ * by the event name, checking `event` narrows `args` to the matching payload.
+ *
+ * @template M The event map, where each key is an event name and each value is its payload type.
+ *
+ * @example
+ * ```ts
+ * interface Events {
+ * 	play: { position: number }
+ * 	error: Error
+ * }
+ *
+ * type OnEventHandler = (...args: MappedArgs<Events>) => void
+ *
+ * const onEvent: OnEventHandler = (event, args): void => {
+ * 	if (event === 'play') {
+ * 		console.log(args.position) // `args` is narrowed to `{ position: number }`
+ * 	}
+ * 	if (event === 'error') {
+ * 		console.log(args) // `args` is narrowed to `Error`
+ * 	}
+ * }
+ *
+ * onEvent('play', { position: 0 })
+ * onEvent('error', new Error())
+ * ```
+ *
+ * ---
+ *
+ * @example
+ * ```ts
+ * interface Events {
+ * 	play: [data: { position: number }]
+ * 	error: [error: Error]
+ * }
+ *
+ * type OnEventHandler = (...args: MappedArgs<Events>) => void
+ *
+ * const onEvent: OnEventHandler = (event, args): void => {
+ * 	if (event === 'play') {
+ * 		const [payload] = args
+ * 		console.log(payload.position) // `args` is narrowed to [`{ position: number }`]
+ * 	}
+ * 	if (event === 'error') {
+ * 		const [error] = args // `args` is narrowed to [`Error`]
+ * 		console.log(error)
+ * 	}
+ * }
+ *
+ * onEvent('play', [{ position: 0 }])
+ * onEvent('error', [new Error()])
+ * ```
+ */
+export type MappedArgs<M> = { [K in keyof M]: [event: K, args: M[K]]; }[keyof M];
 export type { RecursivelyUnflatDotKeys, UnflatDotKeys };

package/dist/index.d.mts

@@ -1,4 +1,3 @@
-//#region src/unflat-dot-keys.d.ts
 type RequiredKey<T> = { [K in keyof T]-?: object extends Pick<T, K> ? never : K; }[keyof T];
 type Head<K> = K extends `${infer H}.${string}` ? H : never;
 /**
@@ -33,8 +32,6 @@ type UnflatDotKeys<T, K extends string = never> = Unflat<PickDotKeys<T, K>, fals
  * @template K The object interface specific key to work with (`${K}.*`).
  */
 type RecursivelyUnflatDotKeys<T, K extends string = never> = Unflat<PickDotKeys<T, K>, true>;
-//#endregion
-//#region src/index.d.ts
 /**
  * Get the Type of the Value of a object/array property.
  *
@@ -146,5 +143,62 @@ export type NonNullableFields<T> = { [P in keyof T]: NonNullable<T[P]>; };
  * ```
  */
 export type MergedEnumValue<T> = { [K in keyof T]: { [K2 in keyof T[K]]: T[K][K2]; }[keyof T[K]]; }[keyof T];
-//#endregion
+/**
+ * Builds a discriminated union of `[event, args]` tuples from an event map.
+ *
+ * Each key of the given map becomes a tuple whose first element is the event name
+ * and whose second element is its payload type. Since the tuples are discriminated
+ * by the event name, checking `event` narrows `args` to the matching payload.
+ *
+ * @template M The event map, where each key is an event name and each value is its payload type.
+ *
+ * @example
+ * ```ts
+ * interface Events {
+ * 	play: { position: number }
+ * 	error: Error
+ * }
+ *
+ * type OnEventHandler = (...args: MappedArgs<Events>) => void
+ *
+ * const onEvent: OnEventHandler = (event, args): void => {
+ * 	if (event === 'play') {
+ * 		console.log(args.position) // `args` is narrowed to `{ position: number }`
+ * 	}
+ * 	if (event === 'error') {
+ * 		console.log(args) // `args` is narrowed to `Error`
+ * 	}
+ * }
+ *
+ * onEvent('play', { position: 0 })
+ * onEvent('error', new Error())
+ * ```
+ *
+ * ---
+ *
+ * @example
+ * ```ts
+ * interface Events {
+ * 	play: [data: { position: number }]
+ * 	error: [error: Error]
+ * }
+ *
+ * type OnEventHandler = (...args: MappedArgs<Events>) => void
+ *
+ * const onEvent: OnEventHandler = (event, args): void => {
+ * 	if (event === 'play') {
+ * 		const [payload] = args
+ * 		console.log(payload.position) // `args` is narrowed to [`{ position: number }`]
+ * 	}
+ * 	if (event === 'error') {
+ * 		const [error] = args // `args` is narrowed to [`Error`]
+ * 		console.log(error)
+ * 	}
+ * }
+ *
+ * onEvent('play', [{ position: 0 }])
+ * onEvent('error', [new Error()])
+ * ```
+ */
+export type MappedArgs<M> = { [K in keyof M]: [event: K, args: M[K]]; }[keyof M];
 export type { RecursivelyUnflatDotKeys, UnflatDotKeys };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alessiofrittoli/type-utils",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Lightweight TypeScript types utilities",
   "type": "module",
   "author": {
@@ -63,30 +63,30 @@
   },
   "sideEffects": false,
   "peerDependencies": {
-    "@alessiofrittoli/chain-functions": "^2.7.0",
-    "@alessiofrittoli/node-scripts": "^4.1.0"
+    "@alessiofrittoli/chain-functions": "^2.8.0",
+    "@alessiofrittoli/node-scripts": "^4.2.0"
   },
   "devDependencies": {
-    "@alessiofrittoli/chain-functions": "^2.7.0",
-    "@alessiofrittoli/node-scripts": "^4.1.0",
-    "@alessiofrittoli/package-configs": "^1.6.0",
+    "@alessiofrittoli/chain-functions": "^2.8.0",
+    "@alessiofrittoli/node-scripts": "^4.2.0",
+    "@alessiofrittoli/package-configs": "^1.9.0",
     "@types/node": "^24.19.1",
-    "@vitest/coverage-v8": "^5.0.4",
+    "@vitest/coverage-v8": "^5.0.5",
     "concurrently": "^10.0.6",
     "http-server": "^14.1.1",
-    "oxlint": "^1.88.0",
+    "oxlint": "^1.89.0",
+    "oxlint-tsgolint": "^7.0.2005",
     "prettier": "^3.9.10",
     "prettier-plugin-sort-imports": "^1.8.11",
-    "tsdown": "^0.23.1",
-    "typescript": "^6.0.3",
-    "vite": "^8.3.4"
+    "tsdown": "^0.23.2",
+    "typescript": "^6.0.3"
   },
   "scripts": {
     "//1a": "*********************************************************************",
     "//1b": "******************** DEV - BUILD - LINT - RELEASE *******************",
     "//1c": "*********************************************************************",
     "dev": "tsdown --watch",
-    "build": "pnpm lint && pnpm tsc && pnpm tsdown",
+    "build": "pnpm lint && pnpm tsdown",
     "lint": "oxlint --report-unused-disable-directives --max-warnings 0",
     "release": "node scripts/release.ts --verbose --npm",
     "//2a": "*********************************************************************",

package/scripts/postinstall/index.cjs

@@ -13,4 +13,5 @@ const lastChainLink = () => () => {
 /** @type {import( '@alessiofrittoli/chain-functions/types' ).ChainFactory<() => void | Promise<void>>} */
 const chain = [tsSetup, lastChainLink]
 
+// oxlint-disable-next-line typescript/no-floating-promises
 Chain.functions(chain)()