@pitininja/envious-typebox 6.0.0-beta4

package/README.md

@@ -0,0 +1,58 @@
+# Envious Typebox resolver
+
+[![npm version](https://badge.fury.io/js/@pitininja%2Fenvious-typebox.svg)](https://badge.fury.io/js/@pitininja%2Fenvious-typebox)
+
+> Only Typebox v1 or superior is supported
+
+- [Install](#install)
+- [Usage](#usage)
+- [Formats](#formats)
+
+## Install
+
+```shell
+npm i @pitininja/envious-typebox
+```
+
+## Usage
+
+```typescript
+import { envious } from '@pitininja/envious';
+import { typeboxResolver } from '@pitininja/envious-typebox';
+import { Type } from '@sinclair/typebox';
+
+const env = envious({
+    resolver: typeboxResolver({
+        schema: Type.Object({
+            STRING_VAR: Type.String(),
+            NUMBER_VAR: Type.Integer(),
+            BOOLEAN_VAR_WITH_DEFAULT: Type.Boolean({ default: false }),
+            OPTIONAL_VAR: Type.Optional(Type.String())
+        })
+    })
+});
+```
+
+## Formats
+
+String formats can be loaded in the `formats` property of the Typebox resolver options, as an object with the format name as key and a regex or a validation function as value.
+
+```typescript
+import { envious } from '@pitininja/envious';
+import { typeboxResolver } from '@pitininja/envious-typebox';
+import { Type } from '@sinclair/typebox';
+import dayjs from 'dayjs';
+
+const env = envious({
+    resolver: typeboxResolver({
+        schema: Type.Object({
+            EXAMPLE_URI: Type.String({ format: 'uri' }),
+            EXAMPLE_DATE: Type.String({ format: 'date' })
+        }),
+        formats: {
+            uri: /^(?:[a-z][a-z0-9+\-.]*:)(?:\/?\/)?[^\s]*$/i,
+            date: (val) => dayjs(val).isValid()
+        }
+    })
+});
+```

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/typebox/src/index.d.ts

@@ -0,0 +1,11 @@
+import type { Static, TObject } from 'typebox';
+type EnviousTypeboxResolver<T extends TObject> = (env: NodeJS.ProcessEnv) => Static<T>;
+export type EnviousTypeboxFormats = {
+    [name: string]: RegExp | ((val: unknown) => boolean);
+};
+export type EnviousTypeboxResolverOptions<T extends TObject> = {
+    schema: T;
+    formats?: EnviousTypeboxFormats;
+};
+export declare const typeboxResolver: <T extends TObject<import("typebox", { with: { "resolution-mode": "import" } }).TProperties>>({ schema, formats }: EnviousTypeboxResolverOptions<T>) => EnviousTypeboxResolver<T>;
+export {};

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

@@ -0,0 +1,100 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.typeboxResolver = void 0;
+const format_1 = __importDefault(require("typebox/format"));
+const value_1 = __importStar(require("typebox/value"));
+const error_1 = require("../../../common/error");
+const setTypeboxFormats = (formats) => {
+    for (const [name, format] of Object.entries(formats)) {
+        format_1.default.Set(name, format instanceof RegExp ? (val) => format.test(val) : format);
+    }
+};
+const typeboxErrorsToEnviousErrors = (typeboxErrors) => {
+    return (0, error_1.resolverErrorsToEnviousErrors)({
+        resolverErrors: typeboxErrors,
+        transform: (typeboxError) => {
+            const { instancePath, message } = typeboxError;
+            return { name: instancePath.replace(/^\//, ''), message };
+        }
+    });
+};
+function checkIfObject(val) {
+    if (!val || typeof val !== 'object') {
+        throw new error_1.EnviousError({
+            message: 'Could not parse environment variables'
+        });
+    }
+}
+const typeboxResolver = ({ schema, formats }) => {
+    return (env) => {
+        try {
+            if (formats) {
+                setTypeboxFormats(formats);
+            }
+            const clonedEnv = value_1.default.Clone(env);
+            // Below we use object assertion and spread because Clean / Default / Convert functions return unknown referenced objects
+            const cleaned = value_1.default.Clean(schema, clonedEnv);
+            checkIfObject(cleaned);
+            const defaulted = value_1.default.Default(schema, { ...cleaned });
+            checkIfObject(defaulted);
+            const converted = value_1.default.Convert(schema, { ...defaulted });
+            checkIfObject(converted);
+            const errors = value_1.default.Errors(schema, { ...converted });
+            if (errors.length) {
+                throw new error_1.EnviousError({
+                    variables: typeboxErrorsToEnviousErrors(errors)
+                });
+            }
+            return value_1.default.Repair({
+                ...schema,
+                additionalProperties: false
+            }, converted);
+        }
+        catch (err) {
+            if (err instanceof value_1.AssertError) {
+                throw new error_1.EnviousError({
+                    variables: typeboxErrorsToEnviousErrors(err.cause.errors)
+                });
+            }
+            throw err;
+        }
+    };
+};
+exports.typeboxResolver = typeboxResolver;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,4DAAoC;AACpC,uDAAmD;AACnD,iDAI+B;AAe/B,MAAM,iBAAiB,GAAG,CAAC,OAA8B,EAAE,EAAE,CAAC;IAC1D,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACnD,gBAAM,CAAC,GAAG,CACN,IAAI,EACJ,MAAM,YAAY,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAChE,CAAC;IACN,CAAC;AAAA,CACJ,CAAC;AAEF,MAAM,4BAA4B,GAAG,CACjC,aAA0C,EACpB,EAAE,CAAC;IACzB,OAAO,IAAA,qCAA6B,EAAC;QACjC,cAAc,EAAE,aAAa;QAC7B,SAAS,EAAE,CAAC,YAAuC,EAAE,EAAE,CAAC;YACpD,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC;YAC/C,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;QAAA,CAC7D;KACJ,CAAC,CAAC;AAAA,CACN,CAAC;AAEF,SAAS,aAAa,CAAC,GAAY,EAAyB;IACxD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAClC,MAAM,IAAI,oBAAY,CAAC;YACnB,OAAO,EAAE,uCAAuC;SACnD,CAAC,CAAC;IACP,CAAC;AAAA,CACJ;AAEM,MAAM,eAAe,GAAG,CAAoB,EAC/C,MAAM,EACN,OAAO,EACwB,EAA6B,EAAE,CAAC;IAC/D,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC;QACZ,IAAI,CAAC;YACD,IAAI,OAAO,EAAE,CAAC;gBACV,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAC/B,CAAC;YACD,MAAM,SAAS,GAAG,eAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnC,yHAAyH;YACzH,MAAM,OAAO,GAAG,eAAK,CAAC,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAC/C,aAAa,CAAC,OAAO,CAAC,CAAC;YACvB,MAAM,SAAS,GAAG,eAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;YACxD,aAAa,CAAC,SAAS,CAAC,CAAC;YACzB,MAAM,SAAS,GAAG,eAAK,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;YAC1D,aAAa,CAAC,SAAS,CAAC,CAAC;YACzB,MAAM,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC;YACtD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAChB,MAAM,IAAI,oBAAY,CAAC;oBACnB,SAAS,EAAE,4BAA4B,CAAC,MAAM,CAAC;iBAClD,CAAC,CAAC;YACP,CAAC;YACD,OAAO,eAAK,CAAC,MAAM,CACf;gBACI,GAAG,MAAM;gBACT,oBAAoB,EAAE,KAAK;aAC9B,EACD,SAAS,CACZ,CAAC;QACN,CAAC;QAAC,OAAO,GAAY,EAAE,CAAC;YACpB,IAAI,GAAG,YAAY,mBAAW,EAAE,CAAC;gBAC7B,MAAM,IAAI,oBAAY,CAAC;oBACnB,SAAS,EAAE,4BAA4B,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC;iBAC5D,CAAC,CAAC;YACP,CAAC;YACD,MAAM,GAAG,CAAC;QACd,CAAC;IAAA,CACJ,CAAC;AAAA,CACL,CAAC;AAvCW,QAAA,eAAe,GAAf,eAAe,CAuC1B"}

package/package.json

@@ -0,0 +1,22 @@
+{
+    "name": "@pitininja/envious-typebox",
+    "version": "6.0.0-beta4",
+    "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": {
+        "typebox": "^1.0.24"
+    }
+}