@abinnovision/nestjs-configx 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.0.1](https://github.com/abinnovision/nestjs-commons/compare/nestjs-configx-v2.0.0...nestjs-configx-v2.0.1) (2025-12-16)
+
+
+### Bug Fixes
+
+* align exports in package.json ([#70](https://github.com/abinnovision/nestjs-commons/issues/70)) ([58956c5](https://github.com/abinnovision/nestjs-commons/commit/58956c5ea55394b65c6af405f4c6ac45555dc94a))
+
 ## [2.0.0](https://github.com/abinnovision/nestjs-commons/compare/nestjs-configx-v1.1.1...nestjs-configx-v2.0.0) (2025-12-13)
 
 

package/dist/configx.constants.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Symbol key used to store resolved config values on the Configx class.
+ */
+export declare const CONFIGX_RESOLVED: unique symbol;

package/dist/configx.constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONFIGX_RESOLVED = void 0;
+/**
+ * Symbol key used to store resolved config values on the Configx class.
+ */
+exports.CONFIGX_RESOLVED = Symbol("CONFIGX_RESOLVED");

package/dist/configx.errors.d.ts

@@ -0,0 +1,8 @@
+import type { StandardSchemaV1 } from "@standard-schema/spec";
+/**
+ * Generic error class for Configx.
+ */
+export declare class ConfigxError extends Error {
+    constructor(message: string);
+    static fromSchemaIssues(issues: readonly StandardSchemaV1.Issue[]): ConfigxError;
+}

package/dist/configx.errors.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigxError = void 0;
+/**
+ * Formats an issue for the ConfigxError.
+ *
+ * @param issue The issue to format.
+ * @returns The formatted issue.
+ */
+const formatIssue = (issue) => {
+    let result = "";
+    if ((issue.path?.length ?? 0) > 0) {
+        // Format the path segments.
+        const path = (issue.path ?? [])
+            .map((segment) => {
+            // If the segment is an object with a key property, use that.
+            if (typeof segment === "object" && "key" in segment) {
+                return segment.key.toString();
+            }
+            return segment.toString();
+        })
+            .join(".");
+        // Add the path to the result.
+        result += `${path}: `;
+    }
+    else {
+        // If there is no path, the issue is a root issue.
+        result += "@: ";
+    }
+    // Add the message.
+    result += issue.message;
+    return result;
+};
+/**
+ * Generic error class for Configx.
+ */
+class ConfigxError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ConfigxError";
+    }
+    static fromSchemaIssues(issues) {
+        const messageHeader = "Invalid config:\n";
+        const messageBody = issues.map((it) => `- ${formatIssue(it)}`).join("\n");
+        return new ConfigxError(`${messageHeader}${messageBody}`);
+    }
+}
+exports.ConfigxError = ConfigxError;

package/dist/configx.helpers.d.ts

@@ -0,0 +1,7 @@
+import type { ConfigxSchema, ConfigxType } from "./configx.types";
+/**
+ * Creates a new Configx class.
+ *
+ * @param schema The schema of the Configx class (Zod, ArkType, or any StandardSchema).
+ */
+export declare function configx<T extends ConfigxSchema>(schema: T): ConfigxType<T>;

package/dist/configx.helpers.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configx = configx;
+const configx_resolver_1 = require("./configx.resolver");
+/**
+ * Creates a new Configx class.
+ *
+ * @param schema The schema of the Configx class (Zod, ArkType, or any StandardSchema).
+ */
+function configx(schema) {
+    // eslint-disable-next-line @typescript-eslint/no-extraneous-class
+    class ConfigxUsage {
+        static schema = schema;
+        constructor() {
+            // Resolve the configuration.
+            const config = (0, configx_resolver_1.resolveConfig)({
+                schema,
+                resolveEnv: () => process.env,
+            });
+            // Assign the resolved configuration to the instance.
+            Object.assign(this, config);
+        }
+    }
+    return ConfigxUsage;
+}

package/dist/configx.module.d.ts

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

package/dist/configx.module.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/configx.resolver.d.ts

@@ -0,0 +1,19 @@
+import type { ConfigxSchema } from "./configx.types";
+import type { StandardSchemaV1 } from "@standard-schema/spec";
+interface ResolveConfigArgs<T extends ConfigxSchema> {
+    /**
+     * Schema of the Configx class.
+     */
+    schema: T;
+    /**
+     * Resolves the environment variables object.
+     */
+    resolveEnv: () => Record<string, string | undefined>;
+}
+/**
+ * Resolves the configuration with the given ConfigxConfig.
+ *
+ * @param args The arguments for the function.
+ */
+export declare const resolveConfig: <T extends ConfigxSchema>(args: ResolveConfigArgs<T>) => StandardSchemaV1.InferOutput<T>;
+export {};

package/dist/configx.resolver.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveConfig = void 0;
+const configx_errors_1 = require("./configx.errors");
+/**
+ * Resolves the configuration with the given ConfigxConfig.
+ *
+ * @param args The arguments for the function.
+ */
+const resolveConfig = (args) => {
+    // The object which will later be parsed by the Zod schema.
+    const parsableObject = args.resolveEnv();
+    const result = args.schema["~standard"].validate(parsableObject);
+    if (result instanceof Promise) {
+        throw new Error("Asynchronous schemas are not supported");
+    }
+    if (result.issues === undefined) {
+        return result.value;
+    }
+    else {
+        throw configx_errors_1.ConfigxError.fromSchemaIssues(result.issues);
+    }
+};
+exports.resolveConfig = resolveConfig;

package/dist/configx.tokens.d.ts

@@ -0,0 +1 @@
+export declare const CONFIGX_RESOLVER_FN: unique symbol;

package/dist/configx.tokens.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONFIGX_RESOLVER_FN = void 0;
+exports.CONFIGX_RESOLVER_FN = Symbol("CONFIGX_RESOLVER_FN");

package/dist/configx.types.d.ts

@@ -0,0 +1,23 @@
+import type { StandardSchemaV1 } from "@standard-schema/spec";
+/**
+ * Describes the allowed types for a Configx schema.
+ */
+export type ConfigxSchema = StandardSchemaV1<Record<string, string | undefined>, Record<string, any>>;
+/**
+ * Describes a Configx class.
+ * The instance of the class is used to access the configuration.
+ */
+export interface ConfigxType<T extends ConfigxSchema = any> {
+    /**
+     * Standard Schema V1 schema of the Configx class.
+     */
+    schema: T;
+    /**
+     * Instantiates a new Configx instance.
+     */
+    new (): ConfigxValue<T>;
+}
+/**
+ * Describes the value of the Configx class.
+ */
+export type ConfigxValue<T extends ConfigxSchema> = StandardSchemaV1.InferOutput<T>;

package/dist/configx.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/helper.d.ts

@@ -0,0 +1,7 @@
+import type { ConfigxSchema, ConfigxType } from "./types";
+/**
+ * Creates a new Configx class based on the provided schema.
+ *
+ * @param schema The schema of the Configx class (Zod, ArkType, or any StandardSchema).
+ */
+export declare function configx<T extends ConfigxSchema>(schema: T): ConfigxType<T>;

package/dist/helper.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configx = configx;
+const resolver_1 = require("./resolver");
+/**
+ * Creates a new Configx class based on the provided schema.
+ *
+ * @param schema The schema of the Configx class (Zod, ArkType, or any StandardSchema).
+ */
+function configx(schema) {
+    // eslint-disable-next-line @typescript-eslint/no-extraneous-class
+    class ConfigxUsage {
+        static schema = schema;
+        constructor() {
+            // Resolve the configuration.
+            const config = (0, resolver_1.resolveConfig)({
+                schema,
+                resolveEnv: () => process.env,
+            });
+            // Assign the resolved configuration to the instance.
+            // This is currently the most efficient way to do this without relying on proxies.
+            Object.assign(this, config);
+        }
+    }
+    return ConfigxUsage;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@abinnovision/nestjs-configx",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "keywords": [
     "nestjs",
     "config",
@@ -9,7 +9,9 @@
     "standard-schema"
   ],
   "repository": {
-    "url": "https://github.com/abinnovision/nestjs-commons"
+    "type": "git",
+    "url": "https://github.com/abinnovision/nestjs-commons.git",
+    "directory": "packages/configx"
   },
   "license": "Apache-2.0",
   "author": {
@@ -17,10 +19,17 @@
     "email": "info@abinnovision.com",
     "url": "https://abinnovision.com/"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
   "files": [
-    "dist"
+    "dist",
+    "LICENSE",
+    "README.md"
   ],
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -56,7 +65,6 @@
     "vitest": "^4.0.15",
     "zod": "^3.24.1"
   },
-  "packageManager": "yarn@4.5.1",
   "publishConfig": {
     "ghpr": true,
     "npm": true,