@x-fiber-sys/be-config 0.1.0

package/README.md

@@ -0,0 +1,11 @@
+# `be-config`
+
+> TODO: description
+
+## Usage
+
+```
+const beConfig = require('be-config');
+
+// TODO: DEMONSTRATE API
+```

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@x-fiber-sys/be-config",
+  "version": "0.1.0",
+  "description": "Service env configurations processing library",
+  "author": "pestsov-v <pestsov.js@gmail.com>",
+  "homepage": "https://github.com/pestsov-v/c-argo-back-mono#readme",
+  "license": "ISC",
+  "main": "src/index.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pestsov-v/c-argo-back-mono.git"
+  },
+  "bugs": {
+    "url": "https://github.com/pestsov-v/c-argo-back-mono/issues"
+  },
+  "dependencies": {
+    "dotenv": "^17.2.1",
+    "envalid": "^8.1.0"
+  }
+}

package/src/config.ts

@@ -0,0 +1,149 @@
+import 'dotenv/config'
+import { num, str, bool, cleanEnv } from 'envalid'
+
+import type { OptionalValidatorSpec, Spec } from 'envalid'
+
+export type ConfigType = 'string' | 'boolean' | 'number'
+
+export type ConfigEnvs = Record<string, ConfigType>
+export type ConfigVal<T = ConfigType> = { type: T; specs?: Spec<unknown> }
+export type ConfigObj<C extends ConfigEnvs> = { [K in keyof C]: ConfigVal<C[K]> }
+
+export class Config<C extends Record<string, ConfigType> = Record<string, ConfigType>> {
+  private _config: Record<string, string | number | boolean>
+  private readonly _hotConfig: Record<string, string | number | boolean>
+
+  constructor() {
+    this._config = {}
+    this._hotConfig = {}
+  }
+
+  public async init(config: ConfigObj<C>): Promise<void> {
+    const specs: Record<string, Spec<unknown>> = {}
+
+    for (const key in config) {
+      const env = config[key]
+
+      switch (env.type) {
+        case 'string':
+          specs[key] = env.specs ? str(env.specs) : str()
+          break
+        case 'number':
+          specs[key] = env.specs ? num(env.specs) : num()
+          break
+        case 'boolean':
+          specs[key] = env.specs ? bool(env.specs as OptionalValidatorSpec<boolean>) : bool()
+          break
+      }
+    }
+
+    this._config = cleanEnv(process.env, specs)
+  }
+
+  public get hotConfig() {
+    return this._hotConfig
+  }
+
+  public get serviceVersion() {
+    return process.env.npm_package_version as string
+  }
+
+  public get nodeVersion() {
+    return process.env.NODE_VERSION as string
+  }
+
+  public get isDevelopment(): boolean {
+    return this._config.isDevelopment as boolean
+  }
+
+  public get isTest(): boolean {
+    return process.env.NODE_ENV === 'test'
+  }
+
+  public getString<V extends string, K extends keyof C = keyof C>(
+    key: K,
+    isRequired?: true,
+    devVal?: V,
+  ): V
+  public getString<V extends string, K extends keyof C = keyof C>(
+    key: K,
+    isRequired: boolean = true,
+    devVal?: string,
+  ): V | null {
+    const val = this._config[key as string]
+
+    if (!val) {
+      if (isRequired) {
+        throw new Error(`Key '${String(key)}' is required, but was not found.`)
+      }
+
+      return (devVal as V) || null
+    }
+
+    if (typeof val !== 'string') {
+      throw new Error(`Key '${String(key)}' is required, but was not found.`)
+    }
+
+    return val as V
+  }
+
+  public getBoolean<K extends keyof C = keyof C>(
+    key: K,
+    isRequired?: true,
+    devVal?: boolean,
+  ): boolean
+  public getBoolean<K extends keyof C = keyof C>(
+    key: K,
+    isRequired: boolean = true,
+    devVal?: boolean,
+  ): boolean | null {
+    const val = this._config[key as string]
+
+    if (val === undefined || val === null) {
+      if (isRequired) {
+        throw new Error(`Key '${String(key)}' is required, but was not found.`)
+      }
+
+      return devVal ?? null
+    }
+
+    if (typeof val !== 'boolean') {
+      throw new Error(`Key '${String(key)}' must be a boolean, but got '${typeof val}'.`)
+    }
+
+    return val
+  }
+
+  public getNumber<K extends keyof C>(
+    key: C[K] extends 'number' ? K : never,
+    isRequired?: true,
+    devVal?: number,
+  ): number
+  public getNumber<K extends keyof C>(
+    key: C[K] extends 'number' ? K : never,
+    isRequired: boolean = true,
+    devVal?: number,
+  ): number | null {
+    const val = this._config[key as string]
+
+    if (!val) {
+      if (isRequired) {
+        throw new Error(`Key '${String(key)}' is required, but was not found.`)
+      }
+
+      return devVal || null
+    }
+
+    if (typeof val !== 'number') {
+      throw new Error(`Key '${String(key)}' is required, but was not found.`)
+    }
+
+    return val
+  }
+
+  public async destroy() {
+    new Config()
+
+    this._config = {}
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './config'