feat(enum): add new random helpers

Author: jlenon7

.github/workflows/cd.yml

@@ -8,6 +8,9 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -32,8 +35,7 @@ jobs:
         id: release
 
       - name: Publish to NPM Registry
-        run: cd build && npm publish --access public
+        run: cd build && npm publish --provenance --access public
         if: steps.release.outputs.released == 'true'
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
           name: Deploy

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/common",
-  "version": "5.27.0",
+  "version": "5.28.0",
   "description": "The Athenna common helpers to use in any Node.js ESM project.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

package.json

@@ -62,6 +62,42 @@ export class Enum extends Macroable {
   public static entries() {
     return this.keys().map(key => [key, this[key]])
   }
+
+  /**
+   * Get a random key from the enum.
+   *
+   * @example
+   * ```ts
+   * export class StatusEnum extends Enum {
+   *   public static PENDING = 'pending' as const
+   *   public static APPROVED = 'approved' as const
+   *   public static BLOCKED = 'blocked' as const
+   * } 
+   * 
+   * const randomKey = StatusEnum.randomKey() // 'PENDING'
+   * ```
+   */
+  public static randomKey() {
+    return this.keys().athenna.random()
+  }
+
+  /**
+   * Get a random value from the enum.
+   *
+   * @example
+   * ```ts
+   * export class StatusEnum extends Enum {
+   *   public static PENDING = 'pending' as const
+   *   public static APPROVED = 'approved' as const
+   *   public static BLOCKED = 'blocked' as const
+   * } 
+   * 
+   * const randomValue = StatusEnum.randomValue() // 'pending'
+   * ```
+   */
+  public static randomValue() {
+    return this.values().athenna.random()
+  }
 }
 
 // eslint-disable-next-line @typescript-eslint/no-namespace

src/helpers/Enum.ts

@@ -125,4 +125,26 @@ export default class EnumTest {
       ['DELETED', 2]
     ])
   }
+
+  @Test()
+  public async shouldBeAbleToGetARandomKeyFromEnum({ assert }: Context) {
+    class Status extends Enum {
+      static PENDING = 0
+      static BLOCKED = 1
+      static DELETED = 2
+    }
+
+    assert.isTrue(Status.keys().includes(Status.randomKey()))
+  }
+
+  @Test()
+  public async shouldBeAbleToGetARandomValueFromEnum({ assert }: Context) {
+    class Status extends Enum {
+      static PENDING = 0
+      static BLOCKED = 1
+      static DELETED = 2
+    }
+
+    assert.isTrue(Status.values().includes(Status.randomValue()))
+  }
 }