@travetto/config 3.4.4 → 4.0.0-rc.0

package/README.md

@@ -117,8 +117,6 @@ export class MemoryConfigSource implements ConfigSource {
 
 **Code: Environment JSON Provider**
 ```typescript
-import { Env } from '@travetto/base';
-
 import { ConfigSource, ConfigSpec } from './types';
 
 /**
@@ -135,10 +133,10 @@ export class EnvConfigSource implements ConfigSource {
 
   get(): ConfigSpec | undefined {
     try {
-      const data = JSON.parse(Env.get(this.#envKey, '{}'));
+      const data = JSON.parse(process.env[this.#envKey] || '{}');
       return { data, priority: this.#priority, source: `env://${this.#envKey}` };
     } catch (e) {
-      console.error(`env.${this.#envKey} is an invalid format`, { text: Env.get(this.#envKey) });
+      console.error(`env.${this.#envKey} is an invalid format`, { text: process.env[this.#envKey] });
     }
   }
 }

package/__index__.ts

@@ -1,3 +1,4 @@
+/// <reference path="./src/trv.d.ts" />
 export * from './src/decorator';
 export * from './src/service';
 export * from './src/source/env';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/config",
-  "version": "3.4.4",
+  "version": "4.0.0-rc.0",
   "description": "Configuration support",
   "keywords": [
     "yaml",
@@ -26,9 +26,9 @@
     "directory": "module/config"
   },
   "dependencies": {
-    "@travetto/di": "^3.4.2",
-    "@travetto/schema": "^3.4.4",
-    "@travetto/yaml": "^3.4.2"
+    "@travetto/di": "^4.0.0-rc.0",
+    "@travetto/schema": "^4.0.0-rc.0",
+    "@travetto/yaml": "^4.0.0-rc.0"
   },
   "travetto": {
     "displayName": "Configuration"

package/src/parser/parser.ts

@@ -1,4 +1,4 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 
 import { DependencyRegistry, Injectable } from '@travetto/di';
 import { AppError } from '@travetto/base';

package/src/parser/types.ts

@@ -1,7 +1,7 @@
 export type ConfigData = Record<string, unknown>;
 
 /**
- * @concrete ../internal/types:ConfigParserTarget
+ * @concrete ../internal/types#ConfigParserTarget
  */
 export interface ConfigParser {
   ext: string[];

package/src/service.ts

@@ -1,8 +1,8 @@
-import util from 'util';
+import util from 'node:util';
 
-import { AppError, Class, ClassInstance, GlobalEnv, DataUtil } from '@travetto/base';
+import { AppError, Class, ClassInstance, DataUtil, Env, RuntimeResources } from '@travetto/base';
 import { DependencyRegistry, Injectable } from '@travetto/di';
-import { RootIndex } from '@travetto/manifest';
+import { RuntimeIndex, RuntimeContext } from '@travetto/manifest';
 import { BindUtil, SchemaRegistry, SchemaValidator, ValidationResultError } from '@travetto/schema';
 
 import { ConfigSourceTarget, ConfigTarget } from './internal/types';
@@ -127,7 +127,7 @@ export class ConfigurationService {
           const ogMessage = err.message;
           err.message = `Failed to construct ${cls.Ⲑid} as validation errors have occurred`;
           err.stack = err.stack?.replace(ogMessage, err.message);
-          const file = RootIndex.getFunctionMetadata(cls)!.source;
+          const file = RuntimeIndex.getFunctionMetadata(cls)!.source;
           err.payload = { class: cls.Ⲑid, file, ...(err.payload ?? {}) };
         }
         throw err;
@@ -142,11 +142,23 @@ export class ConfigurationService {
   async initBanner(): Promise<void> {
     const og = util.inspect.defaultOptions.depth;
     util.inspect.defaultOptions.depth = 100;
+
     console.log('Initialized', {
-      manifest: RootIndex.manifestDigest(),
-      env: GlobalEnv.toJSON(),
+      manifest: {
+        main: RuntimeContext.main,
+        workspace: RuntimeContext.workspace
+      },
+      env: {
+        name: Env.name,
+        debug: Env.debug,
+        production: Env.production,
+        dynamic: Env.dynamic,
+        resourcePaths: RuntimeResources.searchPaths,
+        profiles: Env.TRV_PROFILES.list ?? []
+      },
       config: await this.exportActive()
     });
+
     util.inspect.defaultOptions.depth = og;
   }
 }

package/src/source/env.ts

@@ -1,5 +1,3 @@
-import { Env } from '@travetto/base';
-
 import { ConfigSource, ConfigSpec } from './types';
 
 /**
@@ -16,10 +14,10 @@ export class EnvConfigSource implements ConfigSource {
 
   get(): ConfigSpec | undefined {
     try {
-      const data = JSON.parse(Env.get(this.#envKey, '{}'));
+      const data = JSON.parse(process.env[this.#envKey] || '{}');
       return { data, priority: this.#priority, source: `env://${this.#envKey}` };
     } catch (e) {
-      console.error(`env.${this.#envKey} is an invalid format`, { text: Env.get(this.#envKey) });
+      console.error(`env.${this.#envKey} is an invalid format`, { text: process.env[this.#envKey] });
     }
   }
 }

package/src/source/file.ts

@@ -1,7 +1,7 @@
-import fs from 'fs/promises';
+import fs from 'node:fs/promises';
 
-import { Env, GlobalEnv, ResourceLoader } from '@travetto/base';
-import { RootIndex, path } from '@travetto/manifest';
+import { Env, RuntimeResources } from '@travetto/base';
+import { RuntimeContext, path } from '@travetto/manifest';
 
 import { ConfigSource, ConfigSpec } from './types';
 import { ParserManager } from '../parser/parser';
@@ -9,7 +9,7 @@ import { ParserManager } from '../parser/parser';
 type Profile = [string, number] | readonly [string, number];
 
 /**
- * File-base config source, builds on common file resource provider
+ * File-based config source, relies on resource search paths for finding files
  */
 export class FileConfigSource implements ConfigSource {
 
@@ -17,16 +17,15 @@ export class FileConfigSource implements ConfigSource {
   #searchPaths: string[];
   #parser: ParserManager;
 
-  constructor(parser: ParserManager, paths?: string[], profiles?: Profile[]) {
+  constructor(parser: ParserManager) {
     this.#parser = parser;
-    this.#searchPaths = ResourceLoader.getSearchPaths(paths).reverse();
-    this.#profiles = profiles ?? [
+    this.#searchPaths = RuntimeResources.searchPaths.slice().reverse();
+    this.#profiles = ([
       ['application', 100],
-      [GlobalEnv.envName, 200],
-      ...(Env.getList('TRV_PROFILES') ?? [])
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        .map((p, i) => [p, 300 + i * 10] as [string, number])
-    ];
+      [Env.name!, 200],
+      ...(Env.TRV_PROFILES.list ?? [])
+        .map((p, i) => [p, 300 + i * 10] as const)
+    ] as const).filter(x => !!x[0]);
   }
 
   async get(): Promise<ConfigSpec[]> {
@@ -43,7 +42,7 @@ export class FileConfigSource implements ConfigSource {
               data,
               priority: priority + i++,
               source: `file://${profile}`,
-              detail: full.replace(`${RootIndex.manifest.workspacePath}/`, '')
+              detail: full.replace(`${RuntimeContext.workspace.path}/`, '')
             })));
           }
         }

package/src/source/types.ts

@@ -6,7 +6,7 @@ type OneOf<T> = T[] | T | undefined;
 export type ConfigSpec = { data: ConfigData, priority: number, source: string, detail?: string };
 
 /**
- * @concrete ../internal/types:ConfigSourceTarget
+ * @concrete ../internal/types#ConfigSourceTarget
  */
 export interface ConfigSource {
   get(): OrProm<OneOf<ConfigSpec>>;

package/src/trv.d.ts

@@ -0,0 +1,10 @@
+import '@travetto/base';
+
+declare global {
+  interface TravettoEnv {
+    /** 
+     * Configuration profiles, in addition to TRV_ENV
+     */
+    TRV_PROFILES: string[];
+  }
+}