@takaro/config 0.0.1

package/README.md

@@ -0,0 +1,36 @@
+# @takaro/config
+
+An opinionated config manager based on [node-convict](https://github.com/mozilla/node-convict)
+
+## Usage
+
+```ts
+import { Config, IBaseConfig } from '@takaro/config';
+
+interface IExampleConfig extends IBaseConfig {
+  test: string;
+}
+
+// This is a schema from convict
+const exampleSchema = {
+  test: {
+    doc: 'Test value',
+    format: String,
+    default: 'test',
+    env: 'TAKARO_TEST'
+  }
+};
+
+const config = new Config<IExampleConfig>([exampleSchema]);
+
+// ---
+
+config.load({ test: 1 });
+// Error! 'test' should be a string
+config.validate();
+
+// ---
+
+config.load({ test: 'Hello world' });
+config.get('test') // 'Hello world'
+```

package/dist/main.d.ts

@@ -0,0 +1,22 @@
+import convict, { Path, PathValue, Schema } from 'convict';
+export declare enum EXECUTION_MODE {
+    LOCAL = "local",
+    LAMBDA = "lambda"
+}
+export interface IBaseConfig {
+    app: {
+        name: string;
+    };
+    mode: 'development' | 'production' | 'test';
+    functions: {
+        executionMode: EXECUTION_MODE;
+    };
+}
+export declare const baseConfigConvict: Schema<IBaseConfig>;
+export declare class Config<T extends IBaseConfig> {
+    _config: convict.Config<T>;
+    constructor(valuesArray?: Schema<Partial<T>>[]);
+    get<K extends Path<T>>(arg: K): K extends null | undefined ? T : K extends Path<T> ? PathValue<T, K> : never;
+    load(data: Partial<T>): void;
+    validate(): void;
+}

package/dist/main.js

@@ -0,0 +1,55 @@
+import convict from 'convict';
+export var EXECUTION_MODE;
+(function (EXECUTION_MODE) {
+    EXECUTION_MODE["LOCAL"] = "local";
+    EXECUTION_MODE["LAMBDA"] = "lambda";
+})(EXECUTION_MODE || (EXECUTION_MODE = {}));
+export const baseConfigConvict = {
+    app: {
+        name: {
+            doc: 'Name of the running package',
+            format: String,
+            default: 'UNNAMED_PACKAGE',
+            env: 'APP_NAME',
+        },
+    },
+    mode: {
+        doc: 'The application mode',
+        format: ['development', 'production', 'test'],
+        default: 'production',
+        env: 'NODE_ENV',
+    },
+    functions: {
+        executionMode: {
+            doc: 'The mode to use when executing functions. Setting to "local" is VERY INSECURE! Only do it if you know what you are doing',
+            format: Object.values(EXECUTION_MODE),
+            default: EXECUTION_MODE.LAMBDA,
+            env: 'FUNCTIONS_EXECUTION_MODE',
+        },
+    },
+};
+export class Config {
+    constructor(valuesArray = []) {
+        const values = [...valuesArray, baseConfigConvict].reduce((acc, curr) => {
+            return { ...acc, ...curr };
+        }, {});
+        this._config = convict(values);
+    }
+    // Thanks Diego :)
+    // https://twitter.com/diegohaz/status/1309489079378219009
+    get(arg) {
+        return this._config.get(arg);
+    }
+    load(data) {
+        this._config.load(data);
+    }
+    validate() {
+        this._config.validate({
+            allowed: 'strict',
+            output: (str) => {
+                throw new Error(str);
+            },
+        });
+    }
+}
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,OAAoC,MAAM,SAAS,CAAC;AAE3D,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,iCAAe,CAAA;IACf,mCAAiB,CAAA;AACnB,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB;AAYD,MAAM,CAAC,MAAM,iBAAiB,GAAwB;IACpD,GAAG,EAAE;QACH,IAAI,EAAE;YACJ,GAAG,EAAE,6BAA6B;YAClC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,iBAAiB;YAC1B,GAAG,EAAE,UAAU;SAChB;KACF;IACD,IAAI,EAAE;QACJ,GAAG,EAAE,sBAAsB;QAC3B,MAAM,EAAE,CAAC,aAAa,EAAE,YAAY,EAAE,MAAM,CAAC;QAC7C,OAAO,EAAE,YAAY;QACrB,GAAG,EAAE,UAAU;KAChB;IACD,SAAS,EAAE;QACT,aAAa,EAAE;YACb,GAAG,EAAE,0HAA0H;YAC/H,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC;YACrC,OAAO,EAAE,cAAc,CAAC,MAAM;YAC9B,GAAG,EAAE,0BAA0B;SAChC;KACF;CACF,CAAC;AAEF,MAAM,OAAO,MAAM;IAGjB,YAAY,cAAoC,EAAE;QAChD,MAAM,MAAM,GAAG,CAAC,GAAG,WAAW,EAAE,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACtE,OAAO,EAAE,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;QAC7B,CAAC,EAAE,EAAE,CAAC,CAAC;QACP,IAAI,CAAC,OAAO,GAAG,OAAO,CAAI,MAAmB,CAAC,CAAC;IACjD,CAAC;IAED,kBAAkB;IAClB,0DAA0D;IAC1D,GAAG,CAAoB,GAAM;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,CAAC,IAAgB;QACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,QAAQ;QACN,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;YACpB,OAAO,EAAE,QAAQ;YACjB,MAAM,EAAE,CAAC,GAAW,EAAE,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;SACF,CAAC,CAAC;IACL,CAAC;CACF"}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@takaro/config",
+  "version": "0.0.1",
+  "description": "An opinionated config handler",
+  "main": "dist/main.js",
+  "types": "dist/main.d.ts",
+  "type": "module",
+  "scripts": {
+    "start:dev": "tsc --watch --preserveWatchOutput -p ./tsconfig.build.json",
+    "build": "tsc -p ./tsconfig.build.json",
+    "test": "npm run test:unit --if-present && npm run test:integration --if-present",
+    "test:unit": "mocha --config ../../.mocharc.js src/**/*.unit.test.ts",
+    "test:integration": "echo 'No tests (yet :))'"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "convict": "^6.2.3"
+  },
+  "devDependencies": {
+    "@takaro/test": "0.0.1",
+    "@types/convict": "^6.1.1"
+  }
+}

package/src/__tests__/config.unit.test.ts

@@ -0,0 +1,32 @@
+import { expect } from '@takaro/test';
+
+import { Config, IBaseConfig } from '../main.js';
+
+interface ITestConfig extends IBaseConfig {
+  test: string;
+}
+
+const testConfigSchema = {
+  test: {
+    doc: 'Test value',
+    format: String,
+    default: 'test',
+  },
+};
+
+describe('config', () => {
+  it('Allows loading one config', () => {
+    const config = new Config<ITestConfig>();
+    expect(config.get('app.name')).to.equal('UNNAMED_PACKAGE');
+  });
+  it('Throws an error when validating', () => {
+    const config = new Config<ITestConfig>([testConfigSchema]);
+    // @ts-expect-error Testing something the compiler could catch...
+    config.load({ test: 1 });
+    expect(() => config.validate()).to.throw('test: must be of type String: value was 1');
+  });
+  it('Allows loading multiple configs', () => {
+    const config = new Config<ITestConfig>([testConfigSchema]);
+    expect(config.get('test')).to.equal('test');
+  });
+});

package/src/main.ts

@@ -0,0 +1,71 @@
+import convict, { Path, PathValue, Schema } from 'convict';
+
+export enum EXECUTION_MODE {
+  LOCAL = 'local',
+  LAMBDA = 'lambda',
+}
+
+export interface IBaseConfig {
+  app: {
+    name: string;
+  };
+  mode: 'development' | 'production' | 'test';
+  functions: {
+    executionMode: EXECUTION_MODE;
+  };
+}
+
+export const baseConfigConvict: Schema<IBaseConfig> = {
+  app: {
+    name: {
+      doc: 'Name of the running package',
+      format: String,
+      default: 'UNNAMED_PACKAGE',
+      env: 'APP_NAME',
+    },
+  },
+  mode: {
+    doc: 'The application mode',
+    format: ['development', 'production', 'test'],
+    default: 'production',
+    env: 'NODE_ENV',
+  },
+  functions: {
+    executionMode: {
+      doc: 'The mode to use when executing functions. Setting to "local" is VERY INSECURE! Only do it if you know what you are doing',
+      format: Object.values(EXECUTION_MODE),
+      default: EXECUTION_MODE.LAMBDA,
+      env: 'FUNCTIONS_EXECUTION_MODE',
+    },
+  },
+};
+
+export class Config<T extends IBaseConfig> {
+  public _config: convict.Config<T>;
+
+  constructor(valuesArray: Schema<Partial<T>>[] = []) {
+    const values = [...valuesArray, baseConfigConvict].reduce((acc, curr) => {
+      return { ...acc, ...curr };
+    }, {});
+    this._config = convict<T>(values as Schema<T>);
+  }
+
+  // Thanks Diego :)
+  // https://twitter.com/diegohaz/status/1309489079378219009
+  get<K extends Path<T>>(arg: K): K extends null | undefined ? T : K extends Path<T> ? PathValue<T, K> : never {
+    return this._config.get(arg);
+  }
+
+  load(data: Partial<T>) {
+    this._config.load(data);
+  }
+
+  validate() {
+    this._config.validate({
+      allowed: 'strict',
+      output: (str: string) => {
+        throw new Error(str);
+      },
+    });
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["./src/**/*.ts"],
+  "exclude": ["./src/**/*.test.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.esm.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"]
+}

package/typedoc.json

@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/main.ts"]
+}