@keeex/projectconfig 4.1.1

package/LICENSE

@@ -0,0 +1,16 @@
+KeeeX SAS Confidential
+https://keeex.me
+Copyright 2013-2022 KeeeX All Rights Reserved.
+
+These computer program listings and specifications, herein,
+are and remain the property of KeeeX SAS. The intellectual
+and technical concepts herein are proprietary to KeeeX SAS
+and may be covered by EU and foreign patents,
+patents in process, trade secrets and copyright law.
+
+They shall not be reproduced or copied or used in whole or
+in part as the basis for manufacture or sale of items unless
+prior written permission is obtained from KeeeX SAS.
+
+For a license agreement, please contact:
+<mailto: contact@keeex.net>

package/README.md

@@ -0,0 +1,52 @@
+Project configuration loader
+============================
+
+Load project for a project from the following places, whichever works first:
+
+- Command line argument, as a JSON string
+- Command line argument, as a path to a JSON/JS file
+- From a file at the root of the project
+
+Additionaly, it will automatically sideload a "secrets" file, for settings that
+should not remain in a shared configuration file.
+The secrets file is expected to be named "secrets.js[on]" at the root of the
+project.
+It can be a symlink.
+If no secret file is found at the root of the project, this library will try to
+load it one directory above the project.
+
+Usage
+-----
+
+### Configuration location
+The main configuration should be placed at the root of the project, in a file
+named `config.js` or `config.json`.
+Same for the secrets, using a file named `secrets.js` or `secrets.json`.
+
+#### Overriding default file names
+For testing purpose it can be useful to override the file names locally.
+If `NODE_ENV` is set to `test`, file names will be `config-test.js[on]` and
+`secrets-test.js[on]`.
+Alternatively, if `KEEEX_CONFIG_SUFFIX` is set, it will be appended to the base
+names (with no dash).
+The `KEEEX_CONFIG_SUFFIX` option takes precedence over `NODE_ENV`.
+
+In any case, the default names (without any suffix) will be used as fallback.
+
+### Command-line configuration
+It is possible to load a different configuration from command line.
+Passing `--config <some json>` will load that JSON instead of the config file.
+
+One can also pass `--config <path to json file>` to load a different config from
+another file.
+
+It is not possible to specify a different secret file from command line.
+
+### Accessing the configuration
+The loaded configuration is available as the default export of the library:
+
+```JavaScript
+import config from "@keeex/projectconfig";
+
+console.log(config.something);
+```

package/lib/env.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Return the config suffix from env value
+ */
+export declare const getConfigSuffix: () => string | undefined;
+/**
+ * Return the current NODE_ENV value (default to `production`)
+ */
+export declare const getNodeEnv: () => string;

package/lib/env.js

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * @preserve
+ * KeeeX SAS Confidential
+ * https://keeex.me
+ * Copyright 2013-2022 KeeeX All Rights Reserved.
+ *
+ * These computer program listings and specifications, herein,
+ * are and remain the property of KeeeX SAS. The intellectual
+ * and technical concepts herein are proprietary to KeeeX SAS
+ * and may be covered by EU and foreign patents,
+ * patents in process, trade secrets and copyright law.
+ *
+ * They shall not be reproduced or copied or used in whole or
+ * in part as the basis for manufacture or sale of items unless
+ * prior written permission is obtained from KeeeX SAS.
+ *
+ * For a license agreement, please contact:
+ * <mailto: contact@keeex.net>
+ *
+ */
+/* eslint-disable no-process-env */
+/**
+ * Return the config suffix from env value
+ */
+export const getConfigSuffix = () => process.env["KEEEX_CONFIG_SUFFIX"];
+/**
+ * Return the current NODE_ENV value (default to `production`)
+ */
+export const getNodeEnv = () => { var _a; return (_a = process.env["NODE_ENV"]) !== null && _a !== void 0 ? _a : "production"; };

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import { BaseConfig } from "./types.js";
+declare const _default: BaseConfig;
+export default _default;

package/lib/index.js

@@ -0,0 +1,199 @@
+/**
+ * @license
+ * @preserve
+ * KeeeX SAS Confidential
+ * https://keeex.me
+ * Copyright 2013-2022 KeeeX All Rights Reserved.
+ *
+ * These computer program listings and specifications, herein,
+ * are and remain the property of KeeeX SAS. The intellectual
+ * and technical concepts herein are proprietary to KeeeX SAS
+ * and may be covered by EU and foreign patents,
+ * patents in process, trade secrets and copyright law.
+ *
+ * They shall not be reproduced or copied or used in whole or
+ * in part as the basis for manufacture or sale of items unless
+ * prior written permission is obtained from KeeeX SAS.
+ *
+ * For a license agreement, please contact:
+ * <mailto: contact@keeex.net>
+ *
+ */
+/**
+ * Load configuration from three places, whichever works first:
+ * - command line, as a JSON after "--config"
+ * - command line, as the path to a JSON file after "--config"
+ * - config file, "${CWD}/config.js"
+ *
+ * It will automatically append a "secrets" property to the config object read
+ * from "${CWD}/secrets.js[on]".
+ */
+import { existsSync } from "fs";
+import { readFile } from "fs/promises";
+import { join, resolve, extname, } from "path";
+import { getConfigSuffix, getNodeEnv } from "./env.js";
+const defaultCliArgName = "--config";
+const defaultConfigBasename = "config";
+const defaultSecretsBasename = "secrets";
+const acceptableExtensions = [
+    ".js",
+    ".json",
+    ".ts",
+];
+const configSuffix = (useSuffix) => {
+    if (!useSuffix) {
+        return "";
+    }
+    const suffixFromEnv = getConfigSuffix();
+    if (suffixFromEnv !== undefined) {
+        return suffixFromEnv;
+    }
+    const nodeEnvValue = getNodeEnv();
+    if (nodeEnvValue === "test") {
+        return "-test";
+    }
+    return "";
+};
+/**
+ * Config basename with suffix
+ */
+const configBasename = (withSuffix) => `${defaultConfigBasename}${configSuffix(withSuffix)}`;
+/**
+ * Secrets basename with suffix
+ */
+const secretsBasename = (withSuffix) => `${defaultSecretsBasename}${configSuffix(withSuffix)}`;
+/**
+ * Initial directory of the app. Hopefully the project root.
+ */
+const projectRoot = process.cwd();
+/**
+ * Try multiple suffix for a file path, return the first one that exist.
+ */
+const getFirstFileFound = (basepath, basename, extensions) => {
+    for (const extension of extensions) {
+        const candidate = join(basepath, `${basename}${extension}`);
+        if (existsSync(candidate)) {
+            return candidate;
+        }
+    }
+};
+/**
+ * Return path to the config file
+ */
+const getConfigPath = () => {
+    const configPath = getFirstFileFound(projectRoot, configBasename(true), acceptableExtensions);
+    if (configPath === undefined) {
+        const configPathNoSuffix = getFirstFileFound(projectRoot, configBasename(false), acceptableExtensions);
+        if (configPathNoSuffix === undefined) {
+            throw new Error("No configuration file found");
+        }
+        return configPathNoSuffix;
+    }
+    return configPath;
+};
+/**
+ * Return path to the secrets file
+ */
+const getSecretsPath = () => {
+    const secretsPathWithSuffix = getFirstFileFound(projectRoot, secretsBasename(true), acceptableExtensions);
+    if (secretsPathWithSuffix) {
+        return secretsPathWithSuffix;
+    }
+    const secretsPathNoSuffix = getFirstFileFound(projectRoot, secretsBasename(false), acceptableExtensions);
+    if (secretsPathNoSuffix) {
+        return secretsPathNoSuffix;
+    }
+    const secretsPathAbove = getFirstFileFound(resolve(projectRoot, ".."), secretsBasename(false), acceptableExtensions);
+    if (secretsPathAbove) {
+        return secretsPathAbove;
+    }
+};
+const loadFile = async (path) => {
+    const suffix = extname(path);
+    if ([".js", ".ts"].includes(suffix)) {
+        const module = await import(path);
+        if (module.default) {
+            return module.default;
+        }
+        return module;
+    }
+    if (suffix === ".json") {
+        return JSON.parse(await readFile(path, "utf8"));
+    }
+    throw new Error(`Unexpected suffix: ${suffix}`);
+};
+/**
+ * Return the secrets data
+ */
+const getSecrets = async () => {
+    const secretsPath = getSecretsPath();
+    if (secretsPath === undefined) {
+        return;
+    }
+    return loadFile(secretsPath);
+};
+/**
+ * Return the configuration object from the command line arguments
+ */
+const getConfigFromCLI = async () => {
+    const cliArgName = defaultCliArgName;
+    const configArgIndex = process.argv.indexOf(cliArgName);
+    if (configArgIndex !== -1) {
+        const configFromArgs = process.argv[configArgIndex + 1];
+        const valuesExtracted = 2;
+        process.argv.splice(configArgIndex, valuesExtracted);
+        let configObj;
+        try {
+            configObj = JSON.parse(configFromArgs);
+        }
+        catch (_error) {
+            configObj = JSON.parse(await readFile(configFromArgs, "utf8"));
+        }
+        return configObj;
+    }
+    return null;
+};
+/**
+ * Load the project configuration from a file
+ */
+const getConfigFromFile = async () => {
+    const filePath = getConfigPath();
+    return loadFile(filePath);
+};
+/**
+ * Return the configuration object from the first available source
+ */
+const getBaseProjectConfig = async () => {
+    const configFromCLI = await getConfigFromCLI();
+    if (configFromCLI !== null) {
+        return configFromCLI;
+    }
+    return getConfigFromFile();
+};
+/**
+ * Merge the base configuration and the secrets
+ */
+const getProjectConfig = async () => {
+    const baseConfig = await getBaseProjectConfig();
+    const secrets = await getSecrets();
+    if (secrets) {
+        const merged = {
+            ...baseConfig,
+            secrets,
+        };
+        return merged;
+    }
+    return baseConfig;
+};
+/**
+ * Cache of the loaded configuration
+ */
+let config = null;
+/** Load the project configuration */
+const loadConfig = async () => {
+    const activeConfig = config !== null && config !== void 0 ? config : await getProjectConfig();
+    if (!config)
+        config = activeConfig;
+    return config;
+};
+export default await loadConfig();

package/lib/types.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Base for any returned configuration
+ */
+export declare type BaseConfig = Record<string, any>;

package/lib/types.js

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * @preserve
+ * KeeeX SAS Confidential
+ * https://keeex.me
+ * Copyright 2013-2022 KeeeX All Rights Reserved.
+ *
+ * These computer program listings and specifications, herein,
+ * are and remain the property of KeeeX SAS. The intellectual
+ * and technical concepts herein are proprietary to KeeeX SAS
+ * and may be covered by EU and foreign patents,
+ * patents in process, trade secrets and copyright law.
+ *
+ * They shall not be reproduced or copied or used in whole or
+ * in part as the basis for manufacture or sale of items unless
+ * prior written permission is obtained from KeeeX SAS.
+ *
+ * For a license agreement, please contact:
+ * <mailto: contact@keeex.net>
+ *
+ */
+export {};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@keeex/projectconfig",
+  "version": "4.1.1",
+  "description": "Load project configuration with separate secrets",
+  "main": "lib/index.js",
+  "scripts": {
+    "prepack": "npm run grunt -- clean build",
+    "grunt": "npm exec grunt -- --gruntfile Gruntfile.cjs",
+    "check": "npx eslint . && npx tsc --noEmit"
+  },
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git2@dev-machine.keeex:keeex/libraries/node/projectconfig"
+  },
+  "author": "KeeeX SAS",
+  "contributors": [],
+  "license": "SEE LICENSE IN LICENSE",
+  "devDependencies": {
+    "@keeex/eslint-config": "^1.7.5",
+    "@types/node": "^16.11.26",
+    "@typescript-eslint/eslint-plugin": "^5.19.0",
+    "@typescript-eslint/parser": "^5.19.0",
+    "eslint": "^8.13.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "grunt": "^1.5.2",
+    "grunt-banner": "^0.6.0",
+    "grunt-contrib-clean": "^2.0.0",
+    "grunt-run": "^0.8.1",
+    "load-grunt-tasks": "^5.1.0",
+    "typescript": "^4.6.3"
+  },
+  "files": [
+    "lib/**/*.js",
+    "lib/**/*.d.ts"
+  ]
+}