@pitininja/envious 2.0.0 → 3.0.0-beta.1

package/README.md

@@ -2,9 +2,9 @@
 
 > Environment variable parsing using Dotenv & Typebox
 
-## Warning ⚠️
+## Compatibility
 
-From v2 this library is shipped in ESM. If your project is setup in CJS you must use v1.
+Since v3 this library is compatible with both ESM and CJS.
 
 ## Install
 
@@ -21,7 +21,7 @@ npm i @pitininja/envious
 import { Type } from '@sinclair/typebox';
 import { envious } from '@pitininja/envious';
 
-export const envSchema = Type.Object({
+export const schema = Type.Object({
     STRING_VAR: Type.String(),
     NUMBER_VAR: Type.Integer(),
     BOOLEAN_VAR: Type.Boolean(),
@@ -29,8 +29,18 @@ export const envSchema = Type.Object({
 });
 
 /**
-Parse your environment variables
-If the environment variables don't match the schema, an error will be thrown
+Parse your environment variables.
+If the environment variables don't match the schema, an error will be thrown.
 */
-const env = envious(myEnvSchema);
+const env = envious(schema);
+
+/**
+You can provide default values as second parameter of the envious function.
+*/
+const envWithDefaults = envious(schema, {
+    STRING_VAR: 'Example',
+    NUMBER_VAR: 123,
+    BOOLEAN_VAR: true,
+    OPTIONAL_VAR: 'Example'
+});
 ```

package/dist/index.cjs

@@ -0,0 +1,47 @@
+'use strict';
+
+require('dotenv/config');
+var value = require('@sinclair/typebox/value');
+var Os = require('os');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var Os__default = /*#__PURE__*/_interopDefault(Os);
+
+// src/index.ts
+var envious = (schema, defaultValues) => {
+  const parsed = value.Value.Convert(schema, process.env);
+  const errors = [...value.Value.Errors(schema, parsed)];
+  if (errors.length) {
+    const computedErrorMessages = {};
+    errors.forEach(({ path, message }) => {
+      const envVarName = path.replace(/^\//, "");
+      if (!computedErrorMessages[envVarName]) {
+        computedErrorMessages[envVarName] = [];
+      }
+      computedErrorMessages[envVarName].push(message);
+    });
+    const errorTextParts = [
+      "Invalid environment variables",
+      ...Object.entries(computedErrorMessages).map(
+        ([varName, messages]) => `  ${varName} : ${messages.join(", ")}`
+      )
+    ];
+    throw new Error(errorTextParts.join(Os__default.default.EOL));
+  }
+  const env = value.Value.Cast(
+    {
+      ...schema,
+      additionalProperties: false
+    },
+    parsed
+  );
+  return {
+    ...defaultValues,
+    ...env
+  };
+};
+
+exports.envious = envious;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO;AAEP,SAAS,aAAa;AACtB,OAAO,QAAQ;AAER,IAAM,UAAU,CACnB,QACA,kBACY;AACZ,QAAM,SAAS,MAAM,QAAQ,QAAQ,QAAQ,GAAG;AAChD,QAAM,SAAS,CAAC,GAAG,MAAM,OAAO,QAAQ,MAAM,CAAC;AAC/C,MAAI,OAAO,QAAQ;AACf,UAAM,wBAAkD,CAAC;AACzD,WAAO,QAAQ,CAAC,EAAE,MAAM,QAAQ,MAAM;AAClC,YAAM,aAAa,KAAK,QAAQ,OAAO,EAAE;AACzC,UAAI,CAAC,sBAAsB,UAAU,GAAG;AACpC,8BAAsB,UAAU,IAAI,CAAC;AAAA,MACzC;AACA,4BAAsB,UAAU,EAAE,KAAK,OAAO;AAAA,IAClD,CAAC;AACD,UAAM,iBAA2B;AAAA,MAC7B;AAAA,MACA,GAAG,OAAO,QAAQ,qBAAqB,EAAE;AAAA,QACrC,CAAC,CAAC,SAAS,QAAQ,MAAM,KAAK,OAAO,MAAM,SAAS,KAAK,IAAI,CAAC;AAAA,MAClE;AAAA,IACJ;AACA,UAAM,IAAI,MAAM,eAAe,KAAK,GAAG,GAAG,CAAC;AAAA,EAC/C;AACA,QAAM,MAAM,MAAM;AAAA,IACd;AAAA,MACI,GAAG;AAAA,MACH,sBAAsB;AAAA,IAC1B;AAAA,IACA;AAAA,EACJ;AACA,SAAO;AAAA,IACH,GAAG;AAAA,IACH,GAAG;AAAA,EACP;AACJ","sourcesContent":["import 'dotenv/config';\nimport { type TObject, type Static } from '@sinclair/typebox';\nimport { Value } from '@sinclair/typebox/value';\nimport Os from 'os';\n\nexport const envious = <T extends TObject>(\n    schema: T,\n    defaultValues?: Static<T>\n): Static<T> => {\n    const parsed = Value.Convert(schema, process.env);\n    const errors = [...Value.Errors(schema, parsed)];\n    if (errors.length) {\n        const computedErrorMessages: Record<string, string[]> = {};\n        errors.forEach(({ path, message }) => {\n            const envVarName = path.replace(/^\\//, '');\n            if (!computedErrorMessages[envVarName]) {\n                computedErrorMessages[envVarName] = [];\n            }\n            computedErrorMessages[envVarName].push(message);\n        });\n        const errorTextParts: string[] = [\n            'Invalid environment variables',\n            ...Object.entries(computedErrorMessages).map(\n                ([varName, messages]) => `  ${varName} : ${messages.join(', ')}`\n            )\n        ];\n        throw new Error(errorTextParts.join(Os.EOL));\n    }\n    const env = Value.Cast(\n        {\n            ...schema,\n            additionalProperties: false\n        },\n        parsed\n    );\n    return {\n        ...defaultValues,\n        ...env\n    };\n};\n"]}

package/dist/index.d.cts

@@ -0,0 +1,6 @@
+import * as _sinclair_typebox from '@sinclair/typebox';
+import { TObject, Static } from '@sinclair/typebox';
+
+declare const envious: <T extends TObject<_sinclair_typebox.TProperties>>(schema: T, defaultValues?: Static<T>) => Static<T>;
+
+export { envious };

package/dist/index.d.ts

@@ -1,3 +1,6 @@
-import 'dotenv/config';
-import { type Static, type TSchema } from '@sinclair/typebox';
-export declare const envious: <T extends TSchema>(schema: T) => Static<T>;
+import * as _sinclair_typebox from '@sinclair/typebox';
+import { TObject, Static } from '@sinclair/typebox';
+
+declare const envious: <T extends TObject<_sinclair_typebox.TProperties>>(schema: T, defaultValues?: Static<T>) => Static<T>;
+
+export { envious };

package/dist/index.js

@@ -1,27 +1,41 @@
 import 'dotenv/config';
-import Os from 'os';
 import { Value } from '@sinclair/typebox/value';
-export const envious = (schema) => {
-    const parsed = Value.Convert(schema, process.env);
-    const errors = [...Value.Errors(schema, parsed)];
-    if (errors.length) {
-        const computedErrorMessages = {};
-        errors.forEach(({ path, message }) => {
-            const envVarName = path.replace(/^\//, '');
-            if (!computedErrorMessages[envVarName]) {
-                computedErrorMessages[envVarName] = [];
-            }
-            computedErrorMessages[envVarName].push(message);
-        });
-        const errorTextParts = [
-            'Invalid environment variables',
-            ...Object.entries(computedErrorMessages).map(([varName, messages]) => `  ${varName} : ${messages.join(', ')}`)
-        ];
-        throw new Error(errorTextParts.join(Os.EOL));
-    }
-    return Value.Cast({
-        ...schema,
-        additionalProperties: false
-    }, parsed);
+import Os from 'os';
+
+// src/index.ts
+var envious = (schema, defaultValues) => {
+  const parsed = Value.Convert(schema, process.env);
+  const errors = [...Value.Errors(schema, parsed)];
+  if (errors.length) {
+    const computedErrorMessages = {};
+    errors.forEach(({ path, message }) => {
+      const envVarName = path.replace(/^\//, "");
+      if (!computedErrorMessages[envVarName]) {
+        computedErrorMessages[envVarName] = [];
+      }
+      computedErrorMessages[envVarName].push(message);
+    });
+    const errorTextParts = [
+      "Invalid environment variables",
+      ...Object.entries(computedErrorMessages).map(
+        ([varName, messages]) => `  ${varName} : ${messages.join(", ")}`
+      )
+    ];
+    throw new Error(errorTextParts.join(Os.EOL));
+  }
+  const env = Value.Cast(
+    {
+      ...schema,
+      additionalProperties: false
+    },
+    parsed
+  );
+  return {
+    ...defaultValues,
+    ...env
+  };
 };
+
+export { envious };
+//# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AACvB,OAAO,EAAE,MAAM,IAAI,CAAC;AAEpB,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAEhD,MAAM,CAAC,MAAM,OAAO,GAAG,CAAoB,MAAS,EAAa,EAAE;IAC/D,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACjD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAChB,MAAM,qBAAqB,GAA6B,EAAE,CAAC;QAC3D,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;YACjC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC3C,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,EAAE,CAAC;gBACrC,qBAAqB,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;YAC3C,CAAC;YACD,qBAAqB,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,MAAM,cAAc,GAAa;YAC7B,+BAA+B;YAC/B,GAAG,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,GAAG,CACxC,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,KAAK,OAAO,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACnE;SACJ,CAAC;QACF,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CACb;QACI,GAAG,MAAM;QACT,oBAAoB,EAAE,KAAK;KAC9B,EACD,MAAM,CACT,CAAC;AACN,CAAC,CAAC"}
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAAA,OAAO;AAEP,SAAS,aAAa;AACtB,OAAO,QAAQ;AAER,IAAM,UAAU,CACnB,QACA,kBACY;AACZ,QAAM,SAAS,MAAM,QAAQ,QAAQ,QAAQ,GAAG;AAChD,QAAM,SAAS,CAAC,GAAG,MAAM,OAAO,QAAQ,MAAM,CAAC;AAC/C,MAAI,OAAO,QAAQ;AACf,UAAM,wBAAkD,CAAC;AACzD,WAAO,QAAQ,CAAC,EAAE,MAAM,QAAQ,MAAM;AAClC,YAAM,aAAa,KAAK,QAAQ,OAAO,EAAE;AACzC,UAAI,CAAC,sBAAsB,UAAU,GAAG;AACpC,8BAAsB,UAAU,IAAI,CAAC;AAAA,MACzC;AACA,4BAAsB,UAAU,EAAE,KAAK,OAAO;AAAA,IAClD,CAAC;AACD,UAAM,iBAA2B;AAAA,MAC7B;AAAA,MACA,GAAG,OAAO,QAAQ,qBAAqB,EAAE;AAAA,QACrC,CAAC,CAAC,SAAS,QAAQ,MAAM,KAAK,OAAO,MAAM,SAAS,KAAK,IAAI,CAAC;AAAA,MAClE;AAAA,IACJ;AACA,UAAM,IAAI,MAAM,eAAe,KAAK,GAAG,GAAG,CAAC;AAAA,EAC/C;AACA,QAAM,MAAM,MAAM;AAAA,IACd;AAAA,MACI,GAAG;AAAA,MACH,sBAAsB;AAAA,IAC1B;AAAA,IACA;AAAA,EACJ;AACA,SAAO;AAAA,IACH,GAAG;AAAA,IACH,GAAG;AAAA,EACP;AACJ","sourcesContent":["import 'dotenv/config';\nimport { type TObject, type Static } from '@sinclair/typebox';\nimport { Value } from '@sinclair/typebox/value';\nimport Os from 'os';\n\nexport const envious = <T extends TObject>(\n    schema: T,\n    defaultValues?: Static<T>\n): Static<T> => {\n    const parsed = Value.Convert(schema, process.env);\n    const errors = [...Value.Errors(schema, parsed)];\n    if (errors.length) {\n        const computedErrorMessages: Record<string, string[]> = {};\n        errors.forEach(({ path, message }) => {\n            const envVarName = path.replace(/^\\//, '');\n            if (!computedErrorMessages[envVarName]) {\n                computedErrorMessages[envVarName] = [];\n            }\n            computedErrorMessages[envVarName].push(message);\n        });\n        const errorTextParts: string[] = [\n            'Invalid environment variables',\n            ...Object.entries(computedErrorMessages).map(\n                ([varName, messages]) => `  ${varName} : ${messages.join(', ')}`\n            )\n        ];\n        throw new Error(errorTextParts.join(Os.EOL));\n    }\n    const env = Value.Cast(\n        {\n            ...schema,\n            additionalProperties: false\n        },\n        parsed\n    );\n    return {\n        ...defaultValues,\n        ...env\n    };\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pitininja/envious",
-    "version": "2.0.0",
+    "version": "3.0.0-beta.1",
     "license": "AGPL-3.0-or-later",
     "homepage": "https://github.com/pitininja/envious",
     "repository": {
@@ -8,14 +8,27 @@
         "url": "https://github.com/pitininja/envious"
     },
     "type": "module",
+    "files": [
+        "./dist",
+        "./LICENSE",
+        "./package.json",
+        "./package-lock.json",
+        "./README.md"
+    ],
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "import": "./dist/index.js",
+            "require": "./dist/index.cjs",
+            "types": "./dist/index.d.ts"
+        }
+    },
     "scripts": {
         "prepare": "[ -d '.husky' ] && husky || true",
-        "build": "tsc --build --clean tsconfig.json && tsc --project tsconfig.json",
+        "build": "tsup",
         "lint": "npx eslint . --ext=.js,.ts --max-warnings=0 && npx prettier --check . && npx tsc --noEmit",
         "format": "npx eslint . --fix --ext=.js,.ts --max-warnings=0 && npx prettier --write . && npx tsc --noEmit"
     },
-    "types": "./dist/index.d.ts",
-    "main": "./dist/index.js",
     "dependencies": {
         "@sinclair/typebox": "^0.32.20",
         "dotenv": "^16.4.5"
@@ -32,6 +45,7 @@
         "eslint-plugin-import": "^2.29.1",
         "husky": "^9.0.11",
         "prettier": "^3.2.5",
+        "tsup": "^8.0.2",
         "typescript": "^5.4.4"
     }
 }

package/.eslintignore

@@ -1,3 +0,0 @@
-node_modules
-dist
-.husky

package/.eslintrc

@@ -1,29 +0,0 @@
-{
-    "root": true,
-    "env": {
-        "node": true
-    },
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "project": "tsconfig.json"
-    },
-    "extends": ["airbnb-base", "airbnb-typescript/base", "prettier"],
-    "rules": {
-        "@typescript-eslint/lines-between-class-members": [
-            "error",
-            "always",
-            {
-                "exceptAfterSingleLine": true
-            }
-        ],
-        "import/prefer-default-export": "off",
-        "lines-between-class-members": "off",
-        "no-param-reassign": [
-            "error",
-            {
-                "props": false
-            }
-        ],
-        "radix": "off"
-    }
-}

package/.husky/pre-commit

@@ -1,5 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npm run format
-git add -u

package/.prettierignore

@@ -1,4 +0,0 @@
-node_modules
-dist
-.husky
-README.md

package/.prettierrc

@@ -1,7 +0,0 @@
-{
-    "trailingComma": "none",
-    "jsxSingleQuote": false,
-    "singleQuote": true,
-    "tabWidth": 4,
-    "useTabs": false
-}

package/src/index.ts

@@ -1,33 +0,0 @@
-import 'dotenv/config';
-import Os from 'os';
-import { type Static, type TSchema } from '@sinclair/typebox';
-import { Value } from '@sinclair/typebox/value';
-
-export const envious = <T extends TSchema>(schema: T): Static<T> => {
-    const parsed = Value.Convert(schema, process.env);
-    const errors = [...Value.Errors(schema, parsed)];
-    if (errors.length) {
-        const computedErrorMessages: Record<string, string[]> = {};
-        errors.forEach(({ path, message }) => {
-            const envVarName = path.replace(/^\//, '');
-            if (!computedErrorMessages[envVarName]) {
-                computedErrorMessages[envVarName] = [];
-            }
-            computedErrorMessages[envVarName].push(message);
-        });
-        const errorTextParts: string[] = [
-            'Invalid environment variables',
-            ...Object.entries(computedErrorMessages).map(
-                ([varName, messages]) => `  ${varName} : ${messages.join(', ')}`
-            )
-        ];
-        throw new Error(errorTextParts.join(Os.EOL));
-    }
-    return Value.Cast(
-        {
-            ...schema,
-            additionalProperties: false
-        },
-        parsed
-    );
-};

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-    "extends": "@tsconfig/recommended/tsconfig.json",
-    "ts-node": {
-        "transpileOnly": true,
-        "files": true
-    },
-    "compilerOptions": {
-        "outDir": "dist",
-        "target": "ESNext",
-        "module": "NodeNext",
-        "moduleResolution": "NodeNext",
-        "declaration": true,
-        "sourceMap": true,
-        "strict": true,
-        "esModuleInterop": true
-    },
-    "include": ["src"],
-    "exclude": ["node_modules"]
-}