@travetto/config 4.1.2 → 5.0.0-rc.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 ArcSine Technologies
+Copyright (c) 2023 ArcSine Technologies
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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/travetto/travetto/tree/main/module/yaml#readme "Simple YAML support, provides only clean subset of 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#L31) functionality applies.
 
 ## Resolution
 The configuration information is comprised of:
@@ -76,6 +76,11 @@ Config {
     {
       priority: 100,
       source: 'file://application',
+      detail: 'resources/application.yaml'
+    },
+    {
+      priority: 101,
+      source: 'file://application',
       detail: 'module/config/doc/resources/application.yml'
     },
     {
@@ -198,7 +203,7 @@ $ trv main doc/dbconfig-run.ts
   message: 'Failed to construct @travetto/config:doc/dbconfig￮DBConfig as validation errors have occurred',
   category: 'data',
   type: 'ValidationResultError',
-  at: 2029-03-14T04:00:00.618Z,
+  at: '2029-03-14T04:00:00.618Z',
   details: {
     class: '@travetto/config:doc/dbconfig￮DBConfig',
     file: './doc/dbconfig.ts',
@@ -229,6 +234,11 @@ Config {
     {
       priority: 100,
       source: 'file://application',
+      detail: 'resources/application.yaml'
+    },
+    {
+      priority: 101,
+      source: 'file://application',
       detail: 'module/config/doc/resources/application.yml'
     },
     {

package/package.json

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

package/src/parser/parser.ts

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

package/src/parser/yaml.ts

@@ -1,10 +1,10 @@
 import { Injectable } from '@travetto/di';
-import { YamlUtil } from '@travetto/yaml';
+import { parse as parseYaml } from 'yaml';
 
-import { ConfigParser } from './types';
+import { ConfigData, ConfigParser } from './types';
 
 @Injectable()
 export class YAMLConfigParser implements ConfigParser {
   ext = ['.yaml', '.yml'];
-  parse = YamlUtil.parse;
+  parse = (input: string): ConfigData => parseYaml(input) ?? {};
 }

package/src/service.ts

@@ -1,8 +1,8 @@
 import util from 'node:util';
 
-import { AppError, Class, ClassInstance, Env, RuntimeResources } from '@travetto/base';
+import { RuntimeIndex } from '@travetto/manifest';
+import { AppError, Class, ClassInstance, Env, RuntimeContext, RuntimeResources } from '@travetto/base';
 import { DependencyRegistry, Injectable } from '@travetto/di';
-import { RuntimeIndex, RuntimeContext } from '@travetto/manifest';
 import { BindUtil, DataUtil, SchemaRegistry, SchemaValidator, ValidationResultError } from '@travetto/schema';
 
 import { ConfigSourceTarget, ConfigTarget } from './internal/types';
@@ -22,7 +22,7 @@ export class ConfigurationService {
 
   #storage: Record<string, unknown> = {};   // Lowered, and flattened
   #specs: ConfigSpecSimple[] = [];
-  #secrets: (RegExp | string)[] = [/secure(-|_|[a-z])|password|private|secret|salt|(api(-|_)?key)/i];
+  #secrets: (RegExp | string)[] = [/secure(-|_|[a-z])|password|private|secret|salt|(\bkey|key\b)|serviceAccount|(api(-|_)?key)/i];
 
   /**
    * Get a sub tree of the config, or everything if namespace is not passed

package/src/source/file.ts

@@ -1,7 +1,7 @@
 import fs from 'node:fs/promises';
+import path from 'node:path';
 
-import { Env, RuntimeResources } from '@travetto/base';
-import { RuntimeContext, path } from '@travetto/manifest';
+import { Env, RuntimeContext, RuntimeResources } from '@travetto/base';
 
 import { ConfigSource, ConfigSpec } from './types';
 import { ParserManager } from '../parser/parser';