├── .eslintignore ├── .github └── workflows │ └── build.yml ├── .gitignore ├── .husky ├── .gitignore └── pre-commit ├── LICENSE ├── README.md ├── build ├── environment.d.ts ├── environment.mjs └── environment.mjs.map ├── jest.config.ts ├── package-lock.json ├── package.json ├── rollup.config.ts ├── src └── environment.ts ├── test └── environment.spec.ts ├── tsconfig.json └── tsconfig.prod.json /.eslintignore: -------------------------------------------------------------------------------- 1 | *.js 2 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v4 12 | 13 | - uses: actions/setup-node@v3 14 | with: { node-version: 18.x } 15 | 16 | - run: npm --no-git-tag-version version 2.0.${{ github.run_number }} 17 | 18 | - run: npm ci 19 | 20 | - run: npm test 21 | 22 | - run: npm run build 23 | 24 | - if: github.ref == 'refs/heads/master' 25 | run: | 26 | echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > .npmrc 27 | npm publish --access public 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | dist 2 | node_modules 3 | coverage 4 | .idea 5 | -------------------------------------------------------------------------------- /.husky/.gitignore: -------------------------------------------------------------------------------- 1 | _ 2 | -------------------------------------------------------------------------------- /.husky/pre-commit: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | . "$(dirname "$0")/_/husky.sh" 3 | 4 | npm test 5 | npm run build && npm test 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | @hexlabs/env-vars-ts 2 | 3 | Typesafe control over environment variables in Typescript. 4 | 5 | [![Build](https://github.com/hexlabsio/env-vars-ts/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/hexlabsio/env-vars-ts/actions/workflows/build.yml) 6 | [![npm version](https://badge.fury.io/js/%40hexlabs%2Fenv-vars-ts.svg)](https://badge.fury.io/js/%40hexlabs%2Fenv-vars-ts) 7 | 8 | ## Get Started 9 | 10 | Define the **required** environment variable names that you want by calling `create()`: 11 | 12 | ```typescript 13 | const builder = EnvironmentBuilder.create('a', 'b'); 14 | ``` 15 | 16 | Define the optional environment variable names that you want: 17 | 18 | ```typescript 19 | const builder = EnvironmentBuilder 20 | .create('a', 'b') 21 | .optionals('c', 'd'); 22 | ``` 23 | 24 | Provide defaults optionally: 25 | 26 | ```typescript 27 | const builder = EnvironmentBuilder 28 | .create('a', 'b') 29 | .optionals('c', 'd') 30 | .defaults({ a: 'default for a' }); 31 | ``` 32 | 33 | Get environment variables from `process.env` by default or provide your own 34 | 35 | ```typescript 36 | // The type of environment is { a: string; b: string; c?: string; d?: string } 37 | const environment = EnvironmentBuilder 38 | .create('a', 'b') 39 | .optionals('c', 'd') 40 | .defaults({ a: 'default for a' }) 41 | .environment(); // <- Provide your own envs here 42 | ``` 43 | 44 | Provide custom transforms for selected envs 45 | 46 | ```typescript 47 | // The type of environment is 48 | // { 49 | // selected: boolean; 50 | // count: number; 51 | // optionallySelected?: boolean; 52 | // standardEnv?: string; 53 | // } 54 | const environment = EnvironmentBuilder 55 | .create('selected', 'count') 56 | .optionals('optionallySelected', 'standardEnv') 57 | .transform(s => s === 'true', 'selected', 'optionallySelected') 58 | .transform(s => Number.parseInt(s), 'count') 59 | .defaults({ count: 25 }) // defaults will take into account your transforms notice this is a number and not a string. 60 | .environment(); 61 | ``` 62 | 63 | Lazily retrieve the type of environment before running 64 | ```typescript 65 | const environmentBuilder = EnvironmentBuilder.create('a', 'b'); 66 | 67 | // Use Type alias for the environment defintion 68 | // We use this in HexLabs to define expected lambda environment variables when creating CloudFormation stacks 69 | // where we do not want to check at build time as the stack is generated form TypeScript. 70 | type EnvVars = ReturnType; 71 | 72 | //Get actual environment variables somewhere else 73 | const environment = environmentBuilder.environment(); 74 | ``` 75 | 76 | -------------------------------------------------------------------------------- /build/environment.d.ts: -------------------------------------------------------------------------------- 1 | type MapNamesToKeys = { 2 | [K in T[number]]: string; 3 | }; 4 | export declare class EnvironmentBuilder { 5 | private readonly info; 6 | private constructor(); 7 | optionals(...vars: S): EnvironmentBuilder]?: MapNamesToKeys[K]; 9 | }>; 10 | defaults(defaultValues?: Partial): EnvironmentBuilder; 11 | transform(transform: (value: string) => R, ...vars: S): EnvironmentBuilder & { 12 | [K in keyof Pick>]: R; 13 | }, Omit & { 14 | [K in keyof Pick>]: R; 15 | }>; 16 | environment(variables?: unknown): { 17 | [K in keyof (E & O)]: (E & O)[K]; 18 | }; 19 | static create(...vars: S): EnvironmentBuilder<{ 20 | [K in keyof MapNamesToKeys]: MapNamesToKeys[K]; 21 | }, {}>; 22 | private requiredEnvs; 23 | private optionalEnvs; 24 | } 25 | export {}; 26 | -------------------------------------------------------------------------------- /build/environment.mjs: -------------------------------------------------------------------------------- 1 | class EnvironmentBuilder { 2 | info; 3 | constructor(info) { 4 | this.info = info; 5 | } 6 | optionals(...vars) { 7 | return new EnvironmentBuilder({ ...this.info, optionalKeys: [...this.info.optionalKeys, ...vars] }); 8 | } 9 | defaults(defaultValues = {}) { 10 | return new EnvironmentBuilder({ ...this.info, defaultValues }); 11 | } 12 | transform(transform, ...vars) { 13 | return new EnvironmentBuilder({ ...this.info, transforms: vars.reduce((prev, next) => ({ ...prev, [next]: transform }), this.info.transforms) }); 14 | } 15 | environment(variables = process.env) { 16 | const optionalEnvs = this.optionalEnvs(variables); 17 | const requiredEnvs = this.requiredEnvs(variables); 18 | const allEnvs = { ...optionalEnvs, ...requiredEnvs.requiredEnvs }; 19 | const errors = requiredEnvs?.errors ?? []; 20 | if (errors.length > 0) { 21 | const message = `The following environment variables are required but not set ${JSON.stringify(errors)}`; 22 | throw new Error(message); 23 | } 24 | return allEnvs; 25 | } 26 | static create(...vars) { 27 | return new EnvironmentBuilder({ requiredKeys: vars, optionalKeys: [], defaultValues: {}, transforms: {} }); 28 | } 29 | requiredEnvs(environment) { 30 | return this.info.requiredKeys.reduce((result, key) => { 31 | const envValue = environment[key] ?? this.info.defaultValues[key]; 32 | if (envValue !== undefined) { 33 | const transformed = this.info.transforms[key] ? this.info.transforms[key](envValue) : envValue; 34 | return { errors: result.errors, requiredEnvs: { ...result.requiredEnvs, [key]: transformed } }; 35 | } 36 | return { errors: [...result.errors, key], requiredEnvs: { ...result.requiredEnvs, [key]: envValue } }; 37 | }, { errors: new Array(), requiredEnvs: {} }); 38 | } 39 | optionalEnvs(environment) { 40 | return this.info.optionalKeys.reduce((result, key) => { 41 | const transformed = this.info.transforms[key] ? this.info.transforms[key](environment[key]) : environment[key]; 42 | return ({ ...result, [key]: transformed }); 43 | }, {}); 44 | } 45 | } 46 | 47 | export { EnvironmentBuilder }; 48 | //# sourceMappingURL=environment.mjs.map 49 | -------------------------------------------------------------------------------- /build/environment.mjs.map: -------------------------------------------------------------------------------- 1 | {"version":3,"file":"environment.mjs","sources":["../src/src/environment.ts"],"sourcesContent":[null],"names":[],"mappings":"MAEa,kBAAkB,CAAA;AAGV,IAAA,IAAA,CAAA;AADnB,IAAA,WAAA,CACmB,IAKhB,EAAA;QALgB,IAAI,CAAA,IAAA,GAAJ,IAAI,CAKpB;KACA;IAGH,SAAS,CAAqB,GAAG,IAAO,EAAA;QACtC,OAAO,IAAI,kBAAkB,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAE,YAAY,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;KACtG;IAED,QAAQ,CAAC,gBAA4B,EAAE,EAAA;AACrC,QAAA,OAAO,IAAI,kBAAkB,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;KAChE;AAED,IAAA,SAAS,CAAiC,SAA+B,EAAE,GAAG,IAAO,EAAA;AACnF,QAAA,OAAO,IAAI,kBAAkB,CAAW,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,MAAM,EAAC,GAAG,IAAI,EAAE,CAAC,IAAI,GAAG,SAAS,EAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;KAC1J;AAED,IAAA,WAAW,CAAC,SAAA,GAAqB,OAAO,CAAC,GAAG,EAAA;QAC1C,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAClD,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,EAAC,GAAG,YAAY,EAAE,GAAG,YAAY,CAAC,YAAY,EAAC,CAAC;AAChE,QAAA,MAAM,MAAM,GAAG,YAAY,EAAE,MAAM,IAAI,EAAE,CAAC;AAC1C,QAAA,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,MAAM,OAAO,GAAG,CAAA,6DAAA,EAAgE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA,CAAE,CAAC;AACzG,YAAA,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;AAC1B,SAAA;AACD,QAAA,OAAO,OAAc,CAAC;KACvB;AAED,IAAA,OAAO,MAAM,CAAqB,GAAG,IAAO,EAAA;QAC1C,OAAO,IAAI,kBAAkB,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;KAC5G;AAEO,IAAA,YAAY,CAAC,WAAgB,EAAA;AACnC,QAAA,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAI;AACnD,YAAA,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,IAAK,IAAI,CAAC,IAAI,CAAC,aAAqB,CAAC,GAAG,CAAC,CAAC;YAC3E,IAAI,QAAQ,KAAK,SAAS,EAAE;AAC1B,gBAAA,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;gBAC/F,OAAO,EAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,EAAC,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC,GAAG,GAAG,WAAW,EAAC,EAAC,CAAC;AAC5F,aAAA;YACD,OAAO,EAAC,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAC,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC,GAAG,GAAG,QAAQ,EAAC,EAAC,CAAC;AACpG,SAAC,EAAE,EAAC,MAAM,EAAE,IAAI,KAAK,EAAU,EAAE,YAAY,EAAE,EAAE,EAAC,CAAC,CAAC;KACrD;AAEO,IAAA,YAAY,CAAC,WAAgB,EAAA;AACnC,QAAA,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,KAAI;AACnD,YAAA,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;AAC/G,YAAA,QAAQ,EAAC,GAAG,MAAM,EAAE,CAAC,GAAG,GAAG,WAAW,EAAE,EAAE;SAC3C,EAAE,EAAE,CAAC,CAAC;KACR;AACF;;;;"} -------------------------------------------------------------------------------- /jest.config.ts: -------------------------------------------------------------------------------- 1 | import { JestConfigWithTsJest } from 'ts-jest'; 2 | import { defaultsESM as tsjPreset } from 'ts-jest/presets'; 3 | 4 | 5 | const config: JestConfigWithTsJest = { 6 | ...tsjPreset, 7 | } 8 | 9 | export default config; 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@hexlabs/env-vars-ts", 3 | "author": "hexlabs.io", 4 | "type": "module", 5 | "version": "2.0.0", 6 | "description": "Type safe control over environment variables in typescript", 7 | "main": "build/environment.mjs", 8 | "types": "build/environment.d.ts", 9 | "homepage": "https://github.com/hexlabsio/env-vars-ts#readme", 10 | "scripts": { 11 | "build": "rollup -c rollup.config.ts --configPlugin @rollup/plugin-typescript", 12 | "prebuild": "npm run lint", 13 | "lint": "eslint src --ext .ts", 14 | "test": "NODE_OPTIONS=--experimental-vm-modules jest --no-cache --ci --runInBand --collectCoverage --restoreMocks", 15 | "prepare": "husky install" 16 | }, 17 | "keywords": ["environment", "variables", "env", "envs"], 18 | "devDependencies": { 19 | "@types/jest": "^29.5.5", 20 | "@types/node": "^18.18.5", 21 | "@typescript-eslint/eslint-plugin": "^6.7.5", 22 | "@typescript-eslint/parser": "^6.7.5", 23 | "eslint": "^8.51.0", 24 | "husky": "^5.2.0", 25 | "jest": "^29.7.0", 26 | "jest-mock-extended": "^3.0.5", 27 | "ts-jest": "^29.1.1", 28 | "ts-node": "^10.9.1", 29 | "typescript": "^5.7.2", 30 | "@rollup/plugin-commonjs": "^25.0.5", 31 | "@rollup/plugin-json": "^6.0.1", 32 | "@rollup/plugin-node-resolve": "^15.2.3", 33 | "@rollup/plugin-typescript": "^11.1.5", 34 | "tslib": "^2.6.2", 35 | "rollup": "^4.0.2" 36 | }, 37 | "eslintConfig": { 38 | "root": true, 39 | "parser": "@typescript-eslint/parser", 40 | "plugins": [ 41 | "@typescript-eslint" 42 | ], 43 | "extends": [ 44 | "eslint:recommended", 45 | "plugin:@typescript-eslint/eslint-recommended", 46 | "plugin:@typescript-eslint/recommended" 47 | ], 48 | "rules": { 49 | "@typescript-eslint/ban-types": 0, 50 | "@typescript-eslint/no-explicit-any": 0 51 | } 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /rollup.config.ts: -------------------------------------------------------------------------------- 1 | import { defineConfig } from 'rollup'; 2 | import commonjs from '@rollup/plugin-commonjs'; 3 | import typescript from '@rollup/plugin-typescript'; 4 | import resolve from '@rollup/plugin-node-resolve'; 5 | import json from '@rollup/plugin-json'; 6 | 7 | export default defineConfig({ 8 | input: 'src/environment.ts', 9 | output: { 10 | format: 'esm', 11 | sourcemap: true, 12 | file: 'build/environment.mjs', 13 | }, 14 | plugins: [ 15 | json({ compact: true }), 16 | commonjs(), 17 | resolve({ preferBuiltins: true, exportConditions: ['node'] }), 18 | typescript({ sourceMap: true, tsconfig: 'tsconfig.prod.json' }) 19 | ], 20 | }); 21 | -------------------------------------------------------------------------------- /src/environment.ts: -------------------------------------------------------------------------------- 1 | type MapNamesToKeys = { [K in T[number]]: string } 2 | 3 | export class EnvironmentBuilder { 4 | 5 | private constructor( 6 | private readonly info: { 7 | requiredKeys: string[]; 8 | optionalKeys: string[]; 9 | defaultValues: Partial; 10 | transforms: Record unknown>; 11 | } 12 | ){} 13 | 14 | 15 | optionals(...vars: S): EnvironmentBuilder]?: MapNamesToKeys[K] }> { 16 | return new EnvironmentBuilder({ ...this.info, optionalKeys: [...this.info. optionalKeys, ...vars] }); 17 | } 18 | 19 | defaults(defaultValues: Partial): EnvironmentBuilder { 20 | return new EnvironmentBuilder({ ...this.info, defaultValues }); 21 | } 22 | 23 | transform(transform: (value: string) => R, ...vars: S): EnvironmentBuilder & { [K in keyof Pick>]: R }, Omit & { [K in keyof Pick>]: R }> { 24 | return new EnvironmentBuilder({ ...this.info, transforms: vars.reduce((prev, next) => ({...prev, [next]: transform}), this.info.transforms) }); 25 | } 26 | 27 | environment(variables: unknown = process.env): { [K in keyof (E & O)]: (E & O)[K] } { 28 | const optionalEnvs = this.optionalEnvs(variables); 29 | const requiredEnvs = this.requiredEnvs(variables); 30 | const allEnvs = {...optionalEnvs, ...requiredEnvs.requiredEnvs}; 31 | const errors = requiredEnvs?.errors ?? []; 32 | if (errors.length > 0) { 33 | const message = `The following environment variables are required but not set ${JSON.stringify(errors)}`; 34 | throw new Error(message); 35 | } 36 | return allEnvs as any; 37 | } 38 | 39 | static create(...vars: S): EnvironmentBuilder<{ [K in keyof MapNamesToKeys]: MapNamesToKeys[K] }, {}> { 40 | return new EnvironmentBuilder({ requiredKeys: vars, optionalKeys: [], defaultValues: {}, transforms: {} }) as any; 41 | } 42 | 43 | private requiredEnvs(environment: any): { errors: string[], requiredEnvs: any } { 44 | return this.info.requiredKeys.reduce((result, key) => { 45 | const value = environment[key]; 46 | const hasValue = value !== undefined; 47 | const envValue = hasValue ? environment[key] : (this.info.defaultValues as any)[key]; 48 | if (envValue !== undefined) { 49 | const transformed = (this.info.transforms[key] && hasValue) ? this.info.transforms[key](envValue) : envValue; 50 | return {errors: result.errors, requiredEnvs: {...result.requiredEnvs, [key]: transformed}}; 51 | } 52 | return {errors: [...result.errors, key], requiredEnvs: {...result.requiredEnvs, [key]: envValue}}; 53 | }, {errors: new Array(), requiredEnvs: {}}); 54 | } 55 | 56 | private optionalEnvs(environment: any): any { 57 | return this.info.optionalKeys.reduce((result, key) => { 58 | const transformed = this.info.transforms[key] ? this.info.transforms[key](environment[key]) : environment[key]; 59 | return ({...result, [key]: transformed }); 60 | }, {}); 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /test/environment.spec.ts: -------------------------------------------------------------------------------- 1 | import { EnvironmentBuilder } from '../src/environment'; 2 | 3 | describe('Environment', () => { 4 | 5 | it('should pull only typed vars from environment passed in', () => { 6 | const environment = EnvironmentBuilder.create('a').optionals('c').environment({a: 'abc', b: '123', c: 'def'}); 7 | expect(Object.keys(environment)).toEqual(['c', 'a']); 8 | expect(environment).toEqual({a: 'abc', c: 'def'}) 9 | }); 10 | 11 | it('should accept only required variables', () => { 12 | const environment = EnvironmentBuilder.create('a').environment({a: 'abc', b: '123', c: 'def'}); 13 | expect(Object.keys(environment)).toEqual(['a']); 14 | expect(environment).toEqual({a: 'abc'}) 15 | }); 16 | 17 | it('should pull only typed vars from process environment', () => { 18 | process.env = {a: 'abc', b: '123', c: 'def'} 19 | const environment = EnvironmentBuilder.create('a').optionals('c').environment(); 20 | expect(Object.keys(environment)).toEqual(['c', 'a']); 21 | expect(environment).toEqual({a: 'abc', c: 'def'}) 22 | }); 23 | 24 | it('should default vars that are not present', () => { 25 | const environment = EnvironmentBuilder.create('a').optionals('c').defaults({a: 'a'}).environment({}); 26 | expect(environment).toEqual({a: 'a'}) 27 | }); 28 | 29 | describe('Getting and Translating Envs', () => { 30 | 31 | it('should get boolean env', () => { 32 | const environment = EnvironmentBuilder.create('a').optionals('c', 'd') 33 | .transform(s => s === 'true', 'a').environment({a: 'true', b: '123'}); 34 | expect(environment).toEqual({a: true}); 35 | }); 36 | 37 | it('should allow setting of transformed type as default', () => { 38 | const environment = EnvironmentBuilder.create('a').optionals('c', 'd') 39 | .transform(s => s === 'true', 'a') 40 | .defaults({ a: false }) 41 | .environment({ d: '123'}); 42 | expect(environment).toEqual({a: false, d: '123'}); 43 | }); 44 | 45 | describe('Error Scenarios', () => { 46 | it('should throw err when required var not present', () => { 47 | expect(() => EnvironmentBuilder.create('a').environment({b: '123'})) 48 | .toThrowError("The following environment variables are required but not set [\"a\"]"); 49 | }); 50 | }); 51 | 52 | }); 53 | 54 | it('should allow setting of transformed type as default', () => { 55 | const builder = EnvironmentBuilder.create('a').optionals('c', 'd') 56 | .transform(s => s === 'true', 'a') 57 | .defaults({ a: true }) 58 | expect(builder.environment({ d: '123'})).toEqual({a: true, d: '123'}); 59 | expect(builder.environment({ d: '123', a: 'xyz'})).toEqual({a: false, d: '123'}); 60 | expect(builder.environment({ d: '123', a: 'true'})).toEqual({a: true, d: '123'}); 61 | }); 62 | }) 63 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "rootDir": "src", 4 | "baseUrl": ".", 5 | "outDir": ".", 6 | "strict": true, 7 | "noUnusedLocals": true, 8 | "declaration": true, 9 | "allowSyntheticDefaultImports": false, 10 | "noImplicitAny": true, 11 | "noImplicitThis": true, 12 | "alwaysStrict": true, 13 | "strictNullChecks": true, 14 | "strictFunctionTypes": true, 15 | "allowJs": true, 16 | "moduleResolution": "node", 17 | "module": "ES2022", 18 | "target": "ES2022", 19 | "pretty": true, 20 | "inlineSourceMap": false, 21 | "inlineSources": false, 22 | "esModuleInterop": true 23 | }, 24 | "ts-node": { 25 | "esm": true, 26 | "experimentalSpecifierResolution": "node" 27 | }, 28 | "include": ["src/**/*"], 29 | "exclude": ["node_modules"] 30 | } 31 | -------------------------------------------------------------------------------- /tsconfig.prod.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./tsconfig.json", 3 | "exclude": ["node_modules", "**/*.spec.ts"] 4 | } 5 | --------------------------------------------------------------------------------