@kibibit/configit 1.0.0-beta.1 → 1.0.0-beta.16

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://github.com/Kibibit/configit" target="blank"><img src="https://github.com/kibibit.png" width="150" ></a>
+  <a href="https://github.com/Kibibit/configit" target="blank"><img src="logo.png" width="150" ></a>
   <h2 align="center">
     @kibibit/configit
   </h2>
@@ -8,6 +8,16 @@
   <a href="https://www.npmjs.com/package/@kibibit/configit"><img src="https://img.shields.io/npm/v/@kibibit/configit/latest.svg?style=for-the-badge&logo=npm&color=CB3837"></a>
 </p>
 <p align="center">
+<a href="https://www.npmjs.com/package/@kibibit/configit"><img src="https://img.shields.io/npm/v/@kibibit/configit/beta.svg?logo=npm&color=CB3837"></a>
+<a href="https://codecov.io/gh/Kibibit/configit">
+  <img src="https://codecov.io/gh/Kibibit/configit/branch/beta/graph/badge.svg?token=DrXLrpuExK">
+</a>
+<a href="https://github.com/Kibibit/configit/actions/workflows/build.yml">
+  <img src="https://github.com/Kibibit/configit/actions/workflows/build.yml/badge.svg?style=flat-square&branch=beta" alt="Build">
+</a>
+<a href="https://github.com/Kibibit/configit/actions/workflows/tests.yml">
+  <img src="https://github.com/Kibibit/configit/actions/workflows/tests.yml/badge.svg?branch=beta" alt="Tests">
+</a>
 <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg"></a>
  <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 <a href="#contributors-"><img src="https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square" alt="All Contributors"></a>
@@ -15,51 +25,107 @@
 </p>
 <p align="center">
   A general typescript configuration service
+
 </p>
 <hr>
 
 Unless forced to create a new service, this service will return the first created service
 
-### Usage
+## Usage
 
 Create a new class to define your configuration.
 The class should extend the `Config` class from this repo
 ```typescript
-import { Exclude, Expose } from 'class-transformer';
-import { IsNumber, Validate, IsString, IsArray } from 'class-validator';
-import { Config, JsonSchema } from '@kibibit/configit';
+import { IsNumber, IsString } from 'class-validator';
+
+import { BaseConfig, Configuration, ConfigVariable } from '@kibibit/configit';
 
-@Exclude()
-export class ProjectConfig extends Config {
-  @Expose()
+@Configuration()
+export class ProjectConfig extends BaseConfig {
+  @ConfigVariable('Server port')
   @IsNumber()
-  @Validate(JsonSchema, [
-    'Server port'
-  ])
   PORT: number;
+
+  @ConfigVariable([
+    'This is the slack API to talk and report to channel "hello"'
+  ])
+  @IsString()
+  SLACK_API_KEY: string;
+}
+
 }
 ```
 Then, in your code, initialize the config service when you bootstrap your application
 ```typescript
+import express from 'express';
 import { ConfigService } from '@kibibit/configit';
 import { ProjectConfig } from './project-config.model';
-import express from "express";
 
 export const configService = new ConfigService<ProjectConfig>(ProjectConfig);
-
-console.log(configService.config.PORT);
-
 const app = express();
 
-app.get( "/", ( req, res ) => {
-  res.send( "Hello world!" );
+app.get( '/', ( req, res ) => {
+  res.send( 'Hello world!' );
 } );
 
 app.listen(configService.config.PORT, () => {
-  console.log( `server started at http://localhost:${ configService.config.PORT }` );
-} );
+  console.log(
+    `server started at http://localhost:${ configService.config.PORT }`
+  );
+});
+
 ```
 
+### Extending the Configuration Service (Recommended)
+You can extend the configuration to add your own customization and functions!
+```typescript
+import { chain } from 'lodash';
+
+import { ConfigService, IConfigServiceOptions } from '@kibibit/configit';
+import { WinstonLogger } from '@kibibit/nestjs-winston';
+
+import { ExtProjectConfig } from './ext-project-config.model';
+import { initializeWinston } from './winston.config';
+
+export class ExtConfigService extends ConfigService<ExtProjectConfig> {
+  public logger: WinstonLogger;
+  constructor(passedConfig?: Partial<ExtProjectConfig>, options: IConfigServiceOptions = {}) {
+    super(ExtProjectConfig, passedConfig, options);
+
+    initializeWinston(this.appRoot);
+    this.logger = new WinstonLogger('');
+  }
+
+  getSlackApiObject() {
+    const slackApiObject = chain(this.toPlainObject())
+      .pickBy((value, key) => key.startsWith('SLACK_'))
+      .mapKeys((value, key) => key.replace(/^SLACK_/i, ''))
+      .mapKeys((value, key) => key.toLowerCase())
+      .value();
+
+    return slackApiObject;
+  }
+}
+
+export const configService = new ExtConfigService() as ExtConfigService;
+
+```
+
+
+## Features
+- Supports JSON\YAML files\env variables\cli flags as configuration inputs. See `yaml-config` in the examples folder
+- Supports shared configuration files (same file shared for multiple projects)
+- initialize a configuration file with `--saveToFile` or `--init`
+- save configuration files anywhere above your project's package.json
+- forced singleton for a single installation (reuse same class)
+- testable
+- The ability to create json schemas automatically and add descriptions
+  to configuration variables
+- Get meaningfull errors when configuration is wrong!
+
+## Examples
+See the examples folder for a variety of usage examples
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -79,6 +145,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!
 
+<div>Logo made by <a href="https://www.flaticon.com/authors/good-ware" title="Good Ware">Good Ware</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>
+<br>
+
 ## Stay in touch
 
 - Author - [Neil Kalman](https://github.com/thatkookooguy)

package/lib/config.model.d.ts

@@ -1,8 +1,19 @@
+/// <reference types="lodash" />
+import { EFileFormats } from './config.service';
 export declare const NODE_ENVIRONMENT_OPTIONS: string[];
-export declare class Config {
+declare type TClass<T> = (new (partial: Partial<T>) => T);
+export declare class BaseConfig {
+    name: string;
     NODE_ENV: string;
     saveToFile: boolean;
-    constructor(partial?: Partial<Config>);
-    toJsonSchema(): import("openapi3-ts").SchemaObject;
+    convert: EFileFormats;
+    wrapper: any;
+    constructor(partial?: Partial<BaseConfig>);
+    toJsonSchema(): import("lodash").Omit<import("openapi3-ts").SchemaObject, "properties.NODE_ENV" | "properties.nodeEnv" | "properties.saveToFile" | "properties.convert" | "properties.wrapper">;
+    private cleanFileName;
+    setName(genericClass: TClass<BaseConfig>): void;
+    getFileName(ext: string, isSharedConfig?: boolean): string;
+    getSchemaFileName(): string;
 }
+export {};
 //# sourceMappingURL=config.model.d.ts.map

package/lib/config.model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.model.d.ts","sourceRoot":"","sources":["../src/config.model.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,wBAAwB,UAMpC,CAAC;AAEF,qBACa,MAAM;IAOjB,QAAQ,SAAiB;IAOzB,UAAU,UAAS;gBAEP,OAAO,GAAE,OAAO,CAAC,MAAM,CAAM;IAIlC,YAAY;CAwBpB"}
+{"version":3,"file":"config.model.d.ts","sourceRoot":"","sources":["../src/config.model.ts"],"names":[],"mappings":";AAUA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAIhD,eAAO,MAAM,wBAAwB,UAMpC,CAAC;AAEF,aAAK,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAElD,qBACa,UAAU;IACrB,IAAI,EAAE,MAAM,CAAC;IAQb,QAAQ,SAAiB;IAOzB,UAAU,UAAS;IAQnB,OAAO,EAAE,YAAY,CAAC;IAQtB,OAAO,MAAC;gBAEI,OAAO,GAAE,OAAO,CAAC,UAAU,CAAM;IAItC,YAAY;IAsCnB,OAAO,CAAC,aAAa;IAOrB,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC;IAIxC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,cAAc,UAAQ;IAU/C,iBAAiB;CAGlB"}

package/lib/config.model.js

@@ -9,11 +9,12 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Config = exports.NODE_ENVIRONMENT_OPTIONS = void 0;
-const class_transformer_1 = require("class-transformer");
+exports.BaseConfig = exports.NODE_ENVIRONMENT_OPTIONS = void 0;
 const class_validator_1 = require("class-validator");
 const class_validator_jsonschema_1 = require("class-validator-jsonschema");
 const lodash_1 = require("lodash");
+const config_service_1 = require("./config.service");
+const environment_service_1 = require("./environment.service");
 const json_schema_validator_1 = require("./json-schema.validator");
 exports.NODE_ENVIRONMENT_OPTIONS = [
     'google',
@@ -22,14 +23,13 @@ exports.NODE_ENVIRONMENT_OPTIONS = [
     'test',
     'devcontainer'
 ];
-let Config = class Config {
+let BaseConfig = class BaseConfig {
     constructor(partial = {}) {
         this.NODE_ENV = 'development';
         this.saveToFile = false;
         Object.assign(this, partial);
     }
     toJsonSchema() {
-        var _a, _b;
         const configJsonSchemaObj = (0, class_validator_jsonschema_1.validationMetadatasToSchemas)({
             additionalConverters: {
                 JsonSchema: (meta) => ({
@@ -39,35 +39,81 @@ let Config = class Config {
         });
         const classForSchema = (0, lodash_1.chain)(configJsonSchemaObj)
             .keys()
-            .filter((className) => className !== 'Config')
-            .first()
+            .find((className) => className === this.constructor.name)
             .value();
-        const configJsonSchema = configJsonSchemaObj[classForSchema];
-        (_a = configJsonSchema.properties) === null || _a === void 0 ? true : delete _a.nodeEnv;
-        (_b = configJsonSchema.required) === null || _b === void 0 ? void 0 : _b.splice(configJsonSchema.required.indexOf('nodeEnv'), 1);
+        const configJsonSchema = (0, lodash_1.chain)(configJsonSchemaObj[classForSchema])
+            .omit([
+            'properties.NODE_ENV',
+            'properties.nodeEnv',
+            'properties.saveToFile',
+            'properties.convert',
+            'properties.wrapper'
+        ])
+            .value();
+        if (configJsonSchema.required) {
+            configJsonSchema.required = (0, lodash_1.chain)(configJsonSchema.required)
+                .filter((value) => ![
+                'NODE_ENV',
+                'nodeEnv',
+                'saveToFile',
+                'convert',
+                'wrapper'
+            ].includes(value))
+                .value();
+        }
         return configJsonSchema;
     }
+    cleanFileName(fileName) {
+        return (0, lodash_1.chain)(fileName)
+            .replace(/Config$/i, '')
+            .replace(/Configuration$/i, '')
+            .value();
+    }
+    setName(genericClass) {
+        this.name = this.cleanFileName(genericClass.name);
+    }
+    getFileName(ext, isSharedConfig = false) {
+        return [
+            '.env.',
+            (0, environment_service_1.getEnvironment)(), '.',
+            isSharedConfig ? '_shared_.' : '',
+            (0, lodash_1.kebabCase)(this.name), '.',
+            ext
+        ].join('');
+    }
+    getSchemaFileName() {
+        return `${(0, lodash_1.kebabCase)(this.name)}.env.schema.json`;
+    }
 };
 __decorate([
-    (0, class_transformer_1.Expose)(),
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsIn)(exports.NODE_ENVIRONMENT_OPTIONS),
-    (0, class_validator_1.Validate)(json_schema_validator_1.JsonSchema, [
-        'Tells which env file to use and what environment we are running on'
-    ]),
+    (0, json_schema_validator_1.ConfigVariable)('Tells which env file to use and what environment we are running on', { exclude: true }),
     __metadata("design:type", Object)
-], Config.prototype, "NODE_ENV", void 0);
+], BaseConfig.prototype, "NODE_ENV", void 0);
 __decorate([
     (0, class_validator_1.IsBoolean)(),
-    (0, class_validator_1.Validate)(json_schema_validator_1.JsonSchema, [
+    (0, json_schema_validator_1.ConfigVariable)([
         'Create a file made out of the internal config. This is mostly for ',
         'merging command line, environment, and file variables to a single instance'
-    ]),
+    ], { exclude: true }),
+    __metadata("design:type", Object)
+], BaseConfig.prototype, "saveToFile", void 0);
+__decorate([
+    (0, class_validator_1.IsEnum)(config_service_1.EFileFormats),
+    (0, class_validator_1.IsOptional)(),
+    (0, json_schema_validator_1.ConfigVariable)('Save the file to JSON if defaults to YAML and vise versa', { exclude: true }),
+    __metadata("design:type", String)
+], BaseConfig.prototype, "convert", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, json_schema_validator_1.ConfigVariable)('Object Wrapper for saved file', { exclude: true }),
     __metadata("design:type", Object)
-], Config.prototype, "saveToFile", void 0);
-Config = __decorate([
-    (0, class_transformer_1.Exclude)(),
+], BaseConfig.prototype, "wrapper", void 0);
+BaseConfig = __decorate([
+    (0, json_schema_validator_1.Configuration)(),
     __metadata("design:paramtypes", [Object])
-], Config);
-exports.Config = Config;
+], BaseConfig);
+exports.BaseConfig = BaseConfig;
 //# sourceMappingURL=config.model.js.map

package/lib/config.model.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.model.js","sourceRoot":"","sources":["../src/config.model.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAoD;AACpD,qDAKyB;AACzB,2EAA0E;AAC1E,mCAA+B;AAE/B,mEAAqD;AAExC,QAAA,wBAAwB,GAAG;IACtC,QAAQ;IACR,aAAa;IACb,YAAY;IACZ,MAAM;IACN,cAAc;CACf,CAAC;AAGF,IAAa,MAAM,GAAnB,MAAa,MAAM;IAgBjB,YAAY,UAA2B,EAAE;QATzC,aAAQ,GAAG,aAAa,CAAC;QAOzB,eAAU,GAAG,KAAK,CAAC;QAGjB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;IAEM,YAAY;;QACjB,MAAM,mBAAmB,GAAG,IAAA,yDAA4B,EAAC;YACvD,oBAAoB,EAAE;gBACpB,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;oBACrB,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;iBACvC,CAAC;aACH;SACF,CAAC,CAAC;QAEH,MAAM,cAAc,GAAG,IAAA,cAAK,EAAC,mBAAmB,CAAC;aAC9C,IAAI,EAAE;aACN,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,QAAQ,CAAC;aAC7C,KAAK,EAAE;aACP,KAAK,EAAE,CAAC;QACX,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAEtD,MAAA,gBAAgB,CAAC,UAAU,+CAAE,OAAO,CAAC;QAC5C,MAAA,gBAAgB,CAAC,QAAQ,0CAAE,MAAM,CAC/B,gBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,EAC5C,CAAC,CACF,CAAC;QAEF,OAAO,gBAAgB,CAAC;IAC1B,CAAC;CACF,CAAA;AArCC;IANC,IAAA,0BAAM,GAAE;IACR,IAAA,0BAAQ,GAAE;IACV,IAAA,sBAAI,EAAC,gCAAwB,CAAC;IAC9B,IAAA,0BAAQ,EAAC,kCAAU,EAAE;QACpB,oEAAoE;KACrE,CAAC;;wCACuB;AAOzB;IALC,IAAA,2BAAS,GAAE;IACX,IAAA,0BAAQ,EAAC,kCAAU,EAAE;QACpB,oEAAoE;QACpE,4EAA4E;KAC7E,CAAC;;0CACiB;AAdR,MAAM;IADlB,IAAA,2BAAO,GAAE;;GACG,MAAM,CA4ClB;AA5CY,wBAAM"}
+{"version":3,"file":"config.model.js","sourceRoot":"","sources":["../src/config.model.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAMyB;AACzB,2EAA0E;AAC1E,mCAA0C;AAE1C,qDAAgD;AAChD,+DAAuD;AACvD,mEAAwE;AAE3D,QAAA,wBAAwB,GAAG;IACtC,QAAQ;IACR,aAAa;IACb,YAAY;IACZ,MAAM;IACN,cAAc;CACf,CAAC;AAKF,IAAa,UAAU,GAAvB,MAAa,UAAU;IAkCrB,YAAY,UAA+B,EAAE;QAzB7C,aAAQ,GAAG,aAAa,CAAC;QAOzB,eAAU,GAAG,KAAK,CAAC;QAmBjB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;IAEM,YAAY;QACjB,MAAM,mBAAmB,GAAG,IAAA,yDAA4B,EAAC;YACvD,oBAAoB,EAAE;gBACpB,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;oBACrB,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;iBACvC,CAAC;aACH;SACF,CAAC,CAAC;QAEH,MAAM,cAAc,GAAG,IAAA,cAAK,EAAC,mBAAmB,CAAC;aAC9C,IAAI,EAAE;aACN,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;aACxD,KAAK,EAAE,CAAC;QACX,MAAM,gBAAgB,GAAG,IAAA,cAAK,EAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;aAChE,IAAI,CAAC;YACJ,qBAAqB;YACrB,oBAAoB;YACpB,uBAAuB;YACvB,oBAAoB;YACpB,oBAAoB;SACrB,CAAC;aACD,KAAK,EAAE,CAAC;QAEX,IAAI,gBAAgB,CAAC,QAAQ,EAAE;YAC7B,gBAAgB,CAAC,QAAQ,GAAG,IAAA,cAAK,EAAC,gBAAgB,CAAC,QAAQ,CAAC;iBACzD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAClB,UAAU;gBACV,SAAS;gBACT,YAAY;gBACZ,SAAS;gBACT,SAAS;aACV,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;iBACjB,KAAK,EAAE,CAAC;SACZ;QAED,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,aAAa,CAAC,QAAgB;QACpC,OAAO,IAAA,cAAK,EAAC,QAAQ,CAAC;aACnB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;aACvB,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC;aAC9B,KAAK,EAAE,CAAC;IACb,CAAC;IAED,OAAO,CAAC,YAAgC;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,WAAW,CAAC,GAAW,EAAE,cAAc,GAAG,KAAK;QAC7C,OAAO;YACL,OAAO;YACP,IAAA,oCAAc,GAAE,EAAE,GAAG;YACrB,cAAc,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;YACjC,IAAA,kBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG;YACzB,GAAG;SACJ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACb,CAAC;IAED,iBAAiB;QACf,OAAO,GAAI,IAAA,kBAAS,EAAC,IAAI,CAAC,IAAI,CAAE,kBAAkB,CAAC;IACrD,CAAC;CACF,CAAA;AA3FC;IANC,IAAA,0BAAQ,GAAE;IACV,IAAA,sBAAI,EAAC,gCAAwB,CAAC;IAC9B,IAAA,sCAAc,EACb,oEAAoE,EACpE,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB;;4CACwB;AAOzB;IALC,IAAA,2BAAS,GAAE;IACX,IAAA,sCAAc,EAAC;QACd,oEAAoE;QACpE,4EAA4E;KAC7E,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;8CACF;AAQnB;IANC,IAAA,wBAAM,EAAC,6BAAY,CAAC;IACpB,IAAA,4BAAU,GAAE;IACZ,IAAA,sCAAc,EACb,0DAA0D,EAC1D,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB;;2CACqB;AAQtB;IANC,IAAA,0BAAQ,GAAE;IACV,IAAA,4BAAU,GAAE;IACZ,IAAA,sCAAc,EACb,+BAA+B,EAC/B,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB;;2CACO;AAhCG,UAAU;IADtB,IAAA,qCAAa,GAAE;;GACH,UAAU,CAoGtB;AApGY,gCAAU"}

package/lib/config.service.d.ts

@@ -1,25 +1,54 @@
-import { Config } from './config.model';
+import { BaseConfig } from './config.model';
 export interface IConfigServiceOptions {
     convertToCamelCase?: boolean;
+    fileFormat?: EFileFormats;
+    sharedConfig?: TClass<BaseConfig>[];
+    schemaFolderName?: string;
+    showOverrides?: boolean;
+    configFolderRelativePath?: string;
+    encryptConfig?: {
+        algorithm: string;
+        secret: string;
+    };
 }
-declare type TClass<T> = new (partial: Partial<T>) => T;
-export declare class ConfigService<T extends Config> {
-    private readonly mode;
+export declare enum EFileFormats {
+    json = "json",
+    yaml = "yaml",
+    jsonc = "jsonc",
+    hjson = "hjson"
+}
+export interface IWriteConfigToFileOptions {
+    fileFormat: EFileFormats;
+    excludeSchema?: boolean;
+    objectWrapper?: string;
+    outputFolder?: string;
+}
+declare type TClass<T> = (new (partial: Partial<T>) => T);
+export declare class ConfigService<T extends BaseConfig> {
+    private fileExtension;
+    readonly mode: string;
     readonly options: IConfigServiceOptions;
     readonly config?: T;
     readonly genericClass?: TClass<T>;
     readonly fileName?: string;
-    readonly jsonSchemaFullname?: string;
-    readonly defaultConfigFilePath?: string;
     readonly configFileName: string;
-    readonly configFilePath?: string;
+    readonly configFileFullPath?: string;
     readonly configFileRoot?: string;
     readonly appRoot: string;
     constructor(givenClass: TClass<T>, passedConfig?: Partial<T>, options?: IConfigServiceOptions);
     toPlainObject(): Record<string, any>;
+    writeConfigToFile({ fileFormat, excludeSchema, objectWrapper, outputFolder }?: IWriteConfigToFileOptions): void;
+    private createConfigInstance;
+    private initializeNconf;
+    private writeSchema;
+    private orderObjectKeys;
+    private writeSharedSchema;
+    private writeSharedConfigToFile;
     private findRoot;
     private findConfigRoot;
     private validateInput;
+    private validateSharedInput;
+    private generateTerminalTitleBar;
 }
 export {};
 //# sourceMappingURL=config.service.d.ts.map

package/lib/config.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.service.d.ts","sourceRoot":"","sources":["../src/config.service.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,MAAM,WAAW,qBAAqB;IACpC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAOD,aAAK,MAAM,CAAC,CAAC,IAAI,KAAK,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAQhD,qBAAa,aAAa,CAAC,CAAC,SAAS,MAAM;IACzC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAuB;IAC5C,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAC;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACpB,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IACxC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAM;IACrC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBAGvB,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,EACrB,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EACzB,OAAO,GAAE,qBAA0B;IAuErC,aAAa;IAIb,OAAO,CAAC,QAAQ;IAgBhB,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,aAAa;CAYtB"}
+{"version":3,"file":"config.service.d.ts","sourceRoot":"","sources":["../src/config.service.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAY5C,MAAM,WAAW,qBAAqB;IACpC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;IACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,aAAa,CAAC,EAAE;QACd,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,oBAAY,YAAY;IACtB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,yBAAyB;IACtC,UAAU,EAAE,YAAY,CAAC;IACzB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAKD,aAAK,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAQlD,qBAAa,aAAa,CAAC,CAAC,SAAS,UAAU;IAC7C,OAAO,CAAC,aAAa,CAAe;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAoB;IACzC,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAC;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACpB,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAM;IACrC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBAGvB,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,EACrB,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EACzB,OAAO,GAAE,qBAA0B;IA+DrC,aAAa;IAKb,iBAAiB,CACf,EACE,UAAU,EACV,aAAa,EACb,aAAa,EACb,YAAY,EACb,GAAE,yBAGF;IA8DH,OAAO,CAAC,oBAAoB;IAO5B,OAAO,CAAC,eAAe;IAqDvB,OAAO,CAAC,WAAW;IAuCnB,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,uBAAuB;IAoC/B,OAAO,CAAC,QAAQ;IAgBhB,OAAO,CAAC,cAAc;IAsBtB,OAAO,CAAC,aAAa;IAsCrB,OAAO,CAAC,mBAAmB;IAqB3B,OAAO,CAAC,wBAAwB;CAQjC"}