@travetto/config 5.0.0-rc.1 → 5.0.0-rc.10

package/README.md

@@ -13,7 +13,7 @@ npm install @travetto/config
 yarn add @travetto/config
 ```
 
-The config module provides support for loading application config on startup. Configuration values support the common [YAML](https://en.wikipedia.org/wiki/YAML) constructs as defined in [yaml](https://github.com/eemeli/yaml).  Additionally, the configuration is built upon the [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.") module, to enforce type correctness, and allow for validation of configuration as an entrypoint into the application.  Given that all [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) classes are [@Schema](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/schema.ts#L14)-based classes, all the standard [@Schema](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/schema.ts#L14) and [@Field](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L31) functionality applies.
+The config module provides support for loading application config on startup. Configuration values support the common [YAML](https://en.wikipedia.org/wiki/YAML) constructs as defined in [yaml](https://github.com/eemeli/yaml).  Additionally, the configuration is built upon the [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.") module, to enforce type correctness, and allow for validation of configuration as an entrypoint into the application.  Given that all [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) classes are [@Schema](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/schema.ts#L14)-based classes, all the standard [@Schema](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/schema.ts#L14) and [@Field](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L30) functionality applies.
 
 ## Resolution
 The configuration information is comprised of:
@@ -23,7 +23,7 @@ Config loading follows a defined resolution path, below is the order in increasi
    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. [@Injectable](https://github.com/travetto/travetto/tree/main/module/di/src/decorator.ts#L31) [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. [@Injectable](https://github.com/travetto/travetto/tree/main/module/di/src/decorator.ts#L29) [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#L11) - Priority `999` - This is for [EnvVar](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L34) overrides, and is at the top priority for all built-in config sources.
 By default all configuration data is inert, and will only be applied when constructing an instance of a configuration class.
 
@@ -140,7 +140,7 @@ export class EnvConfigSource implements ConfigSource {
     try {
       const data = JSON.parse(process.env[this.#envKey] || '{}');
       return { data, priority: this.#priority, source: `env://${this.#envKey}` };
-    } catch (e) {
+    } catch {
       console.error(`env.${this.#envKey} is an invalid format`, { text: process.env[this.#envKey] });
     }
   }
@@ -148,7 +148,7 @@ export class EnvConfigSource implements ConfigSource {
 ```
 
 ### Custom Configuration Provider
-In addition to files and environment variables, configuration sources can also be provided via the class itself.  This is useful for reading remote configurations, or dealing with complex configuration normalization.  The only caveat to this pattern, is that the these configuration sources cannot rely on the [ConfigurationService](https://github.com/travetto/travetto/tree/main/module/config/src/service.ts#L21) service for input.  This means any needed configuration will need to be accessed via specific patterns.
+In addition to files and environment variables, configuration sources can also be provided via the class itself.  This is useful for reading remote configurations, or dealing with complex configuration normalization.  The only caveat to this pattern, is that the these configuration sources cannot rely on the [ConfigurationService](https://github.com/travetto/travetto/tree/main/module/config/src/service.ts#L20) service for input.  This means any needed configuration will need to be accessed via specific patterns.
 
 **Code: Custom Configuration Source**
 ```typescript
@@ -167,10 +167,10 @@ export class CustomConfigSource implements ConfigSource {
 ```
 
 ## Startup
-At startup, the [ConfigurationService](https://github.com/travetto/travetto/tree/main/module/config/src/service.ts#L21) service will log out all the registered configuration objects.  The configuration state output is useful to determine if everything is configured properly when diagnosing runtime errors.  This service will find all configurations, and output a redacted version with all secrets removed.  The default pattern for secrets is `/password|private|secret/i`.  More values can be added in your configuration under the path `config.secrets`.  These values can either be simple strings (for exact match), or `/pattern/` to create a regular expression.
+At startup, the [ConfigurationService](https://github.com/travetto/travetto/tree/main/module/config/src/service.ts#L20) service will log out all the registered configuration objects.  The configuration state output is useful to determine if everything is configured properly when diagnosing runtime errors.  This service will find all configurations, and output a redacted version with all secrets removed.  The default pattern for secrets is `/password|private|secret/i`.  More values can be added in your configuration under the path `config.secrets`.  These values can either be simple strings (for exact match), or `/pattern/` to create a regular expression.
 
 ## Consuming
-The [ConfigurationService](https://github.com/travetto/travetto/tree/main/module/config/src/service.ts#L21) service provides injectable access to all of the loaded configuration. For simplicity, a decorator, [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) allows for classes to automatically be bound with config information on post construction via the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") module. The decorator will install a `postConstruct` method if not already defined, that performs the binding of configuration.  This is due to the fact that we cannot rewrite the constructor, and order of operation matters.
+The [ConfigurationService](https://github.com/travetto/travetto/tree/main/module/config/src/service.ts#L20) service provides injectable access to all of the loaded configuration. For simplicity, a decorator, [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) allows for classes to automatically be bound with config information on post construction via the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") module. The decorator will install a `postConstruct` method if not already defined, that performs the binding of configuration.  This is due to the fact that we cannot rewrite the constructor, and order of operation matters.
 
 ### Environment Variables
 Additionally there are times in which you may want to also support configuration via environment variables.  [EnvVar](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L34) supports override configuration values when environment variables are present. 
@@ -206,7 +206,7 @@ $ trv main doc/dbconfig-run.ts
   at: '2029-03-14T04:00:00.618Z',
   details: {
     class: '@travetto/config:doc/dbconfig￮DBConfig',
-    file: './doc/dbconfig.ts',
+    import: '@travetto/config/doc/dbconfig.ts',
     errors: [
       {
         kind: 'required',

package/package.json

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

package/src/decorator.ts

@@ -1,4 +1,4 @@
-import { Class, ClassInstance } from '@travetto/base';
+import { Class, ClassInstance } from '@travetto/runtime';
 import { DependencyRegistry } from '@travetto/di';
 import { SchemaRegistry } from '@travetto/schema';
 

package/src/parser/parser.ts

@@ -2,7 +2,7 @@ import fs from 'node:fs/promises';
 import path from 'node:path';
 
 import { DependencyRegistry, Injectable } from '@travetto/di';
-import { AppError } from '@travetto/base';
+import { AppError } from '@travetto/runtime';
 
 import { ConfigParserTarget } from '../internal/types';
 import { ConfigData, ConfigParser } from './types';

package/src/service.ts

@@ -1,7 +1,6 @@
 import util from 'node:util';
 
-import { RuntimeIndex } from '@travetto/manifest';
-import { AppError, Class, ClassInstance, Env, RuntimeContext, RuntimeResources } from '@travetto/base';
+import { AppError, castTo, Class, ClassInstance, Env, Runtime, RuntimeResources } from '@travetto/runtime';
 import { DependencyRegistry, Injectable } from '@travetto/di';
 import { BindUtil, DataUtil, SchemaRegistry, SchemaValidator, ValidationResultError } from '@travetto/schema';
 
@@ -34,8 +33,7 @@ export class ConfigurationService {
 
     while (parts.length && sub) {
       const next = parts.shift()!;
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      sub = sub[next] as Record<string, unknown>;
+      sub = castTo(sub[next]);
     }
 
     return sub;
@@ -127,8 +125,8 @@ 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 = RuntimeIndex.getFunctionMetadata(cls)!.source;
-          Object.defineProperty(err, 'details', { value: { class: cls.Ⲑid, file, ...(err.details ?? {}) } });
+          const imp = Runtime.getImport(cls);
+          Object.defineProperty(err, 'details', { value: { class: cls.Ⲑid, import: imp, ...(err.details ?? {}) } });
         }
         throw err;
       }
@@ -145,14 +143,14 @@ export class ConfigurationService {
 
     console.log('Initialized', {
       manifest: {
-        main: RuntimeContext.main,
-        workspace: RuntimeContext.workspace
+        main: Runtime.main,
+        workspace: Runtime.workspace
       },
-      env: {
-        name: Env.name,
-        debug: Env.debug,
-        production: Env.production,
-        dynamic: Env.dynamic,
+      runtime: {
+        env: Runtime.env,
+        debug: Runtime.debug,
+        production: Runtime.production,
+        dynamic: Runtime.dynamic,
         resourcePaths: RuntimeResources.searchPaths,
         profiles: Env.TRV_PROFILES.list ?? []
       },

package/src/source/env.ts

@@ -16,7 +16,7 @@ export class EnvConfigSource implements ConfigSource {
     try {
       const data = JSON.parse(process.env[this.#envKey] || '{}');
       return { data, priority: this.#priority, source: `env://${this.#envKey}` };
-    } catch (e) {
+    } catch {
       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 'node:fs/promises';
 import path from 'node:path';
 
-import { Env, RuntimeContext, RuntimeResources } from '@travetto/base';
+import { Env, Runtime, RuntimeResources } from '@travetto/runtime';
 
 import { ConfigSource, ConfigSpec } from './types';
 import { ParserManager } from '../parser/parser';
@@ -22,7 +22,7 @@ export class FileConfigSource implements ConfigSource {
     this.#searchPaths = RuntimeResources.searchPaths.slice().reverse();
     this.#profiles = ([
       ['application', 100],
-      [Env.name!, 200],
+      [Runtime.env!, 200],
       ...(Env.TRV_PROFILES.list ?? [])
         .map((p, i) => [p, 300 + i * 10] as const)
     ] as const).filter(x => !!x[0]);
@@ -31,18 +31,20 @@ export class FileConfigSource implements ConfigSource {
   async get(): Promise<ConfigSpec[]> {
     const cache: Record<string, Promise<string[]>> = {};
     const configs: Promise<ConfigSpec>[] = [];
+
     for (const [profile, priority] of this.#profiles) {
-      let i = 0;
+      let i = priority;
       for (const folder of this.#searchPaths) {
         const files = await (cache[folder] ??= fs.readdir(folder).catch(() => []));
         for (const file of files) {
           if (this.#parser.matches(file) && path.basename(file, path.extname(file)) === profile) {
             const full = path.resolve(folder, file);
+            const configPriority = i++;
             configs.push(this.#parser.parse(full).then(data => ({
               data,
-              priority: priority + i++,
+              priority: configPriority,
               source: `file://${profile}`,
-              detail: RuntimeContext.stripWorkspacePath(full)
+              detail: Runtime.stripWorkspacePath(full)
             })));
           }
         }

package/src/trv.d.ts

@@ -1,4 +1,4 @@
-import '@travetto/base';
+import '@travetto/runtime';
 
 declare global {
   interface TravettoEnv {