@trayio/commons 4.12.0 → 4.13.0

package/dist/zod/SchemaParser.abstract.test.d.ts

@@ -0,0 +1,7 @@
+import { SchemaParser } from './SchemaParser';
+export type TestType = {
+    strField: string;
+    intField?: number;
+};
+export declare function testSchemaParser(testTypeParser: SchemaParser<TestType>): void;
+//# sourceMappingURL=SchemaParser.abstract.test.d.ts.map

package/dist/zod/SchemaParser.abstract.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaParser.abstract.test.d.ts","sourceRoot":"","sources":["../../src/zod/SchemaParser.abstract.test.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,MAAM,QAAQ,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAgB,gBAAgB,CAAC,cAAc,EAAE,YAAY,CAAC,QAAQ,CAAC,QAkEtE"}

package/dist/zod/SchemaParser.abstract.test.js

@@ -0,0 +1,80 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testSchemaParser = void 0;
+const E = __importStar(require("fp-ts/Either"));
+const O = __importStar(require("fp-ts/Option"));
+function testSchemaParser(testTypeParser) {
+    describe('Schema Parser', () => {
+        test('should parse a schema', () => {
+            const testValue = {
+                strField: 'str',
+                intField: 123,
+            };
+            const parsedOutput = {
+                strField: 'str',
+                intField: O.some(123),
+            };
+            const result = testTypeParser.parse(testValue);
+            expect(result).toStrictEqual(E.right(parsedOutput));
+        });
+        test('should parse a schema with optional field', () => {
+            const testValue = {
+                strField: 'str',
+            };
+            const parsedOutput = {
+                strField: 'str',
+                intField: O.none,
+            };
+            const result = testTypeParser.parse(testValue);
+            expect(result).toStrictEqual(E.right(parsedOutput));
+        });
+        test('should fail to parse a schema with invalid type', () => {
+            const testValue = {
+                strField: 'str',
+                intField: '123',
+            };
+            const result = testTypeParser.parse(testValue);
+            expect(result._tag).toBe('Left');
+        });
+        test('should fail to parse a schema with missing required field', () => {
+            const testValue = {
+                intField: 123,
+            };
+            const result = testTypeParser.parse(testValue);
+            expect(result._tag).toBe('Left');
+        });
+        test('should fail to parse a schema with extra field', () => {
+            const testValue = {
+                strField: 'str',
+                intField: 123,
+                extraField: 'extra',
+            };
+            const result = testTypeParser.parse(testValue);
+            expect(result._tag).toBe('Left');
+        });
+    });
+}
+exports.testSchemaParser = testSchemaParser;

package/dist/zod/SchemaParser.d.ts

@@ -0,0 +1,5 @@
+import * as E from 'fp-ts/Either';
+export interface SchemaParser<T> {
+    parse(value: unknown): E.Either<Error, T>;
+}
+//# sourceMappingURL=SchemaParser.d.ts.map

package/dist/zod/SchemaParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaParser.d.ts","sourceRoot":"","sources":["../../src/zod/SchemaParser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAElC,MAAM,WAAW,YAAY,CAAC,CAAC;IAC9B,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;CAC1C"}

package/dist/zod/SchemaParser.js

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

package/dist/zod/ZodSchemaParser.d.ts

@@ -0,0 +1,13 @@
+import { z, ZodSchema } from 'zod';
+import * as E from 'fp-ts/Either';
+import { Option } from 'fp-ts/Option';
+import { SchemaParser } from './SchemaParser';
+export declare const zodOptionFromNullable: <T>(schema: z.ZodType<T, any, any>) => z.ZodType<Option<T>, any, any>;
+export declare class ZodSchemaParser<T> implements SchemaParser<T> {
+    private readonly schema;
+    constructor(schema: ZodSchema<T>);
+    static fromSchema<T>(schema: ZodSchema): SchemaParser<T>;
+    parse(value: unknown): E.Either<Error, T>;
+    private errorTransformer;
+}
+//# sourceMappingURL=ZodSchemaParser.d.ts.map

package/dist/zod/ZodSchemaParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZodSchemaParser.d.ts","sourceRoot":"","sources":["../../src/zod/ZodSchemaParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,SAAS,EAAsB,MAAM,KAAK,CAAC;AACvD,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,EAAE,MAAM,EAAc,MAAM,cAAc,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,eAAO,MAAM,qBAAqB,uEAKiC,CAAC;AAEpE,qBAAa,eAAe,CAAC,CAAC,CAAE,YAAW,YAAY,CAAC,CAAC,CAAC;IAC7C,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IAEjD,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC;IAIxD,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IAOzC,OAAO,CAAC,gBAAgB;CAmCxB"}

package/dist/zod/ZodSchemaParser.js

@@ -0,0 +1,79 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZodSchemaParser = exports.zodOptionFromNullable = void 0;
+const E = __importStar(require("fp-ts/Either"));
+const Option_1 = require("fp-ts/Option");
+const zodOptionFromNullable = (schema) => schema
+    .optional()
+    .transform((value) => (value === undefined ? Option_1.none : (0, Option_1.some)(value)));
+exports.zodOptionFromNullable = zodOptionFromNullable;
+class ZodSchemaParser {
+    schema;
+    constructor(schema) {
+        this.schema = schema;
+    }
+    static fromSchema(schema) {
+        return new ZodSchemaParser(schema);
+    }
+    parse(value) {
+        const parseResult = this.schema.safeParse(value);
+        return parseResult.success
+            ? E.right(parseResult.data)
+            : E.left(this.errorTransformer(parseResult.error));
+    }
+    errorTransformer(zodError) {
+        let errorString = '';
+        let errorIndex = 1;
+        const flattendError = zodError.flatten((issue) => ({
+            message: issue.message,
+            code: issue.code,
+            path: issue.path.join('.'),
+        }));
+        const { fieldErrors, formErrors } = flattendError;
+        Object.keys(fieldErrors).forEach((fieldName) => {
+            const errors = fieldErrors[fieldName];
+            errors?.forEach((error, index) => {
+                errorString += `${errorIndex}. ${error.code} at ${error.path}: ${error.message}`;
+                if (index < errors.length - 1) {
+                    errorString += '\n';
+                }
+                errorIndex += 1;
+            });
+            errorString += '\n';
+        });
+        formErrors.forEach((error, index) => {
+            errorString += `${errorIndex}. ${error.code}: ${error.message}`;
+            if (index < formErrors.length - 1) {
+                errorString += '\n';
+            }
+            errorIndex += 1;
+            errorString += '\n';
+        });
+        errorString = errorString.trim();
+        return new Error(errorString);
+    }
+}
+exports.ZodSchemaParser = ZodSchemaParser;

package/dist/zod/ZodSchemaParser.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ZodSchemaParser.unit.test.d.ts.map

package/dist/zod/ZodSchemaParser.unit.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZodSchemaParser.unit.test.d.ts","sourceRoot":"","sources":["../../src/zod/ZodSchemaParser.unit.test.ts"],"names":[],"mappings":""}

package/dist/zod/ZodSchemaParser.unit.test.js

@@ -0,0 +1,46 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const E = __importStar(require("fp-ts/Either"));
+const zod_1 = require("zod");
+const SchemaParser_abstract_test_1 = require("./SchemaParser.abstract.test");
+const ZodSchemaParser_1 = require("./ZodSchemaParser");
+const TestSchema = zod_1.z
+    .object({
+    strField: zod_1.z.string(),
+    intField: (0, ZodSchemaParser_1.zodOptionFromNullable)(zod_1.z.number()),
+})
+    .strict();
+describe('Zod Schema Parser', () => {
+    (0, SchemaParser_abstract_test_1.testSchemaParser)(ZodSchemaParser_1.ZodSchemaParser.fromSchema(TestSchema));
+    test('should fail to parse a schema with invalid type', () => {
+        const testValue = {
+            strField: 'str',
+            intField: '123',
+        };
+        const result = ZodSchemaParser_1.ZodSchemaParser.fromSchema(TestSchema).parse(testValue);
+        expect(result).toStrictEqual(E.left(new Error('1. invalid_type at intField: Expected number, received string')));
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/commons",
-  "version": "4.12.0",
+  "version": "4.13.0",
   "description": "Extensions to the standard/core libraries and basic features",
   "exports": {
     "./*": "./dist/*.js"
@@ -30,7 +30,8 @@
     "lodash": "4.17.21",
     "monocle-ts": "2.3.13",
     "newtype-ts": "0.3.5",
-    "uuid": "9.0.0"
+    "uuid": "9.0.0",
+    "zod": "3.23.5"
   },
   "typesVersions": {
     "*": {