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.
- package/lib/InferType.js +1 -19
- package/lib/InferType.js.map +1 -1
- package/lib/asserts/array/index.js +7 -86
- package/lib/asserts/array/index.js.map +1 -1
- package/lib/asserts/array/index.mjs +7 -59
- package/lib/asserts/array/index.mjs.map +1 -1
- package/lib/asserts/boolean/index.js +7 -114
- package/lib/asserts/boolean/index.js.map +1 -1
- package/lib/asserts/boolean/index.mjs +7 -87
- package/lib/asserts/boolean/index.mjs.map +1 -1
- package/lib/asserts/common/equalTo.js +4 -50
- package/lib/asserts/common/equalTo.js.map +1 -1
- package/lib/asserts/common/equalTo.mjs +4 -23
- package/lib/asserts/common/equalTo.mjs.map +1 -1
- package/lib/asserts/common/index.js +6 -68
- package/lib/asserts/common/index.js.map +1 -1
- package/lib/asserts/common/index.mjs +6 -41
- package/lib/asserts/common/index.mjs.map +1 -1
- package/lib/asserts/number/index.js +8 -108
- package/lib/asserts/number/index.js.map +1 -1
- package/lib/asserts/number/index.mjs +8 -81
- package/lib/asserts/number/index.mjs.map +1 -1
- package/lib/asserts/number/max.js +6 -47
- package/lib/asserts/number/max.js.map +1 -1
- package/lib/asserts/number/max.mjs +3 -17
- package/lib/asserts/number/max.mjs.map +1 -1
- package/lib/asserts/number/maxExcluded.js +6 -47
- package/lib/asserts/number/maxExcluded.js.map +1 -1
- package/lib/asserts/number/maxExcluded.mjs +3 -17
- package/lib/asserts/number/maxExcluded.mjs.map +1 -1
- package/lib/asserts/number/min.js +6 -47
- package/lib/asserts/number/min.js.map +1 -1
- package/lib/asserts/number/min.mjs +3 -17
- package/lib/asserts/number/min.mjs.map +1 -1
- package/lib/asserts/number/minExcluded.js +6 -47
- package/lib/asserts/number/minExcluded.js.map +1 -1
- package/lib/asserts/number/minExcluded.mjs +3 -17
- package/lib/asserts/number/minExcluded.mjs.map +1 -1
- package/lib/asserts/number/negative.js +6 -47
- package/lib/asserts/number/negative.js.map +1 -1
- package/lib/asserts/number/negative.mjs +3 -17
- package/lib/asserts/number/negative.mjs.map +1 -1
- package/lib/asserts/number/positive.js +6 -47
- package/lib/asserts/number/positive.js.map +1 -1
- package/lib/asserts/number/positive.mjs +3 -17
- package/lib/asserts/number/positive.mjs.map +1 -1
- package/lib/asserts/object/index.js +7 -90
- package/lib/asserts/object/index.js.map +1 -1
- package/lib/asserts/object/index.mjs +7 -63
- package/lib/asserts/object/index.mjs.map +1 -1
- package/lib/asserts/string/email.js +6 -47
- package/lib/asserts/string/email.js.map +1 -1
- package/lib/asserts/string/email.mjs +3 -17
- package/lib/asserts/string/email.mjs.map +1 -1
- package/lib/asserts/string/index.js +8 -108
- package/lib/asserts/string/index.js.map +1 -1
- package/lib/asserts/string/index.mjs +8 -81
- package/lib/asserts/string/index.mjs.map +1 -1
- package/lib/asserts/string/maxLength.js +6 -47
- package/lib/asserts/string/maxLength.js.map +1 -1
- package/lib/asserts/string/maxLength.mjs +3 -17
- package/lib/asserts/string/maxLength.mjs.map +1 -1
- package/lib/asserts/string/minLength.js +6 -47
- package/lib/asserts/string/minLength.js.map +1 -1
- package/lib/asserts/string/minLength.mjs +3 -17
- package/lib/asserts/string/minLength.mjs.map +1 -1
- package/lib/asserts/string/regExp.js +6 -47
- package/lib/asserts/string/regExp.js.map +1 -1
- package/lib/asserts/string/regExp.mjs +3 -17
- package/lib/asserts/string/regExp.mjs.map +1 -1
- package/lib/chunk-2AP4OQMT.js +26 -0
- package/lib/chunk-2AP4OQMT.js.map +1 -0
- package/lib/chunk-32IQXZRK.mjs +13 -0
- package/lib/chunk-32IQXZRK.mjs.map +1 -0
- package/lib/chunk-3FEJUC3K.mjs +13 -0
- package/lib/chunk-3FEJUC3K.mjs.map +1 -0
- package/lib/chunk-5NCJN6D2.js +70 -0
- package/lib/chunk-5NCJN6D2.js.map +1 -0
- package/lib/chunk-5ZMICHV3.js +21 -0
- package/lib/chunk-5ZMICHV3.js.map +1 -0
- package/lib/chunk-63IQFNFO.mjs +27 -0
- package/lib/chunk-63IQFNFO.mjs.map +1 -0
- package/lib/chunk-A2SAWKJA.mjs +13 -0
- package/lib/chunk-A2SAWKJA.mjs.map +1 -0
- package/lib/chunk-A3UTB4RE.mjs +28 -0
- package/lib/chunk-A3UTB4RE.mjs.map +1 -0
- package/lib/chunk-A7I2JEQO.js +13 -0
- package/lib/chunk-A7I2JEQO.js.map +1 -0
- package/lib/chunk-AJ4WV5DG.mjs +13 -0
- package/lib/chunk-AJ4WV5DG.mjs.map +1 -0
- package/lib/chunk-APTTIN2L.js +42 -0
- package/lib/chunk-APTTIN2L.js.map +1 -0
- package/lib/chunk-AXOP6HPJ.js +14 -0
- package/lib/chunk-AXOP6HPJ.js.map +1 -0
- package/lib/chunk-BGMR7A6X.mjs +13 -0
- package/lib/chunk-BGMR7A6X.mjs.map +1 -0
- package/lib/chunk-FCFO5J5Y.mjs +14 -0
- package/lib/chunk-FCFO5J5Y.mjs.map +1 -0
- package/lib/chunk-GEZME6V2.mjs +39 -0
- package/lib/chunk-GEZME6V2.mjs.map +1 -0
- package/lib/chunk-GNBSKTFV.js +27 -0
- package/lib/chunk-GNBSKTFV.js.map +1 -0
- package/lib/chunk-IQ3QYABE.js +32 -0
- package/lib/chunk-IQ3QYABE.js.map +1 -0
- package/lib/chunk-K2S3FS5K.js +13 -0
- package/lib/chunk-K2S3FS5K.js.map +1 -0
- package/lib/chunk-KCBOOOTF.mjs +13 -0
- package/lib/chunk-KCBOOOTF.mjs.map +1 -0
- package/lib/chunk-L6A7NXUJ.js +13 -0
- package/lib/chunk-L6A7NXUJ.js.map +1 -0
- package/lib/chunk-L7HUXYFV.mjs +42 -0
- package/lib/chunk-L7HUXYFV.mjs.map +1 -0
- package/lib/chunk-LHTJHMKJ.mjs +27 -0
- package/lib/chunk-LHTJHMKJ.mjs.map +1 -0
- package/lib/chunk-NOADI6PO.mjs +21 -0
- package/lib/chunk-NOADI6PO.mjs.map +1 -0
- package/lib/chunk-NWY33MFU.js +13 -0
- package/lib/chunk-NWY33MFU.js.map +1 -0
- package/lib/chunk-P3Y6IWFA.mjs +70 -0
- package/lib/chunk-P3Y6IWFA.mjs.map +1 -0
- package/lib/chunk-PDVXBE27.js +27 -0
- package/lib/chunk-PDVXBE27.js.map +1 -0
- package/lib/chunk-PJP63SJT.js +13 -0
- package/lib/chunk-PJP63SJT.js.map +1 -0
- package/lib/chunk-QJOXKH7A.mjs +26 -0
- package/lib/chunk-QJOXKH7A.mjs.map +1 -0
- package/lib/chunk-QKGQ4XZC.js +13 -0
- package/lib/chunk-QKGQ4XZC.js.map +1 -0
- package/lib/chunk-QYLH5ZAC.mjs +32 -0
- package/lib/chunk-QYLH5ZAC.mjs.map +1 -0
- package/lib/chunk-VPFIIM2X.js +39 -0
- package/lib/chunk-VPFIIM2X.js.map +1 -0
- package/lib/chunk-YXHH5BF6.js +28 -0
- package/lib/chunk-YXHH5BF6.js.map +1 -0
- package/lib/core.js +6 -107
- package/lib/core.js.map +1 -1
- package/lib/core.mjs +5 -78
- package/lib/core.mjs.map +1 -1
- package/lib/exceptions.js +9 -50
- package/lib/exceptions.js.map +1 -1
- package/lib/exceptions.mjs +5 -19
- package/lib/exceptions.mjs.map +1 -1
- package/lib/index.js +29 -283
- package/lib/index.js.map +1 -1
- package/lib/index.mjs +34 -252
- package/lib/index.mjs.map +1 -1
- package/lib/parseSchema.js +5 -115
- package/lib/parseSchema.js.map +1 -1
- package/lib/parseSchema.mjs +5 -88
- package/lib/parseSchema.mjs.map +1 -1
- package/lib/schemas/ArraySchema.js +6 -81
- package/lib/schemas/ArraySchema.js.map +1 -1
- package/lib/schemas/ArraySchema.mjs +6 -54
- package/lib/schemas/ArraySchema.mjs.map +1 -1
- package/lib/schemas/BooleanSchema.js +6 -109
- package/lib/schemas/BooleanSchema.js.map +1 -1
- package/lib/schemas/BooleanSchema.mjs +6 -82
- package/lib/schemas/BooleanSchema.mjs.map +1 -1
- package/lib/schemas/CommonSchema.js +5 -63
- package/lib/schemas/CommonSchema.js.map +1 -1
- package/lib/schemas/CommonSchema.mjs +5 -36
- package/lib/schemas/CommonSchema.mjs.map +1 -1
- package/lib/schemas/NumberSchema.js +7 -103
- package/lib/schemas/NumberSchema.js.map +1 -1
- package/lib/schemas/NumberSchema.mjs +7 -76
- package/lib/schemas/NumberSchema.mjs.map +1 -1
- package/lib/schemas/ObjectSchema.js +6 -85
- package/lib/schemas/ObjectSchema.js.map +1 -1
- package/lib/schemas/ObjectSchema.mjs +6 -58
- package/lib/schemas/ObjectSchema.mjs.map +1 -1
- package/lib/schemas/StringSchema.js +7 -103
- package/lib/schemas/StringSchema.js.map +1 -1
- package/lib/schemas/StringSchema.mjs +7 -76
- package/lib/schemas/StringSchema.mjs.map +1 -1
- package/package.json +15 -14
- package/lib/__tests__/ArraySchema.test.d.mts +0 -2
- package/lib/__tests__/ArraySchema.test.d.ts +0 -2
- package/lib/__tests__/ArraySchema.test.js +0 -201
- package/lib/__tests__/ArraySchema.test.js.map +0 -1
- package/lib/__tests__/ArraySchema.test.mjs +0 -199
- package/lib/__tests__/ArraySchema.test.mjs.map +0 -1
- package/lib/__tests__/BooleanSchema.test.d.mts +0 -2
- package/lib/__tests__/BooleanSchema.test.d.ts +0 -2
- package/lib/__tests__/BooleanSchema.test.js +0 -219
- package/lib/__tests__/BooleanSchema.test.js.map +0 -1
- package/lib/__tests__/BooleanSchema.test.mjs +0 -217
- package/lib/__tests__/BooleanSchema.test.mjs.map +0 -1
- package/lib/__tests__/CommonSchema.test.d.mts +0 -2
- package/lib/__tests__/CommonSchema.test.d.ts +0 -2
- package/lib/__tests__/CommonSchema.test.js +0 -253
- package/lib/__tests__/CommonSchema.test.js.map +0 -1
- package/lib/__tests__/CommonSchema.test.mjs +0 -251
- package/lib/__tests__/CommonSchema.test.mjs.map +0 -1
- package/lib/__tests__/MixTypes.test.d.mts +0 -2
- package/lib/__tests__/MixTypes.test.d.ts +0 -2
- package/lib/__tests__/MixTypes.test.js +0 -165
- package/lib/__tests__/MixTypes.test.js.map +0 -1
- package/lib/__tests__/MixTypes.test.mjs +0 -163
- package/lib/__tests__/MixTypes.test.mjs.map +0 -1
- package/lib/__tests__/NumberSchema.test.d.mts +0 -2
- package/lib/__tests__/NumberSchema.test.d.ts +0 -2
- package/lib/__tests__/NumberSchema.test.js +0 -253
- package/lib/__tests__/NumberSchema.test.js.map +0 -1
- package/lib/__tests__/NumberSchema.test.mjs +0 -251
- package/lib/__tests__/NumberSchema.test.mjs.map +0 -1
- package/lib/__tests__/ObjectSchema.test.d.mts +0 -2
- package/lib/__tests__/ObjectSchema.test.d.ts +0 -2
- package/lib/__tests__/ObjectSchema.test.js +0 -356
- package/lib/__tests__/ObjectSchema.test.js.map +0 -1
- package/lib/__tests__/ObjectSchema.test.mjs +0 -354
- package/lib/__tests__/ObjectSchema.test.mjs.map +0 -1
- package/lib/__tests__/StringSchema.test.d.mts +0 -2
- package/lib/__tests__/StringSchema.test.d.ts +0 -2
- package/lib/__tests__/StringSchema.test.js +0 -228
- package/lib/__tests__/StringSchema.test.js.map +0 -1
- package/lib/__tests__/StringSchema.test.mjs +0 -226
- package/lib/__tests__/StringSchema.test.mjs.map +0 -1
|
@@ -1,79 +1,10 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
super();
|
|
9
|
-
this.expected = expected;
|
|
10
|
-
this.received = received;
|
|
11
|
-
this.pathToError = pathToError;
|
|
12
|
-
this.message = message;
|
|
13
|
-
}
|
|
14
|
-
};
|
|
15
|
-
function throwException(expected, received, pathToError, message) {
|
|
16
|
-
throw new ValidationError(expected, received, pathToError, message);
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
// src/asserts/common/equalTo.ts
|
|
20
|
-
var equalTo = (expected) => (received, pathToError) => {
|
|
21
|
-
if (expected !== received)
|
|
22
|
-
throwException(expected, received, pathToError, "The received value is not equal to expected");
|
|
23
|
-
};
|
|
24
|
-
|
|
25
|
-
// src/core.ts
|
|
26
|
-
var ctxSymbol = Symbol("contextSymbol");
|
|
27
|
-
|
|
28
|
-
// src/schemas/CommonSchema.ts
|
|
29
|
-
var CommonSchema = class {
|
|
30
|
-
[ctxSymbol];
|
|
31
|
-
constructor(ctx) {
|
|
32
|
-
this[ctxSymbol] = ctx;
|
|
33
|
-
}
|
|
34
|
-
/**
|
|
35
|
-
* @param validators - One or more custom validation functions.
|
|
36
|
-
* @returns {this} The schema instance with the added custom validation.
|
|
37
|
-
*/
|
|
38
|
-
custom(...validators) {
|
|
39
|
-
this[ctxSymbol].requiredValidations.push(...validators);
|
|
40
|
-
return this;
|
|
41
|
-
}
|
|
42
|
-
/**
|
|
43
|
-
* Marks the schema as nullable, allowing the value to be `null`.
|
|
44
|
-
*
|
|
45
|
-
* @returns {WithNull<this>} The schema instance marked as nullable.
|
|
46
|
-
*/
|
|
47
|
-
nullable() {
|
|
48
|
-
this[ctxSymbol].isNullable = true;
|
|
49
|
-
return this;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Marks the schema as optional, allowing the value to be `undefined`.
|
|
53
|
-
*
|
|
54
|
-
* @returns {WithUndefined<this>}} The schema instance marked as optional.
|
|
55
|
-
*/
|
|
56
|
-
optional() {
|
|
57
|
-
this[ctxSymbol].isOptional = true;
|
|
58
|
-
return this;
|
|
59
|
-
}
|
|
60
|
-
};
|
|
61
|
-
|
|
62
|
-
// src/schemas/StringSchema.ts
|
|
63
|
-
var StringSchema = class extends CommonSchema {
|
|
64
|
-
_string = 1;
|
|
65
|
-
/**
|
|
66
|
-
* Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.
|
|
67
|
-
*
|
|
68
|
-
* @param expectedValue - The value that the schema must exactly match.
|
|
69
|
-
* @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type
|
|
70
|
-
*
|
|
71
|
-
* @example - string().equalTo('hello'); // Infers the type 'hello'
|
|
72
|
-
*/
|
|
73
|
-
equalTo(expectedValue) {
|
|
74
|
-
return this.custom(equalTo(expectedValue));
|
|
75
|
-
}
|
|
76
|
-
};
|
|
1
|
+
import {
|
|
2
|
+
StringSchema
|
|
3
|
+
} from "../chunk-LHTJHMKJ.mjs";
|
|
4
|
+
import "../chunk-FCFO5J5Y.mjs";
|
|
5
|
+
import "../chunk-L7HUXYFV.mjs";
|
|
6
|
+
import "../chunk-P3Y6IWFA.mjs";
|
|
7
|
+
import "../chunk-QJOXKH7A.mjs";
|
|
77
8
|
export {
|
|
78
9
|
StringSchema
|
|
79
10
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":[
|
|
1
|
+
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "bguard",
|
|
3
3
|
"private": false,
|
|
4
4
|
"license": "MIT",
|
|
5
|
-
"version": "0.0.
|
|
5
|
+
"version": "0.0.7",
|
|
6
6
|
"main": "lib/index.js",
|
|
7
7
|
"module": "lib/index.mjs",
|
|
8
8
|
"types": "lib/index.d.ts",
|
|
@@ -78,9 +78,10 @@
|
|
|
78
78
|
},
|
|
79
79
|
"tsup": {
|
|
80
80
|
"entry": [
|
|
81
|
-
"src/**"
|
|
81
|
+
"src/**",
|
|
82
|
+
"!src/__tests__/**"
|
|
82
83
|
],
|
|
83
|
-
"splitting":
|
|
84
|
+
"splitting": true,
|
|
84
85
|
"sourcemap": true,
|
|
85
86
|
"clean": true,
|
|
86
87
|
"outDir": "./lib",
|
|
@@ -97,32 +98,32 @@
|
|
|
97
98
|
"types": "./lib/index.d.ts"
|
|
98
99
|
},
|
|
99
100
|
"./string/*": {
|
|
100
|
-
"import": "./lib/asserts/string/*.
|
|
101
|
+
"import": "./lib/asserts/string/*.mjs",
|
|
101
102
|
"require": "./lib/asserts/string/*.js",
|
|
102
|
-
"types": "./lib/asserts/
|
|
103
|
+
"types": "./lib/asserts/string/*.d.ts"
|
|
103
104
|
},
|
|
104
105
|
"./boolean/*": {
|
|
105
|
-
"import": "./lib/asserts/boolean/*.
|
|
106
|
+
"import": "./lib/asserts/boolean/*.mjs",
|
|
106
107
|
"require": "./lib/asserts/boolean/*.js",
|
|
107
|
-
"types": "./lib/
|
|
108
|
+
"types": "./lib/asserts/boolean/*.d.ts"
|
|
108
109
|
},
|
|
109
110
|
"./number/*": {
|
|
110
|
-
"import": "./lib/asserts/number/*.
|
|
111
|
+
"import": "./lib/asserts/number/*.mjs",
|
|
111
112
|
"require": "./lib/asserts/number/*.js",
|
|
112
|
-
"types": "./lib/asserts/
|
|
113
|
+
"types": "./lib/asserts/number/*.d.ts"
|
|
113
114
|
},
|
|
114
115
|
"./array/*": {
|
|
115
|
-
"import": "./lib/asserts/array/*.
|
|
116
|
+
"import": "./lib/asserts/array/*.mjs",
|
|
116
117
|
"require": "./lib/asserts/array/*.js",
|
|
117
|
-
"types": "./lib/asserts/
|
|
118
|
+
"types": "./lib/asserts/array/*.d.ts"
|
|
118
119
|
},
|
|
119
120
|
"./object/*": {
|
|
120
|
-
"import": "./lib/asserts/object/*.
|
|
121
|
+
"import": "./lib/asserts/object/*.mjs",
|
|
121
122
|
"require": "./lib/asserts/object/*.js",
|
|
122
|
-
"types": "./lib/asserts/
|
|
123
|
+
"types": "./lib/asserts/object/*.d.ts"
|
|
123
124
|
},
|
|
124
125
|
"./common/*": {
|
|
125
|
-
"import": "./lib/asserts/common/*.
|
|
126
|
+
"import": "./lib/asserts/common/*.mjs",
|
|
126
127
|
"require": "./lib/asserts/common/*.js",
|
|
127
128
|
"types": "./lib/asserts/common/*.d.ts"
|
|
128
129
|
}
|
|
@@ -1,201 +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
|
-
var BuildSchemaError = class extends Error {
|
|
23
|
-
};
|
|
24
|
-
function throwException(expected, received, pathToError, message) {
|
|
25
|
-
throw new ValidationError(expected, received, pathToError, message);
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
// src/core.ts
|
|
29
|
-
var ctxSymbol = Symbol("contextSymbol");
|
|
30
|
-
function innerCheck(schema, receivedValue, pathToError) {
|
|
31
|
-
const ctx = schema[ctxSymbol];
|
|
32
|
-
if (receivedValue === void 0) {
|
|
33
|
-
if (!ctx.isOptional) throwException("Required", receivedValue, pathToError, "The required value is missing");
|
|
34
|
-
return receivedValue;
|
|
35
|
-
}
|
|
36
|
-
if (receivedValue === null) {
|
|
37
|
-
if (!ctx.isNullable) throwException("Not null", receivedValue, pathToError, "Value should not be null");
|
|
38
|
-
return receivedValue;
|
|
39
|
-
}
|
|
40
|
-
if (ctx.array) {
|
|
41
|
-
if (!Array.isArray(receivedValue))
|
|
42
|
-
throwException("Array", receivedValue, pathToError, "Expected an array but received a different type");
|
|
43
|
-
const schema2 = ctx.array;
|
|
44
|
-
receivedValue.forEach((elem, i) => {
|
|
45
|
-
innerCheck(schema2, elem, `${pathToError}[${i}]`);
|
|
46
|
-
});
|
|
47
|
-
return receivedValue;
|
|
48
|
-
}
|
|
49
|
-
const typeOfVal = typeof receivedValue;
|
|
50
|
-
if (ctx.object) {
|
|
51
|
-
if (typeOfVal !== "object")
|
|
52
|
-
throwException("Object", receivedValue, pathToError, "Expected an object but received a different type");
|
|
53
|
-
if (Array.isArray(receivedValue))
|
|
54
|
-
throwException(
|
|
55
|
-
"Object",
|
|
56
|
-
receivedValue,
|
|
57
|
-
pathToError,
|
|
58
|
-
"Expected an object but received an array. Invalid type of data"
|
|
59
|
-
);
|
|
60
|
-
const shapeSchema = ctx.object;
|
|
61
|
-
for (const keyPerReceivedValue of Object.keys(receivedValue)) {
|
|
62
|
-
if (shapeSchema[keyPerReceivedValue] === void 0)
|
|
63
|
-
throwException("Not allowed", keyPerReceivedValue, pathToError, "This key is not allowed in the object");
|
|
64
|
-
}
|
|
65
|
-
for (const [keyOfSchema, valueOfSchema] of Object.entries(shapeSchema)) {
|
|
66
|
-
const receivedObjectValuePropery = receivedValue[keyOfSchema];
|
|
67
|
-
if (receivedObjectValuePropery === void 0) {
|
|
68
|
-
if (!valueOfSchema[ctxSymbol].isOptional)
|
|
69
|
-
throwException(
|
|
70
|
-
"Required",
|
|
71
|
-
receivedObjectValuePropery,
|
|
72
|
-
pathToError,
|
|
73
|
-
"Missing required property in the object"
|
|
74
|
-
);
|
|
75
|
-
}
|
|
76
|
-
innerCheck(valueOfSchema, receivedObjectValuePropery, `${pathToError}.${keyOfSchema}`);
|
|
77
|
-
}
|
|
78
|
-
return receivedValue;
|
|
79
|
-
}
|
|
80
|
-
if (ctx.type.length) {
|
|
81
|
-
if (!ctx.type.includes(typeOfVal)) throwException(ctx.type, typeOfVal, pathToError, "Invalid type of data");
|
|
82
|
-
}
|
|
83
|
-
ctx.requiredValidations.forEach((requiredValidation) => {
|
|
84
|
-
requiredValidation(receivedValue, pathToError);
|
|
85
|
-
});
|
|
86
|
-
return receivedValue;
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
// src/parseSchema.ts
|
|
90
|
-
function parseSchema(schema, receivedValue) {
|
|
91
|
-
try {
|
|
92
|
-
return innerCheck(schema, receivedValue, "");
|
|
93
|
-
} catch (e) {
|
|
94
|
-
if (e instanceof ValidationError) throw e;
|
|
95
|
-
throw new Error("Something unexpected happened");
|
|
96
|
-
}
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
// src/asserts/common/equalTo.ts
|
|
100
|
-
var equalTo = (expected) => (received, pathToError) => {
|
|
101
|
-
if (expected !== received)
|
|
102
|
-
throwException(expected, received, pathToError, "The received value is not equal to expected");
|
|
103
|
-
};
|
|
104
|
-
|
|
105
|
-
// src/schemas/CommonSchema.ts
|
|
106
|
-
var CommonSchema = class {
|
|
107
|
-
[ctxSymbol];
|
|
108
|
-
constructor(ctx) {
|
|
109
|
-
this[ctxSymbol] = ctx;
|
|
110
|
-
}
|
|
111
|
-
/**
|
|
112
|
-
* @param validators - One or more custom validation functions.
|
|
113
|
-
* @returns {this} The schema instance with the added custom validation.
|
|
114
|
-
*/
|
|
115
|
-
custom(...validators) {
|
|
116
|
-
this[ctxSymbol].requiredValidations.push(...validators);
|
|
117
|
-
return this;
|
|
118
|
-
}
|
|
119
|
-
/**
|
|
120
|
-
* Marks the schema as nullable, allowing the value to be `null`.
|
|
121
|
-
*
|
|
122
|
-
* @returns {WithNull<this>} The schema instance marked as nullable.
|
|
123
|
-
*/
|
|
124
|
-
nullable() {
|
|
125
|
-
this[ctxSymbol].isNullable = true;
|
|
126
|
-
return this;
|
|
127
|
-
}
|
|
128
|
-
/**
|
|
129
|
-
* Marks the schema as optional, allowing the value to be `undefined`.
|
|
130
|
-
*
|
|
131
|
-
* @returns {WithUndefined<this>}} The schema instance marked as optional.
|
|
132
|
-
*/
|
|
133
|
-
optional() {
|
|
134
|
-
this[ctxSymbol].isOptional = true;
|
|
135
|
-
return this;
|
|
136
|
-
}
|
|
137
|
-
};
|
|
138
|
-
|
|
139
|
-
// src/schemas/NumberSchema.ts
|
|
140
|
-
var NumberSchema = class extends CommonSchema {
|
|
141
|
-
_number = 1;
|
|
142
|
-
/**
|
|
143
|
-
* Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.
|
|
144
|
-
*
|
|
145
|
-
* @param expectedValue - The value that the schema must exactly match.
|
|
146
|
-
* @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type
|
|
147
|
-
*
|
|
148
|
-
* @example - number().equalTo(42); // Infers the type 42
|
|
149
|
-
*/
|
|
150
|
-
equalTo(expectedValue) {
|
|
151
|
-
return this.custom(equalTo(expectedValue));
|
|
152
|
-
}
|
|
153
|
-
};
|
|
154
|
-
|
|
155
|
-
// src/asserts/number/index.ts
|
|
156
|
-
function number() {
|
|
157
|
-
return new NumberSchema({ type: ["number"], requiredValidations: [] });
|
|
158
|
-
}
|
|
159
|
-
|
|
160
|
-
// src/schemas/ArraySchema.ts
|
|
161
|
-
var ArraySchema = class extends CommonSchema {
|
|
162
|
-
_array = 1;
|
|
163
|
-
constructor(ctx, arraySchema) {
|
|
164
|
-
super(ctx);
|
|
165
|
-
this.validateArrayEntry(arraySchema);
|
|
166
|
-
this[ctxSymbol].array = arraySchema;
|
|
167
|
-
}
|
|
168
|
-
validateArrayEntry(arraySchema) {
|
|
169
|
-
if (!arraySchema) throw new BuildSchemaError("Missing schema in array method");
|
|
170
|
-
if (!(arraySchema instanceof CommonSchema)) throw new BuildSchemaError("Invalid schema in array method");
|
|
171
|
-
}
|
|
172
|
-
};
|
|
173
|
-
|
|
174
|
-
// src/asserts/array/index.ts
|
|
175
|
-
function array(arraySchema) {
|
|
176
|
-
return new ArraySchema({ type: [], requiredValidations: [] }, arraySchema);
|
|
177
|
-
}
|
|
178
|
-
|
|
179
|
-
// src/__tests__/ArraySchema.test.ts
|
|
180
|
-
describe("ArraySchema", () => {
|
|
181
|
-
it("should be an array", () => {
|
|
182
|
-
const arrayOfNumbersSchema = array(number());
|
|
183
|
-
expectEqualTypes(true);
|
|
184
|
-
const myArray = [1, 2, 3];
|
|
185
|
-
expect(parseSchema(arrayOfNumbersSchema, myArray)).toBe(myArray);
|
|
186
|
-
expect(() => parseSchema(arrayOfNumbersSchema, 1)).toThrow("Expected an array but received a different type");
|
|
187
|
-
});
|
|
188
|
-
it("should not build with missing parameters", () => {
|
|
189
|
-
const invalidArraySchemaFunction = () => array();
|
|
190
|
-
expectEqualTypes(true);
|
|
191
|
-
expect(invalidArraySchemaFunction).toThrow("Missing schema in array method");
|
|
192
|
-
expect(invalidArraySchemaFunction).toThrow(BuildSchemaError);
|
|
193
|
-
});
|
|
194
|
-
it("should not build with invalid parameters", () => {
|
|
195
|
-
const invalidArraySchemaFunction = () => array("not a bguard schema");
|
|
196
|
-
expectEqualTypes(true);
|
|
197
|
-
expect(invalidArraySchemaFunction).toThrow("Invalid schema in array method");
|
|
198
|
-
expect(invalidArraySchemaFunction).toThrow(BuildSchemaError);
|
|
199
|
-
});
|
|
200
|
-
});
|
|
201
|
-
//# sourceMappingURL=ArraySchema.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/ArraySchema.ts","../../src/asserts/array/index.ts","../../src/__tests__/ArraySchema.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 { ctxSymbol } from '../core';\nimport { BuildSchemaError } from '../exceptions';\nimport { CommonSchema, ValidatorContext } from './CommonSchema';\n\nexport class ArraySchema extends CommonSchema {\n _array = 1;\n constructor(ctx: ValidatorContext, arraySchema: CommonSchema) {\n super(ctx);\n this.validateArrayEntry(arraySchema);\n this[ctxSymbol].array = arraySchema;\n }\n\n private validateArrayEntry(arraySchema: CommonSchema) {\n if (!arraySchema) throw new BuildSchemaError('Missing schema in array method');\n if (!(arraySchema instanceof CommonSchema)) throw new BuildSchemaError('Invalid schema in array method');\n }\n}\n\nexport type WithArray<Y extends CommonSchema> = ArraySchema & { validation_array: Y };\nexport type ExtractFromArray<T> = T extends WithArray<infer X> ? X : never;\n","import { ArraySchema, WithArray } from '../../schemas/ArraySchema';\nimport { CommonSchema } from '../../schemas/CommonSchema';\n\n/**\n * Creates a new schema for validating arrays where each element must match the specified schema.\n *\n * @template T\n * @param {T} arraySchema - The schema that each element of the array must match.\n * @returns {WithArray<T>} A new instance of `ArraySchema` for validating arrays of elements that match the specified schema.\n *\n * @example\n * const schema = array(string());\n * parseSchema(schema, ['hello', 'world']); // Validates successfully\n * parseSchema(schema, ['hello', 123]); // Throws a validation error\n */\nexport function array<T extends CommonSchema>(arraySchema: T): WithArray<T> {\n return new ArraySchema({ type: [], requiredValidations: [] }, arraySchema) as WithArray<T>;\n}\n","import { expectEqualTypes } from '../../jest/setup';\nimport { BuildSchemaError } from '../exceptions';\nimport { parseSchema, InferType, array, number } from '../';\n\ndescribe('ArraySchema', () => {\n it('should be an array', () => {\n const arrayOfNumbersSchema = array(number());\n expectEqualTypes<number[], InferType<typeof arrayOfNumbersSchema>>(true);\n const myArray = [1, 2, 3];\n expect(parseSchema(arrayOfNumbersSchema, myArray)).toBe(myArray);\n expect(() => parseSchema(arrayOfNumbersSchema, 1)).toThrow('Expected an array but received a different type');\n });\n\n it('should not build with missing parameters', () => {\n //@ts-expect-error testing missing parameters in runtime\n const invalidArraySchemaFunction = () => array();\n expectEqualTypes<unknown[], InferType<ReturnType<typeof invalidArraySchemaFunction>>>(true);\n expect(invalidArraySchemaFunction).toThrow('Missing schema in array method');\n expect(invalidArraySchemaFunction).toThrow(BuildSchemaError);\n });\n\n it('should not build with invalid parameters', () => {\n //@ts-expect-error testing invalid schema in runtime\n const invalidArraySchemaFunction = () => array('not a bguard schema');\n expectEqualTypes<unknown[], InferType<ReturnType<typeof invalidArraySchemaFunction>>>(true);\n expect(invalidArraySchemaFunction).toThrow('Invalid schema in array method');\n expect(invalidArraySchemaFunction).toThrow(BuildSchemaError);\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;AAEO,IAAM,mBAAN,cAA+B,MAAM;AAAC;AAEtC,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;;;ACVO,IAAM,cAAN,cAA0B,aAAa;AAAA,EAC5C,SAAS;AAAA,EACT,YAAY,KAAuB,aAA2B;AAC5D,UAAM,GAAG;AACT,SAAK,mBAAmB,WAAW;AACnC,SAAK,SAAS,EAAE,QAAQ;AAAA,EAC1B;AAAA,EAEQ,mBAAmB,aAA2B;AACpD,QAAI,CAAC,YAAa,OAAM,IAAI,iBAAiB,gCAAgC;AAC7E,QAAI,EAAE,uBAAuB,cAAe,OAAM,IAAI,iBAAiB,gCAAgC;AAAA,EACzG;AACF;;;ACDO,SAAS,MAA8B,aAA8B;AAC1E,SAAO,IAAI,YAAY,EAAE,MAAM,CAAC,GAAG,qBAAqB,CAAC,EAAE,GAAG,WAAW;AAC3E;;;ACbA,SAAS,eAAe,MAAM;AAC5B,KAAG,sBAAsB,MAAM;AAC7B,UAAM,uBAAuB,MAAM,OAAO,CAAC;AAC3C,qBAAmE,IAAI;AACvE,UAAM,UAAU,CAAC,GAAG,GAAG,CAAC;AACxB,WAAO,YAAY,sBAAsB,OAAO,CAAC,EAAE,KAAK,OAAO;AAC/D,WAAO,MAAM,YAAY,sBAAsB,CAAC,CAAC,EAAE,QAAQ,iDAAiD;AAAA,EAC9G,CAAC;AAED,KAAG,4CAA4C,MAAM;AAEnD,UAAM,6BAA6B,MAAM,MAAM;AAC/C,qBAAsF,IAAI;AAC1F,WAAO,0BAA0B,EAAE,QAAQ,gCAAgC;AAC3E,WAAO,0BAA0B,EAAE,QAAQ,gBAAgB;AAAA,EAC7D,CAAC;AAED,KAAG,4CAA4C,MAAM;AAEnD,UAAM,6BAA6B,MAAM,MAAM,qBAAqB;AACpE,qBAAsF,IAAI;AAC1F,WAAO,0BAA0B,EAAE,QAAQ,gCAAgC;AAC3E,WAAO,0BAA0B,EAAE,QAAQ,gBAAgB;AAAA,EAC7D,CAAC;AACH,CAAC;","names":["schema"]}
|
|
@@ -1,199 +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
|
-
var BuildSchemaError = class extends Error {
|
|
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/ArraySchema.ts
|
|
159
|
-
var ArraySchema = class extends CommonSchema {
|
|
160
|
-
_array = 1;
|
|
161
|
-
constructor(ctx, arraySchema) {
|
|
162
|
-
super(ctx);
|
|
163
|
-
this.validateArrayEntry(arraySchema);
|
|
164
|
-
this[ctxSymbol].array = arraySchema;
|
|
165
|
-
}
|
|
166
|
-
validateArrayEntry(arraySchema) {
|
|
167
|
-
if (!arraySchema) throw new BuildSchemaError("Missing schema in array method");
|
|
168
|
-
if (!(arraySchema instanceof CommonSchema)) throw new BuildSchemaError("Invalid schema in array method");
|
|
169
|
-
}
|
|
170
|
-
};
|
|
171
|
-
|
|
172
|
-
// src/asserts/array/index.ts
|
|
173
|
-
function array(arraySchema) {
|
|
174
|
-
return new ArraySchema({ type: [], requiredValidations: [] }, arraySchema);
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
// src/__tests__/ArraySchema.test.ts
|
|
178
|
-
describe("ArraySchema", () => {
|
|
179
|
-
it("should be an array", () => {
|
|
180
|
-
const arrayOfNumbersSchema = array(number());
|
|
181
|
-
expectEqualTypes(true);
|
|
182
|
-
const myArray = [1, 2, 3];
|
|
183
|
-
expect(parseSchema(arrayOfNumbersSchema, myArray)).toBe(myArray);
|
|
184
|
-
expect(() => parseSchema(arrayOfNumbersSchema, 1)).toThrow("Expected an array but received a different type");
|
|
185
|
-
});
|
|
186
|
-
it("should not build with missing parameters", () => {
|
|
187
|
-
const invalidArraySchemaFunction = () => array();
|
|
188
|
-
expectEqualTypes(true);
|
|
189
|
-
expect(invalidArraySchemaFunction).toThrow("Missing schema in array method");
|
|
190
|
-
expect(invalidArraySchemaFunction).toThrow(BuildSchemaError);
|
|
191
|
-
});
|
|
192
|
-
it("should not build with invalid parameters", () => {
|
|
193
|
-
const invalidArraySchemaFunction = () => array("not a bguard schema");
|
|
194
|
-
expectEqualTypes(true);
|
|
195
|
-
expect(invalidArraySchemaFunction).toThrow("Invalid schema in array method");
|
|
196
|
-
expect(invalidArraySchemaFunction).toThrow(BuildSchemaError);
|
|
197
|
-
});
|
|
198
|
-
});
|
|
199
|
-
//# sourceMappingURL=ArraySchema.test.mjs.map
|