@theshelf/validation-driver-zod 0.4.5 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/Zod.d.ts +1 -1
  2. package/dist/Zod.js +85 -73
  3. package/package.json +5 -4
package/dist/Zod.d.ts CHANGED
@@ -4,5 +4,5 @@ export default class Zod implements Driver {
4
4
  #private;
5
5
  constructor();
6
6
  get name(): string;
7
- validate(data: unknown, schema: ValidationSchema): ValidationResult;
7
+ validate<T>(data: T, schema: ValidationSchema<T>): ValidationResult;
8
8
  }
package/dist/Zod.js CHANGED
@@ -1,20 +1,23 @@
1
1
  import { z } from 'zod';
2
- import { ValidationResult, FieldTypes, MAX_EMAIL_LENGTH, MAX_URL_LENGTH, UnknownValidator } from '@theshelf/validation';
2
+ import { ValidationResult, FieldTypes, MAX_EMAIL_LENGTH, MAX_URL_LENGTH } from '@theshelf/validation';
3
3
  // Zod is so type heavy that we've chosen for inferred types to be used.
4
4
  // This is a trade-off between readability and verbosity.
5
5
  export default class Zod {
6
- #validations = new Map();
6
+ #validators = new Map();
7
7
  constructor() {
8
- this.#validations.set(FieldTypes.STRING, (value) => this.#validateString(value));
9
- this.#validations.set(FieldTypes.NUMBER, (value) => this.#validateNumber(value));
10
- this.#validations.set(FieldTypes.BOOLEAN, (value) => this.#validateBoolean(value));
11
- this.#validations.set(FieldTypes.DATE, (value) => this.#validateDate(value));
12
- this.#validations.set(FieldTypes.DATETIME, (value) => this.#validateDateTime(value));
13
- this.#validations.set(FieldTypes.UUID, (value) => this.#validateUuid(value));
14
- this.#validations.set(FieldTypes.EMAIL, (value) => this.#validateEmail(value));
15
- this.#validations.set(FieldTypes.ARRAY, (value) => this.#validateArray(value));
16
- this.#validations.set(FieldTypes.URL, (value) => this.#validateUrl(value));
17
- this.#validations.set(FieldTypes.ENUM, (value) => this.#validateEnum(value));
8
+ this.#validators.set(FieldTypes.STRING, (constraints, required) => this.#validateString(constraints, required));
9
+ this.#validators.set(FieldTypes.NUMBER, (constraints, required) => this.#validateNumber(constraints, required));
10
+ this.#validators.set(FieldTypes.BOOLEAN, (constraints, required) => this.#validateBoolean(constraints, required));
11
+ this.#validators.set(FieldTypes.DATE, (constraints, required) => this.#validateDate(constraints, required));
12
+ this.#validators.set(FieldTypes.DATE_STRING, (constraints, required) => this.#validateDateString(constraints, required));
13
+ this.#validators.set(FieldTypes.DATE_TIME_STRING, (constraints, required) => this.#validateDateTimeString(constraints, required));
14
+ this.#validators.set(FieldTypes.TIME_STRING, (constraints, required) => this.#validateTimeString(constraints, required));
15
+ this.#validators.set(FieldTypes.UUID, (constraints, required) => this.#validateUuid(constraints, required));
16
+ this.#validators.set(FieldTypes.EMAIL, (constraints, required) => this.#validateEmail(constraints, required));
17
+ this.#validators.set(FieldTypes.ARRAY, (constraints, required) => this.#validateArray(constraints, required));
18
+ this.#validators.set(FieldTypes.URL, (constraints, required) => this.#validateUrl(constraints, required));
19
+ this.#validators.set(FieldTypes.URL_STRING, (constraints, required) => this.#validateUrlString(constraints, required));
20
+ this.#validators.set(FieldTypes.ENUM, (constraints, required) => this.#validateEnum(constraints, required));
18
21
  }
19
22
  get name() { return Zod.name; }
20
23
  validate(data, schema) {
@@ -30,89 +33,98 @@ export default class Zod {
30
33
  #buildValidator(schema) {
31
34
  return Object.entries(schema)
32
35
  .reduce((partialSchema, [key, value]) => {
33
- const fieldValidation = this.#getValidation(value);
34
- return partialSchema.extend({ [key]: fieldValidation });
36
+ const fieldValidator = this.#getFieldValidator(value);
37
+ return partialSchema.extend({ [key]: fieldValidator });
35
38
  }, z.object({})).strict();
36
39
  }
37
- #getValidation(schema) {
38
- for (const [key, validation] of Object.entries(schema)) {
39
- if (key === 'message')
40
+ #getFieldValidator(validation) {
41
+ const required = validation.required === true;
42
+ for (const key of Object.keys(validation)) {
43
+ const type = key.toLowerCase();
44
+ const validator = this.#validators.get(type);
45
+ if (validator === undefined)
40
46
  continue;
41
- const validator = this.#validations.get(key.toLowerCase());
42
- if (validator === undefined) {
43
- throw new UnknownValidator(key);
44
- }
45
- return validator(validation);
47
+ const constraints = validation[key];
48
+ return validator(constraints, required);
46
49
  }
47
50
  return z.never();
48
51
  }
49
- #validateString(value) {
52
+ #validateString(constraints, required) {
50
53
  let validation = z.string();
51
- if (value.minLength !== undefined)
52
- validation = validation.min(value.minLength);
53
- if (value.maxLength !== undefined)
54
- validation = validation.max(value.maxLength);
55
- if (value.pattern !== undefined)
56
- validation = validation.regex(new RegExp(value.pattern));
57
- return this.#checkRequired(value, validation);
58
- }
59
- #validateNumber(value) {
54
+ if (constraints.minLength !== undefined)
55
+ validation = validation.min(constraints.minLength);
56
+ if (constraints.maxLength !== undefined)
57
+ validation = validation.max(constraints.maxLength);
58
+ if (constraints.pattern !== undefined)
59
+ validation = validation.regex(new RegExp(constraints.pattern));
60
+ return this.#checkRequired(validation, required);
61
+ }
62
+ #validateNumber(constraints, required) {
60
63
  let validation = z.number();
61
- if (value.minValue !== undefined)
62
- validation = validation.min(value.minValue);
63
- if (value.maxValue !== undefined)
64
- validation = validation.max(value.maxValue);
65
- return this.#checkRequired(value, validation);
64
+ if (constraints.minValue !== undefined)
65
+ validation = validation.min(constraints.minValue);
66
+ if (constraints.maxValue !== undefined)
67
+ validation = validation.max(constraints.maxValue);
68
+ return this.#checkRequired(validation, required);
66
69
  }
67
- #validateBoolean(value) {
70
+ #validateBoolean(constraints, required) {
68
71
  const validation = z.boolean();
69
- return this.#checkRequired(value, validation);
72
+ return this.#checkRequired(validation, required);
73
+ }
74
+ #validateDate(constraints, required) {
75
+ const validation = z.date();
76
+ return this.#checkRequired(validation, required);
70
77
  }
71
- #validateDate(value) {
78
+ #validateDateString(constraints, required) {
72
79
  const validation = z.iso.date();
73
- return this.#checkRequired(value, validation);
80
+ return this.#checkRequired(validation, required);
74
81
  }
75
- #validateDateTime(value) {
82
+ #validateDateTimeString(constraints, required) {
76
83
  const validation = z.iso.datetime();
77
- return this.#checkRequired(value, validation);
84
+ return this.#checkRequired(validation, required);
85
+ }
86
+ #validateTimeString(constraints, required) {
87
+ const validation = z.iso.time();
88
+ return this.#checkRequired(validation, required);
78
89
  }
79
- #validateUuid(value) {
80
- const validation = z.uuid();
81
- return this.#checkRequired(value, validation);
90
+ #validateUuid(constraints, required) {
91
+ const validation = z.uuid(); // String or UUID object?
92
+ return this.#checkRequired(validation, required);
82
93
  }
83
- #validateEmail(value) {
94
+ #validateEmail(constraints, required) {
84
95
  const validation = z.email().max(MAX_EMAIL_LENGTH);
85
- return this.#checkRequired(value, validation);
86
- }
87
- #validateArray(value) {
88
- let validation = value.validations === undefined
89
- ? z.array(z.unknown())
90
- : z.array(this.#getValidation(value.validations));
91
- if (value.minLength !== undefined)
92
- validation = validation.min(value.minLength);
93
- if (value.maxLength !== undefined)
94
- validation = validation.max(value.maxLength);
95
- return this.#checkRequired(value, validation);
96
- }
97
- #validateUrl(value) {
96
+ return this.#checkRequired(validation, required);
97
+ }
98
+ #validateArray(constraints, required) {
99
+ const itemValidator = this.#getFieldValidator(constraints);
100
+ let validation = z.array(itemValidator);
101
+ if (constraints.minLength !== undefined)
102
+ validation = validation.min(constraints.minLength);
103
+ if (constraints.maxLength !== undefined)
104
+ validation = validation.max(constraints.maxLength);
105
+ return this.#checkRequired(validation, required);
106
+ }
107
+ #validateUrl(constraints, required) {
108
+ const validation = z.instanceof(URL);
109
+ return this.#checkRequired(validation, required);
110
+ }
111
+ #validateUrlString(constraints, required) {
98
112
  let validation = z.url().max(MAX_URL_LENGTH);
99
- if (value.protocols !== undefined) {
100
- const escapedProtocols = value.protocols.map(p => p.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'));
113
+ if (constraints.protocols !== undefined) {
114
+ const escapedProtocols = constraints.protocols.map((p) => p.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'));
101
115
  const expression = escapedProtocols.join('|');
102
116
  validation = validation.regex(new RegExp(`^(${expression}):.*`));
103
117
  }
104
- return this.#checkRequired(value, validation);
118
+ return this.#checkRequired(validation, required);
105
119
  }
106
- #validateEnum(value) {
107
- const validation = value.values === undefined
120
+ #validateEnum(constraints, required) {
121
+ const validation = constraints.values === undefined
108
122
  ? z.enum([])
109
- : z.enum(value.values);
110
- return this.#checkRequired(value, validation);
123
+ : z.enum(constraints.values);
124
+ return this.#checkRequired(validation, required);
111
125
  }
112
- #checkRequired(value, validation) {
113
- return value.required
114
- ? validation
115
- : validation.optional();
126
+ #checkRequired(validation, required) {
127
+ return required ? validation : validation.optional();
116
128
  }
117
129
  #getMessages(issues, schema) {
118
130
  const messages = new Map();
@@ -136,7 +148,7 @@ export default class Zod {
136
148
  }
137
149
  }
138
150
  #getMessageByField(path, schema) {
139
- const field = schema[path];
140
- return field?.message ?? 'Invalid field';
151
+ const validation = schema[path];
152
+ return validation?.message ?? 'Invalid field';
141
153
  }
142
154
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@theshelf/validation-driver-zod",
3
3
  "private": false,
4
- "version": "0.4.5",
4
+ "version": "0.6.0",
5
5
  "type": "module",
6
6
  "repository": {
7
7
  "url": "git+https://github.com/MaskingTechnology/theshelf.git"
@@ -14,7 +14,8 @@
14
14
  "test-coverage": "vitest run --coverage",
15
15
  "lint": "eslint",
16
16
  "review": "npm run build && npm run lint && npm run test",
17
- "prepublishOnly": "npm run clean && npm run build"
17
+ "prepublishOnly": "npm run clean && npm run build",
18
+ "link": "npm link"
18
19
  },
19
20
  "files": [
20
21
  "README.md",
@@ -23,9 +24,9 @@
23
24
  "types": "./dist/index.d.ts",
24
25
  "exports": "./dist/index.js",
25
26
  "dependencies": {
26
- "zod": "4.4.3"
27
+ "zod": "^4.5.4"
27
28
  },
28
29
  "peerDependencies": {
29
- "@theshelf/validation": "^0.4.3"
30
+ "@theshelf/validation": "^0.6.0"
30
31
  }
31
32
  }