xenv-config 1.3.0 → 2.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 Joel Chen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,5 +1,4 @@
-[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]
-[![Dependency Status][daviddm-image]][daviddm-url] [![devDependency Status][daviddm-dev-image]][daviddm-dev-url]
+[![NPM version][npm-image]][npm-url]
 
 # xenv-config
 
@@ -69,6 +68,7 @@ The spec is a JSON object with the following format:
 {
   "<optionKey>": {
     env: "ENV_VAR_NAME",
+    envMap: {},
     default: <default_value>,
     type: "<type>",
     post: (val, trace) => {}
@@ -79,6 +79,7 @@ The spec is a JSON object with the following format:
 - Each `optionKey` specifies the name of the option
 - Its value should be an object with the following fields:
   - `env`: the name (or array of names) of the environment varialbe(s) to check first. If it's `true`, then use `optionKey` as the env variable name.
+  - `envMap`: an object of mapping env value to another value.
   - `default`: the default value or a function to return the default value.
   - `type`: indicate how to interpret and convert the string from `process.env`.
   - `post`: callback to post process value
@@ -132,11 +133,5 @@ The order of source to check are:
 3.  The default value from spec if it's declared
 4.  Nothing
 
-[travis-image]: https://travis-ci.org/jchip/xenv-config.svg?branch=master
-[travis-url]: https://travis-ci.org/jchip/xenv-config
 [npm-image]: https://badge.fury.io/js/xenv-config.svg
 [npm-url]: https://npmjs.org/package/xenv-config
-[daviddm-image]: https://david-dm.org/jchip/xenv-config/status.svg
-[daviddm-url]: https://david-dm.org/jchip/xenv-config
-[daviddm-dev-image]: https://david-dm.org/jchip/xenv-config/dev-status.svg
-[daviddm-dev-url]: https://david-dm.org/jchip/xenv-config?type=dev

package/dist/index.d.ts

@@ -0,0 +1,61 @@
+/**
+ * A trace record describing where a config value's value came from.
+ */
+export interface XenvConfigTrace {
+    /** source(s) the value was resolved from, e.g. "env", "option", "default", or a comma joined list for merged json values */
+    src: string;
+    /** the env var name that was used, when src includes "env" */
+    name?: string;
+}
+/**
+ * Spec for a single config key.
+ */
+export interface XenvConfigSpecOption {
+    /**
+     * env var name(s) to read the value from.
+     * - `true`: use the config key itself as the env var name
+     * - `string`: use this exact env var name
+     * - `string[]`: use the first env var name in the list that exists
+     */
+    env?: string | string[] | boolean;
+    /** map raw env var string values to other values before further processing */
+    envMap?: Record<string, unknown>;
+    /** value type used to coerce a found value */
+    type?: string;
+    /** default value, or a function that returns the default value */
+    default?: unknown;
+    /** transform the resolved value (and its trace) before it's placed in the result */
+    post?: (value: unknown, trace: XenvConfigTrace) => unknown;
+    [extra: string]: unknown;
+}
+/** Spec object mapping config keys to their `XenvConfigSpecOption`. */
+export type XenvConfigSpec = Record<string, XenvConfigSpecOption>;
+/** Env-like lookup object (defaults to `process.env`). */
+export type XenvConfigEnv = Record<string, unknown>;
+/** User supplied config values, keyed the same as `spec`. */
+export type XenvConfigUserConfig = Record<string, unknown>;
+/** A merge function compatible with `Object.assign`'s signature (eg. lodash's `merge`). */
+export type XenvConfigMergeFn = (target: any, ...sources: any[]) => any;
+/** Options controlling how `xenvConfig` resolves values. */
+export interface XenvConfigOptions {
+    /** override for `process.env` */
+    _env?: XenvConfigEnv;
+    /** merge function used to combine json-type values found from multiple sources */
+    merge?: XenvConfigMergeFn;
+    /** ordered list of sources to search; "default" is always appended */
+    sources?: string[];
+}
+/** The resolved config object, plus a hidden `__$trace__` property describing value provenance. */
+export type XenvConfigResult<T = Record<string, unknown>> = T & {
+    readonly __$trace__: Record<string, XenvConfigTrace>;
+};
+/**
+ * Load config from env, user config, or default spec.
+ *
+ * @param spec - spec describing each config key
+ * @param userConfig - user supplied config values
+ * @param options - resolution options
+ * @returns the resolved config object, with a non-enumerable `__$trace__` property
+ */
+declare const xenvConfig: <T = Record<string, unknown>>(spec: XenvConfigSpec, userConfig?: XenvConfigUserConfig, options?: XenvConfigOptions) => XenvConfigResult<T>;
+export default xenvConfig;

package/dist/index.js

@@ -0,0 +1,112 @@
+import assert from "node:assert";
+const typeGetters = {
+    string: x => `${x}`,
+    number: x => parseInt(x, 10),
+    float: x => parseFloat(x),
+    boolean: (x, flagName) => {
+        assert(typeof x === "string", `xenv-config: [${flagName}] trying to convert non-string env value ${x} to boolean.`);
+        const lower = x.toLowerCase();
+        return lower === "true" || lower === "yes" || lower === "1" || lower === "on";
+    },
+    truthy: x => !!x,
+    json: x => JSON.parse(x)
+};
+const getEnvName = (optKey, opt, env) => {
+    if (!Object.prototype.hasOwnProperty.call(opt, "env"))
+        return undefined;
+    let name;
+    if (Array.isArray(opt.env)) {
+        name = opt.env.find(x => Object.prototype.hasOwnProperty.call(env, x));
+    }
+    else {
+        name = opt.env === true ? optKey : opt.env;
+    }
+    if (name && Object.prototype.hasOwnProperty.call(env, name)) {
+        return name;
+    }
+    return undefined;
+};
+/**
+ * Load config from env, user config, or default spec.
+ *
+ * @param spec - spec describing each config key
+ * @param userConfig - user supplied config values
+ * @param options - resolution options
+ * @returns the resolved config object, with a non-enumerable `__$trace__` property
+ */
+const xenvConfig = (spec, userConfig, options) => {
+    const env = (options && options._env) || process.env;
+    const merge = (options && options.merge) || Object.assign;
+    userConfig = userConfig || {};
+    const trace = {};
+    const getType = (opt) => {
+        const tod = Object.prototype.hasOwnProperty.call(opt, "default") && typeof opt.default;
+        const type = opt.type || (tod !== "function" && tod) || "string";
+        return type === "object" ? "json" : type;
+    };
+    const getGetter = (opt) => {
+        const type = getType(opt);
+        return typeGetters[type] || typeGetters.string;
+    };
+    const getters = {
+        env: (opt, k) => {
+            const name = getEnvName(k, opt, env);
+            if (name) {
+                const envVal = env[name];
+                return {
+                    trace: { src: "env", name },
+                    value: opt.envMap && Object.prototype.hasOwnProperty.call(opt.envMap, envVal)
+                        ? opt.envMap[envVal]
+                        : getGetter(opt)(envVal, k)
+                };
+            }
+            return undefined;
+        },
+        option: (opt, k) => {
+            if (Object.prototype.hasOwnProperty.call(userConfig, k)) {
+                return { trace: { src: "option" }, value: userConfig[k] };
+            }
+            return undefined;
+        },
+        default: opt => {
+            if (Object.prototype.hasOwnProperty.call(opt, "default")) {
+                return {
+                    trace: { src: "default" },
+                    value: typeof opt.default === "function" ? opt.default() : opt.default
+                };
+            }
+            return undefined;
+        }
+    };
+    const sources = (options && options.sources) || ["env", "option"];
+    sources.push("default");
+    const config = Object.keys(spec).reduce((cfg, k) => {
+        const opt = spec[k];
+        const type = getType(opt);
+        let found;
+        if (type !== "json") {
+            sources.find(s => (found = getters[s](opt, k)));
+        }
+        else {
+            const mapped = sources.map(s => getters[s](opt, k)).filter((x) => Boolean(x));
+            if (mapped.length > 0) {
+                found = {
+                    trace: { src: mapped.map(x => x.trace.src).join(",") },
+                    value: merge.apply(null, [{}].concat(mapped.map(x => x.value).reverse()))
+                };
+            }
+        }
+        if (!found)
+            return cfg;
+        trace[k] = found.trace;
+        cfg[k] = opt.post ? opt.post(found.value, found.trace) : found.value;
+        return cfg;
+    }, {});
+    Object.defineProperty(config, "__$trace__", {
+        enumerable: false,
+        writable: false,
+        value: trace
+    });
+    return config;
+};
+export default xenvConfig;

package/package.json

@@ -1,39 +1,48 @@
 {
   "name": "xenv-config",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "Load config from env, user config, or default spec",
-  "main": "lib/xenv-config.js",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "homepage": "https://github.com/jchip/fynjs/tree/main/packages/xenv-config",
+  "bugs": {
+    "url": "https://github.com/jchip/fynjs/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/jchip/xenv-config.git"
+    "url": "git+https://github.com/jchip/fynjs.git",
+    "directory": "packages/xenv-config"
   },
   "scripts": {
-    "test": "clap electrode/test",
-    "coverage": "clap check"
+    "build": "rm -rf dist && tsc -p tsconfig.json",
+    "test": "vitest run",
+    "ci:check": "tsc --noEmit -p tsconfig.json && npm test",
+    "coverage": "vitest run --coverage",
+    "prepublishOnly": "xrun build",
+    "postpack": "publish-util-postpack"
   },
-  "keywords": [],
+  "keywords": [
+    "env",
+    "environment",
+    "config",
+    "configuration",
+    "dotenv"
+  ],
   "author": "Joel Chen <joel123@gmail.com>",
   "license": "Apache-2.0",
   "files": [
-    "lib"
-  ],
-  "devDependencies": {
-    "electrode-archetype-njs-module-dev": "^2.2.0",
-    "lodash": "^4.17.10"
-  },
-  "nyc": {
-    "all": true,
-    "reporter": [
-      "lcov",
-      "text",
-      "text-summary"
-    ],
-    "exclude": [
-      "coverage",
-      "*clap.js",
-      "gulpfile.js",
-      "dist",
-      "test"
-    ]
-  }
+    "dist"
+  ]
 }

package/lib/xenv-config.js

@@ -1,122 +0,0 @@
-"use strict";
-
-/* eslint-disable prefer-spread */
-
-const assert = require("assert");
-
-const typeGetters = {
-  string: x => `${x}`,
-  number: x => parseInt(x, 10),
-  float: x => parseFloat(x),
-  boolean: (x, flagName) => {
-    assert(
-      typeof x === "string",
-      `xenv-config: [${flagName}] trying to convert non-string env value ${x} to boolean.`
-    );
-    x = x.toLowerCase();
-    return x === "true" || x === "yes" || x === "1" || x === "on";
-  },
-  truthy: x => !!x,
-  json: x => JSON.parse(x)
-};
-
-const getEnvName = (optKey, opt, env) => {
-  if (!opt.hasOwnProperty("env")) return undefined;
-
-  let name;
-
-  if (Array.isArray(opt.env)) {
-    name = opt.env.find(x => env.hasOwnProperty(x));
-  } else {
-    name = opt.env === true ? optKey : opt.env;
-  }
-
-  if (name && env.hasOwnProperty(name)) {
-    return name;
-  }
-
-  return undefined;
-};
-
-const xenvConfig = (spec, userConfig, options) => {
-  const env = (options && options._env) || process.env;
-  const merge = (options && options.merge) || Object.assign;
-  userConfig = userConfig || {};
-  const trace = {};
-
-  const getType = opt => {
-    const tod = opt.hasOwnProperty("default") && typeof opt.default;
-    const type = opt.type || (tod !== "function" && tod) || "string";
-    return type === "object" ? "json" : type;
-  };
-
-  const getGetter = opt => {
-    const type = getType(opt);
-    return typeGetters[type] || typeGetters.string;
-  };
-
-  const getters = {
-    env: (opt, k) => {
-      const name = getEnvName(k, opt, env);
-      if (name) {
-        return { trace: { src: "env", name }, value: getGetter(opt)(env[name], k) };
-      }
-      return undefined;
-    },
-
-    option: (opt, k) => {
-      if (userConfig.hasOwnProperty(k)) {
-        return { trace: { src: "option" }, value: userConfig[k] };
-      }
-      return undefined;
-    },
-
-    default: opt => {
-      if (opt.hasOwnProperty("default")) {
-        return {
-          trace: { src: "default" },
-          value: typeof opt.default === "function" ? opt.default() : opt.default
-        };
-      }
-      return undefined;
-    }
-  };
-
-  const sources = (options && options.sources) || ["env", "option"];
-  sources.push("default");
-
-  const config = Object.keys(spec).reduce((cfg, k) => {
-    const opt = spec[k];
-    const type = getType(opt);
-    let found;
-
-    if (type !== "json") {
-      sources.find(s => (found = getters[s](opt, k)));
-    } else {
-      const mapped = sources.map(s => getters[s](opt, k)).filter(x => x);
-      if (mapped.length > 0) {
-        found = {
-          trace: { src: mapped.map(x => x.trace.src).join(",") },
-          value: merge.apply(null, [{}].concat(mapped.map(x => x.value).reverse()))
-        };
-      }
-    }
-
-    if (!found) return cfg;
-
-    trace[k] = found.trace;
-    cfg[k] = opt.post ? opt.post(found.value, found.trace) : found.value;
-
-    return cfg;
-  }, {});
-
-  Object.defineProperty(config, "__$trace__", {
-    enumerable: false,
-    writable: false,
-    value: trace
-  });
-
-  return config;
-};
-
-module.exports = xenvConfig;