@agnostack/env 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [1.0.2](https://github.com/agnostack/env/compare/v1.0.1...v1.0.2) (2025-01-14)
+
+
+### Bug Fixes
+
+* initial working version? ([3a52ee1](https://github.com/agnostack/env/commit/3a52ee1f31326c3d51b6af74a4198a3554119781))
+* initial working version? ([f8624b0](https://github.com/agnostack/env/commit/f8624b07b89b17c1f737d5f1e3b7bdf73b0ed3ff))
+
+## [1.0.1](https://github.com/agnostack/env/compare/v1.0.0...v1.0.1) (2025-01-14)
+
+
+### Bug Fixes
+
+* initial working version? ([6643eb4](https://github.com/agnostack/env/commit/6643eb4b58755dab192b5f0b59e6be3efbb3c7ad))
+
 # 1.0.0 (2025-01-14)
 
 

package/dist/utils.d.ts

@@ -1 +1,20 @@
-export const FOO: "bar";
+export namespace ENV_PREFIX {
+    let NEXT: string;
+    let VITE: string;
+    let GATSBY: string;
+    let DEFAULT: string;
+}
+export const ENV_PREFIXES: string[];
+export function cleanPublicEnv(_env: any, keyValidator?: (envKey: any) => boolean): {};
+export function parseEnvData(_env?: NodeJS.ProcessEnv): {
+    nextEnv: {};
+    publicEnv: {};
+    env: {
+        ENVIRONMENT: string;
+        TZ?: string;
+    };
+    params: {};
+    stringifiedEnv: {};
+    args: any[];
+};
+export function getPublicEnvValue(publicEnv: any, key: any): any;

package/dist/utils.js

@@ -1,5 +1,116 @@
 "use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FOO = void 0;
-exports.FOO = 'bar';
+exports.getPublicEnvValue = exports.parseEnvData = exports.cleanPublicEnv = exports.ENV_PREFIXES = exports.ENV_PREFIX = void 0;
+exports.ENV_PREFIX = {
+    NEXT: 'NEXT_PUBLIC_',
+    VITE: 'VITE_PUBLIC_',
+    GATSBY: 'GATSBY_',
+    DEFAULT: 'PUBLIC_',
+};
+exports.ENV_PREFIXES = Object.values(exports.ENV_PREFIX);
+// HMMM: what if 'string' is an object?
+const ensureStringOnly = (string) => (
+// eslint-disable-next-line eqeqeq
+(string != undefined) ? `${string}` : '');
+const stringNotEmptyOnly = (stringable) => {
+    const string = ensureStringOnly(stringable);
+    return ((string.length > 0) && !['null', 'undefined'].includes(string));
+};
+const stringEmptyOnly = (stringable) => (!stringNotEmptyOnly(stringable));
+const isCapitalized = (string) => (/^[A-Z_]+$/.test(ensureStringOnly(string)));
+const nextKeyValidator = (envKey) => (
+// NOTE: not allowed by NEXT: https://nextjs.org/docs/messages/env-key-not-allowed
+!(envKey.startsWith('__') || envKey.startsWith('NODE_')));
+const publicKeyValidator = (envKey) => (exports.ENV_PREFIXES.some((envPrefix) => envKey === null || envKey === void 0 ? void 0 : envKey.startsWith(envPrefix)) ||
+    ['NODE_ENV', 'PORT', 'ENVIRONMENT', 'DEBUG', 'SCOPES', 'SHOPIFY_API_SCOPES'].includes(envKey));
+const paramKeyValidator = (envKey) => (publicKeyValidator(envKey) || (nextKeyValidator(envKey) &&
+    !isCapitalized(envKey) &&
+    !envKey.startsWith('npm_')));
+// TODO: move to processBatch???
+const stringifyEnv = (_env) => (Object.entries(_env !== null && _env !== void 0 ? _env : {}).reduce((__env, [key, val]) => (Object.assign(Object.assign({}, __env), { 
+    // NOTE: DefinePlugin requires stringified
+    [key]: JSON.stringify(val) })), {}));
+// TODO: move to processBatch???
+const cleanEnv = (_env, keyValidator = nextKeyValidator) => (Object.entries(_env !== null && _env !== void 0 ? _env : []).reduce((__env, [key, val]) => (Object.assign(Object.assign({}, __env), keyValidator(key) && {
+    [key]: val,
+})), {}));
+const cleanPublicEnv = (_env, keyValidator = publicKeyValidator) => (cleanEnv(_env, keyValidator));
+exports.cleanPublicEnv = cleanPublicEnv;
+const cleanParams = (_env, keyValidator = paramKeyValidator) => (cleanEnv(_env, keyValidator));
+const parseEnvData = (_env = process.env) => {
+    const { ENVIRONMENT, NODE_ENV } = _env;
+    const _environment = [ENVIRONMENT, NODE_ENV, 'development'].find((value) => stringNotEmptyOnly(value));
+    const mergedEnv = Object.assign(Object.assign({}, _env), { ENVIRONMENT: _environment });
+    const _a = process.argv.reduce(({ args: _args, params: _params, }, data) => {
+        var _a, _b;
+        const [_param, value] = (_a = data === null || data === void 0 ? void 0 : data.split('=')) !== null && _a !== void 0 ? _a : [];
+        const param = (_b = _param === null || _param === void 0 ? void 0 : _param.replace) === null || _b === void 0 ? void 0 : _b.call(_param, '--', '');
+        if (stringNotEmptyOnly(param)) {
+            return {
+                args: _args,
+                params: _params,
+            };
+        }
+        return {
+            args: [
+                ..._args,
+                ...!value ? [param] : []
+            ],
+            params: Object.assign(Object.assign({}, _params), stringNotEmptyOnly(value) && {
+                [param]: value,
+            }),
+        };
+    }, {
+        args: [],
+        params: mergedEnv,
+    }), { params } = _a, output = __rest(_a, ["params"]);
+    const nextEnv = cleanEnv(mergedEnv);
+    const publicEnv = (0, exports.cleanPublicEnv)(mergedEnv);
+    return Object.assign(Object.assign({}, output), { nextEnv,
+        publicEnv, env: mergedEnv, params: cleanParams(params), stringifiedEnv: stringifyEnv(publicEnv) });
+};
+exports.parseEnvData = parseEnvData;
+const getPublicEnvValue = (publicEnv, key) => {
+    let envValue;
+    if (stringEmptyOnly(key) || !publicEnv) {
+        return envValue;
+    }
+    if (stringNotEmptyOnly(publicEnv === null || publicEnv === void 0 ? void 0 : publicEnv[key])) {
+        return publicEnv[key];
+    }
+    let baseKey = key;
+    // NOTE: intentionally using for/of loop instead of map so we can break to exit quickly soon as matched
+    // eslint-disable-next-line no-restricted-syntax
+    for (const envPrefix of exports.ENV_PREFIXES) {
+        if (key.startsWith(envPrefix)) {
+            const trimmedKey = key.slice(envPrefix.length);
+            if (stringNotEmptyOnly(trimmedKey)) {
+                baseKey = trimmedKey;
+                break;
+            }
+        }
+    }
+    const matchableEnvKeys = exports.ENV_PREFIXES.map((envPrefix) => `${envPrefix}${baseKey}`);
+    // NOTE: intentionally using for/of loop instead of map so we can break to exit quickly soon as matched
+    // eslint-disable-next-line no-restricted-syntax
+    for (const matchableEnvKey of matchableEnvKeys) {
+        envValue = publicEnv[matchableEnvKey];
+        if (stringNotEmptyOnly(envValue)) {
+            break;
+        }
+    }
+    return envValue;
+};
+exports.getPublicEnvValue = getPublicEnvValue;
 //# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":";;;AAAa,QAAA,GAAG,GAAG,KAAK,CAAA"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":";;;;;;;;;;;;;;AAAa,QAAA,UAAU,GAAG;IACxB,IAAI,EAAE,cAAc;IACpB,IAAI,EAAE,cAAc;IACpB,MAAM,EAAE,SAAS;IACjB,OAAO,EAAE,SAAS;CACnB,CAAA;AAEY,QAAA,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAA;AAErD,uCAAuC;AACvC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC;AACnC,kCAAkC;AAClC,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CACzC,CAAA;AAED,MAAM,kBAAkB,GAAG,CAAC,UAAU,EAAE,EAAE;IACxC,MAAM,MAAM,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAA;IAC3C,OAAO,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;AACzE,CAAC,CAAA;AAED,MAAM,eAAe,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC,CACtC,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAChC,CAAA;AAED,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAChC,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAC3C,CAAA;AAED,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC;AACnC,kFAAkF;AAClF,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CACzD,CAAA;AAED,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CACrC,oBAAY,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,CAAC,SAAS,CAAC,CAAC;IAC/D,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAC9F,CAAA;AAED,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CACpC,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAC5B,gBAAgB,CAAC,MAAM,CAAC;IACxB,CAAC,aAAa,CAAC,MAAM,CAAC;IACtB,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAC3B,CACF,CAAA;AAED,gCAAgC;AAChC,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAC7B,MAAM,CAAC,OAAO,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAChC,KAAK,EACL,CAAC,GAAG,EAAE,GAAG,CAAC,EACV,EAAE,CAAC,iCACA,KAAK;IACR,0CAA0C;IAC1C,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAC1B,EAAE,EAAE,CAAC,CACR,CAAA;AAED,gCAAgC;AAChC,MAAM,QAAQ,GAAG,CAAC,IAAI,EAAE,YAAY,GAAG,gBAAgB,EAAE,EAAE,CAAC,CAC1D,MAAM,CAAC,OAAO,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAChC,KAAK,EACL,CAAC,GAAG,EAAE,GAAG,CAAC,EACV,EAAE,CAAC,iCACA,KAAK,GAEL,YAAY,CAAC,GAAG,CAAC,IAAI;IACtB,CAAC,GAAG,CAAC,EAAE,GAAG;CACX,EACD,EAAE,EAAE,CAAC,CACR,CAAA;AAEM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,YAAY,GAAG,kBAAkB,EAAE,EAAE,CAAC,CACzE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAC7B,CAAA;AAFY,QAAA,cAAc,kBAE1B;AAED,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,YAAY,GAAG,iBAAiB,EAAE,EAAE,CAAC,CAC9D,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAC7B,CAAA;AAEM,MAAM,YAAY,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,EAAE;IACjD,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;IACtC,MAAM,YAAY,GAAG,CAAC,WAAW,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAA;IAEtG,MAAM,SAAS,mCACV,IAAI,KACP,WAAW,EAAE,YAAY,GAC1B,CAAA;IAED,MAAM,KAAwB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EACjD,IAAI,EAAE,KAAK,EACX,MAAM,EAAE,OAAO,GAChB,EAAE,IAAI,EAAE,EAAE;;QACT,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,CAAC,GAAG,CAAC,mCAAI,EAAE,CAAA;QAC9C,MAAM,KAAK,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,uDAAG,IAAI,EAAE,EAAE,CAAC,CAAA;QAEzC,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,MAAM,EAAE,OAAO;aAChB,CAAA;QACH,CAAC;QAED,OAAO;YACL,IAAI,EAAE;gBACJ,GAAG,KAAK;gBACR,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;aACzB;YACD,MAAM,kCACD,OAAO,GACP,kBAAkB,CAAC,KAAK,CAAC,IAAI;gBAC9B,CAAC,KAAK,CAAC,EAAE,KAAK;aACf,CACF;SACF,CAAA;IACH,CAAC,EAAE;QACD,IAAI,EAAE,EAAE;QACR,MAAM,EAAE,SAAS;KAClB,CAAC,EA7BI,EAAE,MAAM,OA6BZ,EA7BiB,MAAM,cAAnB,UAAqB,CA6BzB,CAAA;IAEF,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAA;IACnC,MAAM,SAAS,GAAG,IAAA,sBAAc,EAAC,SAAS,CAAC,CAAA;IAG3C,uCACK,MAAM,KACT,OAAO;QACP,SAAS,EACT,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,EAC3B,cAAc,EAAE,YAAY,CAAC,SAAS,CAAC,IACxC;AACH,CAAC,CAAA;AApDY,QAAA,YAAY,gBAoDxB;AAEM,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,GAAG,EAAE,EAAE;IAClD,IAAI,QAAQ,CAAA;IACZ,IAAI,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QACvC,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED,IAAI,kBAAkB,CAAC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG,GAAG,CAAC,CAAC,EAAE,CAAC;QACzC,OAAO,SAAS,CAAC,GAAG,CAAC,CAAA;IACvB,CAAC;IAED,IAAI,OAAO,GAAG,GAAG,CAAA;IACjB,uGAAuG;IACvG,gDAAgD;IAChD,KAAK,MAAM,SAAS,IAAI,oBAAY,EAAE,CAAC;QACrC,IAAI,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,MAAM,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;YAC9C,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;gBACnC,OAAO,GAAG,UAAU,CAAA;gBACpB,MAAK;YACP,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,gBAAgB,GAAG,oBAAY,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,SAAS,GAAG,OAAO,EAAE,CAAC,CAAA;IAClF,uGAAuG;IACvG,gDAAgD;IAChD,KAAK,MAAM,eAAe,IAAI,gBAAgB,EAAE,CAAC;QAC/C,QAAQ,GAAG,SAAS,CAAC,eAAe,CAAC,CAAA;QACrC,IAAI,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;YACjC,MAAK;QACP,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAjCY,QAAA,iBAAiB,qBAiC7B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agnostack/env",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "author": "agnoStack Dev <developers@agnostack.com> (https://agnostack.com)",
   "owner": "agnoStack",
   "description": "Please contact agnoStack via info@agnostack.com for any questions",
@@ -51,8 +51,8 @@
     "@types/jest": "26.0.24",
     "@types/react": "17.0.2",
     "@types/react-dom": "17.0.2",
-    "@typescript-eslint/eslint-plugin": "5.36.1",
-    "@typescript-eslint/parser": "5.36.1",
+    "@typescript-eslint/eslint-plugin": "6.3.0",
+    "@typescript-eslint/parser": "6.3.0",
     "chai": "4.3.10",
     "chai-as-promised": "7.1.1",
     "chalk": "4.1.2",