configate 0.1.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 [yyyy] [name of copyright owner]
+
+   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

@@ -0,0 +1,215 @@
+# Configate
+
+Configuration helper for TypeScript applications.
+
+It acts as a gateway to your configuration, allowing it to be defined in various ways but used only in a single, type-safe manner.
+
+No dependencies, ESM only.
+
+## Overview
+
+Configate supports:
+- defining type-safe configuration files in TypeScript
+- loading configuration files in `ts`, `js` and `json` formats
+- merging default configuration with environment-specific one based on `NODE_ENV` environment variable (or the provided environment name) 
+- merging configs from multiple directories
+- merging objects deeply. Arrays are always replaced, not merged. 
+- reading environment variables and treating them as part of configuration - should always be used for secrets
+- easy and type-safe access to configuration properties - it throws error when accessing undefined properties
+- configuration immutability - it freezes the configuration object to prevent modifications
+- EcmaScript Modules (ESM) - it works **only** in ESM applications
+   - but config files can be in CommonJS format if really necessary
+
+## Installation
+
+To install Configate, use your preferred package manager:
+
+```sh
+npm install configate
+```
+
+## Usage
+
+### Using Configate in your application
+
+Use the `loadConfig` function once, to load and merge configurations from specified directories. 
+With parameters you can define:
+- `configDirs`: (Default: `['${current-working-directory}/config']`) An array of directories to load configurations from
+- `environment`: (Default: `process.env.NODE_ENV`) The environment to load specific configurations for
+- `fileExtensions`: (Default: `['ts', 'js']`) An array of file extensions to load configurations from
+- `throwOnUndefinedProp`: (Default: `true`) If true, throws an error when accessing undefined properties
+- `freezeConfig`: (Default: `true`) If true, freezes the configuration object to make it immutable
+
+```ts
+// src/config.ts
+import { loadConfig } from 'configate';
+
+export const { config } = await loadConfig<YourConfigStructure>();
+
+export type YourConfigStructure = {
+  database: {
+    host: string;
+    port: number;
+    password: string
+  };
+};
+```
+
+Use this `src/config.ts` anywhere in your application to access the configuration object just like this:
+```ts
+// src/app.ts
+import { config } from './config.ts';
+
+const database = dbClient({
+  host: config.database.host,
+  port: config.database.port,
+  password: config.database.password, 
+});
+```
+
+### Defining configuration files
+
+1. Create a `config` directory in your project.
+2. Create `default.ts` file in `config` directory and export a `config` object with default values.
+
+```ts
+// config/default.ts
+import type { YourConfigStructure } from '../src/config.ts';
+
+export const config: YourConfigStructure = {
+  database: {
+    host: 'localhost',
+    port: 5432,
+    password: ''   
+  },
+};
+```
+
+That's it 🎉 
+
+### Defining environment-specific configuration files
+
+Environments can be named for example `development`, `staging`, `production` but you can use any names you want.
+
+Create for example `production.ts` file in `config` directory and export a `config` object.
+- you can use the `DeepPartial` type to allow partial configuration, since usually you just want to override some properties.
+- this file will be merged with the default configuration if the `NODE_ENV` environment variable is set to `production`.
+
+```ts
+// config/production.ts
+import type { DeepPartial } from 'configate';
+import type { YourConfigStructure } from '../src/config.ts';
+
+export const config: DeepPartial<YourConfigStructure> = {
+    database: {
+        host: 'database-production-server.com',
+    },
+};
+```
+
+Do the same for other environments if you need to override more properties for them.
+
+### Using environment variables
+
+When you need to define secrets in configuration, they should be defined via environment variables.
+
+Create `custom-environment-variables.ts` file in `config` directory and export a `config` object.
+- use `process.env` to read environment variables and assign to property in your configuration
+- this file will be merged with other configs as last one so environment variables always have priority
+
+```ts
+// config/custom-environment-variables.ts
+import type { DeepPartial } from 'configate';
+import type { YourConfigStructure } from '../src/config.ts';
+
+export const config: DeepPartial<YourConfigStructure> = {
+    database: {
+        password: process.env.DATABASE_PASSWORD,
+    },
+};
+```
+
+### Defining local configuration files
+
+Local configuration files are not committed to the repository and are used for local development only.
+Use them to override some configuration when running the application locally.
+
+Supported variants:
+- `local.ts` - always loaded
+- `local-{environment}.ts` - local, environment-specific config. Example: `local-development.ts` 
+   - loaded when `NODE_ENV` is set or `environment` parameter is provided to `loadConfig` function
+
+Add this to `.gitignore` to prevent committing local configuration files:
+```txt
+**/config/local*
+```
+
+### Order of loading configuration files
+
+```
+default.ext
+{environment}.ext
+local.ext
+local-{environment}.ext
+custom-environment-variables.ext
+```
+
+### Using unsecure config
+
+Sometimes you may need to use configuration which doesn't throw on undefined properties, 
+for example when you want to pass part of it to some external module and it will try to read unknown properties.
+But you shouldn't set `throwOnUndefinedProp: false` to just handle this case.
+
+For this reason, the `unsecureConfig` object is also returned from `loadConfig` function, alongside the `config` object.
+
+```ts
+// src/config.ts
+import { loadConfig } from 'configate';
+
+export const { config, unsecureConfig } = await loadConfig();
+
+someExternalModule(unsecureConfig.database); // It won't throw error if external module tries to read e.g. `unsecureConfig.database.user` property
+```
+
+### Alias for config file
+
+If you want to import `src/config.ts` with absolute path, define:
+```json5
+// package.json
+{
+  "imports": {
+    "#config": "./src/config.ts"
+  }
+}
+```
+and
+```json5
+// tsconfig.json
+{
+  "compilerOptions": {
+    "paths": { "#config": ["./src/config.ts"] }
+  }
+}
+```
+and then import it like this:
+```ts
+import { config } from '#config';
+
+const host = config.database.host;
+```    
+
+### Examples
+
+#### Loading configurations from multiple directories
+
+```ts
+import { loadConfig } from 'configate';
+
+export const { config } = await loadConfig<TestConfig>({
+  configDirs: [
+    `${import.meta.dirname}/../../someParentConfigDirectory`,
+    `${import.meta.dirname}/../config`,
+  ],
+});
+```
+

package/dist/common.d.ts

@@ -0,0 +1,7 @@
+export type DefaultConfig = Record<string, any>;
+export type Environment = 'development' | 'staging' | 'production' | 'test' | string;
+export type FileExtension = 'ts' | 'mts' | 'js' | 'mjs' | 'cjs' | 'json';
+export type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T | undefined;
+export declare function isObject(item: unknown): item is object;

package/dist/common.js

@@ -0,0 +1,3 @@
+export function isObject(item) {
+    return item !== null && typeof item === 'object' && !Array.isArray(item);
+}

package/dist/deepFreezeConfig.d.ts

@@ -0,0 +1,5 @@
+import { type DefaultConfig } from './common.ts';
+/**
+ * Use Object.freeze to make the config object immutable
+ */
+export declare function deepFreezeConfig<T extends DefaultConfig>(config: T): T;

package/dist/deepFreezeConfig.js

@@ -0,0 +1,12 @@
+import { isObject } from "./common.js";
+/**
+ * Use Object.freeze to make the config object immutable
+ */
+export function deepFreezeConfig(config) {
+    for (const key in config) {
+        if (isObject(config[key])) {
+            config[key] = deepFreezeConfig(config[key]);
+        }
+    }
+    return Object.freeze(config);
+}

package/dist/deepMerge.d.ts

@@ -0,0 +1,9 @@
+import { type DefaultConfig } from './common.ts';
+/**
+ * Custom implementation of deepMerge to avoid using an external dependency
+ *
+ * - it merges objects deeply
+ * - it overrides array, doesn't merge array elements
+ * - it ignores properties with `undefined` values
+ */
+export declare function deepMerge<T extends DefaultConfig>(target: T, ...sources: Array<Partial<T>>): T;

package/dist/deepMerge.js

@@ -0,0 +1,31 @@
+import { isObject } from "./common.js";
+/**
+ * Custom implementation of deepMerge to avoid using an external dependency
+ *
+ * - it merges objects deeply
+ * - it overrides array, doesn't merge array elements
+ * - it ignores properties with `undefined` values
+ */
+export function deepMerge(target, ...sources) {
+    if (!sources.length) {
+        return target;
+    }
+    const source = sources.shift();
+    if (isObject(target) && isObject(source)) {
+        for (const key in source) {
+            if (Object.prototype.hasOwnProperty.call(source, key)) {
+                if (key === '__proto__' || key === 'constructor') {
+                    continue;
+                }
+                const sourceValue = source[key];
+                if (isObject(sourceValue) && isObject(target[key])) {
+                    target[key] = deepMerge(target[key], sourceValue);
+                }
+                else if (sourceValue !== undefined) {
+                    target[key] = sourceValue;
+                }
+            }
+        }
+    }
+    return deepMerge(target, ...sources);
+}

package/dist/defineConfig.d.ts

@@ -0,0 +1,39 @@
+import type { DefaultConfig, Environment, FileExtension } from './common.ts';
+/**
+ * Config library to load configuration files based on the environment
+ *
+ * Features:
+ * - Load config files in order:
+ *     1. default.ext
+ *     2. {environment}.ext
+ *     4. local.ext
+ *     3. local-{environment}.ext
+ *     5. custom-environment-variables.ext (only for .ts and .js files)
+ * - Throw an error if a property is accessed that is not defined in the config
+ * - Freeze the config object to prevent modifications
+ * - Supported config file formats: TypeScript (.ts, .mts), JavaScript (.js, .mjs), JSON (.json)
+ * - Config file can `export default {}` or `export const config: Config = { ... }`.
+ *     - named export is recommended in TS for type safety of the config object
+ *
+ * @param configDirs - paths to directories where the config files are located. Relative or absolute. Directories are merged in the array order. Default: ['${current-working-directory}/config']
+ * @param environment - the environment to load the config for. Default: process.env.NODE_ENV
+ * @param fileExtensions - an array of file extensions to use when looking for config files. Configs are loaded in this order. Default: ['ts', 'js']
+ * @param throwOnUndefinedProp - throw an error if a property is accessed that is not defined in the config. Default: true
+ * @param freezeConfig - freeze the config object to prevent modifications. Default: true
+ *
+ * @returns a promise that resolves to an object with 2 properties:
+ *    - `config` - a secure, frozen object with the loaded config. Throws an error if an undefined property is accessed
+ *    - `unsecureConfig` - an unsecure config. May be needed if config is passed directly to some module that wants to read undefined props or modify it
+ */
+export declare function defineConfig<Config extends DefaultConfig>({ configDirs, environment, fileExtensions, throwOnUndefinedProp, freezeConfig, }: DefineConfigOptions): Promise<{
+    config: Config;
+    unsecureConfig: Config;
+}>;
+type DefineConfigOptions = {
+    configDirs?: string[];
+    environment?: Environment;
+    fileExtensions?: FileExtension[];
+    throwOnUndefinedProp?: boolean;
+    freezeConfig?: boolean;
+};
+export {};

package/dist/defineConfig.js

@@ -0,0 +1,52 @@
+import { deepFreezeConfig } from "./deepFreezeConfig.js";
+import { deepMerge } from "./deepMerge.js";
+import { importConfigFiles } from "./importConfigFiles.js";
+import { makeSecureDeepProxy } from "./makeSecureDeepProxy.js";
+/**
+ * Config library to load configuration files based on the environment
+ *
+ * Features:
+ * - Load config files in order:
+ *     1. default.ext
+ *     2. {environment}.ext
+ *     4. local.ext
+ *     3. local-{environment}.ext
+ *     5. custom-environment-variables.ext (only for .ts and .js files)
+ * - Throw an error if a property is accessed that is not defined in the config
+ * - Freeze the config object to prevent modifications
+ * - Supported config file formats: TypeScript (.ts, .mts), JavaScript (.js, .mjs), JSON (.json)
+ * - Config file can `export default {}` or `export const config: Config = { ... }`.
+ *     - named export is recommended in TS for type safety of the config object
+ *
+ * @param configDirs - paths to directories where the config files are located. Relative or absolute. Directories are merged in the array order. Default: ['${current-working-directory}/config']
+ * @param environment - the environment to load the config for. Default: process.env.NODE_ENV
+ * @param fileExtensions - an array of file extensions to use when looking for config files. Configs are loaded in this order. Default: ['ts', 'js']
+ * @param throwOnUndefinedProp - throw an error if a property is accessed that is not defined in the config. Default: true
+ * @param freezeConfig - freeze the config object to prevent modifications. Default: true
+ *
+ * @returns a promise that resolves to an object with 2 properties:
+ *    - `config` - a secure, frozen object with the loaded config. Throws an error if an undefined property is accessed
+ *    - `unsecureConfig` - an unsecure config. May be needed if config is passed directly to some module that wants to read undefined props or modify it
+ */
+export async function defineConfig({ configDirs = [`${process.cwd()}/config`], environment = process.env.NODE_ENV, fileExtensions = ['ts', 'js'], throwOnUndefinedProp = true, freezeConfig = true, }) {
+    let mergedConfig = {};
+    for (const configDir of configDirs) {
+        const config = await importConfigFiles({
+            configDir,
+            environment,
+            fileExtensions,
+        });
+        mergedConfig = deepMerge(mergedConfig, config);
+    }
+    const unsecureConfig = structuredClone(mergedConfig);
+    if (throwOnUndefinedProp) {
+        mergedConfig = makeSecureDeepProxy(mergedConfig);
+    }
+    if (freezeConfig) {
+        mergedConfig = deepFreezeConfig(mergedConfig);
+    }
+    return {
+        config: mergedConfig,
+        unsecureConfig: unsecureConfig,
+    };
+}

package/dist/importConfigFile.d.ts

@@ -0,0 +1,6 @@
+import type { DefaultConfig, FileExtension } from './common.ts';
+export declare function importConfigFile<Config extends DefaultConfig>({ filePath, fileExtensions, shouldThrowError, }: {
+    filePath: string;
+    fileExtensions: FileExtension[];
+    shouldThrowError?: boolean;
+}): Promise<Config>;

package/dist/importConfigFile.js

@@ -0,0 +1,45 @@
+var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
+    if (typeof path === "string" && /^\.\.?\//.test(path)) {
+        return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
+            return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
+        });
+    }
+    return path;
+};
+import fs from 'node:fs/promises';
+export async function importConfigFile({ filePath, fileExtensions, shouldThrowError = false, }) {
+    let selectedExtension;
+    for (const ext of fileExtensions) {
+        try {
+            // Quickly check if the file exists to avoid unnecessary parsing in import()
+            await fs.access(`${filePath}.${ext}`, fs.constants.R_OK);
+            selectedExtension = ext;
+            break;
+        }
+        catch (_error) { }
+    }
+    if (!selectedExtension) {
+        if (shouldThrowError) {
+            throw new Error(`Config file "${filePath}" not found with any extension: ${fileExtensions.join(', ')}`);
+        }
+        return {};
+    }
+    const importOptions = selectedExtension === 'json' ? { with: { type: 'json' } } : undefined;
+    try {
+        const configFile = await import(__rewriteRelativeImportExtension(`${filePath}.${selectedExtension}`), importOptions);
+        // Named export of `config` variable is preferred over default export
+        if (configFile.config) {
+            return configFile.config;
+        }
+        if (configFile.default) {
+            return configFile.default;
+        }
+        throw new Error(`Config file "${filePath}" has no default export and does not have export "config"`);
+    }
+    catch (error) {
+        if (shouldThrowError) {
+            throw error;
+        }
+        return {};
+    }
+}

package/dist/importConfigFiles.d.ts

@@ -0,0 +1,8 @@
+import type { DefaultConfig, Environment, FileExtension } from './common.ts';
+export declare function importConfigFiles<Config extends DefaultConfig>({ configDir, environment, fileExtensions, }: ImportConfigFilesOptions): Promise<DefaultConfig>;
+type ImportConfigFilesOptions = {
+    configDir: string;
+    environment?: Environment;
+    fileExtensions: FileExtension[];
+};
+export {};

package/dist/importConfigFiles.js

@@ -0,0 +1,37 @@
+import { deepMerge } from "./deepMerge.js";
+import { importConfigFile } from "./importConfigFile.js";
+export async function importConfigFiles({ configDir, environment, fileExtensions, }) {
+    const defaultConfig = await importConfigFile({
+        filePath: `${configDir}/default`,
+        fileExtensions,
+        shouldThrowError: true,
+    });
+    let envConfig;
+    if (environment) {
+        try {
+            envConfig = await importConfigFile({
+                filePath: `${configDir}/${environment}`,
+                fileExtensions,
+                shouldThrowError: true,
+            });
+        }
+        catch (_error) {
+            console.warn(`Environment ${environment} defined but no config file found`);
+        }
+    }
+    const localConfig = await importConfigFile({
+        filePath: `${configDir}/local`,
+        fileExtensions,
+    });
+    const localEnvConfig = environment
+        ? await importConfigFile({
+            filePath: `${configDir}/local-${environment}`,
+            fileExtensions,
+        })
+        : {};
+    const customEnvVarsConfig = await importConfigFile({
+        filePath: `${configDir}/custom-environment-variables`,
+        fileExtensions: fileExtensions.filter((ext) => ext !== 'json'), // JSON not supported because it cannot use `process.env`
+    });
+    return deepMerge(structuredClone(defaultConfig), structuredClone(envConfig ?? {}), structuredClone(localConfig), structuredClone(localEnvConfig), structuredClone(customEnvVarsConfig));
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { defineConfig } from './defineConfig.ts';
+export type { DeepPartial, Environment, FileExtension } from './common.ts';

package/dist/index.js

@@ -0,0 +1 @@
+export { defineConfig } from "./defineConfig.js";

package/dist/makeSecureDeepProxy.d.ts

@@ -0,0 +1,6 @@
+import { type DefaultConfig } from './common.ts';
+/**
+ * Use Proxy to add custom behavior when accessing properties of the config object
+ * Throw an error if the property is not defined in the config
+ */
+export declare function makeSecureDeepProxy<T extends DefaultConfig>(config: T): T;

package/dist/makeSecureDeepProxy.js

@@ -0,0 +1,35 @@
+import { isObject } from "./common.js";
+/**
+ * Use Proxy to add custom behavior when accessing properties of the config object
+ * Throw an error if the property is not defined in the config
+ */
+export function makeSecureDeepProxy(config) {
+    for (const prop in config) {
+        if (isObject(config[prop])) {
+            // If it's an object, recursively wrap it
+            config[prop] = makeSecureDeepProxy(config[prop]);
+        }
+        else if (Array.isArray(config[prop])) {
+            // If it's an array, wrap each element and the array itself
+            config[prop] = makeSecureProxy(config[prop].map((item) => isObject(item) || Array.isArray(item)
+                ? makeSecureDeepProxy(item)
+                : item));
+        }
+    }
+    return makeSecureProxy(config);
+}
+function makeSecureProxy(targetObject) {
+    return new Proxy(targetObject, {
+        get(target, prop) {
+            // Handle Symbol.toStringTag and Array properties
+            if (prop === Symbol.toStringTag ||
+                (Array.isArray(target) && Number.isNaN(Number(prop)))) {
+                return Reflect.get(target, prop);
+            }
+            if (!(prop in target)) {
+                throw new Error(`Property ${String(prop)} is not defined in the config`);
+            }
+            return Reflect.get(target, prop);
+        },
+    });
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "configate",
+	"version": "0.1.0",
+	"type": "module",
+	"description": "Configuration helper for TypeScript applications",
+	"main": "dist/index.js",
+	"module": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		".": {
+			"default": "./dist/index.js",
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
+		}
+	},
+	"scripts": {
+		"build": "tsc",
+		"ci": "node --run test && npm run typecheck && node --run lint",
+		"lint": "biome check",
+		"test": "node --test-isolation=none --test-reporter=spec --experimental-test-coverage --test-coverage-exclude='src/{testConfigDirs/**/*,**/*.test.ts}' --test 'src/**/*.test.ts'",
+		"typecheck": "tsc --noEmit"
+	},
+	"files": ["dist"],
+	"engines": {
+		"node": ">= 20"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/mdrobny/configate.git"
+	},
+	"keywords": ["config"],
+	"author": "Michal Drobniak",
+	"license": "Apache-2.0",
+	"bugs": {
+		"url": "https://github.com/mdrobny/configate/issues"
+	},
+	"homepage": "https://github.com/mdrobny/configate#readme",
+	"devDependencies": {
+		"@biomejs/biome": "1.9.4",
+		"@types/node": "^22.10.6",
+		"typescript": "^5.7.3"
+	}
+}