@kibibit/configit 1.0.0-beta.2 → 1.0.0-beta.20

package/src/__snapshots__/config.service.spec.ts.snap

@@ -0,0 +1,314 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Config Service Service can SAVE the config files with saveToFile or init param 1`] = `
+Array [
+  "/.schemas/pizza.env.schema.json",
+  Object {
+    "properties": Object {
+      "toppings": Object {
+        "description": "optional toppings for the pizza",
+        "items": Object {
+          "enum": Array [
+            "cheese",
+            "pepperoni",
+            "sausage",
+          ],
+          "type": "string",
+        },
+        "type": "array",
+      },
+    },
+    "required": Array [],
+    "type": "object",
+  },
+  Object {
+    "spaces": 2,
+  },
+]
+`;
+
+exports[`Config Service Service can SAVE the config files with saveToFile or init param 2`] = `
+Array [
+  "/.env.test.pizza.json",
+  Object {
+    "$schema": ".schemas/pizza.env.schema.json",
+    "toppings": Array [
+      "cheese",
+    ],
+  },
+  Object {
+    "spaces": 2,
+  },
+]
+`;
+
+exports[`Config Service Service can Save and CONVERT the config files with saveToFile or init param 1`] = `"/.env.test.pizza.yaml"`;
+
+exports[`Config Service Service can Save and CONVERT the config files with saveToFile or init param 2`] = `
+"
+# yaml-language-server: $schema=.schemas/pizza.env.schema.json
+toppings:
+  - cheese
+
+"
+`;
+
+exports[`Config Service Service can be forced to be created again 1`] = `
+PizzaConfig {
+  "NODE_ENV": "test",
+  "name": "Pizza",
+  "saveToFile": false,
+  "toppings": Array [
+    "cheese",
+  ],
+}
+`;
+
+exports[`Config Service Service can initialize the config files with saveToFile or init param 1`] = `
+Array [
+  "/.env.test.pizza.json",
+  Object {
+    "$schema": ".schemas/pizza.env.schema.json",
+    "toppings": undefined,
+  },
+  Object {
+    "spaces": 2,
+  },
+]
+`;
+
+exports[`Config Service Service can initialize the config files with saveToFile or init param 2`] = `
+Array [
+  "/.schemas/pizza.env.schema.json",
+  Object {
+    "properties": Object {
+      "toppings": Object {
+        "description": "optional toppings for the pizza",
+        "items": Object {
+          "enum": Array [
+            "cheese",
+            "pepperoni",
+            "sausage",
+          ],
+          "type": "string",
+        },
+        "type": "array",
+      },
+    },
+    "required": Array [],
+    "type": "object",
+  },
+  Object {
+    "spaces": 2,
+  },
+]
+`;
+
+exports[`Config Service Service can return a plain object 1`] = `
+Object {
+  "toppings": Array [
+    "cheese",
+  ],
+}
+`;
+
+exports[`Config Service Service can save yaml without schema 1`] = `"/.env.test.pizza.yaml"`;
+
+exports[`Config Service Service can save yaml without schema 2`] = `
+"toppings:
+  - cheese
+"
+`;
+
+exports[`Config Service Service returns correct empty yaml when config is empty 1`] = `"/.env.test.pizza.yaml"`;
+
+exports[`Config Service Service returns correct empty yaml when config is empty 2`] = `"# yaml-language-server: $schema=.schemas/pizza.env.schema.json"`;
+
+exports[`Config Service Shared Configurations Can define shared config 1`] = `"/.schemas/toppings.env.schema.json"`;
+
+exports[`Config Service Shared Configurations Can define shared config 2`] = `
+Object {
+  "properties": Object {
+    "INCLUDE_MEAT": Object {
+      "description": "(OVERRIDE SHARED CONFIG)
+Should meat be included in the toppings options",
+      "type": "boolean",
+    },
+  },
+  "required": Array [],
+  "type": "object",
+}
+`;
+
+exports[`Config Service Shared Configurations Can define shared config 3`] = `"/.schemas/pizza.env.schema.json"`;
+
+exports[`Config Service Shared Configurations Can define shared config 4`] = `
+Object {
+  "properties": Object {
+    "toppings": Object {
+      "description": "optional toppings for the pizza",
+      "items": Object {
+        "enum": Array [
+          "cheese",
+          "pepperoni",
+          "sausage",
+        ],
+        "type": "string",
+      },
+      "type": "array",
+    },
+  },
+  "required": Array [],
+  "type": "object",
+}
+`;
+
+exports[`Config Service Shared Configurations Can define shared config 5`] = `"/.env.test.pizza.json"`;
+
+exports[`Config Service Shared Configurations Can define shared config 6`] = `
+Object {
+  "$schema": ".schemas/pizza.env.schema.json",
+  "toppings": Array [
+    "cheese",
+  ],
+}
+`;
+
+exports[`Config Service Shared Configurations Can define shared config 7`] = `"/.env.test._shared_.toppings.json"`;
+
+exports[`Config Service Shared Configurations Can define shared config 8`] = `
+Object {
+  "$schema": ".schemas/toppings.env.schema.json",
+  "INCLUDE_MEAT": true,
+}
+`;
+
+exports[`Config Service wrap variables in attribute JSON 1`] = `"/.schemas/pizza.env.schema.json"`;
+
+exports[`Config Service wrap variables in attribute JSON 2`] = `
+Object {
+  "properties": Object {
+    "toppings": Object {
+      "description": "optional toppings for the pizza",
+      "items": Object {
+        "enum": Array [
+          "cheese",
+          "pepperoni",
+          "sausage",
+        ],
+        "type": "string",
+      },
+      "type": "array",
+    },
+  },
+  "required": Array [],
+  "type": "object",
+}
+`;
+
+exports[`Config Service wrap variables in attribute JSON 3`] = `"/.env.test.pizza.json"`;
+
+exports[`Config Service wrap variables in attribute JSON 4`] = `
+Object {
+  "env_variables": Object {
+    "$schema": ".schemas/pizza.env.schema.json",
+    "toppings": Array [
+      "cheese",
+    ],
+  },
+}
+`;
+
+exports[`Config Service wrap variables in attribute JSONC 1`] = `"/.schemas/pizza.env.schema.json"`;
+
+exports[`Config Service wrap variables in attribute JSONC 2`] = `
+Object {
+  "properties": Object {
+    "toppings": Object {
+      "description": "optional toppings for the pizza",
+      "items": Object {
+        "enum": Array [
+          "cheese",
+          "pepperoni",
+          "sausage",
+        ],
+        "type": "string",
+      },
+      "type": "array",
+    },
+  },
+  "required": Array [],
+  "type": "object",
+}
+`;
+
+exports[`Config Service wrap variables in attribute JSONC 3`] = `"/.env.test.pizza.jsonc"`;
+
+exports[`Config Service wrap variables in attribute JSONC 4`] = `
+Object {
+  "env_variables": Object {
+    "$schema": ".schemas/pizza.env.schema.json",
+    "toppings": Array [
+      "cheese",
+    ],
+  },
+}
+`;
+
+exports[`Config Service wrap variables in attribute YAML 1`] = `"/.env.test.pizza.yaml"`;
+
+exports[`Config Service wrap variables in attribute YAML 2`] = `
+"
+# yaml-language-server: $schema=.schemas/pizza.env.schema.json
+env_variables:
+  toppings:
+    - cheese
+
+"
+`;
+
+exports[`Config Service writeConfigToFile HJSON 1`] = `"/.env.test.pizza.hjson"`;
+
+exports[`Config Service writeConfigToFile HJSON 2`] = `
+"{
+  env_variables:
+  {
+    toppings:
+    [
+      cheese
+    ]
+  }
+}"
+`;
+
+exports[`Config Service writeConfigToFile JSON 1`] = `"/.env.test.pizza.json"`;
+
+exports[`Config Service writeConfigToFile JSON 2`] = `
+Object {
+  "env_variables": Object {
+    "toppings": Array [
+      "cheese",
+    ],
+  },
+}
+`;
+
+exports[`Config Service writeConfigToFile JSONC 1`] = `"/.env.test.pizza.jsonc"`;
+
+exports[`Config Service writeConfigToFile JSONC 2`] = `
+Object {
+  "env_variables": Object {
+    "toppings": Array [
+      "cheese",
+    ],
+  },
+}
+`;
+
+exports[`Config Service writeConfigToFile YAML 1`] = `"/.env.test.pizza.yaml"`;
+
+exports[`Config Service writeConfigToFile YAML 2`] = `
+"env_variables:
+  toppings:
+    - cheese"
+`;

package/src/config.errors.spec.ts

@@ -0,0 +1,26 @@
+import { validateSync } from 'class-validator';
+import strip from 'strip-color';
+
+import { ConfigValidationError } from './config.errors';
+import { PizzaConfig, ToppingEnum } from './pizza.config.model.mock';
+
+describe('Config Model', () => {
+  let validationError: ConfigValidationError;
+  beforeEach(() => {
+    validationError = new ConfigValidationError([]);
+  });
+  test('validationError creation', () => {
+    expect(validationError).toBeDefined();
+  });
+
+  test('ConfigValidationError beautify class-validator errors', () => {
+    const config = new PizzaConfig({
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      toppings: [ ToppingEnum.Cheese, ToppingEnum.Pepperoni, 5 as any ]
+    });
+    const validationErrors = validateSync(config);
+    validationError = new ConfigValidationError(validationErrors);
+
+    expect(strip(validationError.message).replace(/(?:\r\n|\r|\n)/g, '\n')).toMatchSnapshot();
+  });
+});

package/src/config.model.spec.ts

@@ -0,0 +1,52 @@
+
+import { BaseConfig } from './config.model';
+import { setEnvironment } from './environment.service';
+import { PizzaConfig } from './pizza.config.model.mock';
+
+setEnvironment('test');
+
+describe('Config Model', () => {
+  let config: BaseConfig;
+  beforeEach(() => {
+    process.env.NODE_ENV = 'test';
+    config = new BaseConfig({
+      NODE_ENV: 'test'
+    });
+    config.setName(BaseConfig);
+  });
+  test('Base config creation', () => {
+    expect(config).toBeDefined();
+  });
+
+  test('config.getFileName', () => {
+    expect(config.getFileName('json'))
+      .toEqual('.env.test.base.json');
+    expect(config.getFileName('yaml'))
+      .toEqual('.env.test.base.yaml');
+    expect(config.getFileName('json', true))
+      .toEqual('.env.test._shared_.base.json');
+
+    config.setName(PizzaConfig);
+
+    expect(config.getFileName('json'))
+      .toEqual('.env.test.pizza.json');
+    expect(config.getFileName('yaml'))
+      .toEqual('.env.test.pizza.yaml');
+    expect(config.getFileName('json', true))
+      .toEqual('.env.test._shared_.pizza.json');
+  });
+
+  test('config.getSchemaFileName', () => {
+    expect(config.getSchemaFileName())
+      .toEqual('base.env.schema.json');
+  });
+
+  test('config.toJsonSchema', () => {
+    const pizzaConfig = new PizzaConfig({
+      NODE_ENV: 'test'
+    });
+    pizzaConfig.setName(PizzaConfig);
+    expect(pizzaConfig.toJsonSchema())
+      .toMatchSnapshot();
+  });
+});

package/src/config.model.ts

@@ -1,41 +1,65 @@
-import { Exclude, Expose } from 'class-transformer';
 import {
   IsBoolean,
+  IsEnum,
   IsIn,
-  IsString,
-  Validate
+  IsOptional,
+  IsString
 } from 'class-validator';
 import { validationMetadatasToSchemas } from 'class-validator-jsonschema';
-import { chain } from 'lodash';
+import { chain, kebabCase } from 'lodash';
 
-import { JsonSchema } from './json-schema.validator';
+import { EFileFormats } from './config.service';
+import { getEnvironment } from './environment.service';
+import { Configuration, ConfigVariable } from './json-schema.validator';
 
 export const NODE_ENVIRONMENT_OPTIONS = [
   'google',
   'development',
   'production',
   'test',
-  'devcontainer'
+  'devcontainer',
+  'staging',
+  'e2e'
 ];
 
-@Exclude()
-export class Config {
-  @Expose()
+type TClass<T> = (new (partial: Partial<T>) => T);
+
+@Configuration()
+export class BaseConfig {
+  name: string;
+
   @IsString()
   @IsIn(NODE_ENVIRONMENT_OPTIONS)
-  @Validate(JsonSchema, [
-    'Tells which env file to use and what environment we are running on'
-  ])
+  @ConfigVariable(
+    'Tells which env file to use and what environment we are running on',
+    { exclude: true }
+  )
   NODE_ENV = 'development';
 
   @IsBoolean()
-  @Validate(JsonSchema, [
+  @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 })
   saveToFile = false;
 
-  constructor(partial: Partial<Config> = {}) {
+  @IsEnum(EFileFormats)
+  @IsOptional()
+  @ConfigVariable(
+    'Save the file to JSON if defaults to YAML and vise versa',
+    { exclude: true }
+  )
+  convert: EFileFormats;
+
+  @IsString()
+  @IsOptional()
+  @ConfigVariable(
+    'Object Wrapper for saved file',
+    { exclude: true }
+  )
+  wrapper;
+
+  constructor(partial: Partial<BaseConfig> = {}) {
     Object.assign(this, partial);
   }
 
@@ -50,17 +74,55 @@ export class Config {
 
     const classForSchema = chain(configJsonSchemaObj)
       .keys()
-      .filter((className) => className !== 'Config')
-      .first()
+      .find((className) => className === this.constructor.name)
+      .value();
+    const configJsonSchema = chain(configJsonSchemaObj[classForSchema])
+      .omit([
+        'properties.NODE_ENV',
+        'properties.nodeEnv',
+        'properties.saveToFile',
+        'properties.convert',
+        'properties.wrapper'
+      ])
       .value();
-    const configJsonSchema = configJsonSchemaObj[classForSchema];
 
-    delete configJsonSchema.properties?.nodeEnv;
-    configJsonSchema.required?.splice(
-      configJsonSchema.required.indexOf('nodeEnv'),
-      1
-    );
+    if (configJsonSchema.required) {
+      configJsonSchema.required = chain(configJsonSchema.required)
+        .filter((value) => ![
+          'NODE_ENV',
+          'nodeEnv',
+          'saveToFile',
+          'convert',
+          'wrapper'
+        ].includes(value))
+        .value();
+    }
 
     return configJsonSchema;
   }
+
+  private cleanFileName(fileName: string) {
+    return chain(fileName)
+      .replace(/Config$/i, '')
+      .replace(/Configuration$/i, '')
+      .value();
+  }
+
+  setName(genericClass: TClass<BaseConfig>) {
+    this.name = this.cleanFileName(genericClass.name);
+  }
+
+  getFileName(ext: string, isSharedConfig = false) {
+    return [
+      '.env.',
+      getEnvironment(), '.',
+      isSharedConfig ? '_shared_.' : '',
+      kebabCase(this.name), '.',
+      ext
+    ].join('');
+  }
+
+  getSchemaFileName() {
+    return `${ kebabCase(this.name) }.env.schema.json`;
+  }
 }