@theshelf/validation 0.3.2 → 0.4.0

package/README.md

@@ -1,7 +1,7 @@
 
-# Validation | The Shelf
+# Validation core | The Shelf
 
-The validation package provides a universal interaction layer with an actual data validation solution.
+This package contains the definition of the validation operations. It uses a interchangeable driver system for performing the actual operations.
 
 ## Installation
 
@@ -9,34 +9,20 @@ The validation package provides a universal interaction layer with an actual dat
 npm install @theshelf/validation
 ```
 
-## Drivers
-
-Currently, there is only one driver available:
-
-* **Zod** - driver for the currently popular Zod library.
-
 ## How to use
 
-The instance of the validator needs to be imported and one of the drivers must be set.
+The basic set up looks like this.
 
 ```ts
-import validator, { Zod as SelectedDriver } from '@theshelf/validation';
+import Validator from '@theshelf/validation';
+import driver from '/path/to/driver';
 
-// Set the driver before performing any operation (the Zod driver is used by default)
-validator.driver = new SelectedDriver(/* configuration */);
+const validator = new Validator(driver);
 
 // Perform operations with the validator instance
 ```
 
-### Configuration
-
-The validator instance does not have any configuration options.
-
-#### Zod driver
-
-No configuration options.
-
-### Operations
+## Operations
 
 ```ts
 import { ValidationSchema, ValidationResult } from '@theshelf/validation';
@@ -56,9 +42,9 @@ const schema: ValidationSchema = {
 const result: ValidationResult = validator.validate(data, schema);
 ```
 
-### Validation scheme options
+## Validation schema
 
-A basic validation scheme has the following structure.
+A basic validation schema has the following structure.
 
 ```ts
 const schema: ValidationSchema = {
@@ -97,7 +83,7 @@ The following types are supported:
 * **URL**
   * `required: boolean`
 
-### Validation result structure
+## Validation result
 
 The validation result has two fields:
 

package/dist/Validator.d.ts

@@ -1,8 +1,9 @@
+import type Logger from '@theshelf/logging';
 import type { Driver } from './definitions/interfaces.js';
 import type { ValidationSchema } from './definitions/types.js';
 import type ValidationResult from './definitions/ValidationResult.js';
-export default class Validator implements Driver {
+export default class Validator {
     #private;
-    constructor(driver: Driver);
+    constructor(driver: Driver, logger?: Logger);
     validate(data: unknown, schema: ValidationSchema): ValidationResult;
 }

package/dist/Validator.js

@@ -1,9 +1,20 @@
 export default class Validator {
     #driver;
-    constructor(driver) {
+    #logger;
+    #logPrefix;
+    constructor(driver, logger) {
         this.#driver = driver;
+        this.#logger = logger?.for(Validator.name);
+        this.#logPrefix = `${this.#driver.name} ->`;
     }
     validate(data, schema) {
-        return this.#driver.validate(data, schema);
+        this.#logger?.debug(this.#logPrefix, 'Validating schema', schema);
+        try {
+            return this.#driver.validate(data, schema);
+        }
+        catch (error) {
+            this.#logger?.error(this.#logPrefix, 'Validating schema', schema, 'failed with error', error);
+            throw error;
+        }
     }
 }

package/dist/definitions/interfaces.d.ts

@@ -1,5 +1,6 @@
 import type ValidationResult from './ValidationResult.js';
 import type { ValidationSchema } from './types.js';
 export interface Driver {
+    get name(): string;
     validate(data: unknown, schema: ValidationSchema): ValidationResult;
 }

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-export * from './definitions/constants.js';
-export type * from './definitions/interfaces.js';
-export type * from './definitions/types.js';
+export { FieldTypes, MAX_EMAIL_LENGTH, MAX_URL_LENGTH } from './definitions/constants.js';
+export type { Driver } from './definitions/interfaces.js';
+export type { ValidationType, ValidationTypes, StringProperties, NumberProperties, ArrayProperties, BooleanProperties, DateProperties, DateTimeProperties, UUIDProperties, EmailProperties, URLProperties, EnumProperties, Message, Validation, ValidationSchema } from './definitions/types.js';
+export { default as ValidationResult } from './definitions/ValidationResult.js';
 export { default as UnknownValidator } from './errors/UnknownValidator.js';
 export { default as ValidationError } from './errors/ValidationError.js';
-export { default as ZodDriver } from './drivers/Zod.js';
 export { default } from './Validator.js';

package/dist/index.js

@@ -1,5 +1,5 @@
-export * from './definitions/constants.js';
+export { FieldTypes, MAX_EMAIL_LENGTH, MAX_URL_LENGTH } from './definitions/constants.js';
+export { default as ValidationResult } from './definitions/ValidationResult.js';
 export { default as UnknownValidator } from './errors/UnknownValidator.js';
 export { default as ValidationError } from './errors/ValidationError.js';
-export { default as ZodDriver } from './drivers/Zod.js';
 export { default } from './Validator.js';

package/package.json

@@ -1,27 +1,26 @@
 {
   "name": "@theshelf/validation",
   "private": false,
-  "version": "0.3.2",
+  "version": "0.4.0",
   "type": "module",
   "repository": {
     "url": "git+https://github.com/MaskingTechnology/theshelf.git"
   },
+  "license": "MIT",
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist",
-    "test": "vitest run",
-    "test-coverage": "vitest run --coverage",
     "lint": "eslint",
-    "review": "npm run build && npm run lint && npm run test",
+    "review": "npm run build && npm run lint",
     "prepublishOnly": "npm run clean && npm run build"
   },
   "files": [
     "README.md",
     "dist"
   ],
-  "types": "dist/index.d.ts",
+  "types": "./dist/index.d.ts",
   "exports": "./dist/index.js",
-  "dependencies": {
-    "zod": "4.1.12"
+  "peerDependencies": {
+    "@theshelf/logging": "^0.4.0"
   }
 }

package/dist/drivers/Zod.d.ts

@@ -1,8 +0,0 @@
-import ValidationResult from '../definitions/ValidationResult.js';
-import type { Driver } from '../definitions/interfaces.js';
-import type { ValidationSchema } from '../definitions/types.js';
-export default class Zod implements Driver {
-    #private;
-    constructor();
-    validate(data: unknown, schema: ValidationSchema): ValidationResult;
-}

package/dist/drivers/Zod.js

@@ -1,140 +0,0 @@
-import { z } from 'zod';
-import ValidationResult from '../definitions/ValidationResult.js';
-import { FieldTypes, MAX_EMAIL_LENGTH, MAX_URL_LENGTH } from '../definitions/constants.js';
-import UnknownValidator from '../errors/UnknownValidator.js';
-// Zod is so type heavy that we've chosen for inferred types to be used.
-// This is a trade-off between readability and verbosity.
-export default class Zod {
-    #validations = new Map();
-    constructor() {
-        this.#validations.set(FieldTypes.STRING, (value) => this.#validateString(value));
-        this.#validations.set(FieldTypes.NUMBER, (value) => this.#validateNumber(value));
-        this.#validations.set(FieldTypes.BOOLEAN, (value) => this.#validateBoolean(value));
-        this.#validations.set(FieldTypes.DATE, (value) => this.#validateDate(value));
-        this.#validations.set(FieldTypes.DATETIME, (value) => this.#validateDateTime(value));
-        this.#validations.set(FieldTypes.UUID, (value) => this.#validateUuid(value));
-        this.#validations.set(FieldTypes.EMAIL, (value) => this.#validateEmail(value));
-        this.#validations.set(FieldTypes.ARRAY, (value) => this.#validateArray(value));
-        this.#validations.set(FieldTypes.URL, (value) => this.#validateUrl(value));
-        this.#validations.set(FieldTypes.ENUM, (value) => this.#validateEnum(value));
-    }
-    validate(data, schema) {
-        const validator = this.#buildValidator(schema);
-        const result = validator.safeParse(data);
-        if (result.success === false) {
-            const issues = result.error.issues;
-            const messages = this.#getMessages(issues, schema);
-            return new ValidationResult(true, messages);
-        }
-        return new ValidationResult(false);
-    }
-    #buildValidator(schema) {
-        return Object.entries(schema)
-            .reduce((partialSchema, [key, value]) => {
-            const fieldValidation = this.#getValidation(value);
-            return partialSchema.extend({ [key]: fieldValidation });
-        }, z.object({})).strict();
-    }
-    #getValidation(schema) {
-        for (const [key, validation] of Object.entries(schema)) {
-            if (key === 'message')
-                continue;
-            const validator = this.#validations.get(key.toLowerCase());
-            if (validator === undefined) {
-                throw new UnknownValidator(key);
-            }
-            return validator(validation);
-        }
-        return z.never();
-    }
-    #validateString(value) {
-        let validation = z.string();
-        if (value.minLength !== undefined)
-            validation = validation.min(value.minLength);
-        if (value.maxLength !== undefined)
-            validation = validation.max(value.maxLength);
-        if (value.pattern !== undefined)
-            validation = validation.regex(new RegExp(value.pattern));
-        return this.#checkRequired(value, validation);
-    }
-    #validateNumber(value) {
-        let validation = z.number();
-        if (value.minValue !== undefined)
-            validation = validation.min(value.minValue);
-        if (value.maxValue !== undefined)
-            validation = validation.max(value.maxValue);
-        return this.#checkRequired(value, validation);
-    }
-    #validateBoolean(value) {
-        const validation = z.boolean();
-        return this.#checkRequired(value, validation);
-    }
-    #validateDate(value) {
-        const validation = z.iso.date();
-        return this.#checkRequired(value, validation);
-    }
-    #validateDateTime(value) {
-        const validation = z.iso.datetime();
-        return this.#checkRequired(value, validation);
-    }
-    #validateUuid(value) {
-        const validation = z.uuid();
-        return this.#checkRequired(value, validation);
-    }
-    #validateEmail(value) {
-        const validation = z.email().max(MAX_EMAIL_LENGTH);
-        return this.#checkRequired(value, validation);
-    }
-    #validateArray(value) {
-        let validation = value.validations === undefined
-            ? z.array(z.unknown())
-            : z.array(this.#getValidation(value.validations));
-        if (value.minLength !== undefined)
-            validation = validation.min(value.minLength);
-        if (value.maxLength !== undefined)
-            validation = validation.max(value.maxLength);
-        return this.#checkRequired(value, validation);
-    }
-    #validateUrl(value) {
-        let validation = z.url().max(MAX_URL_LENGTH);
-        if (value.protocols !== undefined) {
-            const expression = value.protocols.join('|');
-            validation = validation.regex(new RegExp(`^(${expression}):.*`));
-        }
-        return this.#checkRequired(value, validation);
-    }
-    #validateEnum(value) {
-        const validation = value.values === undefined
-            ? z.enum([])
-            : z.enum(value.values);
-        return this.#checkRequired(value, validation);
-    }
-    #checkRequired(value, validation) {
-        return value.required
-            ? validation
-            : validation.optional();
-    }
-    #getMessages(issues, scheme) {
-        const messages = new Map();
-        for (const issue of issues) {
-            if (issue.code === 'unrecognized_keys') {
-                this.#mapUnrecognizedKeys(issue, scheme, messages);
-                continue;
-            }
-            const field = String(issue.path[0]);
-            const message = this.#getMessageByField(field, scheme);
-            messages.set(field, message);
-        }
-        return messages;
-    }
-    #mapUnrecognizedKeys(issue, scheme, messages) {
-        for (const key of issue.keys) {
-            const message = this.#getMessageByField(key, scheme);
-            messages.set(key, message);
-        }
-    }
-    #getMessageByField(path, scheme) {
-        const field = scheme[path];
-        return field?.message ?? 'Invalid field';
-    }
-}