@pitininja/envious-zod 6.0.0-beta3

package/README.md

@@ -0,0 +1,56 @@
+# Envious Zod resolver
+
+[![npm version](https://badge.fury.io/js/@pitininja%2Fenvious-zod.svg)](https://badge.fury.io/js/@pitininja%2Fenvious-zod)
+
+> Only Zod v4 or superior is supported
+
+- [Install](#install)
+- [Usage](#usage)
+- [About Zod schemas](#about-zod-schemas)
+
+## Install
+
+```shell
+npm i @pitininja/envious-zod
+```
+
+## Usage
+
+```typescript
+import { envious } from '@pitininja/envious';
+import { zodResolver } from '@pitininja/envious-zod';
+import * as z from 'zod';
+
+const env = envious({
+    resolver: zodResolver({
+        schema: z.object({
+            STRING_VAR: z.string(),
+            NUMBER_VAR: z.coerce.number().int(),
+            BOOLEAN_VAR_WITH_DEFAULT: z.stringbool().default(true),
+            OPTIONAL_VAR: z.optional(z.string())
+        })
+    })
+});
+```
+
+## About Zod schemas
+
+Zod cannot programmatically convert object values from a schema. Therefore the conversion must happen at the schema level using :
+
+- [coerce](https://zod.dev/api?id=coercion) for numbers
+- [stringbool](https://zod.dev/api?id=stringbool) for booleans
+
+```typescript
+import { envious } from '@pitininja/envious';
+import { zodResolver } from '@pitininja/envious-zod';
+import * as z from 'zod';
+
+const env = envious({
+    resolver: zodResolver({
+        schema: z.object({
+            NUMBER_VAR: z.coerce.number().int(),
+            BOOLEAN_VAR: z.stringbool()
+        })
+    })
+});
+```

package/dist/common/error.d.ts

@@ -0,0 +1,21 @@
+export type EnviousErrorVariable = {
+    name: string;
+    messages: string[];
+};
+type EnviousErrorOptions = {
+    message?: string;
+    variables?: EnviousErrorVariable[];
+};
+export declare class EnviousError extends Error {
+    variables: EnviousErrorVariable[];
+    constructor({ message, variables }: EnviousErrorOptions);
+}
+type ResolverErrorsToEnviousErrorsOptions<T> = {
+    transform: (resolverError: T) => {
+        name: string;
+        message: string;
+    };
+    resolverErrors: T[];
+};
+export declare const resolverErrorsToEnviousErrors: <T>({ transform, resolverErrors }: ResolverErrorsToEnviousErrorsOptions<T>) => EnviousErrorVariable[];
+export {};

package/dist/common/error.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolverErrorsToEnviousErrors = exports.EnviousError = void 0;
+class EnviousError extends Error {
+    variables;
+    constructor({ message = 'Invalid environment variables', variables = [] }) {
+        super(message);
+        this.variables = variables;
+    }
+}
+exports.EnviousError = EnviousError;
+const resolverErrorsToEnviousErrors = ({ transform, resolverErrors }) => {
+    const enviousErrors = [];
+    const validationErrorsMap = new Map();
+    for (const resolverError of resolverErrors) {
+        const { name, message } = transform(resolverError);
+        const errorMessages = validationErrorsMap.get(name);
+        validationErrorsMap.set(name, [...(errorMessages ?? []), message]);
+    }
+    for (const [name, messages] of validationErrorsMap.entries()) {
+        enviousErrors.push({ name, messages });
+    }
+    return enviousErrors;
+};
+exports.resolverErrorsToEnviousErrors = resolverErrorsToEnviousErrors;
+//# sourceMappingURL=error.js.map

package/dist/common/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../../common/error.ts"],"names":[],"mappings":";;;AAUA,kBAA0B,SAAQ,KAAK;IACnC,SAAS,CAAyB;IAClC,YAAY,EACR,OAAO,GAAG,+BAA+B,EACzC,SAAS,GAAG,EAAE,EACI,EAAE;QACpB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAAA,CAC9B;CACJ;;AAUM,MAAM,6BAA6B,GAAG,CAAI,EAC7C,SAAS,EACT,cAAc,EACwB,EAAE,EAAE,CAAC;IAC3C,MAAM,aAAa,GAA2B,EAAE,CAAC;IACjD,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAoB,CAAC;IACxD,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;QACzC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;QACnD,MAAM,aAAa,GAAG,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpD,mBAAmB,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,mBAAmB,CAAC,OAAO,EAAE,EAAE,CAAC;QAC3D,aAAa,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,aAAa,CAAC;AAAA,CACxB,CAAC;AAfW,QAAA,6BAA6B,GAA7B,6BAA6B,CAexC"}

package/dist/resolvers/zod/src/index.d.ts

@@ -0,0 +1,7 @@
+import { type core as ZodCore, type infer as ZodInfer, type ZodObject } from 'zod';
+type EnviousZodResolver<T extends ZodObject> = (env: NodeJS.ProcessEnv) => ZodInfer<T>;
+export type EnviousZodResolverOptions<T extends ZodObject> = {
+    schema: T;
+};
+export declare const zodResolver: <T extends ZodObject<ZodCore.$ZodLooseShape, ZodCore.$strip>>({ schema }: EnviousZodResolverOptions<T>) => EnviousZodResolver<T>;
+export {};

package/dist/resolvers/zod/src/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zodResolver = void 0;
+const zod_1 = require("zod");
+const error_1 = require("../../../common/error");
+const zodIssuesToEnviousErrors = (zodIssues) => {
+    return (0, error_1.resolverErrorsToEnviousErrors)({
+        resolverErrors: zodIssues,
+        transform: (zodIssue) => {
+            const { path, message } = zodIssue;
+            return { name: path.join('/'), message };
+        }
+    });
+};
+const zodResolver = ({ schema }) => {
+    return (env) => {
+        const { success, data, error } = zod_1.z.safeParse(schema, env);
+        if (success && data) {
+            return data;
+        }
+        if (error) {
+            throw new error_1.EnviousError({
+                variables: zodIssuesToEnviousErrors(error.issues)
+            });
+        }
+        throw new Error();
+    };
+};
+exports.zodResolver = zodResolver;
+//# sourceMappingURL=index.js.map

package/dist/resolvers/zod/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/index.ts"],"names":[],"mappings":";;;AAAA,6BAKa;AACb,iDAI+B;AAU/B,MAAM,wBAAwB,GAAG,CAC7B,SAA8B,EACR,EAAE,CAAC;IACzB,OAAO,IAAA,qCAA6B,EAAC;QACjC,cAAc,EAAE,SAAS;QACzB,SAAS,EAAE,CAAC,QAA2B,EAAE,EAAE,CAAC;YACxC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC;YACnC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC;QAAA,CAC5C;KACJ,CAAC,CAAC;AAAA,CACN,CAAC;AAEK,MAAM,WAAW,GAAG,CAAsB,EAC7C,MAAM,EACqB,EAAyB,EAAE,CAAC;IACvD,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;QACZ,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAC,CAAC,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC1D,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YAClB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACR,MAAM,IAAI,oBAAY,CAAC;gBACnB,SAAS,EAAE,wBAAwB,CAAC,KAAK,CAAC,MAAM,CAAC;aACpD,CAAC,CAAC;QACP,CAAC;QACD,MAAM,IAAI,KAAK,EAAE,CAAC;IAAA,CACrB,CAAC;AAAA,CACL,CAAC;AAfW,QAAA,WAAW,GAAX,WAAW,CAetB"}

package/package.json

@@ -0,0 +1,22 @@
+{
+    "name": "@pitininja/envious-zod",
+    "version": "6.0.0-beta3",
+    "license": "AGPL-3.0-or-later",
+    "homepage": "https://codeberg.org/pitininja/envious",
+    "repository": {
+        "type": "git",
+        "url": "https://codeberg.org/pitininja/envious"
+    },
+    "files": [
+        "./dist",
+        "./package.json"
+    ],
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "scripts": {
+        "build": "npx tsgo --build --clean tsconfig.json && npx tsgo -b ./tsconfig.json"
+    },
+    "dependencies": {
+        "zod": "^4.1.11"
+    }
+}