feat: add way to infer enum type

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/common",
-  "version": "5.23.0",
+  "version": "5.24.0",
   "description": "The Athenna common helpers to use in any Node.js ESM project.",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",

src/globals/Enum.ts

@@ -0,0 +1,20 @@
+/**
+ * @athenna/common
+ *
+ * (c) João Lenon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { Enum as EnumImpl } from '#src/helpers/Enum'
+
+declare global {
+  export class Enum extends EnumImpl {}
+}
+
+const __global: any = global
+
+if (!__global.Enum) {
+  __global.Enum = EnumImpl
+}

src/helpers/Enum.ts

@@ -7,6 +7,7 @@
  * file that was distributed with this source code.
  */
 
+import type { InferEnum } from '#src/types'
 import { Macroable } from '#src/helpers/Macroable'
 
 export class Enum extends Macroable {
@@ -35,7 +36,7 @@ export class Enum extends Macroable {
    * ```ts
    * export class StatusEnum extends Enum {
    *   public static PENDING = 'pending' as const
-   *   public static static APPROVED = 'approved' as const
+   *   public static APPROVED = 'approved' as const
    *   public static BLOCKED = 'blocked' as const
    * }
    *
@@ -62,3 +63,13 @@ export class Enum extends Macroable {
     return this.keys().map(key => [key, this[key]])
   }
 }
+
+// eslint-disable-next-line @typescript-eslint/no-namespace
+export namespace Enum {
+  /**
+   * Infer the type of your enum values. Useful to be used
+   * in models and other types to define that that property
+   * should only expect the values defined by your enum.
+   */
+  export type infer<T> = InferEnum<Omit<T, 'infer'>>
+}

src/index.ts

@@ -11,6 +11,7 @@ export * from '#src/types'
 
 export * from '#src/constants/alphabet'
 
+export * from '#src/globals/Enum'
 export * from '#src/globals/Error'
 export * from '#src/globals/Array'
 

src/types/InferEnum.ts

@@ -0,0 +1,12 @@
+/**
+ * @athenna/common
+ *
+ * (c) João Lenon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export type InferEnum<T> = {
+  [K in keyof T]: T[K] extends string | number ? T[K] : never
+}[keyof T]

src/types/index.ts

@@ -28,6 +28,7 @@ export type {
 export * from '#src/types/Merge'
 export * from '#src/types/Except'
 export * from '#src/types/PathDirs'
+export * from '#src/types/InferEnum'
 export * from '#src/types/CommandInput'
 export * from '#src/types/CommandOutput'
 export * from '#src/types/NodeCommandInput'