feat: yaml format, new public methods for credentials

Author: bitkidd

adonis-typings/index.ts

@@ -1,6 +1,9 @@
 declare module '@ioc:Adonis/Addons/Credentials' {
   export interface CredentialsContract {
-    get(key?: string): string | Record<string, string>
+    get(key?: string): string | boolean | number | Record<string, string | boolean | number>
+    key(): string | null
+    content(): string
+    format(): string
     initialize(): void
   }
 

src/Credentials/index.ts

@@ -9,6 +9,7 @@
 
 import fs from 'fs'
 import dotenv from 'dotenv'
+import YAML from 'yaml'
 import { join } from 'path'
 import { Exception } from '@poppinss/utils'
 import { string } from '@poppinss/utils/build/helpers'
@@ -18,11 +19,12 @@ import { Vault } from '../Vault'
 export class Credentials implements CredentialsContract {
   private initialized = false
   private env = 'development'
-  private key: string | null = null
+  private keyValue: string | null = null
   private keyParam = 'APP_CREDENTIALS_KEY'
+  private credentialsFormat: 'yaml' | 'json' = 'yaml'
   private credentialsPath = join('resources', 'credentials')
-  private content: string = ''
-  private credentials: Record<string, string> = {}
+  private credentialsContent: string = ''
+  private credentialsValues: Record<string, string | boolean | number> = {}
 
   constructor(args?: {
     env?: string
@@ -35,12 +37,12 @@ export class Credentials implements CredentialsContract {
     }
 
     this.env = args?.env || process.env.NODE_ENV || this.env
-    this.key = args?.key || process.env[this.keyParam] || this.key
+    this.keyValue = args?.key || process.env[this.keyParam] || this.keyValue
     this.credentialsPath = args?.credentialsPath || this.credentialsPath
   }
 
   private check() {
-    if (!this.key && !fs.existsSync(`${this.credentialsPath}/${this.env}.key`)) {
+    if (!this.keyValue && !fs.existsSync(`${this.credentialsPath}/${this.env}.key`)) {
       throw new Exception(
         `Credentials key for '${this.env}' environment does not exist, please set it in a file or in ${this.keyParam} environment variable`,
         500,
@@ -58,52 +60,93 @@ export class Credentials implements CredentialsContract {
   }
 
   private read() {
-    const key = this.key || fs.readFileSync(`${this.credentialsPath}/${this.env}.key`)
+    const key = this.keyValue || fs.readFileSync(`${this.credentialsPath}/${this.env}.key`)
     const content = fs.readFileSync(`${this.credentialsPath}/${this.env}.credentials`)
     const decryptedContent = Vault.decrypt(content.toString('utf-8'), key.toString('utf-8'))
-    this.content = decryptedContent
+
+    this.keyValue = key.toString('utf-8')
+    this.credentialsContent = decryptedContent
   }
 
   private validate() {
     try {
-      JSON.parse(this.content)
-    } catch (error) {
-      throw new Exception(
-        `Credentials file for '${this.env}' environment is corrupted, should be a valid JSON`,
-        500,
-        'E_CREDENTIALS_WRONG_FORMAT'
-      )
+      JSON.parse(this.credentialsContent)
+      this.credentialsFormat = 'json'
+    } catch {
+      try {
+        YAML.parse(this.credentialsContent)
+        this.credentialsFormat = 'yaml'
+      } catch {
+        throw new Exception(
+          `Credentials file for '${this.env}' environment is corrupted, should be a valid YAML or JSON`,
+          500,
+          'E_CREDENTIALS_WRONG_FORMAT'
+        )
+      }
     }
   }
 
-  private parse(obj?: Object, current?: string) {
-    const object = obj || JSON.parse(this.content)
+  private parse(obj?: Record<string, any>, current?: string) {
+    let object = obj
+
+    if (!object && this.credentialsFormat === 'json') {
+      object = JSON.parse(this.credentialsContent)
+    }
+
+    if (!object && this.credentialsFormat === 'yaml') {
+      object = YAML.parse(this.credentialsContent)
+    }
+
     for (const key in object) {
       const value = object[key]
       const newKey = current ? current + '_' + key : key
       if (value && typeof value === 'object') {
         this.parse(value, newKey)
       } else {
-        this.credentials[string.snakeCase(newKey).toUpperCase()] = value
+        this.credentialsValues[string.snakeCase(newKey).toUpperCase()] = value
       }
     }
   }
 
   private populate() {
-    for (let key in this.credentials) {
-      process.env[key] = this.credentials[key]
+    for (let key in this.credentialsValues) {
+      process.env[key] = `${this.credentialsValues[key]}`
+    }
+  }
+
+  public key(): string | null {
+    if (!this.initialized) {
+      this.initialize()
+    }
+
+    return this.keyValue
+  }
+
+  public content(): string {
+    if (!this.initialized) {
+      this.initialize()
     }
+
+    return this.credentialsContent
+  }
+
+  public format(): string {
+    if (!this.initialized) {
+      this.initialize()
+    }
+
+    return this.credentialsFormat
   }
 
-  public get(key?: string): string | Record<string, string> {
+  public get(key?: string): string | boolean | number | Record<string, string | boolean | number> {
     if (!this.initialized) {
       this.initialize()
     }
 
     if (key) {
-      return this.credentials[key]
+      return this.credentialsValues[key]
     } else {
-      return this.credentials
+      return this.credentialsValues
     }
   }