@trayio/commons 3.10.0 → 3.11.0

package/dist/dynamicschema/DynamicSchema.d.ts

@@ -0,0 +1,15 @@
+import * as E from 'fp-ts/Either';
+import * as t from 'io-ts';
+import { DynamicObject } from '../dynamictype/DynamicType';
+declare const dynamicSchemaTypeDescriptor: t.BrandC<t.Type<DynamicObject, DynamicObject, unknown>, DynamicSchemaBrand>;
+export type DynamicSchema = t.TypeOf<typeof dynamicSchemaTypeDescriptor>;
+export interface DynamicSchemaBrand {
+    readonly DynamicSchema: unique symbol;
+}
+export interface DynamicSchemaInterface {
+    fromDynamicObject: (schemaObj: DynamicObject) => E.Either<Error, DynamicSchema>;
+    validate: (schema: DynamicSchema, value: DynamicObject) => E.Either<Error, undefined>;
+}
+export declare const DynamicSchema: DynamicSchemaInterface;
+export {};
+//# sourceMappingURL=DynamicSchema.d.ts.map

package/dist/dynamicschema/DynamicSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DynamicSchema.d.ts","sourceRoot":"","sources":["../../src/dynamicschema/DynamicSchema.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,OAAO,EACN,aAAa,EAEb,MAAM,4BAA4B,CAAC;AAoBpC,QAAA,MAAM,2BAA2B,6EAKhC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAMzE,MAAM,WAAW,kBAAkB;IAClC,QAAQ,CAAC,aAAa,EAAE,OAAO,MAAM,CAAC;CACtC;AAED,MAAM,WAAW,sBAAsB;IACtC,iBAAiB,EAAE,CAClB,SAAS,EAAE,aAAa,KACpB,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IACpC,QAAQ,EAAE,CACT,MAAM,EAAE,aAAa,EACrB,KAAK,EAAE,aAAa,KAChB,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;CAChC;AAED,eAAO,MAAM,aAAa,EAAE,sBAkB3B,CAAC"}

package/dist/dynamicschema/DynamicSchema.js

@@ -0,0 +1,63 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicSchema = void 0;
+const ajv_draft_04_1 = __importDefault(require("ajv-draft-04"));
+const ajv_formats_1 = __importDefault(require("ajv-formats"));
+const E = __importStar(require("fp-ts/Either"));
+const t = __importStar(require("io-ts"));
+const function_1 = require("fp-ts/function");
+const DynamicType_1 = require("../dynamictype/DynamicType");
+const TypeCodec_1 = require("../codec/TypeCodec");
+const ajv = new ajv_draft_04_1.default();
+/*
+    We define additional formats for the JSON schema
+    See: https://ajv.js.org/packages/ajv-formats.html#formats
+*/
+(0, ajv_formats_1.default)(ajv);
+const isDynamicSchema = (o) => {
+    try {
+        ajv.compile(o);
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+};
+const dynamicSchemaTypeDescriptor = t.brand(DynamicType_1.dynamicObjectTypeDescriptor, (input) => isDynamicSchema(input), 'DynamicSchema');
+const dynamicSchemaTypeCodec = TypeCodec_1.TypeCodec.fromDescriptor(dynamicSchemaTypeDescriptor);
+exports.DynamicSchema = {
+    fromDynamicObject: (schemaObj) => (0, function_1.pipe)(dynamicSchemaTypeCodec.decode(schemaObj), E.mapLeft((e) => new Error(`Failed to create DynamicSchema: ${e}`))),
+    validate: (schema, value) => {
+        const validate = ajv.compile(schema);
+        if (validate(value)) {
+            return E.right(undefined);
+        }
+        return E.left(new Error(ajv.errorsText(validate.errors)));
+    },
+};

package/dist/dynamicschema/DynamicSchema.unit.test.d.ts

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

package/dist/dynamicschema/DynamicSchema.unit.test.d.ts.map

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

package/dist/dynamicschema/DynamicSchema.unit.test.js

@@ -0,0 +1,101 @@
+"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 DynamicSchema_1 = require("./DynamicSchema");
+describe('DynamicSchema', () => {
+    let validSchema;
+    let invalidSchema;
+    let value;
+    beforeEach(() => {
+        validSchema = {
+            type: 'object',
+            properties: {
+                name: {
+                    type: 'string',
+                },
+                age: {
+                    type: 'number',
+                },
+            },
+            required: ['name', 'age'],
+        };
+        invalidSchema = {
+            type: 'invalidType',
+            properties: {
+                name: {
+                    type: 'string',
+                },
+                age: {
+                    type: 'number',
+                },
+            },
+            required: ['name', 'age'],
+        };
+        value = {
+            name: 'John Doe',
+            age: 30,
+        };
+    });
+    describe('fromDynamicObject', () => {
+        it('should return a Right DynamicSchema when given a valid schema object', () => {
+            const result = DynamicSchema_1.DynamicSchema.fromDynamicObject(validSchema);
+            expect(E.isRight(result)).toBe(true);
+            if (E.isRight(result)) {
+                expect(result.right).toEqual(validSchema);
+            }
+        });
+        it('should return a Left Error when given an invalid schema object', () => {
+            const result = DynamicSchema_1.DynamicSchema.fromDynamicObject(invalidSchema);
+            expect(E.isLeft(result)).toBe(true);
+            if (E.isLeft(result)) {
+                expect(result.left).toBeInstanceOf(Error);
+                expect(result.left.message).toContain('Failed to create DynamicSchema:');
+            }
+        });
+    });
+    describe('validate', () => {
+        it('should return a Right undefined when the value matches the schema', () => {
+            const schema = DynamicSchema_1.DynamicSchema.fromDynamicObject(validSchema);
+            if (E.isRight(schema)) {
+                const result = DynamicSchema_1.DynamicSchema.validate(schema.right, value);
+                expect(E.isRight(result)).toBe(true);
+                if (E.isRight(result)) {
+                    expect(result.right).toBeUndefined();
+                }
+            }
+        });
+        it('should return a Left Error when the value does not match the schema', () => {
+            const schema = DynamicSchema_1.DynamicSchema.fromDynamicObject(validSchema);
+            if (E.isRight(schema)) {
+                const result = DynamicSchema_1.DynamicSchema.validate(schema.right, invalidSchema);
+                expect(E.isLeft(result)).toBe(true);
+                if (E.isLeft(result)) {
+                    expect(result.left).toBeInstanceOf(Error);
+                }
+            }
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/commons",
-  "version": "3.10.0",
+  "version": "3.11.0",
   "description": "Extensions to the standard/core libraries and basic features",
   "exports": {
     "./*": "./dist/*.js"
@@ -17,7 +17,10 @@
     "@types/formidable": "3.4.5",
     "@types/node": "18.11.9",
     "@types/uuid": "9.0.2",
-    "formidable": "^3.5.1",
+    "ajv": "^8.12.0",
+    "ajv-draft-04": "^1.0.0",
+    "ajv-formats": "^2.1.1",
+    "formidable": "3.5.1",
     "fp-ts": "2.12.3",
     "fs-extra": "11.1.0",
     "io-ts": "2.2.20",