@travetto/config 7.0.6 → 7.1.0

package/README.md

@@ -22,8 +22,8 @@ The configuration information is comprised of:
 
 Config loading follows a defined resolution path, below is the order in increasing specificity (`ext` can be `yaml`, `yml`, `json`, `properties`):
    1. `resources/application.<ext>` - Priority `100` - Load the default `application.<ext>` if available.
-   1. `resources/{env}.<ext>` - Priority `200` - Load environment specific profile configurations as defined by the values of `process.env.TRV_ENV`.
-   1. `resources/*.<ext>` - Priority `300` - Load profile specific configurations as defined by the values in `process.env.TRV_PROFILES`
+   1. `resources/{role}.<ext>` - Priority `150` - Load environment specific profile configurations as defined by the values of `process.env.TRV_ROLE`. If the role is `std`, it is replaced with `local` for local development.
+   1. `resources/*.<ext>` - Priority `200` - Load profile specific configurations as defined by the values in `process.env.TRV_PROFILES`
    1. [@Injectable](https://github.com/travetto/travetto/tree/main/module/di/src/decorator.ts#L16) [ConfigSource](https://github.com/travetto/travetto/tree/main/module/config/src/source/types.ts#L11) - Priority `???` - These are custom config sources provided by the module, and are able to define their own priorities
    1. [OverrideConfigSource](https://github.com/travetto/travetto/tree/main/module/config/src/source/override.ts#L9) - Priority `999` - This is for [@EnvVar](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L37) overrides, and is at the top priority for all built-in config sources.
 
@@ -48,7 +48,7 @@ database:
     password: test
 ```
 
-**Config: resources/prod.json**
+**Config: resources/production.json**
 ```json
 {
   "database": {
@@ -64,7 +64,7 @@ with environment variables
 
 **Config: Environment variables**
 ```properties
-TRV_ENV = prod
+TRV_PROFILES=production
 ```
 
 At runtime the resolved config would be:
@@ -85,10 +85,15 @@ Config {
       source: 'file://application',
       detail: 'module/config/doc/resources/application.yml'
     },
+    {
+      priority: 200,
+      source: 'file://local',
+      detail: 'resources/local.yml'
+    },
     {
       priority: 300,
-      source: 'file://prod',
-      detail: 'module/config/doc/resources/prod.json'
+      source: 'file://production',
+      detail: 'module/config/doc/resources/production.json'
     },
     { priority: 999, source: 'memory://override' }
   ],
@@ -245,10 +250,15 @@ Config {
       source: 'file://application',
       detail: 'module/config/doc/resources/application.yml'
     },
+    {
+      priority: 200,
+      source: 'file://local',
+      detail: 'resources/local.yml'
+    },
     {
       priority: 300,
-      source: 'file://prod',
-      detail: 'module/config/doc/resources/prod.json'
+      source: 'file://production',
+      detail: 'module/config/doc/resources/production.json'
     },
     { priority: 999, source: 'memory://override' }
   ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/config",
-  "version": "7.0.6",
+  "version": "7.1.0",
   "type": "module",
   "description": "Configuration support",
   "keywords": [
@@ -27,8 +27,9 @@
     "directory": "module/config"
   },
   "dependencies": {
-    "@travetto/di": "^7.0.6",
-    "@travetto/schema": "^7.0.6",
+    "@travetto/cli": "^7.1.0",
+    "@travetto/di": "^7.1.0",
+    "@travetto/schema": "^7.1.0",
     "yaml": "^2.8.2"
   },
   "travetto": {

package/src/service.ts

@@ -149,8 +149,8 @@ export class ConfigurationService {
         workspace: Runtime.workspace
       },
       runtime: {
-        env: Runtime.env,
-        envType: Runtime.envType,
+        production: Runtime.production,
+        role: Runtime.role,
         debug: Runtime.debug,
         resourcePaths: RuntimeResources.searchPaths,
         profiles: Env.TRV_PROFILES.list ?? []

package/src/source/file.ts

@@ -13,6 +13,22 @@ type Profile = [string, number] | readonly [string, number];
  */
 export class FileConfigSource implements ConfigSource {
 
+  static getProfiles(): Profile[] {
+    const profiles: Profile[] = [
+      ['application', 100]
+    ];
+    if (Runtime.role === 'std') {
+      if (Runtime.localDevelopment) {
+        profiles.push(['local', 200]);
+      }
+    } else {
+      profiles.push([Runtime.role, 200]);
+    }
+    profiles.push(...(Env.TRV_PROFILES.list ?? [])
+      .map((profile, i) => [profile, 300 + i * 10] as const));
+    return profiles;
+  }
+
   #profiles: Profile[];
   #searchPaths: string[];
   #parser: ParserManager;
@@ -20,12 +36,7 @@ export class FileConfigSource implements ConfigSource {
   constructor(parser: ParserManager) {
     this.#parser = parser;
     this.#searchPaths = RuntimeResources.searchPaths.toReversed();
-    this.#profiles = ([
-      ['application', 100],
-      [Runtime.env!, 200],
-      ...(Env.TRV_PROFILES.list ?? [])
-        .map((profile, i) => [profile, 300 + i * 10] as const)
-    ] as const).filter(entry => !!entry[0]);
+    this.#profiles = FileConfigSource.getProfiles();
   }
 
   async get(): Promise<ConfigPayload[]> {

package/src/trv.d.ts

@@ -3,7 +3,7 @@ import '@travetto/runtime';
 declare module '@travetto/runtime' {
   interface EnvData {
     /** 
-     * Configuration profiles, in addition to TRV_ENV
+     * Configuration profiles
      */
     TRV_PROFILES: string[];
   }