@proventuslabs/nestjs-zod 1.0.0-rc.1

package/README.md

@@ -0,0 +1,297 @@
+# @proventuslabs/nestjs-zod
+
+A collection of NestJS modules to integrate Zod into your application with enhanced configuration management and type safety.
+
+## Features
+
+- 🔧 **Zod-powered Configuration**: Type-safe configuration management using Zod schemas
+- 🌍 **Environment Variable Support**: Automatic parsing and validation of environment variables
+- 📁 **Configuration Files**: Support for YAML configuration files
+- 🏗️ **Configurable Modules**: Enhanced NestJS configurable modules with Zod validation
+- 🎯 **Type Safety**: Full TypeScript support with automatic type inference
+- 🔄 **Merge Strategy**: Environment variables override configuration file values
+- 📝 **Descriptive Errors**: Enhanced error messages with schema descriptions
+
+## Installation
+
+```bash
+npm install @proventuslabs/nestjs-zod
+```
+
+## Peer Dependencies
+
+This package requires the following peer dependencies:
+
+- `@nestjs/common` ^10.0.0 || ^11.0.0
+- `@nestjs/config` ^3.0.0 || ^4.0.0
+- `zod` ^3.0.0
+
+## Quick Start
+
+### Configuration Management
+
+```typescript
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { registerConfig, type ConfigType } from '@proventuslabs/nestjs-zod';
+import { z } from 'zod';
+
+// Define your configuration schema
+const appConfig = registerConfig(
+  'app',
+  z.object({
+    port: z
+      .number()
+      .int()
+      .min(0)
+      .max(65535)
+      .default(3000)
+      .describe('The local HTTP port to bind the server to'),
+    host: z
+      .string()
+      .default('localhost')
+      .describe('The host to bind the server to'),
+    environment: z
+      .enum(['development', 'production', 'test'])
+      .default('development')
+      .describe('The application environment'),
+  }),
+);
+
+// Type inference
+type AppConfig = ConfigType<typeof appConfig>;
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+      load: [appConfig],
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+### Using Configuration
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { type NamespacedConfigType } from '@proventuslabs/nestjs-zod';
+
+@Injectable()
+export class AppService {
+  constructor(
+    private configService: ConfigService<NamespacedConfigType<typeof appConfig>, true>
+  ) {}
+
+  getPort(): number {
+    return this.configService.get('app.port', { infer: true });
+  }
+
+  getHost(): string {
+    return this.configService.get('app.host', { infer: true });
+  }
+}
+```
+
+## Configuration Sources
+
+The package supports multiple configuration sources with a clear precedence order:
+
+1. **Environment Variables** (highest priority)
+2. **Configuration Files** (YAML)
+3. **Schema Defaults** (lowest priority)
+
+### Environment Variables
+
+Environment variables are automatically parsed and validated. Use the namespace prefix followed by underscores:
+
+```bash
+# For the 'app' namespace
+APP_PORT=8080
+APP_HOST=0.0.0.0
+APP_ENVIRONMENT=production
+
+# Nested configuration using double underscores
+APP_DATABASE__HOST=localhost
+APP_DATABASE__PORT=5432
+APP_DATABASE__NAME=myapp
+```
+
+### Configuration Files
+
+Support for YAML configuration files via environment variables:
+
+```bash
+# Specify a configuration file
+CONFIG_FILE=./config/app.yaml
+
+# Or provide inline YAML content
+CONFIG_CONTENT="app:
+  port: 8080
+  host: 0.0.0.0
+  environment: production
+  database:
+    host: localhost
+    port: 5432
+    name: myapp"
+```
+
+Example `config/app.yaml`:
+
+```yaml
+app:
+  port: 8080
+  host: 0.0.0.0
+  environment: production
+  database:
+    host: localhost
+    port: 5432
+    name: myapp
+  redis:
+    host: localhost
+    port: 6379
+```
+
+## Configurable Modules
+
+Create type-safe configurable modules with Zod validation:
+
+```typescript
+import { Module } from '@nestjs/common';
+import { ZodConfigurableModuleBuilder } from '@proventuslabs/nestjs-zod';
+import { z } from 'zod';
+
+const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN } = new ZodConfigurableModuleBuilder(
+  z.object({
+    apiKey: z.string().min(1),
+    baseUrl: z.string().url().default('https://api.example.com'),
+    timeout: z.number().positive().default(5000),
+  })
+).build();
+
+@Module({
+  providers: [
+    {
+      provide: 'EXTERNAL_SERVICE',
+      useFactory: (options) => {
+        // options is fully typed and validated
+        return new ExternalService(options);
+      },
+      inject: [MODULE_OPTIONS_TOKEN],
+    },
+  ],
+  exports: ['EXTERNAL_SERVICE'],
+})
+export class ExternalServiceModule extends ConfigurableModuleClass {}
+```
+
+### Using Configurable Modules
+
+```typescript
+// Static configuration
+ExternalServiceModule.register({
+  apiKey: 'your-api-key',
+  baseUrl: 'https://custom-api.example.com',
+  timeout: 10000,
+});
+
+// Async configuration
+ExternalServiceModule.registerAsync({
+  useFactory: (configService: ConfigService) => ({
+    apiKey: configService.get('EXTERNAL_API_KEY'),
+    baseUrl: configService.get('EXTERNAL_BASE_URL'),
+    timeout: configService.get('EXTERNAL_TIMEOUT'),
+  }),
+  inject: [ConfigService],
+});
+```
+
+## API Reference
+
+### `registerConfig`
+
+Registers a configuration with the `ConfigModule.forFeature` for partial configuration under the provided namespace.
+
+```typescript
+function registerConfig<N extends string, C extends ConfigObject, I extends JsonValue>(
+  namespace: ConfigNamespace<N>,
+  configSchema: ZodType<C, ZodTypeDef, I>,
+  variables?: Record<string, string | undefined>
+): ReturnType<typeof registerAs<C>> & { NAMESPACE: N }
+```
+
+**Parameters:**
+- `namespace`: The namespace for the configuration (camelCase)
+- `configSchema`: Zod schema for validation
+- `variables`: Environment variables object (defaults to `process.env`)
+
+**Returns:** A configuration provider that can be used with `ConfigModule.forRoot()`
+
+### `ConfigType<T>`
+
+Extracts the inferred type from a configuration schema.
+
+```typescript
+type ConfigType<T extends (...args: unknown[]) => unknown> = NestConfigType<T>;
+```
+
+### `NamespacedConfigType<T>`
+
+Extracts the namespaced configuration type.
+
+```typescript
+type NamespacedConfigType<R> = {
+  [K in R["NAMESPACE"]]: NestConfigType<R>;
+};
+```
+
+### `ZodConfigurableModuleBuilder`
+
+Builder class for creating configurable modules with Zod validation.
+
+```typescript
+class ZodConfigurableModuleBuilder<
+  ModuleOptions,
+  ModuleOptionsInput = unknown,
+  StaticMethodKey extends string = string,
+  FactoryClassMethodKey extends string = string,
+  ExtraModuleDefinitionOptions = object
+>
+```
+
+## Error Handling
+
+The package provides enhanced error messages that include:
+
+- Schema descriptions when available
+- Original environment variable names
+- Detailed validation error paths
+- Helpful suggestions for fixing configuration issues
+
+Example error output:
+
+```
+TypeError: Configuration validation failed for 'app' namespace
+
+  • app.port: Expected number, received string
+    Description: The local HTTP port to bind the server to
+    Environment Variable: APP_PORT
+
+  • app.database.host: Required
+    Description: Database host address
+    Environment Variable: APP_DATABASE__HOST
+```
+
+## Examples
+
+See the [examples](./examples) directory for complete working examples.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](../../LICENSE) file for details.

package/dist/config/config.d.ts

@@ -0,0 +1,56 @@
+import { type ConfigObject, type ConfigType as NestConfigType } from "@nestjs/config";
+import type { CamelCase, JsonValue } from "type-fest";
+import { type ZodType, type ZodTypeDef } from "zod";
+/**
+ * Simple type alias for config namespace.
+ */
+type ConfigNamespace<T extends string> = CamelCase<T>;
+/**
+ * The flattened type of the config.
+ *
+ * @example
+ * const config = registerConfig('app', z.object({ port: z.number() }));
+ * type AppConfig = ConfigType<typeof config>;
+ * //   ^? { port: number }
+ */
+export type ConfigType<T extends (...args: unknown[]) => unknown> = NestConfigType<T>;
+/**
+ * The type of the config for a given namespace.
+ *
+ * @example
+ * const config = registerConfig('app', z.object({ port: z.number() }));
+ * type AppConfig = NamespacedConfigType<typeof config>;
+ * //   ^? { app: { port: number } }
+ */
+export type NamespacedConfigType<R extends ReturnType<typeof registerConfig<string, any, any>>> = {
+    [K in R["NAMESPACE"]]: NestConfigType<R>;
+};
+/**
+ * Registers a config with the `ConfigModule.forFeature` for partial configuration under the provided namespace.
+ *
+ * This function handles configuration by validating and merging values from multiple sources:
+ * - **Environment Variables:** Reads environment variables as JSON values, using the namespace prefix and validating them against the provided schema.
+ * - **Configuration File:** Optionally reads configuration from a file or inline YAML content, specified by the `CONFIG_FILE` or `CONFIG_CONTENT` environment variables respectively.
+ *
+ * **Merge order is Config File < Enviornment Variables** thus enviornment variables _override_ whatever the config sets.
+ *
+ * @param namespace - The namespace of the config
+ * @param configSchema - The schema of the config
+ * @param variables - The environment variables - defaults to `process.env`
+ *
+ * @throws {TypeError} If the environment variables or configuration file content do not match the schema.
+ *
+ * @example
+ * const ConfigSchema = z.object({
+ *   port: z.number().int().min(0).max(65535).default(9558).describe('The local HTTP port to bind the server to'),
+ * });
+ *
+ * export const appConfig = registerConfig('app', ConfigSchema);
+ *
+ * export type AppConfigNamespaced = NamespacedConfigType<typeof appConfig>;
+ * export type AppConfig = ConfigType<typeof appConfig>;
+ */
+export declare function registerConfig<N extends string, C extends ConfigObject, I extends JsonValue>(namespace: ConfigNamespace<N>, configSchema: ZodType<C, ZodTypeDef, I>, variables?: Record<string, string | undefined>): import("@nestjs/config").ConfigFactory<C> & import("@nestjs/config").ConfigFactoryKeyHost<C | Promise<C>> & {
+    NAMESPACE: N;
+};
+export default registerConfig;

package/dist/config/config.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerConfig = registerConfig;
+const node_process_1 = __importDefault(require("node:process"));
+const config_1 = require("@nestjs/config");
+const lodash_1 = require("lodash");
+const zod_1 = require("zod");
+const internal_1 = require("../internal");
+/**
+ * Registers a config with the `ConfigModule.forFeature` for partial configuration under the provided namespace.
+ *
+ * This function handles configuration by validating and merging values from multiple sources:
+ * - **Environment Variables:** Reads environment variables as JSON values, using the namespace prefix and validating them against the provided schema.
+ * - **Configuration File:** Optionally reads configuration from a file or inline YAML content, specified by the `CONFIG_FILE` or `CONFIG_CONTENT` environment variables respectively.
+ *
+ * **Merge order is Config File < Enviornment Variables** thus enviornment variables _override_ whatever the config sets.
+ *
+ * @param namespace - The namespace of the config
+ * @param configSchema - The schema of the config
+ * @param variables - The environment variables - defaults to `process.env`
+ *
+ * @throws {TypeError} If the environment variables or configuration file content do not match the schema.
+ *
+ * @example
+ * const ConfigSchema = z.object({
+ *   port: z.number().int().min(0).max(65535).default(9558).describe('The local HTTP port to bind the server to'),
+ * });
+ *
+ * export const appConfig = registerConfig('app', ConfigSchema);
+ *
+ * export type AppConfigNamespaced = NamespacedConfigType<typeof appConfig>;
+ * export type AppConfig = ConfigType<typeof appConfig>;
+ */
+function registerConfig(namespace, configSchema, variables = node_process_1.default.env) {
+    const service = (0, config_1.registerAs)(namespace, async () => {
+        const [decodedEnv, envKeys] = (0, internal_1.decodeVariables)(variables, namespace);
+        const decodedConfig = (0, internal_1.decodeConfig)(variables.CONFIG_CONTENT, variables.CONFIG_FILE);
+        const namespacedSchema = zod_1.z.object({
+            [namespace]: configSchema,
+        });
+        const parsedConfig = await namespacedSchema.safeParseAsync((0, lodash_1.merge)({ [namespace]: {} }, decodedConfig, decodedEnv));
+        if (!parsedConfig.success)
+            throw (0, internal_1.zodErrorToTypeError)(parsedConfig.error, namespacedSchema, namespace, envKeys);
+        const config = parsedConfig.data[namespace];
+        return config;
+    });
+    // we add the namespace to the object itself for runtime access too
+    return Object.defineProperty(service, "NAMESPACE", {
+        value: namespace,
+        writable: false,
+    });
+}
+exports.default = registerConfig;
+//# sourceMappingURL=config.js.map

package/dist/config/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config/config.ts"],"names":[],"mappings":";;;;;AAiEA,wCA2BC;AA5FD,gEAAmC;AAEnC,2CAAkG;AAElG,mCAA+B;AAE/B,6BAAuD;AAEvD,0CAAiF;AAgCjF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,cAAc,CAC7B,SAA6B,EAC7B,YAAuC,EACvC,YAAgD,sBAAO,CAAC,GAAG;IAE3D,MAAM,OAAO,GAAG,IAAA,mBAAU,EAAC,SAAS,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,IAAA,0BAAe,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACpE,MAAM,aAAa,GAAG,IAAA,uBAAY,EAAC,SAAS,CAAC,cAAc,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC;QAEpF,MAAM,gBAAgB,GAAG,OAAC,CAAC,MAAM,CAAC;YACjC,CAAC,SAAS,CAAC,EAAE,YAAY;SACzB,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,MAAM,gBAAgB,CAAC,cAAc,CACzD,IAAA,cAAK,EAAC,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,aAAa,EAAE,UAAU,CAAC,CACrD,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,OAAO;YACxB,MAAM,IAAA,8BAAmB,EAAC,YAAY,CAAC,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACrF,MAAM,MAAM,GAAM,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE/C,OAAO,MAAM,CAAC;IACf,CAAC,CAAwD,CAAC;IAE1D,mEAAmE;IACnE,OAAO,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,EAAE;QAClD,KAAK,EAAE,SAAS;QAChB,QAAQ,EAAE,KAAK;KACf,CAAC,CAAC;AACJ,CAAC;AAED,kBAAe,cAAc,CAAC"}

package/dist/config/config.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/config/config.spec.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("@nestjs/config");
+const testing_1 = require("@nestjs/testing");
+const zod_1 = require("zod");
+const config_2 = require("./config");
+describe("config", () => {
+    it("should register config with ConfigModule.forFeature", async () => {
+        const config = (0, config_2.registerConfig)("app", zod_1.z.object({}), {});
+        const moduleRef = await testing_1.Test.createTestingModule({
+            imports: [config_1.ConfigModule.forFeature(config)],
+        }).compile();
+        const configService = moduleRef.get(config_1.ConfigService);
+        expect(configService).toBeDefined();
+    });
+    it("should return the correct config", async () => {
+        const config = (0, config_2.registerConfig)("app", zod_1.z.object({
+            port: zod_1.z.coerce
+                .number()
+                .positive()
+                .min(0)
+                .max(65535)
+                .default(9556)
+                .describe("The local HTTP port to bind the server to"),
+        }), {});
+        const moduleRef = await testing_1.Test.createTestingModule({
+            imports: [config_1.ConfigModule.forFeature(config)],
+        }).compile();
+        const configService = moduleRef.get(config_1.ConfigService);
+        expect(configService.get("app")).toEqual({
+            port: 9556,
+        });
+    });
+    it("should throw an error if the config is invalid", async () => {
+        const config = (0, config_2.registerConfig)("app", zod_1.z.object({
+            missing: zod_1.z.string().describe("This is a required field"),
+        }), {
+            APP_NOT_MISSING: "not missing",
+        });
+        const moduleRef = testing_1.Test.createTestingModule({
+            imports: [
+                config_1.ConfigModule.forRoot({ ignoreEnvFile: true, load: [] }),
+                config_1.ConfigModule.forFeature(config),
+            ],
+        }).compile();
+        await expect(moduleRef).rejects.toThrow();
+    });
+});
+//# sourceMappingURL=config.spec.js.map

package/dist/config/config.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.spec.js","sourceRoot":"","sources":["../../src/config/config.spec.ts"],"names":[],"mappings":";;AAAA,2CAA6D;AAC7D,6CAAuC;AAEvC,6BAAwB;AAExB,qCAA0C;AAE1C,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,MAAM,GAAG,IAAA,uBAAc,EAAC,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAEvD,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAChD,OAAO,EAAE,CAAC,qBAAY,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;SAC1C,CAAC,CAAC,OAAO,EAAE,CAAC;QAEb,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,sBAAa,CAAC,CAAC;QAEnD,MAAM,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,MAAM,GAAG,IAAA,uBAAc,EAC5B,KAAK,EACL,OAAC,CAAC,MAAM,CAAC;YACR,IAAI,EAAE,OAAC,CAAC,MAAM;iBACZ,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,GAAG,CAAC,CAAC,CAAC;iBACN,GAAG,CAAC,KAAK,CAAC;iBACV,OAAO,CAAC,IAAI,CAAC;iBACb,QAAQ,CAAC,2CAA2C,CAAC;SACvD,CAAC,EACF,EAAE,CACF,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAChD,OAAO,EAAE,CAAC,qBAAY,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;SAC1C,CAAC,CAAC,OAAO,EAAE,CAAC;QAEb,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,sBAAa,CAAC,CAAC;QAEnD,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;YACxC,IAAI,EAAE,IAAI;SACV,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,MAAM,GAAG,IAAA,uBAAc,EAC5B,KAAK,EACL,OAAC,CAAC,MAAM,CAAC;YACR,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC;SACxD,CAAC,EACF;YACC,eAAe,EAAE,aAAa;SAC9B,CACD,CAAC;QAEF,MAAM,SAAS,GAAG,cAAI,CAAC,mBAAmB,CAAC;YAC1C,OAAO,EAAE;gBACR,qBAAY,CAAC,OAAO,CAAC,EAAE,aAAa,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;gBACvD,qBAAY,CAAC,UAAU,CAAC,MAAM,CAAC;aAC/B;SACD,CAAC,CAAC,OAAO,EAAE,CAAC;QAEb,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3C,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./config/config";
+export * from "./module/module";

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./config/config"), exports);
+__exportStar(require("./module/module"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,kDAAgC"}

package/dist/internal.d.ts

@@ -0,0 +1,77 @@
+import type { JsonValue } from "type-fest";
+import { type ZodTypeAny, type z } from "zod";
+/**
+ * Reads configuration from either a string content or a file path.
+ * String content takes precedence over file path to avoid unnecessary filesystem operations.
+ *
+ * @param content - Optional string content in YAML format
+ * @param file - Optional path to a configuration file
+ * @returns The parsed configuration as a record of string keys to JSON values
+ * @throws {Error} if neither content nor file contains a valid configuration object
+ */
+export declare function decodeConfig(content?: string, file?: string): Record<string, JsonValue>;
+/**
+ * Transforms environment variables from a flat structure with a specific namespace prefix
+ * into a nested object structure with camelCase keys, while preserving the original keys
+ * for error reporting.
+ *
+ * For example, transforms:
+ * {
+ *   "MY_APP_SERVER__HOST": "localhost",
+ *   "MY_APP_DATABASE__PORT": "5432",
+ *   "UNRELATED_VAR": "value"
+ * }
+ *
+ * With namespace "myApp" into:
+ * {
+ *   "my_app": {
+ *     "server": {
+ *       "host": "localhost"
+ *     },
+ *     "database": {
+ *       "port": 5432  // Note: jsonify attempts to parse values
+ *     }
+ *   }
+ * }
+ *
+ * @param variables - Record of environment variables with string keys and string values
+ * @param namespace - The namespace prefix to filter variables (will be converted to SNAKE_CASE)
+ * @returns A tuple containing:
+ *   1. The transformed nested configuration object
+ *   2. A Map relating the transformed path keys to original environment variable names for error reporting
+ */
+export declare function decodeVariables(variables: Record<string, string | undefined>, namespace: string): readonly [Record<string, JsonValue | undefined>, Map<string, string>];
+/**
+ * Converts Zod validation errors into a more descriptive TypeError.
+ * Enhances error messages with schema descriptions when available.
+ *
+ * @param error - The Zod error containing validation issues
+ * @param schema - The namespaced schema that was used for validation
+ * @param namespace - The configuration namespace for context in error messages
+ * @param keys - Map of path strings to user-friendly key names for better error reporting
+ * @returns A TypeError with formatted error messages for each validation issue
+ */
+export declare function zodErrorToTypeError(error: z.ZodError, schema: ZodTypeAny, namespace: string, keys: Map<string, string>, isSchemaNamespaced?: boolean): ZodConfigError;
+/**
+ * Simple error wrapper for expressing an invalid config from a zod schema.
+ */
+export declare class ZodConfigError extends TypeError {
+    readonly namespace: {
+        name: string;
+        description: string | undefined;
+    };
+    readonly configErrors: readonly {
+        path: string;
+        message: string;
+        description: string | undefined;
+    }[];
+    constructor(namespace: {
+        name: string;
+        description: string | undefined;
+    }, configErrors: readonly {
+        path: string;
+        message: string;
+        description: string | undefined;
+    }[], options?: ErrorOptions);
+    private static mapError;
+}

package/dist/internal.js

@@ -0,0 +1,222 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZodConfigError = void 0;
+exports.decodeConfig = decodeConfig;
+exports.decodeVariables = decodeVariables;
+exports.zodErrorToTypeError = zodErrorToTypeError;
+const node_fs_1 = __importDefault(require("node:fs"));
+const lodash_1 = require("lodash");
+const yaml_1 = __importDefault(require("yaml"));
+const zod_1 = require("zod");
+/**
+ * Raw content of the config file as UTF-8.
+ */
+let cachedConfigFileContent;
+/**
+ * Parsed YAML file - unknown as we don't know what shape it will have until we validate it.
+ */
+// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
+let parsedConfigFileContent;
+/**
+ * Parses a string content into a JavaScript object using YAML parser.
+ * Uses a cached result if the content has been parsed before.
+ *
+ * @param content - The string content in YAML format to parse
+ * @returns The parsed JavaScript object representation of the YAML content
+ */
+function parseConfig(content) {
+    if (!(0, lodash_1.isUndefined)(parsedConfigFileContent))
+        return parsedConfigFileContent;
+    parsedConfigFileContent = yaml_1.default.parse(content);
+    return parsedConfigFileContent;
+}
+/**
+ * Reads and parses a configuration file from the filesystem.
+ * Uses cached file content if available to prevent multiple filesystem reads.
+ *
+ * @param path - The path to the configuration file
+ * @returns The parsed JavaScript object representation of the file
+ * @throws {Error} if the file cannot be read or parsed
+ */
+function parseConfigFile(path) {
+    try {
+        if (!(0, lodash_1.isString)(cachedConfigFileContent))
+            cachedConfigFileContent = node_fs_1.default.readFileSync(path).toString("utf8");
+        return parseConfig(cachedConfigFileContent);
+    }
+    catch (err) {
+        const message = err instanceof Error ? err.message : new String(err).toString();
+        throw new Error(`Unable to open the config file provided: ${message}`, {
+            cause: err,
+        });
+    }
+}
+/**
+ * Reads configuration from either a string content or a file path.
+ * String content takes precedence over file path to avoid unnecessary filesystem operations.
+ *
+ * @param content - Optional string content in YAML format
+ * @param file - Optional path to a configuration file
+ * @returns The parsed configuration as a record of string keys to JSON values
+ * @throws {Error} if neither content nor file contains a valid configuration object
+ */
+function decodeConfig(content, file) {
+    let readConfig = {};
+    // NOTE: `content` takes precedence over a `file` (to avoid a file system read in case of both)
+    if ((0, lodash_1.isString)(content))
+        readConfig = parseConfig(content);
+    else if ((0, lodash_1.isString)(file))
+        readConfig = parseConfigFile(file);
+    if (!(0, lodash_1.isObjectLike)(readConfig))
+        throw new Error(`Config file provided must contain the JSON configuration object`);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+    return readConfig;
+}
+/**
+ * Transforms environment variable keys into nested object notation starting from the provided namespace.
+ * For example, transforms "APP_SERVER__HOST" into "app.server.host" using camelCase ("APP" was the env namespace).
+ *
+ * @param envKey - The environment variable key to transform
+ * @param envNamespace - The namespace prefix to replace with a dot notation
+ * @returns A string in dot notation following camelCase conventions
+ */
+function nestedConventionNamespaced(envKey, envNamespace) {
+    return envKey
+        .replace(`${envNamespace}_`, `${envNamespace}.`)
+        .toLowerCase()
+        .replace(/__/g, ".")
+        .replace(/[a-z_]+/g, (word) => (0, lodash_1.camelCase)(word));
+}
+/**
+ * Attempts to parse a string value as JSON, falling back to the original string if parsing fails.
+ * Used for converting environment variables that might contain JSON values to mimic config file read from ENVs as well.
+ *
+ * @param value - The string value to parse as JSON
+ * @returns The parsed JSON value or the original string if parsing fails
+ */
+function jsonify(value) {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
+        return JSON.parse(value ?? "");
+    }
+    catch {
+        return value;
+    }
+}
+/**
+ * Transforms environment variables from a flat structure with a specific namespace prefix
+ * into a nested object structure with camelCase keys, while preserving the original keys
+ * for error reporting.
+ *
+ * For example, transforms:
+ * {
+ *   "MY_APP_SERVER__HOST": "localhost",
+ *   "MY_APP_DATABASE__PORT": "5432",
+ *   "UNRELATED_VAR": "value"
+ * }
+ *
+ * With namespace "myApp" into:
+ * {
+ *   "my_app": {
+ *     "server": {
+ *       "host": "localhost"
+ *     },
+ *     "database": {
+ *       "port": 5432  // Note: jsonify attempts to parse values
+ *     }
+ *   }
+ * }
+ *
+ * @param variables - Record of environment variables with string keys and string values
+ * @param namespace - The namespace prefix to filter variables (will be converted to SNAKE_CASE)
+ * @returns A tuple containing:
+ *   1. The transformed nested configuration object
+ *   2. A Map relating the transformed path keys to original environment variable names for error reporting
+ */
+function decodeVariables(variables, namespace) {
+    const envKeys = new Map();
+    const envNamespace = (0, lodash_1.snakeCase)(namespace).toUpperCase();
+    const relevantEnv = (0, lodash_1.pickBy)(variables, (_value, key) => key.startsWith(envNamespace));
+    const decodedEnv = (0, lodash_1.reduce)(relevantEnv, (env, value, key) => {
+        const newKey = nestedConventionNamespaced(key, envNamespace);
+        envKeys.set(newKey, key);
+        const newValue = jsonify(value);
+        return (0, lodash_1.set)(env, newKey, newValue);
+    }, {});
+    return [decodedEnv, envKeys];
+}
+/**
+ * Recursively navigates through a Zod schema to find description metadata at a specific path.
+ * Handles various Zod schema types including effects, transformers, and objects.
+ *
+ * @param path - Array of string keys representing the path in the schema
+ * @param schema - The Zod schema to search through
+ * @returns The description string if found, otherwise undefined
+ */
+function findDescriptionInSchemaByPath(path, schema) {
+    // we have to work with ZodTypeAny to accept anything, so we disable the unsafe argument check
+    if ((0, lodash_1.isEmpty)(path))
+        return schema?.description;
+    else if (schema instanceof zod_1.ZodEffects)
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        return findDescriptionInSchemaByPath(path, schema.innerType());
+    else if (schema instanceof zod_1.ZodTransformer)
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        return findDescriptionInSchemaByPath(path, schema.innerType());
+    else if (schema instanceof zod_1.ZodObject)
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        return findDescriptionInSchemaByPath((0, lodash_1.tail)(path), (0, lodash_1.get)(schema.shape, (0, lodash_1.head)(path) ?? ""));
+    else
+        return schema?.description;
+}
+/**
+ * Converts Zod validation errors into a more descriptive TypeError.
+ * Enhances error messages with schema descriptions when available.
+ *
+ * @param error - The Zod error containing validation issues
+ * @param schema - The namespaced schema that was used for validation
+ * @param namespace - The configuration namespace for context in error messages
+ * @param keys - Map of path strings to user-friendly key names for better error reporting
+ * @returns A TypeError with formatted error messages for each validation issue
+ */
+function zodErrorToTypeError(error, schema, namespace, keys, isSchemaNamespaced = true) {
+    const errorMessages = error.issues.map((err) => {
+        const pathNotation = err.path.join(".");
+        const path = keys.get(pathNotation) ?? pathNotation;
+        const message = err.message;
+        const description = findDescriptionInSchemaByPath(err.path.map((v) => v.toString()), schema);
+        return { path, message, description };
+    });
+    return new ZodConfigError({
+        name: namespace,
+        description: findDescriptionInSchemaByPath(isSchemaNamespaced ? [namespace] : [], schema),
+    }, errorMessages);
+}
+/**
+ * Simple error wrapper for expressing an invalid config from a zod schema.
+ */
+class ZodConfigError extends TypeError {
+    namespace;
+    configErrors;
+    constructor(namespace, configErrors, options) {
+        const spacing = "    ";
+        const title = `Invalid config for "${namespace.name}":\n`;
+        const description = (0, lodash_1.isUndefined)(namespace.description)
+            ? ""
+            : `${spacing}${namespace.description}\n`;
+        const errors = configErrors.map((v) => ZodConfigError.mapError(v, spacing)).join("\n");
+        super(title + description + errors, options);
+        this.namespace = namespace;
+        this.configErrors = configErrors;
+    }
+    static mapError(error, spacing) {
+        let message = `${spacing}- ${error.path}: ${error.message}`;
+        message += (0, lodash_1.isUndefined)(error.description) ? "" : `\n${spacing}${error.description}`;
+        return message;
+    }
+}
+exports.ZodConfigError = ZodConfigError;
+//# sourceMappingURL=internal.js.map

package/dist/internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.js","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":";;;;;;AA2EA,oCAWC;AAgED,0CAmBC;AAmCD,kDA0BC;AAtOD,sDAAyB;AAEzB,mCAagB;AAEhB,gDAAwB;AACxB,6BAAqF;AAErF;;GAEG;AACH,IAAI,uBAA2C,CAAC;AAChD;;GAEG;AACH,6EAA6E;AAC7E,IAAI,uBAA4C,CAAC;AAEjD;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,OAAe;IACnC,IAAI,CAAC,IAAA,oBAAW,EAAC,uBAAuB,CAAC;QAAE,OAAO,uBAAuB,CAAC;IAE1E,uBAAuB,GAAG,cAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC9C,OAAO,uBAAuB,CAAC;AAChC,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,eAAe,CAAC,IAAY;IACpC,IAAI,CAAC;QACJ,IAAI,CAAC,IAAA,iBAAQ,EAAC,uBAAuB,CAAC;YACrC,uBAAuB,GAAG,iBAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAElE,OAAO,WAAW,CAAC,uBAAuB,CAAC,CAAC;IAC7C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChF,MAAM,IAAI,KAAK,CAAC,4CAA4C,OAAO,EAAE,EAAE;YACtE,KAAK,EAAE,GAAG;SACV,CAAC,CAAC;IACJ,CAAC;AACF,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAAC,OAAgB,EAAE,IAAa;IAC3D,IAAI,UAAU,GAAY,EAAE,CAAC;IAC7B,+FAA+F;IAC/F,IAAI,IAAA,iBAAQ,EAAC,OAAO,CAAC;QAAE,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;SACpD,IAAI,IAAA,iBAAQ,EAAC,IAAI,CAAC;QAAE,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAE5D,IAAI,CAAC,IAAA,qBAAY,EAAC,UAAU,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;IAEpF,uEAAuE;IACvE,OAAO,UAAuC,CAAC;AAChD,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,0BAA0B,CAAC,MAAc,EAAE,YAAoB;IACvE,OAAO,MAAM;SACX,OAAO,CAAC,GAAG,YAAY,GAAG,EAAE,GAAG,YAAY,GAAG,CAAC;SAC/C,WAAW,EAAE;SACb,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,kBAAS,EAAC,IAAI,CAAC,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;GAMG;AACH,SAAS,OAAO,CAAC,KAAyB;IACzC,IAAI,CAAC;QACJ,uEAAuE;QACvE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAc,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,KAAK,CAAC;IACd,CAAC;AACF,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,SAAgB,eAAe,CAC9B,SAA6C,EAC7C,SAAiB;IAEjB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,MAAM,YAAY,GAAG,IAAA,kBAAS,EAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;IACxD,MAAM,WAAW,GAAG,IAAA,eAAM,EAAC,SAAS,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;IACrF,MAAM,UAAU,GAAG,IAAA,eAAM,EACxB,WAAW,EACX,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;QACnB,MAAM,MAAM,GAAG,0BAA0B,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;QAC7D,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;QAChC,OAAO,IAAA,YAAG,EAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC,EACD,EAA2C,CAC3C,CAAC;IAEF,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,6BAA6B,CAAC,IAAc,EAAE,MAAkB;IACxE,8FAA8F;IAC9F,IAAI,IAAA,gBAAO,EAAC,IAAI,CAAC;QAAE,OAAO,MAAM,EAAE,WAAW,CAAC;SACzC,IAAI,MAAM,YAAY,gBAAU;QACpC,iEAAiE;QACjE,OAAO,6BAA6B,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;SAC3D,IAAI,MAAM,YAAY,oBAAc;QACxC,iEAAiE;QACjE,OAAO,6BAA6B,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;SAC3D,IAAI,MAAM,YAAY,eAAS;QACnC,iEAAiE;QACjE,OAAO,6BAA6B,CAAC,IAAA,aAAI,EAAC,IAAI,CAAC,EAAE,IAAA,YAAG,EAAC,MAAM,CAAC,KAAK,EAAE,IAAA,aAAI,EAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;;QAClF,OAAO,MAAM,EAAE,WAAW,CAAC;AACjC,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,mBAAmB,CAClC,KAAiB,EACjB,MAAkB,EAClB,SAAiB,EACjB,IAAyB,EACzB,qBAA8B,IAAI;IAElC,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC9C,MAAM,YAAY,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,YAAY,CAAC;QACpD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC5B,MAAM,WAAW,GAAG,6BAA6B,CAChD,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,EACjC,MAAM,CACN,CAAC;QAEF,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,OAAO,IAAI,cAAc,CACxB;QACC,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,6BAA6B,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC;KACzF,EACD,aAAa,CACb,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,SAAS;IAE3B;IAIA;IALjB,YACiB,SAGf,EACe,YAIb,EACH,OAAsB;QAEtB,MAAM,OAAO,GAAG,MAAM,CAAC;QACvB,MAAM,KAAK,GAAG,uBAAuB,SAAS,CAAC,IAAI,MAAM,CAAC;QAC1D,MAAM,WAAW,GAAG,IAAA,oBAAW,EAAC,SAAS,CAAC,WAAW,CAAC;YACrD,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,GAAG,OAAO,GAAG,SAAS,CAAC,WAAW,IAAI,CAAC;QAC1C,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEvF,KAAK,CAAC,KAAK,GAAG,WAAW,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC;QAlB7B,cAAS,GAAT,SAAS,CAGxB;QACe,iBAAY,GAAZ,YAAY,CAIzB;IAWJ,CAAC;IAEO,MAAM,CAAC,QAAQ,CACtB,KAAyE,EACzE,OAAe;QAEf,IAAI,OAAO,GAAG,GAAG,OAAO,KAAK,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;QAC5D,OAAO,IAAI,IAAA,oBAAW,EAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,OAAO,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QACpF,OAAO,OAAO,CAAC;IAChB,CAAC;CACD;AA/BD,wCA+BC"}

package/dist/module/module.d.ts

@@ -0,0 +1,75 @@
+import { type ConfigurableModuleAsyncOptions, ConfigurableModuleBuilder, type ConfigurableModuleBuilderOptions, type DynamicModule } from "@nestjs/common";
+import type { DEFAULT_FACTORY_CLASS_METHOD_KEY, DEFAULT_METHOD_KEY } from "@nestjs/common/module-utils/constants";
+import { type ZodType, type ZodTypeDef } from "zod";
+export declare class ZodConfigurableModuleBuilder<ModuleOptions, ModuleOptionsInput = unknown, StaticMethodKey extends string = typeof DEFAULT_METHOD_KEY, FactoryClassMethodKey extends string = typeof DEFAULT_FACTORY_CLASS_METHOD_KEY, ExtraModuleDefinitionOptions = object> {
+    protected readonly schema: ZodType<ModuleOptions, ZodTypeDef, ModuleOptionsInput>;
+    protected readonly options: ConfigurableModuleBuilderOptions;
+    protected base: ConfigurableModuleBuilder<ModuleOptionsInput, StaticMethodKey, FactoryClassMethodKey, ExtraModuleDefinitionOptions>;
+    private transformSet;
+    constructor(schema: ZodType<ModuleOptions, ZodTypeDef, ModuleOptionsInput>, options?: ConfigurableModuleBuilderOptions, parentBuilder?: ConfigurableModuleBuilder<ModuleOptionsInput>);
+    setExtras<ExtraModuleDefinitionOptions>(extras: ExtraModuleDefinitionOptions, transformDefinition?: (definition: DynamicModule, extras: ExtraModuleDefinitionOptions) => DynamicModule): ZodConfigurableModuleBuilder<ModuleOptions, ModuleOptionsInput, StaticMethodKey, FactoryClassMethodKey, ExtraModuleDefinitionOptions>;
+    private patchTransform;
+    setClassMethodName<StaticMethodKey extends string>(key: StaticMethodKey): ZodConfigurableModuleBuilder<ModuleOptions, ModuleOptionsInput, StaticMethodKey, FactoryClassMethodKey, ExtraModuleDefinitionOptions>;
+    setFactoryMethodName<FactoryClassMethodKey extends string>(key: FactoryClassMethodKey): ZodConfigurableModuleBuilder<ModuleOptions, ModuleOptionsInput, StaticMethodKey, FactoryClassMethodKey, ExtraModuleDefinitionOptions>;
+    build(): ZodConfigurableModuleHost<ModuleOptions, ModuleOptionsInput, StaticMethodKey, FactoryClassMethodKey, ExtraModuleDefinitionOptions>;
+    private transformModuleDefinitionWithSchema;
+}
+type ZodConfigurableModuleCls<ModuleOptions, ModuleOptionsInput = unknown, MethodKey extends string = typeof DEFAULT_METHOD_KEY, FactoryClassMethodKey extends string = typeof DEFAULT_FACTORY_CLASS_METHOD_KEY, ExtraModuleDefinitionOptions = object> = {
+    new (): any;
+} & Record<`${MethodKey}`, (options: ModuleOptionsInput & Partial<ExtraModuleDefinitionOptions>) => DynamicModule> & Record<`${MethodKey}Async`, (options: ConfigurableModuleAsyncOptions<ModuleOptionsInput, FactoryClassMethodKey> & Partial<ExtraModuleDefinitionOptions>) => DynamicModule>;
+interface ZodConfigurableModuleHost<ModuleOptions = Record<string, unknown>, ModuleOptionsInput = unknown, MethodKey extends string = string, FactoryClassMethodKey extends string = string, ExtraModuleDefinitionOptions = object> {
+    /**
+     * Class that represents a blueprint/prototype for a configurable Nest module.
+     * This class provides static methods for constructing dynamic modules. Their names
+     * can be controlled through the "MethodKey" type argument.
+     *
+     * Your module class should inherit from this class to make the static methods available.
+     *
+     * @example
+     * ```typescript
+     * @Module({})
+     * class IntegrationModule extends ConfigurableModuleCls {
+     *  // ...
+     * }
+     * ```
+     */
+    ConfigurableModuleClass: ZodConfigurableModuleCls<ModuleOptions, ModuleOptionsInput, MethodKey, FactoryClassMethodKey, ExtraModuleDefinitionOptions>;
+    /**
+     * Module options provider token. Can be used to inject the "options object" to
+     * providers registered within the host module.
+     */
+    MODULE_OPTIONS_TOKEN: string | symbol;
+    /**
+     * Can be used to auto-infer the compound "async module options" type.
+     * Note: this property is not supposed to be used as a value.
+     *
+     * @example
+     * ```typescript
+     * @Module({})
+     * class IntegrationModule extends ConfigurableModuleCls {
+     *  static module = initializer(IntegrationModule);
+     *
+     * static registerAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule {
+     *  return super.registerAsync(options);
+     * }
+     * ```
+     */
+    OPTIONS_TYPE: ModuleOptions & Partial<ExtraModuleDefinitionOptions>;
+    /**
+     * Can be used to auto-infer the compound "module options" type (options interface + extra module definition options).
+     * Note: this property is not supposed to be used as a value.
+     *
+     * @example
+     * ```typescript
+     * @Module({})
+     * class IntegrationModule extends ConfigurableModuleCls {
+     *  static module = initializer(IntegrationModule);
+     *
+     * static register(options: typeof OPTIONS_TYPE): DynamicModule {
+     *  return super.register(options);
+     * }
+     * ```
+     */
+    ASYNC_OPTIONS_TYPE: ConfigurableModuleAsyncOptions<ModuleOptions, FactoryClassMethodKey> & Partial<ExtraModuleDefinitionOptions>;
+}
+export {};

package/dist/module/module.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZodConfigurableModuleBuilder = void 0;
+const common_1 = require("@nestjs/common");
+const lodash_1 = require("lodash");
+const zod_1 = require("zod");
+const internal_1 = require("../internal");
+class ZodConfigurableModuleBuilder {
+    schema;
+    options;
+    base;
+    transformSet = false;
+    constructor(schema, options = {}, parentBuilder) {
+        this.schema = schema;
+        this.options = options;
+        this.base = new common_1.ConfigurableModuleBuilder(options, parentBuilder);
+    }
+    setExtras(extras, transformDefinition = (def) => def) {
+        const builder = new ZodConfigurableModuleBuilder(this.schema, this.options, this);
+        // this was called and we patched
+        this.transformSet = true;
+        builder.base = this.patchTransform(extras, transformDefinition);
+        return builder;
+    }
+    patchTransform(extras, transformDefinition = (def) => def) {
+        transformDefinition ??= (definition) => definition;
+        const existingTransform = transformDefinition;
+        transformDefinition = (definition, extraOptions) => {
+            const result = existingTransform(definition, extraOptions);
+            return this.transformModuleDefinitionWithSchema(result, extraOptions, extras);
+        };
+        return this.base.setExtras(extras, transformDefinition);
+    }
+    setClassMethodName(key) {
+        const builder = new ZodConfigurableModuleBuilder(this.schema, this.options, this);
+        builder.base = builder.base.setClassMethodName(key);
+        return builder;
+    }
+    setFactoryMethodName(key) {
+        const builder = new ZodConfigurableModuleBuilder(this.schema, this.options, this);
+        builder.base = builder.base.setFactoryMethodName(key);
+        return builder;
+    }
+    build() {
+        if (!this.transformSet)
+            this.base = this.patchTransform({});
+        return this.base.build();
+    }
+    transformModuleDefinitionWithSchema(definition, extraOptions, extras) {
+        const isOptionProvider = (provider) => "provide" in provider && provider.provide === this.options.optionsInjectionToken;
+        definition.providers = definition.providers?.map((provider) => {
+            if (isOptionProvider(provider)) {
+                if ("useFactory" in provider) {
+                    const existingFactory = provider.useFactory;
+                    provider.useFactory = async (...args) => {
+                        try {
+                            return await this.schema.parseAsync(existingFactory(...args));
+                        }
+                        catch (err) {
+                            if (err instanceof zod_1.ZodError) {
+                                throw (0, internal_1.zodErrorToTypeError)(err, this.schema, definition.module.name, new Map(), false);
+                            }
+                            throw err;
+                        }
+                    };
+                }
+                else {
+                    return {
+                        // biome-ignore lint/style/noNonNullAssertion: the token is guaranteed to be set
+                        provide: this.options.optionsInjectionToken,
+                        useFactory: async () => {
+                            const finalOptions = (0, lodash_1.isObject)(extraOptions)
+                                ? (0, lodash_1.omit)(extraOptions, (0, lodash_1.keys)(extras))
+                                : extraOptions;
+                            try {
+                                return await this.schema.parseAsync(finalOptions);
+                            }
+                            catch (err) {
+                                if (err instanceof zod_1.ZodError) {
+                                    throw (0, internal_1.zodErrorToTypeError)(err, this.schema, definition.module.name, new Map(), false);
+                                }
+                                throw err;
+                            }
+                        },
+                    };
+                }
+            }
+            return provider;
+        });
+        return definition;
+    }
+}
+exports.ZodConfigurableModuleBuilder = ZodConfigurableModuleBuilder;
+//# sourceMappingURL=module.js.map

package/dist/module/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/module/module.ts"],"names":[],"mappings":";;;AAAA,2CAMwB;AAMxB,mCAA8C;AAC9C,6BAA8D;AAE9D,0CAAkD;AAElD,MAAa,4BAA4B;IAiBpB;IACA;IAXV,IAAI,CAKZ;IAEM,YAAY,GAAG,KAAK,CAAC;IAE7B,YACoB,MAA8D,EAC9D,UAA4C,EAAE,EACjE,aAA6D;QAF1C,WAAM,GAAN,MAAM,CAAwD;QAC9D,YAAO,GAAP,OAAO,CAAuC;QAGjE,IAAI,CAAC,IAAI,GAAG,IAAI,kCAAyB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IACnE,CAAC;IAEM,SAAS,CACf,MAAoC,EACpC,sBAGqB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG;QAEjC,MAAM,OAAO,GAAG,IAAI,4BAA4B,CAO9C,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,IAAW,CAAC,CAAC;QAE1C,iCAAiC;QACjC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAEzB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAEhE,OAAO,OAAO,CAAC;IAChB,CAAC;IAEO,cAAc,CACrB,MAAoC,EACpC,sBAGqB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG;QAEjC,mBAAmB,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC;QAEnD,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;QAE9C,mBAAmB,GAAG,CAAC,UAAU,EAAE,YAAY,EAAE,EAAE;YAClD,MAAM,MAAM,GAAG,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;YAE3D,OAAO,IAAI,CAAC,mCAAmC,CAAC,MAAM,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QAC/E,CAAC,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACzD,CAAC;IAEM,kBAAkB,CAAiC,GAAoB;QAC7E,MAAM,OAAO,GAAG,IAAI,4BAA4B,CAO9C,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,IAAW,CAAC,CAAC;QAC1C,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QAEpD,OAAO,OAAO,CAAC;IAChB,CAAC;IAEM,oBAAoB,CAAuC,GAA0B;QAC3F,MAAM,OAAO,GAAG,IAAI,4BAA4B,CAO9C,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,IAAW,CAAC,CAAC;QAC1C,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAEtD,OAAO,OAAO,CAAC;IAChB,CAAC;IAEM,KAAK;QAOX,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,EAAkC,CAAC,CAAC;QAE5F,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAMrB,CAAC;IACH,CAAC;IAEO,mCAAmC,CAC1C,UAAyB,EACzB,YAA0C,EAC1C,MAAe;QAEf,MAAM,gBAAgB,GAAG,CAAC,QAAkB,EAAE,EAAE,CAC/C,SAAS,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC;QAClF,UAAU,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC7D,IAAI,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAChC,IAAI,YAAY,IAAI,QAAQ,EAAE,CAAC;oBAC9B,MAAM,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC;oBAC5C,QAAQ,CAAC,UAAU,GAAG,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;wBACvC,IAAI,CAAC;4BACJ,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;wBAC/D,CAAC;wBAAC,OAAO,GAAG,EAAE,CAAC;4BACd,IAAI,GAAG,YAAY,cAAQ,EAAE,CAAC;gCAC7B,MAAM,IAAA,8BAAmB,EACxB,GAAG,EACH,IAAI,CAAC,MAAM,EACX,UAAU,CAAC,MAAM,CAAC,IAAI,EACtB,IAAI,GAAG,EAAE,EACT,KAAK,CACL,CAAC;4BACH,CAAC;4BACD,MAAM,GAAG,CAAC;wBACX,CAAC;oBACF,CAAC,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACP,OAAO;wBACN,gFAAgF;wBAChF,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,qBAAsB;wBAC5C,UAAU,EAAE,KAAK,IAAI,EAAE;4BACtB,MAAM,YAAY,GAAG,IAAA,iBAAQ,EAAC,YAAY,CAAC;gCAC1C,CAAC,CAAC,IAAA,aAAI,EAAC,YAAY,EAAE,IAAA,aAAI,EAAC,MAAM,CAAC,CAAC;gCAClC,CAAC,CAAC,YAAY,CAAC;4BAChB,IAAI,CAAC;gCACJ,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;4BACnD,CAAC;4BAAC,OAAO,GAAG,EAAE,CAAC;gCACd,IAAI,GAAG,YAAY,cAAQ,EAAE,CAAC;oCAC7B,MAAM,IAAA,8BAAmB,EACxB,GAAG,EACH,IAAI,CAAC,MAAM,EACX,UAAU,CAAC,MAAM,CAAC,IAAI,EACtB,IAAI,GAAG,EAAE,EACT,KAAK,CACL,CAAC;gCACH,CAAC;gCACD,MAAM,GAAG,CAAC;4BACX,CAAC;wBACF,CAAC;qBACD,CAAC;gBACH,CAAC;YACF,CAAC;YAED,OAAO,QAAQ,CAAC;QACjB,CAAC,CAAC,CAAC;QAEH,OAAO,UAAU,CAAC;IACnB,CAAC;CACD;AA7KD,oEA6KC"}

package/dist/module/module.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/module/module.spec.js

@@ -0,0 +1,186 @@
+"use strict";
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_1 = require("@nestjs/common");
+const testing_1 = require("@nestjs/testing");
+const zod_1 = require("zod");
+const module_1 = require("./module");
+describe("module", () => {
+    const MyOptionSchema = zod_1.z
+        .object({
+        useFlags: zod_1.z.boolean().describe("Whether the use of flag is considered when connecting"),
+        clientName: zod_1.z.string().min(5).describe("The client name used for connecting to the universe"),
+    })
+        .describe("The options for connecting using the dynamic module")
+        .transform((v) => ({ ...v, supportsTransforms: false }))
+        .transform(async (v) => ({ ...v, supportsTransforms: true }));
+    const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN } = new module_1.ZodConfigurableModuleBuilder(MyOptionSchema)
+        .setExtras({
+        isGlobal: false,
+    }, (definition, extras) => ({
+        ...definition,
+        global: extras.isGlobal,
+    }))
+        .setClassMethodName("forRoot")
+        .build();
+    let DynModule = (() => {
+        let _classDecorators = [(0, common_1.Module)({})];
+        let _classDescriptor;
+        let _classExtraInitializers = [];
+        let _classThis;
+        let _classSuper = ConfigurableModuleClass;
+        var DynModule = class extends _classSuper {
+            static { _classThis = this; }
+            static {
+                const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+                __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+                DynModule = _classThis = _classDescriptor.value;
+                if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+                __runInitializers(_classThis, _classExtraInitializers);
+            }
+        };
+        return DynModule = _classThis;
+    })();
+    it("should register correct options with static synchronous method", async () => {
+        const moduleRef = await testing_1.Test.createTestingModule({
+            imports: [
+                DynModule.forRoot({
+                    useFlags: true,
+                    clientName: "some long enough client name",
+                }),
+            ],
+        }).compile();
+        const options = moduleRef.get(MODULE_OPTIONS_TOKEN);
+        expect(options).toMatchObject({
+            useFlags: true,
+            clientName: "some long enough client name",
+            supportsTransforms: true,
+        });
+    });
+    it("should register correct options with asynchronous method", async () => {
+        const DEFAULTS_TOKEN = "DEFAULT_OPTIONS";
+        const defaultsValue = {
+            useFlags: false,
+        };
+        const moduleRef = await testing_1.Test.createTestingModule({
+            imports: [
+                DynModule.forRootAsync({
+                    provideInjectionTokensFrom: [{ provide: DEFAULTS_TOKEN, useValue: defaultsValue }],
+                    useFactory: (defaults) => {
+                        return {
+                            ...defaults,
+                            clientName: "some long enough client name",
+                        };
+                    },
+                    inject: [{ token: DEFAULTS_TOKEN, optional: false }],
+                }),
+            ],
+        }).compile();
+        const options = moduleRef.get(MODULE_OPTIONS_TOKEN);
+        expect(options).toMatchObject({
+            useFlags: false,
+            clientName: "some long enough client name",
+            supportsTransforms: true,
+        });
+    });
+    it("should throw an error when clientName is too short", async () => {
+        await expect(testing_1.Test.createTestingModule({
+            imports: [
+                DynModule.forRoot({
+                    useFlags: true,
+                    clientName: "shor", // Less than 5 characters
+                }),
+            ],
+        }).compile()).rejects.toThrow();
+    });
+    it("should throw an error when required options are missing", async () => {
+        await expect(testing_1.Test.createTestingModule({
+            imports: [
+                // @ts-expect-error: we are passing what could be a complete wrong and unchecked object
+                DynModule.forRoot({
+                    // Missing clientName
+                    useFlags: true,
+                }),
+            ],
+        }).compile()).rejects.toThrow();
+    });
+    it("should throw an error when async factory returns invalid options", async () => {
+        const DEFAULTS_TOKEN = "INVALID_DEFAULTS";
+        const defaultsValue = {
+            useFlags: false,
+        };
+        await expect(testing_1.Test.createTestingModule({
+            imports: [
+                DynModule.forRootAsync({
+                    provideInjectionTokensFrom: [{ provide: DEFAULTS_TOKEN, useValue: defaultsValue }],
+                    useFactory: (defaults) => {
+                        return {
+                            ...defaults,
+                            clientName: "bad", // Too short
+                        };
+                    },
+                    inject: [{ token: DEFAULTS_TOKEN, optional: false }],
+                }),
+            ],
+        }).compile()).rejects.toThrow();
+    });
+    it("should throw an error when invalid option types are provided", async () => {
+        await expect(testing_1.Test.createTestingModule({
+            imports: [
+                DynModule.forRoot({
+                    // @ts-expect-error: we are passing a wrong and unchecked field
+                    useFlags: "not-a-boolean", // Wrong type
+                    clientName: "some long enough client name",
+                }),
+            ],
+        }).compile()).rejects.toThrow();
+    });
+    it("should throw an error when injected token is not found and not optional", async () => {
+        const NON_EXISTENT_TOKEN = "NON_EXISTENT_TOKEN";
+        await expect(testing_1.Test.createTestingModule({
+            imports: [
+                DynModule.forRootAsync({
+                    useFactory: () => ({
+                        useFlags: true,
+                        clientName: "some long enough client name",
+                    }),
+                    inject: [{ token: NON_EXISTENT_TOKEN, optional: false }],
+                }),
+            ],
+        }).compile()).rejects.toThrow();
+    });
+});
+//# sourceMappingURL=module.spec.js.map

package/dist/module/module.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.spec.js","sourceRoot":"","sources":["../../src/module/module.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAwC;AACxC,6CAAuC;AAEvC,6BAAwB;AAExB,qCAAwD;AAExD,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACvB,MAAM,cAAc,GAAG,OAAC;SACtB,MAAM,CAAC;QACP,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,uDAAuD,CAAC;QACvF,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,qDAAqD,CAAC;KAC7F,CAAC;SACD,QAAQ,CAAC,qDAAqD,CAAC;SAC/D,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC,CAAC;SACvD,SAAS,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAG/D,MAAM,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,GAAG,IAAI,qCAA4B,CACzF,cAAc,CACd;SACC,SAAS,CACT;QACC,QAAQ,EAAE,KAAK;KACf,EACD,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACxB,GAAG,UAAU;QACb,MAAM,EAAE,MAAM,CAAC,QAAQ;KACvB,CAAC,CACF;SACA,kBAAkB,CAAC,SAAS,CAAC;SAC7B,KAAK,EAAE,CAAC;QAGJ,SAAS;gCADd,IAAA,eAAM,EAAC,EAAE,CAAC;;;;0BACa,uBAAuB;6BAA/B,SAAQ,WAAuB;;;;gBAA/C,6KAAkD;;;gBAA5C,uDAAS;;;;;IAEf,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAChD,OAAO,EAAE;gBACR,SAAS,CAAC,OAAO,CAAC;oBACjB,QAAQ,EAAE,IAAI;oBACd,UAAU,EAAE,8BAA8B;iBAC1C,CAAC;aACF;SACD,CAAC,CAAC,OAAO,EAAE,CAAC;QAEb,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAW,oBAAoB,CAAC,CAAC;QAE9D,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;YAC7B,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,8BAA8B;YAC1C,kBAAkB,EAAE,IAAI;SACxB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,cAAc,GAAG,iBAAiB,CAAC;QACzC,MAAM,aAAa,GAAG;YACrB,QAAQ,EAAE,KAAK;SACf,CAAC;QAEF,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAChD,OAAO,EAAE;gBACR,SAAS,CAAC,YAAY,CAAC;oBACtB,0BAA0B,EAAE,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;oBAClF,UAAU,EAAE,CAAC,QAA8B,EAAE,EAAE;wBAC9C,OAAO;4BACN,GAAG,QAAQ;4BACX,UAAU,EAAE,8BAA8B;yBAC1C,CAAC;oBACH,CAAC;oBACD,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;iBACpD,CAAC;aACF;SACD,CAAC,CAAC,OAAO,EAAE,CAAC;QAEb,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAW,oBAAoB,CAAC,CAAC;QAE9D,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;YAC7B,QAAQ,EAAE,KAAK;YACf,UAAU,EAAE,8BAA8B;YAC1C,kBAAkB,EAAE,IAAI;SACxB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,MAAM,CACX,cAAI,CAAC,mBAAmB,CAAC;YACxB,OAAO,EAAE;gBACR,SAAS,CAAC,OAAO,CAAC;oBACjB,QAAQ,EAAE,IAAI;oBACd,UAAU,EAAE,MAAM,EAAE,yBAAyB;iBAC7C,CAAC;aACF;SACD,CAAC,CAAC,OAAO,EAAE,CACZ,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,MAAM,CACX,cAAI,CAAC,mBAAmB,CAAC;YACxB,OAAO,EAAE;gBACR,uFAAuF;gBACvF,SAAS,CAAC,OAAO,CAAC;oBACjB,qBAAqB;oBACrB,QAAQ,EAAE,IAAI;iBACH,CAAC;aACb;SACD,CAAC,CAAC,OAAO,EAAE,CACZ,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;QACjF,MAAM,cAAc,GAAG,kBAAkB,CAAC;QAC1C,MAAM,aAAa,GAAG;YACrB,QAAQ,EAAE,KAAK;SACf,CAAC;QAEF,MAAM,MAAM,CACX,cAAI,CAAC,mBAAmB,CAAC;YACxB,OAAO,EAAE;gBACR,SAAS,CAAC,YAAY,CAAC;oBACtB,0BAA0B,EAAE,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;oBAClF,UAAU,EAAE,CAAC,QAA8B,EAAE,EAAE;wBAC9C,OAAO;4BACN,GAAG,QAAQ;4BACX,UAAU,EAAE,KAAK,EAAE,YAAY;yBAC/B,CAAC;oBACH,CAAC;oBACD,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;iBACpD,CAAC;aACF;SACD,CAAC,CAAC,OAAO,EAAE,CACZ,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,MAAM,CACX,cAAI,CAAC,mBAAmB,CAAC;YACxB,OAAO,EAAE;gBACR,SAAS,CAAC,OAAO,CAAC;oBACjB,+DAA+D;oBAC/D,QAAQ,EAAE,eAA0B,EAAE,aAAa;oBACnD,UAAU,EAAE,8BAA8B;iBAC1C,CAAC;aACF;SACD,CAAC,CAAC,OAAO,EAAE,CACZ,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACxF,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;QAEhD,MAAM,MAAM,CACX,cAAI,CAAC,mBAAmB,CAAC;YACxB,OAAO,EAAE;gBACR,SAAS,CAAC,YAAY,CAAC;oBACtB,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;wBAClB,QAAQ,EAAE,IAAI;wBACd,UAAU,EAAE,8BAA8B;qBAC1C,CAAC;oBACF,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;iBACxD,CAAC;aACF;SACD,CAAC,CAAC,OAAO,EAAE,CACZ,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,66 @@
+{
+	"name": "@proventuslabs/nestjs-zod",
+	"version": "1.0.0-rc.1",
+	"license": "MIT",
+	"description": "A collection of NestJS modules to integrate Zod into your application.",
+	"keywords": [
+		"nestjs",
+		"zod",
+		"config",
+		"module"
+	],
+	"author": "ProventusLabs <info@proventuslabs.com>",
+	"homepage": "https://github.com/proventuslabs/nestjs/tree/main/packages/zod#readme",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/proventuslabs/nestjs.git",
+		"directory": "packages/zod"
+	},
+	"bugs": {
+		"url": "https://github.com/proventuslabs/nestjs/issues"
+	},
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"prepublishOnly": "npm run build",
+		"build": "nest build",
+		"lint": "biome check .",
+		"lint:fix": "biome check . --write",
+		"format": "biome format .",
+		"format:fix": "biome format . --write",
+		"typecheck": "tsc --noEmit",
+		"test": "jest",
+		"test:watch": "jest --watch",
+		"test:coverage": "jest --coverage",
+		"test:coverage:watch": "jest --coverage --watch"
+	},
+	"dependencies": {
+		"lodash": "^4.17.21",
+		"yaml": "^2.8.0"
+	},
+	"peerDependencies": {
+		"@nestjs/common": "^10.0.0 || ^11.0.0",
+		"@nestjs/config": "^3.0.0 || ^4.0.0",
+		"zod": "^3.0.0"
+	},
+	"devDependencies": {
+		"@nestjs/cli": "^11.0.0",
+		"@nestjs/common": "^11.0.0",
+		"@nestjs/core": "^11.0.0",
+		"@nestjs/platform-express": "^11.0.0",
+		"@nestjs/testing": "^11.0.0",
+		"@types/jest": "^30.0.0",
+		"@types/lodash": "^4.17.18",
+		"@types/node": "^20.0.0",
+		"jest": "^30.0.0",
+		"reflect-metadata": "^0.2.2",
+		"rxjs": "^7.8.2",
+		"ts-jest": "^29.4.0",
+		"type-fest": "^4.41.0",
+		"typescript": "^5.8.3",
+		"zod": "^3.25.67"
+	}
+}