@travetto/config 2.1.5 → 2.2.0

package/README.md

@@ -116,9 +116,10 @@ $ node @travetto/boot/bin/main ./doc/dbconfig-run.ts
   errors: [
     {
       kind: 'required',
-      active: true,
+      value: undefined,
+      message: 'port is required',
       path: 'port',
-      message: 'port is required'
+      type: undefined
     }
   ]
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/config",
   "displayName": "Configuration",
-  "version": "2.1.5",
+  "version": "2.2.0",
   "description": "Environment-aware config management using yaml files",
   "keywords": [
     "yaml",
@@ -28,12 +28,12 @@
     "directory": "module/config"
   },
   "dependencies": {
-    "@travetto/schema": "^2.1.5",
-    "@travetto/transformer": "^2.1.4",
-    "@travetto/yaml": "^2.1.4"
+    "@travetto/schema": "^2.2.0",
+    "@travetto/transformer": "^2.2.0",
+    "@travetto/yaml": "^2.2.0"
   },
   "devDependencies": {
-    "@travetto/di": "^2.1.5"
+    "@travetto/di": "^2.2.0"
   },
   "publishConfig": {
     "access": "public"

package/src/decorator.ts

@@ -7,10 +7,10 @@ import { ConfigManager } from './manager';
  * @augments `@trv:di/Injectable`
  */
 export function Config(ns: string, params?: { internal?: boolean }) {
-  return <T extends Class>(target: T) => {
+  return <T extends Class>(target: T): T => {
     const og = target.prototype.postConstruct;
 
-    target.prototype.postConstruct = async function () {
+    target.prototype.postConstruct = async function (): Promise<void> {
       // Apply config
       await ConfigManager.install(target, this, ns, params?.internal);
       if (og) {

package/src/internal/util.ts

@@ -10,7 +10,7 @@ export class ConfigUtil {
   /**
    * Find the key using case insensitive search
    */
-  static #getKeyName(key: string, fields: string[]) {
+  static #getKeyName(key: string, fields: string[]): string | undefined {
     key = key.trim();
     const match = new RegExp(key, 'i');
     const next = fields.find(x => match.test(x));
@@ -20,7 +20,7 @@ export class ConfigUtil {
   /**
    * Takes a env var, and produces a partial object against a schema definition.  Does not support arrays, only objects.
    */
-  static #expandEnvEntry(cls: Class, key: string, value: unknown) {
+  static #expandEnvEntry(cls: Class, key: string, value: unknown): Record<string, unknown> | undefined {
     const parts = key.split('_');
 
     const lastPart = parts.pop()!;
@@ -49,6 +49,7 @@ export class ConfigUtil {
           break;
         }
       }
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       data = ((data[part!] ??= {}) as Record<string, unknown>); // Recurse
     }
 
@@ -65,11 +66,11 @@ export class ConfigUtil {
    * Bind the environment variables onto an object structure when they match by name.
    * Will split on _ to handle nesting appropriately
    */
-  static getEnvOverlay(cls: Class, ns: string) {
+  static getEnvOverlay(cls: Class, ns: string): Record<string, unknown> {
     // Handle process.env on bind as the structure we need may not
     // fully exist until the config has been created
     const nsRe = new RegExp(`^${ns.replace(/[.]/g, '_')}`, 'i'); // Check is case insensitive
-    const data = {};
+    const data: Record<string, unknown> = {};
     for (const [k, v] of Object.entries(process.env)) { // Find all keys that match ns
       if (k.includes('_') && nsRe.test(k)) { // Require at least one level (nothing should be at the top level as all configs are namespaced)
         Util.deepAssign(data, this.#expandEnvEntry(cls, ns ? k.substring(ns.length + 1) : k, v), 'coerce');
@@ -83,7 +84,7 @@ export class ConfigUtil {
    */
   static async getConfigFileAsData(file: string, ns: string = ''): Promise<Record<string, unknown>> {
     const data = await ResourceManager.read(file, 'utf8');
-    const doc = YamlUtil.parse(data) as Record<string, unknown>;
+    const doc = YamlUtil.parse<Record<string, unknown>>(data);
     return ns ? { [ns]: doc } : doc;
   }
 
@@ -93,7 +94,7 @@ export class ConfigUtil {
    * @param ns
    * @returns
    */
-  static lookupRoot(src: Record<string, unknown>, ns?: string, createIfMissing = false) {
+  static lookupRoot(src: Record<string, unknown>, ns?: string, createIfMissing = false): Record<string, unknown> {
     const parts = (ns ? ns.split('.') : []);
     let sub: Record<string, unknown> = src;
 
@@ -102,6 +103,7 @@ export class ConfigUtil {
       if (createIfMissing && !sub[next]) {
         sub[next] = {};
       }
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       sub = sub[next] as Record<string, unknown>;
     }
 
@@ -121,6 +123,7 @@ export class ConfigUtil {
         full[k] = '*'.repeat(10);
       }
     }
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return BindUtil.expandPaths(full) as T;
   }
 }

package/src/manager.ts

@@ -24,14 +24,14 @@ class $ConfigManager {
     'pw',
   ];
 
-  protected getStorage() {
+  protected getStorage(): Record<string, unknown> {
     return this.#storage;
   }
 
   /**
    * Load all config files
    */
-  async #load() {
+  async #load(): Promise<void> {
     const profileIndex = Object.fromEntries(Object.entries(AppManifest.env.profiles).map(([k, v]) => [v, +k] as const));
 
     const files = (await ResourceManager.findAll(/[.]ya?ml$/))
@@ -51,9 +51,9 @@ class $ConfigManager {
 
   /**
    * Get a sub tree of the config, or everything if namespace is not passed
-   * @param ns The namespace of the config to search for, can be dotted for accesing sub namespaces
+   * @param ns The namespace of the config to search for, can be dotted for accessing sub namespaces
    */
-  #get(ns?: string) {
+  #get(ns?: string): Record<string, unknown> {
     return ConfigUtil.lookupRoot(this.#storage, ns);
   }
 
@@ -64,7 +64,7 @@ class $ConfigManager {
    *   - Resource {env}.yml
    *   - Environment vars -> Overrides everything (happens at bind time)
    */
-  async init() {
+  async init(): Promise<void> {
     if (!this.#initialized) {
       this.#initialized = true;
       await this.#load();
@@ -76,11 +76,12 @@ class $ConfigManager {
    * @param namespace If only a portion of the config should be exported
    * @param secure Determines if secrets should be redacted, defaults to true in prod, false otherwise
    */
-  toJSON(secure: boolean = EnvUtil.isProd()) {
+  toJSON(secure: boolean = EnvUtil.isProd()): Record<string, unknown> {
     const copy = JSON.parse(JSON.stringify(this.#active));
     return secure ?
       ConfigUtil.sanitizeValuesByKey(copy, [
         ...this.#redactedKeys,
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         ...(this.#get('config')?.redacted ?? []) as string[]
       ]) :
       copy;
@@ -92,7 +93,7 @@ class $ConfigManager {
    * @param item
    * @param namespace
    */
-  bindTo<T>(cls: Class<T>, item: T, namespace: string) {
+  bindTo<T>(cls: Class<T>, item: T, namespace: string): T {
     if (!SchemaRegistry.has(cls)) {
       throw new AppError(`${cls.ᚕid} is not a valid schema class, config is not supported`);
     }
@@ -103,16 +104,16 @@ class $ConfigManager {
     return BindUtil.bindSchemaToObject(cls, item, cfg);
   }
 
-  async install<T>(cls: Class<T>, item: T, namespace: string, internal?: boolean) {
+  async install<T>(cls: Class<T>, item: T, namespace: string, internal?: boolean): Promise<T> {
     const out = await this.bindTo(cls, item, namespace);
     try {
       await SchemaValidator.validate(cls, out);
-    } catch (e) {
-      if (e instanceof ValidationResultError) {
-        e.message = `Failed to construct ${cls.ᚕid} as validation errors have occurred`;
-        e.payload = { class: cls.ᚕid, file: cls.ᚕfile, ...(e.payload ?? {}) };
+    } catch (err) {
+      if (err instanceof ValidationResultError) {
+        err.message = `Failed to construct ${cls.ᚕid} as validation errors have occurred`;
+        err.payload = { class: cls.ᚕid, file: cls.ᚕfile, ...(err.payload ?? {}) };
       }
-      throw e;
+      throw err;
     }
     if (out && !internal) {
       Util.deepAssign(ConfigUtil.lookupRoot(this.#active, namespace, true), out, 'coerce');
@@ -123,7 +124,7 @@ class $ConfigManager {
   /**
    * Reset
    */
-  reset() {
+  reset(): void {
     this.#storage = {};
     this.#initialized = false;
   }

package/support/phase.init.ts

@@ -4,7 +4,7 @@
 export const init = {
   key: '@trv:config/init',
   before: ['@trv:registry/init'],
-  async action() {
+  async action(): Promise<void> {
     const { ConfigManager } = await import('../src/manager');
     await ConfigManager.init();
   }