@dsmrt/axiom-config 0.0.1

package/lib/index.d.ts

@@ -0,0 +1,36 @@
+export interface AwsConfigs {
+    account: string;
+    region: string;
+    profile: string;
+    baseParameterPath: string;
+}
+export interface Config {
+    name: string;
+    env: string;
+    aws: AwsConfigs;
+}
+export interface LoadConfigInput {
+    /**
+     * defaults to prod
+     */
+    env?: string;
+    /**
+     * Override configs
+     */
+    overrides?: Config;
+    /**
+     * Load config from a sub directory
+     */
+    cwd?: string;
+}
+export declare const importConfigFromPath: (path: string) => Config;
+export declare const loadConfig: <T extends object>(input?: LoadConfigInput) => Config & T;
+/**
+ * Simple object check.
+ */
+export declare function isObject(item: unknown): unknown;
+/**
+ * Deep merge two objects.
+ */
+export declare function mergeDeep(target: any, ...sources: any[]): any;
+export declare const configPath: (input?: LoadConfigInput) => string;

package/lib/index.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configPath = exports.mergeDeep = exports.isObject = exports.loadConfig = exports.importConfigFromPath = void 0;
+const fs_1 = require("fs");
+const find_up_1 = require("find-up");
+// TODO - Add validation here
+const importConfigFromPath = (path) => {
+    if (/\.json$/.test(path)) {
+        return JSON.parse((0, fs_1.readFileSync)(path).toString());
+    }
+    if (/\.(m)?[j|t]s$/.test(path)) {
+        /* eslint-disable */
+        return require(path);
+    }
+    throw new Error(`Path not found: {path}`);
+};
+exports.importConfigFromPath = importConfigFromPath;
+const loadConfig = (input) => {
+    // get the base file
+    const baseConfigFile = (0, exports.configPath)(input);
+    const baseConfig = (0, exports.importConfigFromPath)(baseConfigFile);
+    let overrides = input?.overrides || {};
+    // get the environment file
+    if (input?.env) {
+        const devConfig = (0, exports.importConfigFromPath)((0, exports.configPath)(input));
+        overrides = mergeDeep(devConfig, overrides);
+    }
+    // merge env file
+    return mergeDeep(baseConfig, overrides);
+};
+exports.loadConfig = loadConfig;
+/**
+ * Simple object check.
+ */
+function isObject(item) {
+    return item && typeof item === "object" && !Array.isArray(item);
+}
+exports.isObject = isObject;
+/**
+ * Deep merge two objects.
+ */
+function mergeDeep(target, ...sources) {
+    if (!sources.length)
+        return target;
+    const source = sources.shift();
+    if (isObject(target) && isObject(source)) {
+        for (const key in source) {
+            if (isObject(source[key])) {
+                if (!target[key])
+                    Object.assign(target, { [key]: {} });
+                mergeDeep(target[key], source[key]);
+            }
+            else {
+                Object.assign(target, { [key]: source[key] });
+            }
+        }
+    }
+    return mergeDeep(target, ...sources);
+}
+exports.mergeDeep = mergeDeep;
+const configPath = (input) => {
+    const envIndicator = input?.env ? `.${input.env}` : "";
+    const p = (0, find_up_1.sync)([
+        `.axiom${envIndicator}.json`,
+        `.axiom${envIndicator}.js`,
+        `.axiom${envIndicator}.mjs`,
+        `.axiom${envIndicator}.ts`,
+        `.axiom${envIndicator}.mts`,
+    ], { cwd: input?.cwd });
+    if (p === undefined)
+        throw new Error(`Axiom config files not found: .axiom${envIndicator}.json, .axiom${envIndicator}.js .axiom${envIndicator}.ts`);
+    return p;
+};
+exports.configPath = configPath;

package/package.json

@@ -0,0 +1,47 @@
+{
+    "name": "@dsmrt/axiom-config",
+    "version": "0.0.1",
+    "description": "Config library for axiom cli",
+    "main": "lib/index.js",
+    "repository": {
+        "type": "git",
+        "url": "git@github.com:dsmrt/axiom.git",
+        "directory": "config"
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
+    },
+    "scripts": {
+        "lint": "eslint ./src/ --ext .ts",
+        "lint:fix": "eslint ./src/ --ext .ts --fix",
+        "test": "vitest run --coverage -c ./vitest.config.ts",
+        "watch": "vitest watch --coverage -c ./vitest.config.ts",
+        "build": "tsc -d -p ./tsconfig.json"
+    },
+    "keywords": [
+        "axiom",
+        "config",
+        "aws"
+    ],
+    "author": {
+        "name": "Damien Smrt",
+        "url": "https://dsmrt.com"
+    },
+    "license": "MIT",
+    "devDependencies": {
+        "@types/node": "^20.9.0",
+        "@types/yargs": "^17.0.31",
+        "@typescript-eslint/eslint-plugin": "^6.12.0",
+        "@typescript-eslint/parser": "^6.12.0",
+        "@vitest/coverage-v8": "^0.34.6",
+        "eslint": "^8.54.0",
+        "prettier": "^3.1.0",
+        "ts-node": "^10.9.1",
+        "typescript": "^5.2.2",
+        "vitest": "^0.34.6"
+    },
+    "dependencies": {
+        "find-up": "^5.0.0",
+        "yargs": "^17.7.2"
+    }
+}

package/src/__mocks__/js/.axiom.dev.js

@@ -0,0 +1,15 @@
+/**
+ * @type {import("../../index").Config}
+ */
+const config = {
+  name: "my-prod-app",
+  env: "dev",
+  aws: {
+    account: "dev-account",
+    profile: "dev-profile",
+    region: "us-north-1",
+    baseParameterPath: "/dev-path",
+  },
+};
+
+module.exports = config;

package/src/__mocks__/js/.axiom.js

@@ -0,0 +1,14 @@
+/**
+ * @type {import("../../index").Config}
+ */
+const config = {
+  name: "my-prod-app",
+  env: "prod",
+  aws: {
+    account: "prod-account",
+    profile: "prod-profile",
+    region: "us-east-1",
+    baseParameterPath: "/prod-path",
+  },
+};
+module.exports = config;

package/src/__mocks__/json/.axiom.dev.json

@@ -0,0 +1,10 @@
+{
+  "name": "my-prod-app",
+  "env": "dev",
+  "aws": {
+    "account": "dev-account",
+    "profile": "dev-profile",
+    "region": "us-north-1",
+    "baseParameterPath": "/dev-path"
+  }
+}

package/src/__mocks__/json/.axiom.json

@@ -0,0 +1,10 @@
+{
+  "name": "my-prod-app",
+  "env": "prod",
+  "aws": {
+    "account": "prod-account",
+    "profile": "prod-profile",
+    "region": "us-east-1",
+    "baseParameterPath": "/prod-path"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "node16",
+    "strict": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node16",
+    "outDir": "lib"
+  },
+  "include": ["src/index.ts"]
+}