bguard 0.0.5 → 0.0.7

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 (217) hide show
  1. package/lib/InferType.js +1 -19
  2. package/lib/InferType.js.map +1 -1
  3. package/lib/asserts/array/index.js +7 -86
  4. package/lib/asserts/array/index.js.map +1 -1
  5. package/lib/asserts/array/index.mjs +7 -59
  6. package/lib/asserts/array/index.mjs.map +1 -1
  7. package/lib/asserts/boolean/index.js +7 -114
  8. package/lib/asserts/boolean/index.js.map +1 -1
  9. package/lib/asserts/boolean/index.mjs +7 -87
  10. package/lib/asserts/boolean/index.mjs.map +1 -1
  11. package/lib/asserts/common/equalTo.js +4 -50
  12. package/lib/asserts/common/equalTo.js.map +1 -1
  13. package/lib/asserts/common/equalTo.mjs +4 -23
  14. package/lib/asserts/common/equalTo.mjs.map +1 -1
  15. package/lib/asserts/common/index.js +6 -68
  16. package/lib/asserts/common/index.js.map +1 -1
  17. package/lib/asserts/common/index.mjs +6 -41
  18. package/lib/asserts/common/index.mjs.map +1 -1
  19. package/lib/asserts/number/index.js +8 -108
  20. package/lib/asserts/number/index.js.map +1 -1
  21. package/lib/asserts/number/index.mjs +8 -81
  22. package/lib/asserts/number/index.mjs.map +1 -1
  23. package/lib/asserts/number/max.js +6 -47
  24. package/lib/asserts/number/max.js.map +1 -1
  25. package/lib/asserts/number/max.mjs +3 -17
  26. package/lib/asserts/number/max.mjs.map +1 -1
  27. package/lib/asserts/number/maxExcluded.js +6 -47
  28. package/lib/asserts/number/maxExcluded.js.map +1 -1
  29. package/lib/asserts/number/maxExcluded.mjs +3 -17
  30. package/lib/asserts/number/maxExcluded.mjs.map +1 -1
  31. package/lib/asserts/number/min.js +6 -47
  32. package/lib/asserts/number/min.js.map +1 -1
  33. package/lib/asserts/number/min.mjs +3 -17
  34. package/lib/asserts/number/min.mjs.map +1 -1
  35. package/lib/asserts/number/minExcluded.js +6 -47
  36. package/lib/asserts/number/minExcluded.js.map +1 -1
  37. package/lib/asserts/number/minExcluded.mjs +3 -17
  38. package/lib/asserts/number/minExcluded.mjs.map +1 -1
  39. package/lib/asserts/number/negative.js +6 -47
  40. package/lib/asserts/number/negative.js.map +1 -1
  41. package/lib/asserts/number/negative.mjs +3 -17
  42. package/lib/asserts/number/negative.mjs.map +1 -1
  43. package/lib/asserts/number/positive.js +6 -47
  44. package/lib/asserts/number/positive.js.map +1 -1
  45. package/lib/asserts/number/positive.mjs +3 -17
  46. package/lib/asserts/number/positive.mjs.map +1 -1
  47. package/lib/asserts/object/index.js +7 -90
  48. package/lib/asserts/object/index.js.map +1 -1
  49. package/lib/asserts/object/index.mjs +7 -63
  50. package/lib/asserts/object/index.mjs.map +1 -1
  51. package/lib/asserts/string/email.js +6 -47
  52. package/lib/asserts/string/email.js.map +1 -1
  53. package/lib/asserts/string/email.mjs +3 -17
  54. package/lib/asserts/string/email.mjs.map +1 -1
  55. package/lib/asserts/string/index.js +8 -108
  56. package/lib/asserts/string/index.js.map +1 -1
  57. package/lib/asserts/string/index.mjs +8 -81
  58. package/lib/asserts/string/index.mjs.map +1 -1
  59. package/lib/asserts/string/maxLength.js +6 -47
  60. package/lib/asserts/string/maxLength.js.map +1 -1
  61. package/lib/asserts/string/maxLength.mjs +3 -17
  62. package/lib/asserts/string/maxLength.mjs.map +1 -1
  63. package/lib/asserts/string/minLength.js +6 -47
  64. package/lib/asserts/string/minLength.js.map +1 -1
  65. package/lib/asserts/string/minLength.mjs +3 -17
  66. package/lib/asserts/string/minLength.mjs.map +1 -1
  67. package/lib/asserts/string/regExp.js +6 -47
  68. package/lib/asserts/string/regExp.js.map +1 -1
  69. package/lib/asserts/string/regExp.mjs +3 -17
  70. package/lib/asserts/string/regExp.mjs.map +1 -1
  71. package/lib/chunk-2AP4OQMT.js +26 -0
  72. package/lib/chunk-2AP4OQMT.js.map +1 -0
  73. package/lib/chunk-32IQXZRK.mjs +13 -0
  74. package/lib/chunk-32IQXZRK.mjs.map +1 -0
  75. package/lib/chunk-3FEJUC3K.mjs +13 -0
  76. package/lib/chunk-3FEJUC3K.mjs.map +1 -0
  77. package/lib/chunk-5NCJN6D2.js +70 -0
  78. package/lib/chunk-5NCJN6D2.js.map +1 -0
  79. package/lib/chunk-5ZMICHV3.js +21 -0
  80. package/lib/chunk-5ZMICHV3.js.map +1 -0
  81. package/lib/chunk-63IQFNFO.mjs +27 -0
  82. package/lib/chunk-63IQFNFO.mjs.map +1 -0
  83. package/lib/chunk-A2SAWKJA.mjs +13 -0
  84. package/lib/chunk-A2SAWKJA.mjs.map +1 -0
  85. package/lib/chunk-A3UTB4RE.mjs +28 -0
  86. package/lib/chunk-A3UTB4RE.mjs.map +1 -0
  87. package/lib/chunk-A7I2JEQO.js +13 -0
  88. package/lib/chunk-A7I2JEQO.js.map +1 -0
  89. package/lib/chunk-AJ4WV5DG.mjs +13 -0
  90. package/lib/chunk-AJ4WV5DG.mjs.map +1 -0
  91. package/lib/chunk-APTTIN2L.js +42 -0
  92. package/lib/chunk-APTTIN2L.js.map +1 -0
  93. package/lib/chunk-AXOP6HPJ.js +14 -0
  94. package/lib/chunk-AXOP6HPJ.js.map +1 -0
  95. package/lib/chunk-BGMR7A6X.mjs +13 -0
  96. package/lib/chunk-BGMR7A6X.mjs.map +1 -0
  97. package/lib/chunk-FCFO5J5Y.mjs +14 -0
  98. package/lib/chunk-FCFO5J5Y.mjs.map +1 -0
  99. package/lib/chunk-GEZME6V2.mjs +39 -0
  100. package/lib/chunk-GEZME6V2.mjs.map +1 -0
  101. package/lib/chunk-GNBSKTFV.js +27 -0
  102. package/lib/chunk-GNBSKTFV.js.map +1 -0
  103. package/lib/chunk-IQ3QYABE.js +32 -0
  104. package/lib/chunk-IQ3QYABE.js.map +1 -0
  105. package/lib/chunk-K2S3FS5K.js +13 -0
  106. package/lib/chunk-K2S3FS5K.js.map +1 -0
  107. package/lib/chunk-KCBOOOTF.mjs +13 -0
  108. package/lib/chunk-KCBOOOTF.mjs.map +1 -0
  109. package/lib/chunk-L6A7NXUJ.js +13 -0
  110. package/lib/chunk-L6A7NXUJ.js.map +1 -0
  111. package/lib/chunk-L7HUXYFV.mjs +42 -0
  112. package/lib/chunk-L7HUXYFV.mjs.map +1 -0
  113. package/lib/chunk-LHTJHMKJ.mjs +27 -0
  114. package/lib/chunk-LHTJHMKJ.mjs.map +1 -0
  115. package/lib/chunk-NOADI6PO.mjs +21 -0
  116. package/lib/chunk-NOADI6PO.mjs.map +1 -0
  117. package/lib/chunk-NWY33MFU.js +13 -0
  118. package/lib/chunk-NWY33MFU.js.map +1 -0
  119. package/lib/chunk-P3Y6IWFA.mjs +70 -0
  120. package/lib/chunk-P3Y6IWFA.mjs.map +1 -0
  121. package/lib/chunk-PDVXBE27.js +27 -0
  122. package/lib/chunk-PDVXBE27.js.map +1 -0
  123. package/lib/chunk-PJP63SJT.js +13 -0
  124. package/lib/chunk-PJP63SJT.js.map +1 -0
  125. package/lib/chunk-QJOXKH7A.mjs +26 -0
  126. package/lib/chunk-QJOXKH7A.mjs.map +1 -0
  127. package/lib/chunk-QKGQ4XZC.js +13 -0
  128. package/lib/chunk-QKGQ4XZC.js.map +1 -0
  129. package/lib/chunk-QYLH5ZAC.mjs +32 -0
  130. package/lib/chunk-QYLH5ZAC.mjs.map +1 -0
  131. package/lib/chunk-VPFIIM2X.js +39 -0
  132. package/lib/chunk-VPFIIM2X.js.map +1 -0
  133. package/lib/chunk-YXHH5BF6.js +28 -0
  134. package/lib/chunk-YXHH5BF6.js.map +1 -0
  135. package/lib/core.js +6 -107
  136. package/lib/core.js.map +1 -1
  137. package/lib/core.mjs +5 -78
  138. package/lib/core.mjs.map +1 -1
  139. package/lib/exceptions.js +9 -50
  140. package/lib/exceptions.js.map +1 -1
  141. package/lib/exceptions.mjs +5 -19
  142. package/lib/exceptions.mjs.map +1 -1
  143. package/lib/index.js +29 -283
  144. package/lib/index.js.map +1 -1
  145. package/lib/index.mjs +34 -252
  146. package/lib/index.mjs.map +1 -1
  147. package/lib/parseSchema.js +5 -115
  148. package/lib/parseSchema.js.map +1 -1
  149. package/lib/parseSchema.mjs +5 -88
  150. package/lib/parseSchema.mjs.map +1 -1
  151. package/lib/schemas/ArraySchema.js +6 -81
  152. package/lib/schemas/ArraySchema.js.map +1 -1
  153. package/lib/schemas/ArraySchema.mjs +6 -54
  154. package/lib/schemas/ArraySchema.mjs.map +1 -1
  155. package/lib/schemas/BooleanSchema.js +6 -109
  156. package/lib/schemas/BooleanSchema.js.map +1 -1
  157. package/lib/schemas/BooleanSchema.mjs +6 -82
  158. package/lib/schemas/BooleanSchema.mjs.map +1 -1
  159. package/lib/schemas/CommonSchema.js +5 -63
  160. package/lib/schemas/CommonSchema.js.map +1 -1
  161. package/lib/schemas/CommonSchema.mjs +5 -36
  162. package/lib/schemas/CommonSchema.mjs.map +1 -1
  163. package/lib/schemas/NumberSchema.js +7 -103
  164. package/lib/schemas/NumberSchema.js.map +1 -1
  165. package/lib/schemas/NumberSchema.mjs +7 -76
  166. package/lib/schemas/NumberSchema.mjs.map +1 -1
  167. package/lib/schemas/ObjectSchema.js +6 -85
  168. package/lib/schemas/ObjectSchema.js.map +1 -1
  169. package/lib/schemas/ObjectSchema.mjs +6 -58
  170. package/lib/schemas/ObjectSchema.mjs.map +1 -1
  171. package/lib/schemas/StringSchema.js +7 -103
  172. package/lib/schemas/StringSchema.js.map +1 -1
  173. package/lib/schemas/StringSchema.mjs +7 -76
  174. package/lib/schemas/StringSchema.mjs.map +1 -1
  175. package/package.json +15 -14
  176. package/lib/__tests__/ArraySchema.test.d.mts +0 -2
  177. package/lib/__tests__/ArraySchema.test.d.ts +0 -2
  178. package/lib/__tests__/ArraySchema.test.js +0 -201
  179. package/lib/__tests__/ArraySchema.test.js.map +0 -1
  180. package/lib/__tests__/ArraySchema.test.mjs +0 -199
  181. package/lib/__tests__/ArraySchema.test.mjs.map +0 -1
  182. package/lib/__tests__/BooleanSchema.test.d.mts +0 -2
  183. package/lib/__tests__/BooleanSchema.test.d.ts +0 -2
  184. package/lib/__tests__/BooleanSchema.test.js +0 -219
  185. package/lib/__tests__/BooleanSchema.test.js.map +0 -1
  186. package/lib/__tests__/BooleanSchema.test.mjs +0 -217
  187. package/lib/__tests__/BooleanSchema.test.mjs.map +0 -1
  188. package/lib/__tests__/CommonSchema.test.d.mts +0 -2
  189. package/lib/__tests__/CommonSchema.test.d.ts +0 -2
  190. package/lib/__tests__/CommonSchema.test.js +0 -253
  191. package/lib/__tests__/CommonSchema.test.js.map +0 -1
  192. package/lib/__tests__/CommonSchema.test.mjs +0 -251
  193. package/lib/__tests__/CommonSchema.test.mjs.map +0 -1
  194. package/lib/__tests__/MixTypes.test.d.mts +0 -2
  195. package/lib/__tests__/MixTypes.test.d.ts +0 -2
  196. package/lib/__tests__/MixTypes.test.js +0 -165
  197. package/lib/__tests__/MixTypes.test.js.map +0 -1
  198. package/lib/__tests__/MixTypes.test.mjs +0 -163
  199. package/lib/__tests__/MixTypes.test.mjs.map +0 -1
  200. package/lib/__tests__/NumberSchema.test.d.mts +0 -2
  201. package/lib/__tests__/NumberSchema.test.d.ts +0 -2
  202. package/lib/__tests__/NumberSchema.test.js +0 -253
  203. package/lib/__tests__/NumberSchema.test.js.map +0 -1
  204. package/lib/__tests__/NumberSchema.test.mjs +0 -251
  205. package/lib/__tests__/NumberSchema.test.mjs.map +0 -1
  206. package/lib/__tests__/ObjectSchema.test.d.mts +0 -2
  207. package/lib/__tests__/ObjectSchema.test.d.ts +0 -2
  208. package/lib/__tests__/ObjectSchema.test.js +0 -356
  209. package/lib/__tests__/ObjectSchema.test.js.map +0 -1
  210. package/lib/__tests__/ObjectSchema.test.mjs +0 -354
  211. package/lib/__tests__/ObjectSchema.test.mjs.map +0 -1
  212. package/lib/__tests__/StringSchema.test.d.mts +0 -2
  213. package/lib/__tests__/StringSchema.test.d.ts +0 -2
  214. package/lib/__tests__/StringSchema.test.js +0 -228
  215. package/lib/__tests__/StringSchema.test.js.map +0 -1
  216. package/lib/__tests__/StringSchema.test.mjs +0 -226
  217. package/lib/__tests__/StringSchema.test.mjs.map +0 -1
@@ -1,253 +0,0 @@
1
- "use strict";
2
-
3
- // jest/setup.ts
4
- function expectEqualTypes(areEqual) {
5
- expect(typeof areEqual).toBe("boolean");
6
- }
7
-
8
- // src/exceptions.ts
9
- var ValidationError = class extends Error {
10
- expected;
11
- received;
12
- pathToError;
13
- message;
14
- constructor(expected, received, pathToError, message) {
15
- super();
16
- this.expected = expected;
17
- this.received = received;
18
- this.pathToError = pathToError;
19
- this.message = message;
20
- }
21
- };
22
- function throwException(expected, received, pathToError, message) {
23
- throw new ValidationError(expected, received, pathToError, message);
24
- }
25
-
26
- // src/core.ts
27
- var ctxSymbol = Symbol("contextSymbol");
28
- function innerCheck(schema, receivedValue, pathToError) {
29
- const ctx = schema[ctxSymbol];
30
- if (receivedValue === void 0) {
31
- if (!ctx.isOptional) throwException("Required", receivedValue, pathToError, "The required value is missing");
32
- return receivedValue;
33
- }
34
- if (receivedValue === null) {
35
- if (!ctx.isNullable) throwException("Not null", receivedValue, pathToError, "Value should not be null");
36
- return receivedValue;
37
- }
38
- if (ctx.array) {
39
- if (!Array.isArray(receivedValue))
40
- throwException("Array", receivedValue, pathToError, "Expected an array but received a different type");
41
- const schema2 = ctx.array;
42
- receivedValue.forEach((elem, i) => {
43
- innerCheck(schema2, elem, `${pathToError}[${i}]`);
44
- });
45
- return receivedValue;
46
- }
47
- const typeOfVal = typeof receivedValue;
48
- if (ctx.object) {
49
- if (typeOfVal !== "object")
50
- throwException("Object", receivedValue, pathToError, "Expected an object but received a different type");
51
- if (Array.isArray(receivedValue))
52
- throwException(
53
- "Object",
54
- receivedValue,
55
- pathToError,
56
- "Expected an object but received an array. Invalid type of data"
57
- );
58
- const shapeSchema = ctx.object;
59
- for (const keyPerReceivedValue of Object.keys(receivedValue)) {
60
- if (shapeSchema[keyPerReceivedValue] === void 0)
61
- throwException("Not allowed", keyPerReceivedValue, pathToError, "This key is not allowed in the object");
62
- }
63
- for (const [keyOfSchema, valueOfSchema] of Object.entries(shapeSchema)) {
64
- const receivedObjectValuePropery = receivedValue[keyOfSchema];
65
- if (receivedObjectValuePropery === void 0) {
66
- if (!valueOfSchema[ctxSymbol].isOptional)
67
- throwException(
68
- "Required",
69
- receivedObjectValuePropery,
70
- pathToError,
71
- "Missing required property in the object"
72
- );
73
- }
74
- innerCheck(valueOfSchema, receivedObjectValuePropery, `${pathToError}.${keyOfSchema}`);
75
- }
76
- return receivedValue;
77
- }
78
- if (ctx.type.length) {
79
- if (!ctx.type.includes(typeOfVal)) throwException(ctx.type, typeOfVal, pathToError, "Invalid type of data");
80
- }
81
- ctx.requiredValidations.forEach((requiredValidation) => {
82
- requiredValidation(receivedValue, pathToError);
83
- });
84
- return receivedValue;
85
- }
86
-
87
- // src/parseSchema.ts
88
- function parseSchema(schema, receivedValue) {
89
- try {
90
- return innerCheck(schema, receivedValue, "");
91
- } catch (e) {
92
- if (e instanceof ValidationError) throw e;
93
- throw new Error("Something unexpected happened");
94
- }
95
- }
96
-
97
- // src/asserts/common/equalTo.ts
98
- var equalTo = (expected) => (received, pathToError) => {
99
- if (expected !== received)
100
- throwException(expected, received, pathToError, "The received value is not equal to expected");
101
- };
102
-
103
- // src/schemas/CommonSchema.ts
104
- var CommonSchema = class {
105
- [ctxSymbol];
106
- constructor(ctx) {
107
- this[ctxSymbol] = ctx;
108
- }
109
- /**
110
- * @param validators - One or more custom validation functions.
111
- * @returns {this} The schema instance with the added custom validation.
112
- */
113
- custom(...validators) {
114
- this[ctxSymbol].requiredValidations.push(...validators);
115
- return this;
116
- }
117
- /**
118
- * Marks the schema as nullable, allowing the value to be `null`.
119
- *
120
- * @returns {WithNull<this>} The schema instance marked as nullable.
121
- */
122
- nullable() {
123
- this[ctxSymbol].isNullable = true;
124
- return this;
125
- }
126
- /**
127
- * Marks the schema as optional, allowing the value to be `undefined`.
128
- *
129
- * @returns {WithUndefined<this>}} The schema instance marked as optional.
130
- */
131
- optional() {
132
- this[ctxSymbol].isOptional = true;
133
- return this;
134
- }
135
- };
136
-
137
- // src/schemas/NumberSchema.ts
138
- var NumberSchema = class extends CommonSchema {
139
- _number = 1;
140
- /**
141
- * Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.
142
- *
143
- * @param expectedValue - The value that the schema must exactly match.
144
- * @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type
145
- *
146
- * @example - number().equalTo(42); // Infers the type 42
147
- */
148
- equalTo(expectedValue) {
149
- return this.custom(equalTo(expectedValue));
150
- }
151
- };
152
-
153
- // src/asserts/number/index.ts
154
- function number() {
155
- return new NumberSchema({ type: ["number"], requiredValidations: [] });
156
- }
157
-
158
- // src/schemas/StringSchema.ts
159
- var StringSchema = class extends CommonSchema {
160
- _string = 1;
161
- /**
162
- * Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.
163
- *
164
- * @param expectedValue - The value that the schema must exactly match.
165
- * @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type
166
- *
167
- * @example - string().equalTo('hello'); // Infers the type 'hello'
168
- */
169
- equalTo(expectedValue) {
170
- return this.custom(equalTo(expectedValue));
171
- }
172
- };
173
-
174
- // src/asserts/string/index.ts
175
- function string() {
176
- return new StringSchema({ type: ["string"], requiredValidations: [] });
177
- }
178
-
179
- // src/schemas/BooleanSchema.ts
180
- var isBoolean = (expected) => (received, pathToError) => {
181
- if (received !== expected) throwException(expected, received, pathToError, `The received value is not ${expected}`);
182
- };
183
- var BooleanSchema = class extends CommonSchema {
184
- _boolean = 1;
185
- /**
186
- * Restricts the schema to exactly match the boolean value true and infers the true value as the TypeScript type.
187
- *
188
- * @returns - The schema instance restricted to the value true, with the true value inferred as the TypeScript type
189
- *
190
- * @example - boolean().onlyTrue(); // Infers the type true
191
- */
192
- onlyTrue() {
193
- return this.custom(isBoolean(true));
194
- }
195
- /**
196
- * Restricts the schema to exactly match the boolean value false and infers the false value as the TypeScript type.
197
- *
198
- * @returns - The schema instance restricted to the value false, with the false value inferred as the TypeScript type
199
- *
200
- * @example - boolean().onlyFalse(); // Infers the type false
201
- */
202
- onlyFalse() {
203
- return this.custom(isBoolean(false));
204
- }
205
- };
206
-
207
- // src/asserts/boolean/index.ts
208
- function boolean() {
209
- return new BooleanSchema({ type: ["boolean"], requiredValidations: [] });
210
- }
211
-
212
- // src/__tests__/CommonSchema.test.ts
213
- describe("CommonSchema", () => {
214
- it("should be a nullable string", () => {
215
- const stringOrNullSchema = string().nullable();
216
- expectEqualTypes(true);
217
- expect(parseSchema(stringOrNullSchema, "this is a string")).toBe("this is a string");
218
- expect(parseSchema(stringOrNullSchema, null)).toBe(null);
219
- });
220
- it("should be an optional string", () => {
221
- const stringOrNullSchema = string().optional();
222
- expectEqualTypes(true);
223
- expect(parseSchema(stringOrNullSchema, "this is a string")).toBe("this is a string");
224
- expect(parseSchema(stringOrNullSchema, void 0)).toBe(void 0);
225
- });
226
- it("should be an optional and nullable string", () => {
227
- const stringOrNullSchema = string().optional().nullable();
228
- expectEqualTypes(true);
229
- expect(parseSchema(stringOrNullSchema, "this is a string")).toBe("this is a string");
230
- expect(parseSchema(stringOrNullSchema, void 0)).toBe(void 0);
231
- expect(parseSchema(stringOrNullSchema, null)).toBe(null);
232
- });
233
- it("should fail on required and non nullable field", () => {
234
- const booleanSchema = boolean();
235
- expectEqualTypes(true);
236
- expect(parseSchema(booleanSchema, true)).toBe(true);
237
- expect(() => parseSchema(booleanSchema, null)).toThrow("Value should not be null");
238
- expect(() => parseSchema(booleanSchema, void 0)).toThrow("The required value is missing");
239
- expect(() => parseSchema(booleanSchema, null)).toThrow(ValidationError);
240
- expect(() => parseSchema(booleanSchema, void 0)).toThrow(ValidationError);
241
- });
242
- it("should work with custom assert", () => {
243
- const even = () => (received, pathToError) => {
244
- if (received % 2 !== 0) throwException("even", received, pathToError, "The received value is not an even number");
245
- };
246
- const numberSchema = number().custom(even());
247
- expectEqualTypes(true);
248
- expect(parseSchema(numberSchema, 4)).toBe(4);
249
- expect(() => parseSchema(numberSchema, 3)).toThrow("The received value is not an even number");
250
- expect(() => parseSchema(numberSchema, 3)).toThrow(ValidationError);
251
- });
252
- });
253
- //# sourceMappingURL=CommonSchema.test.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../jest/setup.ts","../../src/exceptions.ts","../../src/core.ts","../../src/parseSchema.ts","../../src/asserts/common/equalTo.ts","../../src/schemas/CommonSchema.ts","../../src/schemas/NumberSchema.ts","../../src/asserts/number/index.ts","../../src/schemas/StringSchema.ts","../../src/asserts/string/index.ts","../../src/schemas/BooleanSchema.ts","../../src/asserts/boolean/index.ts","../../src/__tests__/CommonSchema.test.ts"],"sourcesContent":["export type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;\n\nexport function expectEqualTypes<X, Y>(areEqual: Equal<X, Y>): void {\n expect(typeof areEqual).toBe('boolean');\n}\n","export class ValidationError extends Error {\n expected: unknown;\n received: unknown;\n pathToError: string;\n message: string;\n constructor(expected: unknown, received: unknown, pathToError: string, message: string) {\n super();\n this.expected = expected;\n this.received = received;\n this.pathToError = pathToError;\n this.message = message;\n }\n}\n\nexport class BuildSchemaError extends Error {}\n\nexport function throwException(expected: unknown, received: unknown, pathToError: string, message: string): never {\n throw new ValidationError(expected, received, pathToError, message);\n}\n","export const ctxSymbol = Symbol('contextSymbol');\n\nimport { throwException } from './exceptions';\nimport type { CommonSchema } from './schemas/CommonSchema';\n\nexport function innerCheck(schema: CommonSchema, receivedValue: unknown, pathToError: string) {\n const ctx = schema[ctxSymbol];\n if (receivedValue === undefined) {\n if (!ctx.isOptional) throwException('Required', receivedValue, pathToError, 'The required value is missing');\n return receivedValue;\n }\n\n if (receivedValue === null) {\n if (!ctx.isNullable) throwException('Not null', receivedValue, pathToError, 'Value should not be null');\n return receivedValue;\n }\n\n if (ctx.array) {\n if (!Array.isArray(receivedValue))\n throwException('Array', receivedValue, pathToError, 'Expected an array but received a different type');\n const schema = ctx.array;\n\n receivedValue.forEach((elem, i) => {\n innerCheck(schema, elem, `${pathToError}[${i}]`);\n });\n\n return receivedValue;\n }\n\n const typeOfVal = typeof receivedValue;\n\n if (ctx.object) {\n if (typeOfVal !== 'object')\n throwException('Object', receivedValue, pathToError, 'Expected an object but received a different type');\n if (Array.isArray(receivedValue))\n throwException(\n 'Object',\n receivedValue,\n pathToError,\n 'Expected an object but received an array. Invalid type of data',\n );\n const shapeSchema = ctx.object;\n for (const keyPerReceivedValue of Object.keys(receivedValue)) {\n if (shapeSchema[keyPerReceivedValue] === undefined)\n throwException('Not allowed', keyPerReceivedValue, pathToError, 'This key is not allowed in the object');\n }\n\n for (const [keyOfSchema, valueOfSchema] of Object.entries(shapeSchema)) {\n const receivedObjectValuePropery = (receivedValue as Record<string, unknown>)[keyOfSchema];\n if (receivedObjectValuePropery === undefined) {\n if (!valueOfSchema[ctxSymbol].isOptional)\n throwException(\n 'Required',\n receivedObjectValuePropery,\n pathToError,\n 'Missing required property in the object',\n );\n }\n innerCheck(valueOfSchema, receivedObjectValuePropery, `${pathToError}.${keyOfSchema}`);\n }\n\n return receivedValue;\n }\n\n if (ctx.type.length) {\n if (!ctx.type.includes(typeOfVal)) throwException(ctx.type, typeOfVal, pathToError, 'Invalid type of data');\n }\n\n ctx.requiredValidations.forEach((requiredValidation) => {\n requiredValidation(receivedValue, pathToError);\n });\n\n return receivedValue;\n}\n","import { InferType } from './InferType';\nimport { innerCheck } from './core';\nimport { ValidationError } from './exceptions';\nimport { CommonSchema } from './schemas/CommonSchema';\n\n/**\n * Parses and validates a value against the provided schema, returning a type-safe result.\n *\n * This function will throw a `ValidationError` if the value does not conform to the schema.\n * The inferred TypeScript type of the returned value will match the structure defined by the schema.\n *\n * @template T\n * @param {T} schema - The schema to validate the received value against. This schema dictates the expected structure and type of the value.\n * @param {unknown} receivedValue - The value to be validated and parsed according to the schema.\n * @returns {InferType<T>} The validated value, with its TypeScript type inferred from the schema.\n *\n * @throws {ValidationError} If the received value does not match the schema, a `ValidationError` will be thrown.\n * @throws {Error} If an unexpected error occurs during validation, an error will be thrown with a generic message.\n *\n * @example\n * const schema = object({\n * name: string(),\n * age: number(),\n * });\n *\n * const result = parseSchema(schema, { name: 'Alice', age: 30 });\n * // result will be inferred as { name: string; age: number }\n *\n * parseSchema(schema, { name: 'Alice', age: '30' });\n * // Throws ValidationError because 'age' should be a number, not a string.\n */\nexport function parseSchema<T extends CommonSchema>(schema: T, receivedValue: unknown): InferType<T> {\n try {\n return innerCheck(schema, receivedValue, '') as InferType<T>;\n } catch (e) {\n if (e instanceof ValidationError) throw e;\n /* istanbul ignore next */\n throw new Error('Something unexpected happened');\n }\n}\n","import { throwException } from '../../exceptions';\nimport { RequiredValidation } from '../../schemas/CommonSchema';\n\n/**\n * Creates a custom assertion that checks if a value is equal to the expected value.\n *\n * This assertion can be used within a `.custom` method to enforce that a value strictly matches the expected value.\n * It will throw a `ValidationError` if the values are not equal.\n *\n * @param {unknown} expected - The value that the received value is expected to match.\n * @returns {RequiredValidation} A function that takes the received value and the path to the error,\n * and throws a `ValidationError` if the received value does not equal the expected value.\n *\n * @throws {ValidationError} If the received value does not match the expected value.\n *\n * @example\n * import { number, equalTo } from 'bguard';\n *\n * // Define a schema with a custom assertion\n * const schema = number().custom(equalTo(5));\n *\n * // This will pass\n * parseSchema(schema, 5);\n *\n * // This will throw a ValidationError\n * parseSchema(schema, 3);\n */\nexport const equalTo =\n (expected: unknown): RequiredValidation =>\n (received: number, pathToError: string) => {\n if (expected !== received)\n throwException(expected, received, pathToError, 'The received value is not equal to expected');\n };\n","import { ctxSymbol } from '../core';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type RequiredValidation = (received: any, pathToError: string) => void;\nexport type ObjectShapeSchemaType = Record<string, CommonSchema>;\n\nexport type PrimitiveType = 'number' | 'string' | 'boolean' | 'undefined' | 'object' | 'function' | 'symbol' | 'bigint';\nexport interface ValidatorContext {\n type: PrimitiveType[];\n isNullable?: boolean;\n isOptional?: boolean;\n requiredValidations: RequiredValidation[];\n array?: CommonSchema;\n object?: ObjectShapeSchemaType;\n}\n\nexport class CommonSchema {\n [ctxSymbol]: ValidatorContext;\n constructor(ctx: ValidatorContext) {\n this[ctxSymbol] = ctx;\n }\n\n /**\n * @param validators - One or more custom validation functions.\n * @returns {this} The schema instance with the added custom validation.\n */\n custom(...validators: RequiredValidation[]): this {\n this[ctxSymbol].requiredValidations.push(...validators);\n return this;\n }\n\n /**\n * Marks the schema as nullable, allowing the value to be `null`.\n *\n * @returns {WithNull<this>} The schema instance marked as nullable.\n */\n nullable(): WithNull<this> {\n this[ctxSymbol].isNullable = true;\n return this as WithNull<this>;\n }\n\n /**\n * Marks the schema as optional, allowing the value to be `undefined`.\n *\n * @returns {WithUndefined<this>}} The schema instance marked as optional.\n */\n optional(): WithUndefined<this> {\n this[ctxSymbol].isOptional = true;\n return this as WithUndefined<this>;\n }\n}\n\nexport type WithNull<T extends CommonSchema> = T & { validation_null: true };\nexport type WithUndefined<T extends CommonSchema> = T & { validation_undefined: true };\n\ntype TypeMapping = {\n number: number;\n string: string;\n boolean: boolean;\n undefined: undefined;\n object: object;\n // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type\n function: Function;\n symbol: symbol;\n bigint: bigint;\n};\n\nexport type WithMix<Y = unknown> = CommonSchema & { validation_mix: Y };\nexport type ExtractFromMix<T> = T extends WithMix<infer X> ? X : never;\n\nexport type MapMixTypes<T extends PrimitiveType[]> = T extends (infer U)[]\n ? U extends keyof TypeMapping\n ? TypeMapping[U]\n : never\n : never;\n","import { equalTo } from '../asserts/common/equalTo';\n\nimport { CommonSchema } from './CommonSchema';\n\nexport class NumberSchema extends CommonSchema {\n _number = 1;\n\n /**\n * Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.\n *\n * @param expectedValue - The value that the schema must exactly match.\n * @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type\n *\n * @example - number().equalTo(42); // Infers the type 42\n */\n equalTo<Y extends number>(expectedValue: Y): WithNumber<this, Y> {\n return this.custom(equalTo(expectedValue)) as WithNumber<this, Y>;\n }\n}\n\nexport type WithNumber<T extends NumberSchema, Y = number> = T & { validation_number: Y };\nexport type ExtractFromNumber<T> = T extends WithNumber<NumberSchema, infer Y> ? Y : never;\n","import { NumberSchema } from '../../schemas/NumberSchema';\n\n/**\n * Creates a new schema for validating number values.\n *\n * @returns {NumberSchema} A new instance of `NumberSchema` for validating numbers.\n *\n * @example\n * const schema = number();\n * parseSchema(schema, 42); // Validates successfully\n * parseSchema(schema, '42'); // Throws a validation error\n */\nexport function number(): NumberSchema {\n return new NumberSchema({ type: ['number'], requiredValidations: [] });\n}\n","import { equalTo } from '../asserts/common/equalTo';\nimport { CommonSchema } from './CommonSchema';\n\nexport class StringSchema extends CommonSchema {\n _string = 1;\n\n /**\n * Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.\n *\n * @param expectedValue - The value that the schema must exactly match.\n * @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type\n *\n * @example - string().equalTo('hello'); // Infers the type 'hello'\n */\n equalTo<Y extends string>(expectedValue: Y): WithString<this, Y> {\n return this.custom(equalTo(expectedValue)) as WithString<this, Y>;\n }\n}\n\nexport type WithString<T extends StringSchema, Y = string> = T & { validation_string: Y };\nexport type ExtractFromString<T> = T extends WithString<StringSchema, infer Y> ? Y : never;\n","import { StringSchema } from '../../schemas/StringSchema';\n\n/**\n * Creates a new schema for validating string values.\n *\n * @returns {StringSchema} A new instance of `StringSchema` for validating strings.\n *\n * @example\n * const schema = string();\n * parseSchema(schema, 'hello'); // Validates successfully\n * parseSchema(schema, 123); // Throws a validation error\n */\nexport function string(): StringSchema {\n return new StringSchema({ type: ['string'], requiredValidations: [] });\n}\n","import { CommonSchema } from './CommonSchema';\nimport { throwException } from '../exceptions';\n\nconst isBoolean = (expected: boolean) => (received: boolean, pathToError: string) => {\n if (received !== expected) throwException(expected, received, pathToError, `The received value is not ${expected}`);\n};\n\nexport class BooleanSchema extends CommonSchema {\n _boolean = 1;\n\n /**\n * Restricts the schema to exactly match the boolean value true and infers the true value as the TypeScript type.\n *\n * @returns - The schema instance restricted to the value true, with the true value inferred as the TypeScript type\n *\n * @example - boolean().onlyTrue(); // Infers the type true\n */\n onlyTrue(): WithBoolean<this, true> {\n return this.custom(isBoolean(true)) as WithBoolean<this, true>;\n }\n\n /**\n * Restricts the schema to exactly match the boolean value false and infers the false value as the TypeScript type.\n *\n * @returns - The schema instance restricted to the value false, with the false value inferred as the TypeScript type\n *\n * @example - boolean().onlyFalse(); // Infers the type false\n */\n onlyFalse(): WithBoolean<this, false> {\n return this.custom(isBoolean(false)) as WithBoolean<this, false>;\n }\n}\n\nexport type WithBoolean<T extends BooleanSchema, Y = boolean> = T & { validation_boolean: Y };\nexport type ExtractFromBoolean<T> = T extends WithBoolean<BooleanSchema, infer Y> ? Y : never;\n","import { BooleanSchema } from '../../schemas/BooleanSchema';\n\n/**\n * Creates a new schema for validating boolean values.\n *\n * @returns {BooleanSchema} A new instance of `BooleanSchema` for validating booleans.\n *\n * @example\n * const schema = boolean();\n * parseSchema(schema, true); // Validates successfully\n * parseSchema(schema, 'true'); // Throws a validation error\n */\nexport function boolean(): BooleanSchema {\n return new BooleanSchema({ type: ['boolean'], requiredValidations: [] });\n}\n","import { expectEqualTypes } from '../../jest/setup';\nimport { InferType, number, throwException, string, boolean, parseSchema, ValidationError } from '../';\nimport { RequiredValidation } from '../schemas/CommonSchema';\n\ndescribe('CommonSchema', () => {\n it('should be a nullable string', () => {\n const stringOrNullSchema = string().nullable();\n\n expectEqualTypes<string | null, InferType<typeof stringOrNullSchema>>(true);\n expect(parseSchema(stringOrNullSchema, 'this is a string')).toBe('this is a string');\n expect(parseSchema(stringOrNullSchema, null)).toBe(null);\n });\n\n it('should be an optional string', () => {\n const stringOrNullSchema = string().optional();\n\n expectEqualTypes<string | undefined, InferType<typeof stringOrNullSchema>>(true);\n expect(parseSchema(stringOrNullSchema, 'this is a string')).toBe('this is a string');\n expect(parseSchema(stringOrNullSchema, undefined)).toBe(undefined);\n });\n\n it('should be an optional and nullable string', () => {\n const stringOrNullSchema = string().optional().nullable();\n\n expectEqualTypes<string | null | undefined, InferType<typeof stringOrNullSchema>>(true);\n expect(parseSchema(stringOrNullSchema, 'this is a string')).toBe('this is a string');\n expect(parseSchema(stringOrNullSchema, undefined)).toBe(undefined);\n expect(parseSchema(stringOrNullSchema, null)).toBe(null);\n });\n\n it('should fail on required and non nullable field', () => {\n const booleanSchema = boolean();\n\n expectEqualTypes<boolean, InferType<typeof booleanSchema>>(true);\n expect(parseSchema(booleanSchema, true)).toBe(true);\n expect(() => parseSchema(booleanSchema, null)).toThrow('Value should not be null');\n expect(() => parseSchema(booleanSchema, undefined)).toThrow('The required value is missing');\n expect(() => parseSchema(booleanSchema, null)).toThrow(ValidationError);\n expect(() => parseSchema(booleanSchema, undefined)).toThrow(ValidationError);\n });\n\n it('should work with custom assert', () => {\n const even = (): RequiredValidation => (received: number, pathToError: string) => {\n if (received % 2 !== 0) throwException('even', received, pathToError, 'The received value is not an even number');\n };\n\n const numberSchema = number().custom(even());\n\n expectEqualTypes<number, InferType<typeof numberSchema>>(true);\n expect(parseSchema(numberSchema, 4)).toBe(4);\n expect(() => parseSchema(numberSchema, 3)).toThrow('The received value is not an even number');\n expect(() => parseSchema(numberSchema, 3)).toThrow(ValidationError);\n });\n});\n"],"mappings":";;;AAEO,SAAS,iBAAuB,UAA6B;AAClE,SAAO,OAAO,QAAQ,EAAE,KAAK,SAAS;AACxC;;;ACJO,IAAM,kBAAN,cAA8B,MAAM;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,YAAY,UAAmB,UAAmB,aAAqB,SAAiB;AACtF,UAAM;AACN,SAAK,WAAW;AAChB,SAAK,WAAW;AAChB,SAAK,cAAc;AACnB,SAAK,UAAU;AAAA,EACjB;AACF;AAIO,SAAS,eAAe,UAAmB,UAAmB,aAAqB,SAAwB;AAChH,QAAM,IAAI,gBAAgB,UAAU,UAAU,aAAa,OAAO;AACpE;;;AClBO,IAAM,YAAY,OAAO,eAAe;AAKxC,SAAS,WAAW,QAAsB,eAAwB,aAAqB;AAC5F,QAAM,MAAM,OAAO,SAAS;AAC5B,MAAI,kBAAkB,QAAW;AAC/B,QAAI,CAAC,IAAI,WAAY,gBAAe,YAAY,eAAe,aAAa,+BAA+B;AAC3G,WAAO;AAAA,EACT;AAEA,MAAI,kBAAkB,MAAM;AAC1B,QAAI,CAAC,IAAI,WAAY,gBAAe,YAAY,eAAe,aAAa,0BAA0B;AACtG,WAAO;AAAA,EACT;AAEA,MAAI,IAAI,OAAO;AACb,QAAI,CAAC,MAAM,QAAQ,aAAa;AAC9B,qBAAe,SAAS,eAAe,aAAa,iDAAiD;AACvG,UAAMA,UAAS,IAAI;AAEnB,kBAAc,QAAQ,CAAC,MAAM,MAAM;AACjC,iBAAWA,SAAQ,MAAM,GAAG,WAAW,IAAI,CAAC,GAAG;AAAA,IACjD,CAAC;AAED,WAAO;AAAA,EACT;AAEA,QAAM,YAAY,OAAO;AAEzB,MAAI,IAAI,QAAQ;AACd,QAAI,cAAc;AAChB,qBAAe,UAAU,eAAe,aAAa,kDAAkD;AACzG,QAAI,MAAM,QAAQ,aAAa;AAC7B;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AACF,UAAM,cAAc,IAAI;AACxB,eAAW,uBAAuB,OAAO,KAAK,aAAa,GAAG;AAC5D,UAAI,YAAY,mBAAmB,MAAM;AACvC,uBAAe,eAAe,qBAAqB,aAAa,uCAAuC;AAAA,IAC3G;AAEA,eAAW,CAAC,aAAa,aAAa,KAAK,OAAO,QAAQ,WAAW,GAAG;AACtE,YAAM,6BAA8B,cAA0C,WAAW;AACzF,UAAI,+BAA+B,QAAW;AAC5C,YAAI,CAAC,cAAc,SAAS,EAAE;AAC5B;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,MACJ;AACA,iBAAW,eAAe,4BAA4B,GAAG,WAAW,IAAI,WAAW,EAAE;AAAA,IACvF;AAEA,WAAO;AAAA,EACT;AAEA,MAAI,IAAI,KAAK,QAAQ;AACnB,QAAI,CAAC,IAAI,KAAK,SAAS,SAAS,EAAG,gBAAe,IAAI,MAAM,WAAW,aAAa,sBAAsB;AAAA,EAC5G;AAEA,MAAI,oBAAoB,QAAQ,CAAC,uBAAuB;AACtD,uBAAmB,eAAe,WAAW;AAAA,EAC/C,CAAC;AAED,SAAO;AACT;;;AC1CO,SAAS,YAAoC,QAAW,eAAsC;AACnG,MAAI;AACF,WAAO,WAAW,QAAQ,eAAe,EAAE;AAAA,EAC7C,SAAS,GAAG;AACV,QAAI,aAAa,gBAAiB,OAAM;AAExC,UAAM,IAAI,MAAM,+BAA+B;AAAA,EACjD;AACF;;;ACZO,IAAM,UACX,CAAC,aACD,CAAC,UAAkB,gBAAwB;AACzC,MAAI,aAAa;AACf,mBAAe,UAAU,UAAU,aAAa,6CAA6C;AACjG;;;AChBK,IAAM,eAAN,MAAmB;AAAA,EACxB,CAAC,SAAS;AAAA,EACV,YAAY,KAAuB;AACjC,SAAK,SAAS,IAAI;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAU,YAAwC;AAChD,SAAK,SAAS,EAAE,oBAAoB,KAAK,GAAG,UAAU;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAA2B;AACzB,SAAK,SAAS,EAAE,aAAa;AAC7B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAgC;AAC9B,SAAK,SAAS,EAAE,aAAa;AAC7B,WAAO;AAAA,EACT;AACF;;;AC9CO,IAAM,eAAN,cAA2B,aAAa;AAAA,EAC7C,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUV,QAA0B,eAAuC;AAC/D,WAAO,KAAK,OAAO,QAAQ,aAAa,CAAC;AAAA,EAC3C;AACF;;;ACNO,SAAS,SAAuB;AACrC,SAAO,IAAI,aAAa,EAAE,MAAM,CAAC,QAAQ,GAAG,qBAAqB,CAAC,EAAE,CAAC;AACvE;;;ACXO,IAAM,eAAN,cAA2B,aAAa;AAAA,EAC7C,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUV,QAA0B,eAAuC;AAC/D,WAAO,KAAK,OAAO,QAAQ,aAAa,CAAC;AAAA,EAC3C;AACF;;;ACLO,SAAS,SAAuB;AACrC,SAAO,IAAI,aAAa,EAAE,MAAM,CAAC,QAAQ,GAAG,qBAAqB,CAAC,EAAE,CAAC;AACvE;;;ACXA,IAAM,YAAY,CAAC,aAAsB,CAAC,UAAmB,gBAAwB;AACnF,MAAI,aAAa,SAAU,gBAAe,UAAU,UAAU,aAAa,6BAA6B,QAAQ,EAAE;AACpH;AAEO,IAAM,gBAAN,cAA4B,aAAa;AAAA,EAC9C,WAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASX,WAAoC;AAClC,WAAO,KAAK,OAAO,UAAU,IAAI,CAAC;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,YAAsC;AACpC,WAAO,KAAK,OAAO,UAAU,KAAK,CAAC;AAAA,EACrC;AACF;;;ACnBO,SAAS,UAAyB;AACvC,SAAO,IAAI,cAAc,EAAE,MAAM,CAAC,SAAS,GAAG,qBAAqB,CAAC,EAAE,CAAC;AACzE;;;ACVA,SAAS,gBAAgB,MAAM;AAC7B,KAAG,+BAA+B,MAAM;AACtC,UAAM,qBAAqB,OAAO,EAAE,SAAS;AAE7C,qBAAsE,IAAI;AAC1E,WAAO,YAAY,oBAAoB,kBAAkB,CAAC,EAAE,KAAK,kBAAkB;AACnF,WAAO,YAAY,oBAAoB,IAAI,CAAC,EAAE,KAAK,IAAI;AAAA,EACzD,CAAC;AAED,KAAG,gCAAgC,MAAM;AACvC,UAAM,qBAAqB,OAAO,EAAE,SAAS;AAE7C,qBAA2E,IAAI;AAC/E,WAAO,YAAY,oBAAoB,kBAAkB,CAAC,EAAE,KAAK,kBAAkB;AACnF,WAAO,YAAY,oBAAoB,MAAS,CAAC,EAAE,KAAK,MAAS;AAAA,EACnE,CAAC;AAED,KAAG,6CAA6C,MAAM;AACpD,UAAM,qBAAqB,OAAO,EAAE,SAAS,EAAE,SAAS;AAExD,qBAAkF,IAAI;AACtF,WAAO,YAAY,oBAAoB,kBAAkB,CAAC,EAAE,KAAK,kBAAkB;AACnF,WAAO,YAAY,oBAAoB,MAAS,CAAC,EAAE,KAAK,MAAS;AACjE,WAAO,YAAY,oBAAoB,IAAI,CAAC,EAAE,KAAK,IAAI;AAAA,EACzD,CAAC;AAED,KAAG,kDAAkD,MAAM;AACzD,UAAM,gBAAgB,QAAQ;AAE9B,qBAA2D,IAAI;AAC/D,WAAO,YAAY,eAAe,IAAI,CAAC,EAAE,KAAK,IAAI;AAClD,WAAO,MAAM,YAAY,eAAe,IAAI,CAAC,EAAE,QAAQ,0BAA0B;AACjF,WAAO,MAAM,YAAY,eAAe,MAAS,CAAC,EAAE,QAAQ,+BAA+B;AAC3F,WAAO,MAAM,YAAY,eAAe,IAAI,CAAC,EAAE,QAAQ,eAAe;AACtE,WAAO,MAAM,YAAY,eAAe,MAAS,CAAC,EAAE,QAAQ,eAAe;AAAA,EAC7E,CAAC;AAED,KAAG,kCAAkC,MAAM;AACzC,UAAM,OAAO,MAA0B,CAAC,UAAkB,gBAAwB;AAChF,UAAI,WAAW,MAAM,EAAG,gBAAe,QAAQ,UAAU,aAAa,0CAA0C;AAAA,IAClH;AAEA,UAAM,eAAe,OAAO,EAAE,OAAO,KAAK,CAAC;AAE3C,qBAAyD,IAAI;AAC7D,WAAO,YAAY,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC;AAC3C,WAAO,MAAM,YAAY,cAAc,CAAC,CAAC,EAAE,QAAQ,0CAA0C;AAC7F,WAAO,MAAM,YAAY,cAAc,CAAC,CAAC,EAAE,QAAQ,eAAe;AAAA,EACpE,CAAC;AACH,CAAC;","names":["schema"]}
@@ -1,251 +0,0 @@
1
- // jest/setup.ts
2
- function expectEqualTypes(areEqual) {
3
- expect(typeof areEqual).toBe("boolean");
4
- }
5
-
6
- // src/exceptions.ts
7
- var ValidationError = class extends Error {
8
- expected;
9
- received;
10
- pathToError;
11
- message;
12
- constructor(expected, received, pathToError, message) {
13
- super();
14
- this.expected = expected;
15
- this.received = received;
16
- this.pathToError = pathToError;
17
- this.message = message;
18
- }
19
- };
20
- function throwException(expected, received, pathToError, message) {
21
- throw new ValidationError(expected, received, pathToError, message);
22
- }
23
-
24
- // src/core.ts
25
- var ctxSymbol = Symbol("contextSymbol");
26
- function innerCheck(schema, receivedValue, pathToError) {
27
- const ctx = schema[ctxSymbol];
28
- if (receivedValue === void 0) {
29
- if (!ctx.isOptional) throwException("Required", receivedValue, pathToError, "The required value is missing");
30
- return receivedValue;
31
- }
32
- if (receivedValue === null) {
33
- if (!ctx.isNullable) throwException("Not null", receivedValue, pathToError, "Value should not be null");
34
- return receivedValue;
35
- }
36
- if (ctx.array) {
37
- if (!Array.isArray(receivedValue))
38
- throwException("Array", receivedValue, pathToError, "Expected an array but received a different type");
39
- const schema2 = ctx.array;
40
- receivedValue.forEach((elem, i) => {
41
- innerCheck(schema2, elem, `${pathToError}[${i}]`);
42
- });
43
- return receivedValue;
44
- }
45
- const typeOfVal = typeof receivedValue;
46
- if (ctx.object) {
47
- if (typeOfVal !== "object")
48
- throwException("Object", receivedValue, pathToError, "Expected an object but received a different type");
49
- if (Array.isArray(receivedValue))
50
- throwException(
51
- "Object",
52
- receivedValue,
53
- pathToError,
54
- "Expected an object but received an array. Invalid type of data"
55
- );
56
- const shapeSchema = ctx.object;
57
- for (const keyPerReceivedValue of Object.keys(receivedValue)) {
58
- if (shapeSchema[keyPerReceivedValue] === void 0)
59
- throwException("Not allowed", keyPerReceivedValue, pathToError, "This key is not allowed in the object");
60
- }
61
- for (const [keyOfSchema, valueOfSchema] of Object.entries(shapeSchema)) {
62
- const receivedObjectValuePropery = receivedValue[keyOfSchema];
63
- if (receivedObjectValuePropery === void 0) {
64
- if (!valueOfSchema[ctxSymbol].isOptional)
65
- throwException(
66
- "Required",
67
- receivedObjectValuePropery,
68
- pathToError,
69
- "Missing required property in the object"
70
- );
71
- }
72
- innerCheck(valueOfSchema, receivedObjectValuePropery, `${pathToError}.${keyOfSchema}`);
73
- }
74
- return receivedValue;
75
- }
76
- if (ctx.type.length) {
77
- if (!ctx.type.includes(typeOfVal)) throwException(ctx.type, typeOfVal, pathToError, "Invalid type of data");
78
- }
79
- ctx.requiredValidations.forEach((requiredValidation) => {
80
- requiredValidation(receivedValue, pathToError);
81
- });
82
- return receivedValue;
83
- }
84
-
85
- // src/parseSchema.ts
86
- function parseSchema(schema, receivedValue) {
87
- try {
88
- return innerCheck(schema, receivedValue, "");
89
- } catch (e) {
90
- if (e instanceof ValidationError) throw e;
91
- throw new Error("Something unexpected happened");
92
- }
93
- }
94
-
95
- // src/asserts/common/equalTo.ts
96
- var equalTo = (expected) => (received, pathToError) => {
97
- if (expected !== received)
98
- throwException(expected, received, pathToError, "The received value is not equal to expected");
99
- };
100
-
101
- // src/schemas/CommonSchema.ts
102
- var CommonSchema = class {
103
- [ctxSymbol];
104
- constructor(ctx) {
105
- this[ctxSymbol] = ctx;
106
- }
107
- /**
108
- * @param validators - One or more custom validation functions.
109
- * @returns {this} The schema instance with the added custom validation.
110
- */
111
- custom(...validators) {
112
- this[ctxSymbol].requiredValidations.push(...validators);
113
- return this;
114
- }
115
- /**
116
- * Marks the schema as nullable, allowing the value to be `null`.
117
- *
118
- * @returns {WithNull<this>} The schema instance marked as nullable.
119
- */
120
- nullable() {
121
- this[ctxSymbol].isNullable = true;
122
- return this;
123
- }
124
- /**
125
- * Marks the schema as optional, allowing the value to be `undefined`.
126
- *
127
- * @returns {WithUndefined<this>}} The schema instance marked as optional.
128
- */
129
- optional() {
130
- this[ctxSymbol].isOptional = true;
131
- return this;
132
- }
133
- };
134
-
135
- // src/schemas/NumberSchema.ts
136
- var NumberSchema = class extends CommonSchema {
137
- _number = 1;
138
- /**
139
- * Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.
140
- *
141
- * @param expectedValue - The value that the schema must exactly match.
142
- * @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type
143
- *
144
- * @example - number().equalTo(42); // Infers the type 42
145
- */
146
- equalTo(expectedValue) {
147
- return this.custom(equalTo(expectedValue));
148
- }
149
- };
150
-
151
- // src/asserts/number/index.ts
152
- function number() {
153
- return new NumberSchema({ type: ["number"], requiredValidations: [] });
154
- }
155
-
156
- // src/schemas/StringSchema.ts
157
- var StringSchema = class extends CommonSchema {
158
- _string = 1;
159
- /**
160
- * Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.
161
- *
162
- * @param expectedValue - The value that the schema must exactly match.
163
- * @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type
164
- *
165
- * @example - string().equalTo('hello'); // Infers the type 'hello'
166
- */
167
- equalTo(expectedValue) {
168
- return this.custom(equalTo(expectedValue));
169
- }
170
- };
171
-
172
- // src/asserts/string/index.ts
173
- function string() {
174
- return new StringSchema({ type: ["string"], requiredValidations: [] });
175
- }
176
-
177
- // src/schemas/BooleanSchema.ts
178
- var isBoolean = (expected) => (received, pathToError) => {
179
- if (received !== expected) throwException(expected, received, pathToError, `The received value is not ${expected}`);
180
- };
181
- var BooleanSchema = class extends CommonSchema {
182
- _boolean = 1;
183
- /**
184
- * Restricts the schema to exactly match the boolean value true and infers the true value as the TypeScript type.
185
- *
186
- * @returns - The schema instance restricted to the value true, with the true value inferred as the TypeScript type
187
- *
188
- * @example - boolean().onlyTrue(); // Infers the type true
189
- */
190
- onlyTrue() {
191
- return this.custom(isBoolean(true));
192
- }
193
- /**
194
- * Restricts the schema to exactly match the boolean value false and infers the false value as the TypeScript type.
195
- *
196
- * @returns - The schema instance restricted to the value false, with the false value inferred as the TypeScript type
197
- *
198
- * @example - boolean().onlyFalse(); // Infers the type false
199
- */
200
- onlyFalse() {
201
- return this.custom(isBoolean(false));
202
- }
203
- };
204
-
205
- // src/asserts/boolean/index.ts
206
- function boolean() {
207
- return new BooleanSchema({ type: ["boolean"], requiredValidations: [] });
208
- }
209
-
210
- // src/__tests__/CommonSchema.test.ts
211
- describe("CommonSchema", () => {
212
- it("should be a nullable string", () => {
213
- const stringOrNullSchema = string().nullable();
214
- expectEqualTypes(true);
215
- expect(parseSchema(stringOrNullSchema, "this is a string")).toBe("this is a string");
216
- expect(parseSchema(stringOrNullSchema, null)).toBe(null);
217
- });
218
- it("should be an optional string", () => {
219
- const stringOrNullSchema = string().optional();
220
- expectEqualTypes(true);
221
- expect(parseSchema(stringOrNullSchema, "this is a string")).toBe("this is a string");
222
- expect(parseSchema(stringOrNullSchema, void 0)).toBe(void 0);
223
- });
224
- it("should be an optional and nullable string", () => {
225
- const stringOrNullSchema = string().optional().nullable();
226
- expectEqualTypes(true);
227
- expect(parseSchema(stringOrNullSchema, "this is a string")).toBe("this is a string");
228
- expect(parseSchema(stringOrNullSchema, void 0)).toBe(void 0);
229
- expect(parseSchema(stringOrNullSchema, null)).toBe(null);
230
- });
231
- it("should fail on required and non nullable field", () => {
232
- const booleanSchema = boolean();
233
- expectEqualTypes(true);
234
- expect(parseSchema(booleanSchema, true)).toBe(true);
235
- expect(() => parseSchema(booleanSchema, null)).toThrow("Value should not be null");
236
- expect(() => parseSchema(booleanSchema, void 0)).toThrow("The required value is missing");
237
- expect(() => parseSchema(booleanSchema, null)).toThrow(ValidationError);
238
- expect(() => parseSchema(booleanSchema, void 0)).toThrow(ValidationError);
239
- });
240
- it("should work with custom assert", () => {
241
- const even = () => (received, pathToError) => {
242
- if (received % 2 !== 0) throwException("even", received, pathToError, "The received value is not an even number");
243
- };
244
- const numberSchema = number().custom(even());
245
- expectEqualTypes(true);
246
- expect(parseSchema(numberSchema, 4)).toBe(4);
247
- expect(() => parseSchema(numberSchema, 3)).toThrow("The received value is not an even number");
248
- expect(() => parseSchema(numberSchema, 3)).toThrow(ValidationError);
249
- });
250
- });
251
- //# sourceMappingURL=CommonSchema.test.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../jest/setup.ts","../../src/exceptions.ts","../../src/core.ts","../../src/parseSchema.ts","../../src/asserts/common/equalTo.ts","../../src/schemas/CommonSchema.ts","../../src/schemas/NumberSchema.ts","../../src/asserts/number/index.ts","../../src/schemas/StringSchema.ts","../../src/asserts/string/index.ts","../../src/schemas/BooleanSchema.ts","../../src/asserts/boolean/index.ts","../../src/__tests__/CommonSchema.test.ts"],"sourcesContent":["export type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;\n\nexport function expectEqualTypes<X, Y>(areEqual: Equal<X, Y>): void {\n expect(typeof areEqual).toBe('boolean');\n}\n","export class ValidationError extends Error {\n expected: unknown;\n received: unknown;\n pathToError: string;\n message: string;\n constructor(expected: unknown, received: unknown, pathToError: string, message: string) {\n super();\n this.expected = expected;\n this.received = received;\n this.pathToError = pathToError;\n this.message = message;\n }\n}\n\nexport class BuildSchemaError extends Error {}\n\nexport function throwException(expected: unknown, received: unknown, pathToError: string, message: string): never {\n throw new ValidationError(expected, received, pathToError, message);\n}\n","export const ctxSymbol = Symbol('contextSymbol');\n\nimport { throwException } from './exceptions';\nimport type { CommonSchema } from './schemas/CommonSchema';\n\nexport function innerCheck(schema: CommonSchema, receivedValue: unknown, pathToError: string) {\n const ctx = schema[ctxSymbol];\n if (receivedValue === undefined) {\n if (!ctx.isOptional) throwException('Required', receivedValue, pathToError, 'The required value is missing');\n return receivedValue;\n }\n\n if (receivedValue === null) {\n if (!ctx.isNullable) throwException('Not null', receivedValue, pathToError, 'Value should not be null');\n return receivedValue;\n }\n\n if (ctx.array) {\n if (!Array.isArray(receivedValue))\n throwException('Array', receivedValue, pathToError, 'Expected an array but received a different type');\n const schema = ctx.array;\n\n receivedValue.forEach((elem, i) => {\n innerCheck(schema, elem, `${pathToError}[${i}]`);\n });\n\n return receivedValue;\n }\n\n const typeOfVal = typeof receivedValue;\n\n if (ctx.object) {\n if (typeOfVal !== 'object')\n throwException('Object', receivedValue, pathToError, 'Expected an object but received a different type');\n if (Array.isArray(receivedValue))\n throwException(\n 'Object',\n receivedValue,\n pathToError,\n 'Expected an object but received an array. Invalid type of data',\n );\n const shapeSchema = ctx.object;\n for (const keyPerReceivedValue of Object.keys(receivedValue)) {\n if (shapeSchema[keyPerReceivedValue] === undefined)\n throwException('Not allowed', keyPerReceivedValue, pathToError, 'This key is not allowed in the object');\n }\n\n for (const [keyOfSchema, valueOfSchema] of Object.entries(shapeSchema)) {\n const receivedObjectValuePropery = (receivedValue as Record<string, unknown>)[keyOfSchema];\n if (receivedObjectValuePropery === undefined) {\n if (!valueOfSchema[ctxSymbol].isOptional)\n throwException(\n 'Required',\n receivedObjectValuePropery,\n pathToError,\n 'Missing required property in the object',\n );\n }\n innerCheck(valueOfSchema, receivedObjectValuePropery, `${pathToError}.${keyOfSchema}`);\n }\n\n return receivedValue;\n }\n\n if (ctx.type.length) {\n if (!ctx.type.includes(typeOfVal)) throwException(ctx.type, typeOfVal, pathToError, 'Invalid type of data');\n }\n\n ctx.requiredValidations.forEach((requiredValidation) => {\n requiredValidation(receivedValue, pathToError);\n });\n\n return receivedValue;\n}\n","import { InferType } from './InferType';\nimport { innerCheck } from './core';\nimport { ValidationError } from './exceptions';\nimport { CommonSchema } from './schemas/CommonSchema';\n\n/**\n * Parses and validates a value against the provided schema, returning a type-safe result.\n *\n * This function will throw a `ValidationError` if the value does not conform to the schema.\n * The inferred TypeScript type of the returned value will match the structure defined by the schema.\n *\n * @template T\n * @param {T} schema - The schema to validate the received value against. This schema dictates the expected structure and type of the value.\n * @param {unknown} receivedValue - The value to be validated and parsed according to the schema.\n * @returns {InferType<T>} The validated value, with its TypeScript type inferred from the schema.\n *\n * @throws {ValidationError} If the received value does not match the schema, a `ValidationError` will be thrown.\n * @throws {Error} If an unexpected error occurs during validation, an error will be thrown with a generic message.\n *\n * @example\n * const schema = object({\n * name: string(),\n * age: number(),\n * });\n *\n * const result = parseSchema(schema, { name: 'Alice', age: 30 });\n * // result will be inferred as { name: string; age: number }\n *\n * parseSchema(schema, { name: 'Alice', age: '30' });\n * // Throws ValidationError because 'age' should be a number, not a string.\n */\nexport function parseSchema<T extends CommonSchema>(schema: T, receivedValue: unknown): InferType<T> {\n try {\n return innerCheck(schema, receivedValue, '') as InferType<T>;\n } catch (e) {\n if (e instanceof ValidationError) throw e;\n /* istanbul ignore next */\n throw new Error('Something unexpected happened');\n }\n}\n","import { throwException } from '../../exceptions';\nimport { RequiredValidation } from '../../schemas/CommonSchema';\n\n/**\n * Creates a custom assertion that checks if a value is equal to the expected value.\n *\n * This assertion can be used within a `.custom` method to enforce that a value strictly matches the expected value.\n * It will throw a `ValidationError` if the values are not equal.\n *\n * @param {unknown} expected - The value that the received value is expected to match.\n * @returns {RequiredValidation} A function that takes the received value and the path to the error,\n * and throws a `ValidationError` if the received value does not equal the expected value.\n *\n * @throws {ValidationError} If the received value does not match the expected value.\n *\n * @example\n * import { number, equalTo } from 'bguard';\n *\n * // Define a schema with a custom assertion\n * const schema = number().custom(equalTo(5));\n *\n * // This will pass\n * parseSchema(schema, 5);\n *\n * // This will throw a ValidationError\n * parseSchema(schema, 3);\n */\nexport const equalTo =\n (expected: unknown): RequiredValidation =>\n (received: number, pathToError: string) => {\n if (expected !== received)\n throwException(expected, received, pathToError, 'The received value is not equal to expected');\n };\n","import { ctxSymbol } from '../core';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type RequiredValidation = (received: any, pathToError: string) => void;\nexport type ObjectShapeSchemaType = Record<string, CommonSchema>;\n\nexport type PrimitiveType = 'number' | 'string' | 'boolean' | 'undefined' | 'object' | 'function' | 'symbol' | 'bigint';\nexport interface ValidatorContext {\n type: PrimitiveType[];\n isNullable?: boolean;\n isOptional?: boolean;\n requiredValidations: RequiredValidation[];\n array?: CommonSchema;\n object?: ObjectShapeSchemaType;\n}\n\nexport class CommonSchema {\n [ctxSymbol]: ValidatorContext;\n constructor(ctx: ValidatorContext) {\n this[ctxSymbol] = ctx;\n }\n\n /**\n * @param validators - One or more custom validation functions.\n * @returns {this} The schema instance with the added custom validation.\n */\n custom(...validators: RequiredValidation[]): this {\n this[ctxSymbol].requiredValidations.push(...validators);\n return this;\n }\n\n /**\n * Marks the schema as nullable, allowing the value to be `null`.\n *\n * @returns {WithNull<this>} The schema instance marked as nullable.\n */\n nullable(): WithNull<this> {\n this[ctxSymbol].isNullable = true;\n return this as WithNull<this>;\n }\n\n /**\n * Marks the schema as optional, allowing the value to be `undefined`.\n *\n * @returns {WithUndefined<this>}} The schema instance marked as optional.\n */\n optional(): WithUndefined<this> {\n this[ctxSymbol].isOptional = true;\n return this as WithUndefined<this>;\n }\n}\n\nexport type WithNull<T extends CommonSchema> = T & { validation_null: true };\nexport type WithUndefined<T extends CommonSchema> = T & { validation_undefined: true };\n\ntype TypeMapping = {\n number: number;\n string: string;\n boolean: boolean;\n undefined: undefined;\n object: object;\n // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type\n function: Function;\n symbol: symbol;\n bigint: bigint;\n};\n\nexport type WithMix<Y = unknown> = CommonSchema & { validation_mix: Y };\nexport type ExtractFromMix<T> = T extends WithMix<infer X> ? X : never;\n\nexport type MapMixTypes<T extends PrimitiveType[]> = T extends (infer U)[]\n ? U extends keyof TypeMapping\n ? TypeMapping[U]\n : never\n : never;\n","import { equalTo } from '../asserts/common/equalTo';\n\nimport { CommonSchema } from './CommonSchema';\n\nexport class NumberSchema extends CommonSchema {\n _number = 1;\n\n /**\n * Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.\n *\n * @param expectedValue - The value that the schema must exactly match.\n * @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type\n *\n * @example - number().equalTo(42); // Infers the type 42\n */\n equalTo<Y extends number>(expectedValue: Y): WithNumber<this, Y> {\n return this.custom(equalTo(expectedValue)) as WithNumber<this, Y>;\n }\n}\n\nexport type WithNumber<T extends NumberSchema, Y = number> = T & { validation_number: Y };\nexport type ExtractFromNumber<T> = T extends WithNumber<NumberSchema, infer Y> ? Y : never;\n","import { NumberSchema } from '../../schemas/NumberSchema';\n\n/**\n * Creates a new schema for validating number values.\n *\n * @returns {NumberSchema} A new instance of `NumberSchema` for validating numbers.\n *\n * @example\n * const schema = number();\n * parseSchema(schema, 42); // Validates successfully\n * parseSchema(schema, '42'); // Throws a validation error\n */\nexport function number(): NumberSchema {\n return new NumberSchema({ type: ['number'], requiredValidations: [] });\n}\n","import { equalTo } from '../asserts/common/equalTo';\nimport { CommonSchema } from './CommonSchema';\n\nexport class StringSchema extends CommonSchema {\n _string = 1;\n\n /**\n * Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.\n *\n * @param expectedValue - The value that the schema must exactly match.\n * @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type\n *\n * @example - string().equalTo('hello'); // Infers the type 'hello'\n */\n equalTo<Y extends string>(expectedValue: Y): WithString<this, Y> {\n return this.custom(equalTo(expectedValue)) as WithString<this, Y>;\n }\n}\n\nexport type WithString<T extends StringSchema, Y = string> = T & { validation_string: Y };\nexport type ExtractFromString<T> = T extends WithString<StringSchema, infer Y> ? Y : never;\n","import { StringSchema } from '../../schemas/StringSchema';\n\n/**\n * Creates a new schema for validating string values.\n *\n * @returns {StringSchema} A new instance of `StringSchema` for validating strings.\n *\n * @example\n * const schema = string();\n * parseSchema(schema, 'hello'); // Validates successfully\n * parseSchema(schema, 123); // Throws a validation error\n */\nexport function string(): StringSchema {\n return new StringSchema({ type: ['string'], requiredValidations: [] });\n}\n","import { CommonSchema } from './CommonSchema';\nimport { throwException } from '../exceptions';\n\nconst isBoolean = (expected: boolean) => (received: boolean, pathToError: string) => {\n if (received !== expected) throwException(expected, received, pathToError, `The received value is not ${expected}`);\n};\n\nexport class BooleanSchema extends CommonSchema {\n _boolean = 1;\n\n /**\n * Restricts the schema to exactly match the boolean value true and infers the true value as the TypeScript type.\n *\n * @returns - The schema instance restricted to the value true, with the true value inferred as the TypeScript type\n *\n * @example - boolean().onlyTrue(); // Infers the type true\n */\n onlyTrue(): WithBoolean<this, true> {\n return this.custom(isBoolean(true)) as WithBoolean<this, true>;\n }\n\n /**\n * Restricts the schema to exactly match the boolean value false and infers the false value as the TypeScript type.\n *\n * @returns - The schema instance restricted to the value false, with the false value inferred as the TypeScript type\n *\n * @example - boolean().onlyFalse(); // Infers the type false\n */\n onlyFalse(): WithBoolean<this, false> {\n return this.custom(isBoolean(false)) as WithBoolean<this, false>;\n }\n}\n\nexport type WithBoolean<T extends BooleanSchema, Y = boolean> = T & { validation_boolean: Y };\nexport type ExtractFromBoolean<T> = T extends WithBoolean<BooleanSchema, infer Y> ? Y : never;\n","import { BooleanSchema } from '../../schemas/BooleanSchema';\n\n/**\n * Creates a new schema for validating boolean values.\n *\n * @returns {BooleanSchema} A new instance of `BooleanSchema` for validating booleans.\n *\n * @example\n * const schema = boolean();\n * parseSchema(schema, true); // Validates successfully\n * parseSchema(schema, 'true'); // Throws a validation error\n */\nexport function boolean(): BooleanSchema {\n return new BooleanSchema({ type: ['boolean'], requiredValidations: [] });\n}\n","import { expectEqualTypes } from '../../jest/setup';\nimport { InferType, number, throwException, string, boolean, parseSchema, ValidationError } from '../';\nimport { RequiredValidation } from '../schemas/CommonSchema';\n\ndescribe('CommonSchema', () => {\n it('should be a nullable string', () => {\n const stringOrNullSchema = string().nullable();\n\n expectEqualTypes<string | null, InferType<typeof stringOrNullSchema>>(true);\n expect(parseSchema(stringOrNullSchema, 'this is a string')).toBe('this is a string');\n expect(parseSchema(stringOrNullSchema, null)).toBe(null);\n });\n\n it('should be an optional string', () => {\n const stringOrNullSchema = string().optional();\n\n expectEqualTypes<string | undefined, InferType<typeof stringOrNullSchema>>(true);\n expect(parseSchema(stringOrNullSchema, 'this is a string')).toBe('this is a string');\n expect(parseSchema(stringOrNullSchema, undefined)).toBe(undefined);\n });\n\n it('should be an optional and nullable string', () => {\n const stringOrNullSchema = string().optional().nullable();\n\n expectEqualTypes<string | null | undefined, InferType<typeof stringOrNullSchema>>(true);\n expect(parseSchema(stringOrNullSchema, 'this is a string')).toBe('this is a string');\n expect(parseSchema(stringOrNullSchema, undefined)).toBe(undefined);\n expect(parseSchema(stringOrNullSchema, null)).toBe(null);\n });\n\n it('should fail on required and non nullable field', () => {\n const booleanSchema = boolean();\n\n expectEqualTypes<boolean, InferType<typeof booleanSchema>>(true);\n expect(parseSchema(booleanSchema, true)).toBe(true);\n expect(() => parseSchema(booleanSchema, null)).toThrow('Value should not be null');\n expect(() => parseSchema(booleanSchema, undefined)).toThrow('The required value is missing');\n expect(() => parseSchema(booleanSchema, null)).toThrow(ValidationError);\n expect(() => parseSchema(booleanSchema, undefined)).toThrow(ValidationError);\n });\n\n it('should work with custom assert', () => {\n const even = (): RequiredValidation => (received: number, pathToError: string) => {\n if (received % 2 !== 0) throwException('even', received, pathToError, 'The received value is not an even number');\n };\n\n const numberSchema = number().custom(even());\n\n expectEqualTypes<number, InferType<typeof numberSchema>>(true);\n expect(parseSchema(numberSchema, 4)).toBe(4);\n expect(() => parseSchema(numberSchema, 3)).toThrow('The received value is not an even number');\n expect(() => parseSchema(numberSchema, 3)).toThrow(ValidationError);\n });\n});\n"],"mappings":";AAEO,SAAS,iBAAuB,UAA6B;AAClE,SAAO,OAAO,QAAQ,EAAE,KAAK,SAAS;AACxC;;;ACJO,IAAM,kBAAN,cAA8B,MAAM;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA,YAAY,UAAmB,UAAmB,aAAqB,SAAiB;AACtF,UAAM;AACN,SAAK,WAAW;AAChB,SAAK,WAAW;AAChB,SAAK,cAAc;AACnB,SAAK,UAAU;AAAA,EACjB;AACF;AAIO,SAAS,eAAe,UAAmB,UAAmB,aAAqB,SAAwB;AAChH,QAAM,IAAI,gBAAgB,UAAU,UAAU,aAAa,OAAO;AACpE;;;AClBO,IAAM,YAAY,OAAO,eAAe;AAKxC,SAAS,WAAW,QAAsB,eAAwB,aAAqB;AAC5F,QAAM,MAAM,OAAO,SAAS;AAC5B,MAAI,kBAAkB,QAAW;AAC/B,QAAI,CAAC,IAAI,WAAY,gBAAe,YAAY,eAAe,aAAa,+BAA+B;AAC3G,WAAO;AAAA,EACT;AAEA,MAAI,kBAAkB,MAAM;AAC1B,QAAI,CAAC,IAAI,WAAY,gBAAe,YAAY,eAAe,aAAa,0BAA0B;AACtG,WAAO;AAAA,EACT;AAEA,MAAI,IAAI,OAAO;AACb,QAAI,CAAC,MAAM,QAAQ,aAAa;AAC9B,qBAAe,SAAS,eAAe,aAAa,iDAAiD;AACvG,UAAMA,UAAS,IAAI;AAEnB,kBAAc,QAAQ,CAAC,MAAM,MAAM;AACjC,iBAAWA,SAAQ,MAAM,GAAG,WAAW,IAAI,CAAC,GAAG;AAAA,IACjD,CAAC;AAED,WAAO;AAAA,EACT;AAEA,QAAM,YAAY,OAAO;AAEzB,MAAI,IAAI,QAAQ;AACd,QAAI,cAAc;AAChB,qBAAe,UAAU,eAAe,aAAa,kDAAkD;AACzG,QAAI,MAAM,QAAQ,aAAa;AAC7B;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AACF,UAAM,cAAc,IAAI;AACxB,eAAW,uBAAuB,OAAO,KAAK,aAAa,GAAG;AAC5D,UAAI,YAAY,mBAAmB,MAAM;AACvC,uBAAe,eAAe,qBAAqB,aAAa,uCAAuC;AAAA,IAC3G;AAEA,eAAW,CAAC,aAAa,aAAa,KAAK,OAAO,QAAQ,WAAW,GAAG;AACtE,YAAM,6BAA8B,cAA0C,WAAW;AACzF,UAAI,+BAA+B,QAAW;AAC5C,YAAI,CAAC,cAAc,SAAS,EAAE;AAC5B;AAAA,YACE;AAAA,YACA;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,MACJ;AACA,iBAAW,eAAe,4BAA4B,GAAG,WAAW,IAAI,WAAW,EAAE;AAAA,IACvF;AAEA,WAAO;AAAA,EACT;AAEA,MAAI,IAAI,KAAK,QAAQ;AACnB,QAAI,CAAC,IAAI,KAAK,SAAS,SAAS,EAAG,gBAAe,IAAI,MAAM,WAAW,aAAa,sBAAsB;AAAA,EAC5G;AAEA,MAAI,oBAAoB,QAAQ,CAAC,uBAAuB;AACtD,uBAAmB,eAAe,WAAW;AAAA,EAC/C,CAAC;AAED,SAAO;AACT;;;AC1CO,SAAS,YAAoC,QAAW,eAAsC;AACnG,MAAI;AACF,WAAO,WAAW,QAAQ,eAAe,EAAE;AAAA,EAC7C,SAAS,GAAG;AACV,QAAI,aAAa,gBAAiB,OAAM;AAExC,UAAM,IAAI,MAAM,+BAA+B;AAAA,EACjD;AACF;;;ACZO,IAAM,UACX,CAAC,aACD,CAAC,UAAkB,gBAAwB;AACzC,MAAI,aAAa;AACf,mBAAe,UAAU,UAAU,aAAa,6CAA6C;AACjG;;;AChBK,IAAM,eAAN,MAAmB;AAAA,EACxB,CAAC,SAAS;AAAA,EACV,YAAY,KAAuB;AACjC,SAAK,SAAS,IAAI;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAAU,YAAwC;AAChD,SAAK,SAAS,EAAE,oBAAoB,KAAK,GAAG,UAAU;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAA2B;AACzB,SAAK,SAAS,EAAE,aAAa;AAC7B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAgC;AAC9B,SAAK,SAAS,EAAE,aAAa;AAC7B,WAAO;AAAA,EACT;AACF;;;AC9CO,IAAM,eAAN,cAA2B,aAAa;AAAA,EAC7C,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUV,QAA0B,eAAuC;AAC/D,WAAO,KAAK,OAAO,QAAQ,aAAa,CAAC;AAAA,EAC3C;AACF;;;ACNO,SAAS,SAAuB;AACrC,SAAO,IAAI,aAAa,EAAE,MAAM,CAAC,QAAQ,GAAG,qBAAqB,CAAC,EAAE,CAAC;AACvE;;;ACXO,IAAM,eAAN,cAA2B,aAAa;AAAA,EAC7C,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUV,QAA0B,eAAuC;AAC/D,WAAO,KAAK,OAAO,QAAQ,aAAa,CAAC;AAAA,EAC3C;AACF;;;ACLO,SAAS,SAAuB;AACrC,SAAO,IAAI,aAAa,EAAE,MAAM,CAAC,QAAQ,GAAG,qBAAqB,CAAC,EAAE,CAAC;AACvE;;;ACXA,IAAM,YAAY,CAAC,aAAsB,CAAC,UAAmB,gBAAwB;AACnF,MAAI,aAAa,SAAU,gBAAe,UAAU,UAAU,aAAa,6BAA6B,QAAQ,EAAE;AACpH;AAEO,IAAM,gBAAN,cAA4B,aAAa;AAAA,EAC9C,WAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASX,WAAoC;AAClC,WAAO,KAAK,OAAO,UAAU,IAAI,CAAC;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,YAAsC;AACpC,WAAO,KAAK,OAAO,UAAU,KAAK,CAAC;AAAA,EACrC;AACF;;;ACnBO,SAAS,UAAyB;AACvC,SAAO,IAAI,cAAc,EAAE,MAAM,CAAC,SAAS,GAAG,qBAAqB,CAAC,EAAE,CAAC;AACzE;;;ACVA,SAAS,gBAAgB,MAAM;AAC7B,KAAG,+BAA+B,MAAM;AACtC,UAAM,qBAAqB,OAAO,EAAE,SAAS;AAE7C,qBAAsE,IAAI;AAC1E,WAAO,YAAY,oBAAoB,kBAAkB,CAAC,EAAE,KAAK,kBAAkB;AACnF,WAAO,YAAY,oBAAoB,IAAI,CAAC,EAAE,KAAK,IAAI;AAAA,EACzD,CAAC;AAED,KAAG,gCAAgC,MAAM;AACvC,UAAM,qBAAqB,OAAO,EAAE,SAAS;AAE7C,qBAA2E,IAAI;AAC/E,WAAO,YAAY,oBAAoB,kBAAkB,CAAC,EAAE,KAAK,kBAAkB;AACnF,WAAO,YAAY,oBAAoB,MAAS,CAAC,EAAE,KAAK,MAAS;AAAA,EACnE,CAAC;AAED,KAAG,6CAA6C,MAAM;AACpD,UAAM,qBAAqB,OAAO,EAAE,SAAS,EAAE,SAAS;AAExD,qBAAkF,IAAI;AACtF,WAAO,YAAY,oBAAoB,kBAAkB,CAAC,EAAE,KAAK,kBAAkB;AACnF,WAAO,YAAY,oBAAoB,MAAS,CAAC,EAAE,KAAK,MAAS;AACjE,WAAO,YAAY,oBAAoB,IAAI,CAAC,EAAE,KAAK,IAAI;AAAA,EACzD,CAAC;AAED,KAAG,kDAAkD,MAAM;AACzD,UAAM,gBAAgB,QAAQ;AAE9B,qBAA2D,IAAI;AAC/D,WAAO,YAAY,eAAe,IAAI,CAAC,EAAE,KAAK,IAAI;AAClD,WAAO,MAAM,YAAY,eAAe,IAAI,CAAC,EAAE,QAAQ,0BAA0B;AACjF,WAAO,MAAM,YAAY,eAAe,MAAS,CAAC,EAAE,QAAQ,+BAA+B;AAC3F,WAAO,MAAM,YAAY,eAAe,IAAI,CAAC,EAAE,QAAQ,eAAe;AACtE,WAAO,MAAM,YAAY,eAAe,MAAS,CAAC,EAAE,QAAQ,eAAe;AAAA,EAC7E,CAAC;AAED,KAAG,kCAAkC,MAAM;AACzC,UAAM,OAAO,MAA0B,CAAC,UAAkB,gBAAwB;AAChF,UAAI,WAAW,MAAM,EAAG,gBAAe,QAAQ,UAAU,aAAa,0CAA0C;AAAA,IAClH;AAEA,UAAM,eAAe,OAAO,EAAE,OAAO,KAAK,CAAC;AAE3C,qBAAyD,IAAI;AAC7D,WAAO,YAAY,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC;AAC3C,WAAO,MAAM,YAAY,cAAc,CAAC,CAAC,EAAE,QAAQ,0CAA0C;AAC7F,WAAO,MAAM,YAAY,cAAc,CAAC,CAAC,EAAE,QAAQ,eAAe;AAAA,EACpE,CAAC;AACH,CAAC;","names":["schema"]}
@@ -1,2 +0,0 @@
1
-
2
- export { }
@@ -1,2 +0,0 @@
1
-
2
- export { }