@theshelf/validation 0.1.0 → 0.2.1

package/README.md

@@ -9,34 +9,37 @@ The validation package provides a universal interaction layer with an actual dat
 npm install @theshelf/validation
 ```
 
-## Implementations
+## Drivers
 
-Currently, there is only one implementation:
+Currently, there is only one driver available:
 
-* **Zod** - implementation for the currently popular Zod library.
-
-## Configuration
-
-The used implementation needs to be configured in the `.env` file.
-
-```env
-VALIDATION_IMPLEMENTATION="zod"
-```
+* **Zod** - driver for the currently popular Zod library.
 
 ## How to use
 
-An instance of the configured validator implementation can be imported for performing validation operations.
+The instance of the validator needs to be imported and one of the drivers must be set.
 
 ```ts
-import validator from '@theshelf/validation';
+import validator, { Zod as SelectedDriver } from '@theshelf/validation';
+
+// Set the driver before performing any operation (the Zod driver is used by default)
+validator.driver = new SelectedDriver(/* configuration */);
 
 // Perform operations with the validator instance
 ```
 
+### Configuration
+
+The validator instance does not have any configuration options.
+
+#### Zod driver
+
+No configuration options.
+
 ### Operations
 
 ```ts
-import validator, { ValidationSchema, ValidationResult } from '@theshelf/validation';
+import { ValidationSchema, ValidationResult } from '@theshelf/validation';
 
 const data = {
     name: 'John Doe',

package/dist/Validator.d.ts

@@ -0,0 +1,8 @@
+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 {
+    #private;
+    constructor(driver: Driver);
+    validate(data: unknown, schema: ValidationSchema): ValidationResult;
+}

package/dist/Validator.js

@@ -0,0 +1,9 @@
+export default class Validator {
+    #driver;
+    constructor(driver) {
+        this.#driver = driver;
+    }
+    validate(data, schema) {
+        return this.#driver.validate(data, schema);
+    }
+}

package/dist/definitions/constants.d.ts

@@ -1,14 +1,14 @@
 declare const FieldTypes: {
-    STRING: string;
-    NUMBER: string;
-    BOOLEAN: string;
-    DATE: string;
-    DATETIME: string;
-    UUID: string;
-    EMAIL: string;
-    ARRAY: string;
-    URL: string;
-    ENUM: string;
+    readonly STRING: "string";
+    readonly NUMBER: "number";
+    readonly BOOLEAN: "boolean";
+    readonly DATE: "date";
+    readonly DATETIME: "datetime";
+    readonly UUID: "uuid";
+    readonly EMAIL: "email";
+    readonly ARRAY: "array";
+    readonly URL: "url";
+    readonly ENUM: "enum";
 };
 declare const MAX_EMAIL_LENGTH = 320;
 declare const MAX_URL_LENGTH = 2083;

package/dist/definitions/constants.js

@@ -10,7 +10,6 @@ const FieldTypes = {
     URL: 'url',
     ENUM: 'enum'
 };
-Object.freeze(FieldTypes);
 const MAX_EMAIL_LENGTH = 320;
 const MAX_URL_LENGTH = 2083;
 export { FieldTypes, MAX_EMAIL_LENGTH, MAX_URL_LENGTH };

package/dist/definitions/interfaces.d.ts

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

package/dist/drivers/Zod.d.ts

@@ -0,0 +1,8 @@
+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/{implementations/zod → drivers}/Zod.js

@@ -1,7 +1,7 @@
 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';
+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 {
@@ -39,7 +39,7 @@ export default class Zod {
         for (const [key, validation] of Object.entries(schema)) {
             if (key === 'message')
                 continue;
-            const validator = this.#validations.get(key.toLocaleLowerCase());
+            const validator = this.#validations.get(key.toLowerCase());
             if (validator === undefined) {
                 throw new UnknownValidator(key);
             }

package/dist/errors/ValidationError.js

@@ -1,5 +1,9 @@
 export default class ValidationError extends Error {
     constructor(message) {
         super(message ?? 'Validation error');
+        this.name = this.constructor.name;
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
     }
 }

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './definitions/constants.js';
-export * from './definitions/types.js';
-export { default as UnknownImplementation } from './errors/UnknownImplementation.js';
+export type * from './definitions/interfaces.js';
+export type * from './definitions/types.js';
 export { default as UnknownValidator } from './errors/UnknownValidator.js';
 export { default as ValidationError } from './errors/ValidationError.js';
-export { default } from './implementation.js';
+export { default as ZodDriver } from './drivers/Zod.js';
+export { default } from './Validator.js';

package/dist/index.js

@@ -1,6 +1,5 @@
 export * from './definitions/constants.js';
-export * from './definitions/types.js';
-export { default as UnknownImplementation } from './errors/UnknownImplementation.js';
 export { default as UnknownValidator } from './errors/UnknownValidator.js';
 export { default as ValidationError } from './errors/ValidationError.js';
-export { default } from './implementation.js';
+export { default as ZodDriver } from './drivers/Zod.js';
+export { default } from './Validator.js';

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@theshelf/validation",
   "private": false,
-  "version": "0.1.0",
+  "version": "0.2.1",
   "type": "module",
   "repository": {
-    "url": "https://github.com/MaskingTechnology/theshelf"
+    "url": "git+https://github.com/MaskingTechnology/theshelf.git"
   },
   "scripts": {
     "build": "tsc",

package/dist/errors/UnknownImplementation.d.ts

@@ -1,4 +0,0 @@
-import ValidationError from './ValidationError.js';
-export default class UnknownImplementation extends ValidationError {
-    constructor(name: string);
-}

package/dist/errors/UnknownImplementation.js

@@ -1,6 +0,0 @@
-import ValidationError from './ValidationError.js';
-export default class UnknownImplementation extends ValidationError {
-    constructor(name) {
-        super(`Unknown validation implementation: ${name}`);
-    }
-}

package/dist/implementation.d.ts

@@ -1,3 +0,0 @@
-import type { Validator } from './definitions/interfaces.js';
-declare const _default: Validator;
-export default _default;

package/dist/implementation.js

@@ -1,12 +0,0 @@
-import UnknownImplementation from './errors/UnknownImplementation.js';
-import createZod from './implementations/zod/create.js';
-const implementations = new Map([
-    ['zod', createZod]
-]);
-const DEFAULT_VALIDATION_IMPLEMENTATION = 'zod';
-const implementationName = process.env.VALIDATION_IMPLEMENTATION ?? DEFAULT_VALIDATION_IMPLEMENTATION;
-const creator = implementations.get(implementationName.toLowerCase());
-if (creator === undefined) {
-    throw new UnknownImplementation(implementationName);
-}
-export default creator();

package/dist/implementations/zod/Zod.d.ts

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

package/dist/implementations/zod/create.d.ts

@@ -1,2 +0,0 @@
-import Zod from './Zod.js';
-export default function create(): Zod;

package/dist/implementations/zod/create.js

@@ -1,4 +0,0 @@
-import Zod from './Zod.js';
-export default function create() {
-    return new Zod();
-}