bguard 0.0.3 → 0.0.5
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/{CommonSchema-DeTBsQhn.d.mts → CommonSchema-BIe85W_A.d.mts} +3 -1
- package/lib/{CommonSchema-DeTBsQhn.d.ts → CommonSchema-BIe85W_A.d.ts} +3 -1
- package/lib/InferType.d.mts +18 -0
- package/lib/InferType.d.ts +18 -0
- package/lib/InferType.js +19 -0
- package/lib/InferType.js.map +1 -0
- package/lib/InferType.mjs +1 -0
- package/lib/InferType.mjs.map +1 -0
- package/lib/__tests__/ArraySchema.test.d.mts +2 -0
- package/lib/__tests__/ArraySchema.test.d.ts +2 -0
- package/lib/__tests__/ArraySchema.test.js +201 -0
- package/lib/__tests__/ArraySchema.test.js.map +1 -0
- package/lib/__tests__/ArraySchema.test.mjs +199 -0
- package/lib/__tests__/ArraySchema.test.mjs.map +1 -0
- package/lib/__tests__/BooleanSchema.test.d.mts +2 -0
- package/lib/__tests__/BooleanSchema.test.d.ts +2 -0
- package/lib/__tests__/BooleanSchema.test.js +219 -0
- package/lib/__tests__/BooleanSchema.test.js.map +1 -0
- package/lib/__tests__/BooleanSchema.test.mjs +217 -0
- package/lib/__tests__/BooleanSchema.test.mjs.map +1 -0
- package/lib/__tests__/CommonSchema.test.d.mts +2 -0
- package/lib/__tests__/CommonSchema.test.d.ts +2 -0
- package/lib/__tests__/CommonSchema.test.js +253 -0
- package/lib/__tests__/CommonSchema.test.js.map +1 -0
- package/lib/__tests__/CommonSchema.test.mjs +251 -0
- package/lib/__tests__/CommonSchema.test.mjs.map +1 -0
- package/lib/__tests__/MixTypes.test.d.mts +2 -0
- package/lib/__tests__/MixTypes.test.d.ts +2 -0
- package/lib/__tests__/MixTypes.test.js +165 -0
- package/lib/__tests__/MixTypes.test.js.map +1 -0
- package/lib/__tests__/MixTypes.test.mjs +163 -0
- package/lib/__tests__/MixTypes.test.mjs.map +1 -0
- package/lib/__tests__/NumberSchema.test.d.mts +2 -0
- package/lib/__tests__/NumberSchema.test.d.ts +2 -0
- package/lib/__tests__/NumberSchema.test.js +253 -0
- package/lib/__tests__/NumberSchema.test.js.map +1 -0
- package/lib/__tests__/NumberSchema.test.mjs +251 -0
- package/lib/__tests__/NumberSchema.test.mjs.map +1 -0
- package/lib/__tests__/ObjectSchema.test.d.mts +2 -0
- package/lib/__tests__/ObjectSchema.test.d.ts +2 -0
- package/lib/__tests__/ObjectSchema.test.js +356 -0
- package/lib/__tests__/ObjectSchema.test.js.map +1 -0
- package/lib/__tests__/ObjectSchema.test.mjs +354 -0
- package/lib/__tests__/ObjectSchema.test.mjs.map +1 -0
- package/lib/__tests__/StringSchema.test.d.mts +2 -0
- package/lib/__tests__/StringSchema.test.d.ts +2 -0
- package/lib/__tests__/StringSchema.test.js +228 -0
- package/lib/__tests__/StringSchema.test.js.map +1 -0
- package/lib/__tests__/StringSchema.test.mjs +226 -0
- package/lib/__tests__/StringSchema.test.mjs.map +1 -0
- package/lib/asserts/array/index.d.mts +18 -2
- package/lib/asserts/array/index.d.ts +18 -2
- package/lib/asserts/boolean/index.d.mts +16 -2
- package/lib/asserts/boolean/index.d.ts +16 -2
- package/lib/asserts/common/equalTo.d.mts +1 -1
- package/lib/asserts/common/equalTo.d.ts +1 -1
- package/lib/asserts/common/index.d.mts +1 -1
- package/lib/asserts/common/index.d.ts +1 -1
- package/lib/asserts/number/index.d.mts +16 -2
- package/lib/asserts/number/index.d.ts +16 -2
- package/lib/asserts/number/max.d.mts +1 -1
- package/lib/asserts/number/max.d.ts +1 -1
- package/lib/asserts/number/maxExcluded.d.mts +1 -1
- package/lib/asserts/number/maxExcluded.d.ts +1 -1
- package/lib/asserts/number/min.d.mts +1 -1
- package/lib/asserts/number/min.d.ts +1 -1
- package/lib/asserts/number/minExcluded.d.mts +1 -1
- package/lib/asserts/number/minExcluded.d.ts +1 -1
- package/lib/asserts/number/negative.d.mts +1 -1
- package/lib/asserts/number/negative.d.ts +1 -1
- package/lib/asserts/number/positive.d.mts +1 -1
- package/lib/asserts/number/positive.d.ts +1 -1
- package/lib/asserts/object/index.d.mts +21 -2
- package/lib/asserts/object/index.d.ts +21 -2
- package/lib/asserts/string/email.d.mts +1 -1
- package/lib/asserts/string/email.d.ts +1 -1
- package/lib/asserts/string/index.d.mts +16 -2
- package/lib/asserts/string/index.d.ts +16 -2
- package/lib/asserts/string/maxLength.d.mts +1 -1
- package/lib/asserts/string/maxLength.d.ts +1 -1
- package/lib/asserts/string/minLength.d.mts +1 -1
- package/lib/asserts/string/minLength.d.ts +1 -1
- package/lib/asserts/string/regExp.d.mts +1 -1
- package/lib/asserts/string/regExp.d.ts +1 -1
- package/lib/core.d.mts +1 -0
- package/lib/core.d.ts +1 -0
- package/lib/core.js +111 -0
- package/lib/core.js.map +1 -0
- package/lib/core.mjs +83 -0
- package/lib/core.mjs.map +1 -0
- package/lib/exceptions.d.mts +12 -0
- package/lib/exceptions.d.ts +12 -0
- package/lib/exceptions.js +52 -0
- package/lib/exceptions.js.map +1 -0
- package/lib/exceptions.mjs +25 -0
- package/lib/exceptions.mjs.map +1 -0
- package/lib/index.d.mts +14 -51
- package/lib/index.d.ts +14 -51
- package/lib/index.js +8 -2
- package/lib/index.js.map +1 -1
- package/lib/index.mjs +4 -1
- package/lib/parseSchema.d.mts +37 -0
- package/lib/parseSchema.d.ts +37 -0
- package/lib/parseSchema.js +119 -0
- package/lib/parseSchema.js.map +1 -0
- package/lib/parseSchema.mjs +92 -0
- package/lib/parseSchema.mjs.map +1 -0
- package/lib/schemas/ArraySchema.d.mts +13 -0
- package/lib/schemas/ArraySchema.d.ts +13 -0
- package/lib/schemas/ArraySchema.js +85 -0
- package/lib/schemas/ArraySchema.js.map +1 -0
- package/lib/schemas/ArraySchema.mjs +58 -0
- package/lib/schemas/ArraySchema.mjs.map +1 -0
- package/lib/{index-nzqBrOHf.d.mts → schemas/BooleanSchema.d.mts} +2 -14
- package/lib/{index-B1yBez0g.d.ts → schemas/BooleanSchema.d.ts} +2 -14
- package/lib/schemas/BooleanSchema.js +113 -0
- package/lib/schemas/BooleanSchema.js.map +1 -0
- package/lib/schemas/BooleanSchema.mjs +86 -0
- package/lib/schemas/BooleanSchema.mjs.map +1 -0
- package/lib/schemas/CommonSchema.d.mts +1 -0
- package/lib/schemas/CommonSchema.d.ts +1 -0
- package/lib/schemas/CommonSchema.js +67 -0
- package/lib/schemas/CommonSchema.js.map +1 -0
- package/lib/schemas/CommonSchema.mjs +40 -0
- package/lib/schemas/CommonSchema.mjs.map +1 -0
- package/lib/{index-B63cXDOm.d.mts → schemas/NumberSchema.d.mts} +2 -14
- package/lib/{index-CK_g_aEC.d.ts → schemas/NumberSchema.d.ts} +2 -14
- package/lib/schemas/NumberSchema.js +107 -0
- package/lib/schemas/NumberSchema.js.map +1 -0
- package/lib/schemas/NumberSchema.mjs +80 -0
- package/lib/schemas/NumberSchema.mjs.map +1 -0
- package/lib/schemas/ObjectSchema.d.mts +12 -0
- package/lib/schemas/ObjectSchema.d.ts +12 -0
- package/lib/schemas/ObjectSchema.js +89 -0
- package/lib/schemas/ObjectSchema.js.map +1 -0
- package/lib/schemas/ObjectSchema.mjs +62 -0
- package/lib/schemas/ObjectSchema.mjs.map +1 -0
- package/lib/{index-aBEYpJdZ.d.mts → schemas/StringSchema.d.mts} +2 -14
- package/lib/{index-BEyBEBSm.d.ts → schemas/StringSchema.d.ts} +2 -14
- package/lib/schemas/StringSchema.js +107 -0
- package/lib/schemas/StringSchema.js.map +1 -0
- package/lib/schemas/StringSchema.mjs +80 -0
- package/lib/schemas/StringSchema.mjs.map +1 -0
- package/package.json +46 -9
- package/lib/index-D3R2euaT.d.mts +0 -29
- package/lib/index-DPkImfCy.d.ts +0 -29
- package/lib/index-DitgsWDO.d.ts +0 -27
- package/lib/index-T3KBmyyn.d.mts +0 -27
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/schemas/NumberSchema.ts
|
|
21
|
+
var NumberSchema_exports = {};
|
|
22
|
+
__export(NumberSchema_exports, {
|
|
23
|
+
NumberSchema: () => NumberSchema
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(NumberSchema_exports);
|
|
26
|
+
|
|
27
|
+
// src/exceptions.ts
|
|
28
|
+
var ValidationError = class extends Error {
|
|
29
|
+
expected;
|
|
30
|
+
received;
|
|
31
|
+
pathToError;
|
|
32
|
+
message;
|
|
33
|
+
constructor(expected, received, pathToError, message) {
|
|
34
|
+
super();
|
|
35
|
+
this.expected = expected;
|
|
36
|
+
this.received = received;
|
|
37
|
+
this.pathToError = pathToError;
|
|
38
|
+
this.message = message;
|
|
39
|
+
}
|
|
40
|
+
};
|
|
41
|
+
function throwException(expected, received, pathToError, message) {
|
|
42
|
+
throw new ValidationError(expected, received, pathToError, message);
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
// src/asserts/common/equalTo.ts
|
|
46
|
+
var equalTo = (expected) => (received, pathToError) => {
|
|
47
|
+
if (expected !== received)
|
|
48
|
+
throwException(expected, received, pathToError, "The received value is not equal to expected");
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
// src/core.ts
|
|
52
|
+
var ctxSymbol = Symbol("contextSymbol");
|
|
53
|
+
|
|
54
|
+
// src/schemas/CommonSchema.ts
|
|
55
|
+
var CommonSchema = class {
|
|
56
|
+
[ctxSymbol];
|
|
57
|
+
constructor(ctx) {
|
|
58
|
+
this[ctxSymbol] = ctx;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* @param validators - One or more custom validation functions.
|
|
62
|
+
* @returns {this} The schema instance with the added custom validation.
|
|
63
|
+
*/
|
|
64
|
+
custom(...validators) {
|
|
65
|
+
this[ctxSymbol].requiredValidations.push(...validators);
|
|
66
|
+
return this;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Marks the schema as nullable, allowing the value to be `null`.
|
|
70
|
+
*
|
|
71
|
+
* @returns {WithNull<this>} The schema instance marked as nullable.
|
|
72
|
+
*/
|
|
73
|
+
nullable() {
|
|
74
|
+
this[ctxSymbol].isNullable = true;
|
|
75
|
+
return this;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Marks the schema as optional, allowing the value to be `undefined`.
|
|
79
|
+
*
|
|
80
|
+
* @returns {WithUndefined<this>}} The schema instance marked as optional.
|
|
81
|
+
*/
|
|
82
|
+
optional() {
|
|
83
|
+
this[ctxSymbol].isOptional = true;
|
|
84
|
+
return this;
|
|
85
|
+
}
|
|
86
|
+
};
|
|
87
|
+
|
|
88
|
+
// src/schemas/NumberSchema.ts
|
|
89
|
+
var NumberSchema = class extends CommonSchema {
|
|
90
|
+
_number = 1;
|
|
91
|
+
/**
|
|
92
|
+
* Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.
|
|
93
|
+
*
|
|
94
|
+
* @param expectedValue - The value that the schema must exactly match.
|
|
95
|
+
* @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type
|
|
96
|
+
*
|
|
97
|
+
* @example - number().equalTo(42); // Infers the type 42
|
|
98
|
+
*/
|
|
99
|
+
equalTo(expectedValue) {
|
|
100
|
+
return this.custom(equalTo(expectedValue));
|
|
101
|
+
}
|
|
102
|
+
};
|
|
103
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
104
|
+
0 && (module.exports = {
|
|
105
|
+
NumberSchema
|
|
106
|
+
});
|
|
107
|
+
//# sourceMappingURL=NumberSchema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/schemas/NumberSchema.ts","../../src/exceptions.ts","../../src/asserts/common/equalTo.ts","../../src/core.ts","../../src/schemas/CommonSchema.ts"],"sourcesContent":["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","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","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","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 { 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"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAO,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;;;ACSO,IAAM,UACX,CAAC,aACD,CAAC,UAAkB,gBAAwB;AACzC,MAAI,aAAa;AACf,mBAAe,UAAU,UAAU,aAAa,6CAA6C;AACjG;;;AChCK,IAAM,YAAY,OAAO,eAAe;;;ACgBxC,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;;;AJ9CO,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;","names":[]}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
// src/exceptions.ts
|
|
2
|
+
var ValidationError = class extends Error {
|
|
3
|
+
expected;
|
|
4
|
+
received;
|
|
5
|
+
pathToError;
|
|
6
|
+
message;
|
|
7
|
+
constructor(expected, received, pathToError, message) {
|
|
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/NumberSchema.ts
|
|
63
|
+
var NumberSchema = class extends CommonSchema {
|
|
64
|
+
_number = 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 - number().equalTo(42); // Infers the type 42
|
|
72
|
+
*/
|
|
73
|
+
equalTo(expectedValue) {
|
|
74
|
+
return this.custom(equalTo(expectedValue));
|
|
75
|
+
}
|
|
76
|
+
};
|
|
77
|
+
export {
|
|
78
|
+
NumberSchema
|
|
79
|
+
};
|
|
80
|
+
//# sourceMappingURL=NumberSchema.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/exceptions.ts","../../src/asserts/common/equalTo.ts","../../src/core.ts","../../src/schemas/CommonSchema.ts","../../src/schemas/NumberSchema.ts"],"sourcesContent":["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","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","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 { 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"],"mappings":";AAAO,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;;;ACSO,IAAM,UACX,CAAC,aACD,CAAC,UAAkB,gBAAwB;AACzC,MAAI,aAAa;AACf,mBAAe,UAAU,UAAU,aAAa,6CAA6C;AACjG;;;AChCK,IAAM,YAAY,OAAO,eAAe;;;ACgBxC,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;","names":[]}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { C as CommonSchema, V as ValidatorContext, O as ObjectShapeSchemaType } from '../CommonSchema-BIe85W_A.mjs';
|
|
2
|
+
|
|
3
|
+
declare class ObjectSchema extends CommonSchema {
|
|
4
|
+
_object: number;
|
|
5
|
+
constructor(ctx: ValidatorContext, shapeSchema: ObjectShapeSchemaType);
|
|
6
|
+
private validateObjectEntry;
|
|
7
|
+
}
|
|
8
|
+
type WithObject<Y extends ObjectShapeSchemaType> = ObjectSchema & {
|
|
9
|
+
validation_object: Y;
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
export { ObjectSchema, type WithObject };
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { C as CommonSchema, V as ValidatorContext, O as ObjectShapeSchemaType } from '../CommonSchema-BIe85W_A.js';
|
|
2
|
+
|
|
3
|
+
declare class ObjectSchema extends CommonSchema {
|
|
4
|
+
_object: number;
|
|
5
|
+
constructor(ctx: ValidatorContext, shapeSchema: ObjectShapeSchemaType);
|
|
6
|
+
private validateObjectEntry;
|
|
7
|
+
}
|
|
8
|
+
type WithObject<Y extends ObjectShapeSchemaType> = ObjectSchema & {
|
|
9
|
+
validation_object: Y;
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
export { ObjectSchema, type WithObject };
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/schemas/ObjectSchema.ts
|
|
21
|
+
var ObjectSchema_exports = {};
|
|
22
|
+
__export(ObjectSchema_exports, {
|
|
23
|
+
ObjectSchema: () => ObjectSchema
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(ObjectSchema_exports);
|
|
26
|
+
|
|
27
|
+
// src/exceptions.ts
|
|
28
|
+
var BuildSchemaError = class extends Error {
|
|
29
|
+
};
|
|
30
|
+
|
|
31
|
+
// src/core.ts
|
|
32
|
+
var ctxSymbol = Symbol("contextSymbol");
|
|
33
|
+
|
|
34
|
+
// src/schemas/CommonSchema.ts
|
|
35
|
+
var CommonSchema = class {
|
|
36
|
+
[ctxSymbol];
|
|
37
|
+
constructor(ctx) {
|
|
38
|
+
this[ctxSymbol] = ctx;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* @param validators - One or more custom validation functions.
|
|
42
|
+
* @returns {this} The schema instance with the added custom validation.
|
|
43
|
+
*/
|
|
44
|
+
custom(...validators) {
|
|
45
|
+
this[ctxSymbol].requiredValidations.push(...validators);
|
|
46
|
+
return this;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Marks the schema as nullable, allowing the value to be `null`.
|
|
50
|
+
*
|
|
51
|
+
* @returns {WithNull<this>} The schema instance marked as nullable.
|
|
52
|
+
*/
|
|
53
|
+
nullable() {
|
|
54
|
+
this[ctxSymbol].isNullable = true;
|
|
55
|
+
return this;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Marks the schema as optional, allowing the value to be `undefined`.
|
|
59
|
+
*
|
|
60
|
+
* @returns {WithUndefined<this>}} The schema instance marked as optional.
|
|
61
|
+
*/
|
|
62
|
+
optional() {
|
|
63
|
+
this[ctxSymbol].isOptional = true;
|
|
64
|
+
return this;
|
|
65
|
+
}
|
|
66
|
+
};
|
|
67
|
+
|
|
68
|
+
// src/schemas/ObjectSchema.ts
|
|
69
|
+
var ObjectSchema = class extends CommonSchema {
|
|
70
|
+
_object = 1;
|
|
71
|
+
constructor(ctx, shapeSchema) {
|
|
72
|
+
super(ctx);
|
|
73
|
+
this.validateObjectEntry(shapeSchema);
|
|
74
|
+
this[ctxSymbol].object = shapeSchema;
|
|
75
|
+
}
|
|
76
|
+
validateObjectEntry(shapeSchema) {
|
|
77
|
+
if (!shapeSchema) throw new BuildSchemaError("Missing schema in object method");
|
|
78
|
+
if (shapeSchema instanceof CommonSchema) throw new BuildSchemaError("Invalid schema in object");
|
|
79
|
+
for (const [key, value] of Object.entries(shapeSchema)) {
|
|
80
|
+
if (!(value instanceof CommonSchema))
|
|
81
|
+
throw new BuildSchemaError(`Invalid schema in object method for property '${key}'`);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
};
|
|
85
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
86
|
+
0 && (module.exports = {
|
|
87
|
+
ObjectSchema
|
|
88
|
+
});
|
|
89
|
+
//# sourceMappingURL=ObjectSchema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/schemas/ObjectSchema.ts","../../src/exceptions.ts","../../src/core.ts","../../src/schemas/CommonSchema.ts"],"sourcesContent":["import { ctxSymbol } from '../core';\nimport { BuildSchemaError } from '../exceptions';\nimport { CommonSchema, ObjectShapeSchemaType, ValidatorContext } from './CommonSchema';\n\nexport class ObjectSchema extends CommonSchema {\n _object = 1;\n constructor(ctx: ValidatorContext, shapeSchema: ObjectShapeSchemaType) {\n super(ctx);\n this.validateObjectEntry(shapeSchema);\n this[ctxSymbol].object = shapeSchema;\n }\n\n private validateObjectEntry(shapeSchema: ObjectShapeSchemaType) {\n if (!shapeSchema) throw new BuildSchemaError('Missing schema in object method');\n if (shapeSchema instanceof CommonSchema) throw new BuildSchemaError('Invalid schema in object');\n for (const [key, value] of Object.entries(shapeSchema)) {\n if (!(value instanceof CommonSchema))\n throw new BuildSchemaError(`Invalid schema in object method for property '${key}'`);\n }\n }\n}\n\nexport type WithObject<Y extends ObjectShapeSchemaType> = ObjectSchema & { validation_object: Y };\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 { 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"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACcO,IAAM,mBAAN,cAA+B,MAAM;AAAC;;;ACdtC,IAAM,YAAY,OAAO,eAAe;;;ACgBxC,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;;;AH9CO,IAAM,eAAN,cAA2B,aAAa;AAAA,EAC7C,UAAU;AAAA,EACV,YAAY,KAAuB,aAAoC;AACrE,UAAM,GAAG;AACT,SAAK,oBAAoB,WAAW;AACpC,SAAK,SAAS,EAAE,SAAS;AAAA,EAC3B;AAAA,EAEQ,oBAAoB,aAAoC;AAC9D,QAAI,CAAC,YAAa,OAAM,IAAI,iBAAiB,iCAAiC;AAC9E,QAAI,uBAAuB,aAAc,OAAM,IAAI,iBAAiB,0BAA0B;AAC9F,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,WAAW,GAAG;AACtD,UAAI,EAAE,iBAAiB;AACrB,cAAM,IAAI,iBAAiB,iDAAiD,GAAG,GAAG;AAAA,IACtF;AAAA,EACF;AACF;","names":[]}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
// src/exceptions.ts
|
|
2
|
+
var BuildSchemaError = class extends Error {
|
|
3
|
+
};
|
|
4
|
+
|
|
5
|
+
// src/core.ts
|
|
6
|
+
var ctxSymbol = Symbol("contextSymbol");
|
|
7
|
+
|
|
8
|
+
// src/schemas/CommonSchema.ts
|
|
9
|
+
var CommonSchema = class {
|
|
10
|
+
[ctxSymbol];
|
|
11
|
+
constructor(ctx) {
|
|
12
|
+
this[ctxSymbol] = ctx;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @param validators - One or more custom validation functions.
|
|
16
|
+
* @returns {this} The schema instance with the added custom validation.
|
|
17
|
+
*/
|
|
18
|
+
custom(...validators) {
|
|
19
|
+
this[ctxSymbol].requiredValidations.push(...validators);
|
|
20
|
+
return this;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Marks the schema as nullable, allowing the value to be `null`.
|
|
24
|
+
*
|
|
25
|
+
* @returns {WithNull<this>} The schema instance marked as nullable.
|
|
26
|
+
*/
|
|
27
|
+
nullable() {
|
|
28
|
+
this[ctxSymbol].isNullable = true;
|
|
29
|
+
return this;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Marks the schema as optional, allowing the value to be `undefined`.
|
|
33
|
+
*
|
|
34
|
+
* @returns {WithUndefined<this>}} The schema instance marked as optional.
|
|
35
|
+
*/
|
|
36
|
+
optional() {
|
|
37
|
+
this[ctxSymbol].isOptional = true;
|
|
38
|
+
return this;
|
|
39
|
+
}
|
|
40
|
+
};
|
|
41
|
+
|
|
42
|
+
// src/schemas/ObjectSchema.ts
|
|
43
|
+
var ObjectSchema = class extends CommonSchema {
|
|
44
|
+
_object = 1;
|
|
45
|
+
constructor(ctx, shapeSchema) {
|
|
46
|
+
super(ctx);
|
|
47
|
+
this.validateObjectEntry(shapeSchema);
|
|
48
|
+
this[ctxSymbol].object = shapeSchema;
|
|
49
|
+
}
|
|
50
|
+
validateObjectEntry(shapeSchema) {
|
|
51
|
+
if (!shapeSchema) throw new BuildSchemaError("Missing schema in object method");
|
|
52
|
+
if (shapeSchema instanceof CommonSchema) throw new BuildSchemaError("Invalid schema in object");
|
|
53
|
+
for (const [key, value] of Object.entries(shapeSchema)) {
|
|
54
|
+
if (!(value instanceof CommonSchema))
|
|
55
|
+
throw new BuildSchemaError(`Invalid schema in object method for property '${key}'`);
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
};
|
|
59
|
+
export {
|
|
60
|
+
ObjectSchema
|
|
61
|
+
};
|
|
62
|
+
//# sourceMappingURL=ObjectSchema.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/exceptions.ts","../../src/core.ts","../../src/schemas/CommonSchema.ts","../../src/schemas/ObjectSchema.ts"],"sourcesContent":["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 { 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 { ctxSymbol } from '../core';\nimport { BuildSchemaError } from '../exceptions';\nimport { CommonSchema, ObjectShapeSchemaType, ValidatorContext } from './CommonSchema';\n\nexport class ObjectSchema extends CommonSchema {\n _object = 1;\n constructor(ctx: ValidatorContext, shapeSchema: ObjectShapeSchemaType) {\n super(ctx);\n this.validateObjectEntry(shapeSchema);\n this[ctxSymbol].object = shapeSchema;\n }\n\n private validateObjectEntry(shapeSchema: ObjectShapeSchemaType) {\n if (!shapeSchema) throw new BuildSchemaError('Missing schema in object method');\n if (shapeSchema instanceof CommonSchema) throw new BuildSchemaError('Invalid schema in object');\n for (const [key, value] of Object.entries(shapeSchema)) {\n if (!(value instanceof CommonSchema))\n throw new BuildSchemaError(`Invalid schema in object method for property '${key}'`);\n }\n }\n}\n\nexport type WithObject<Y extends ObjectShapeSchemaType> = ObjectSchema & { validation_object: Y };\n"],"mappings":";AAcO,IAAM,mBAAN,cAA+B,MAAM;AAAC;;;ACdtC,IAAM,YAAY,OAAO,eAAe;;;ACgBxC,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,EACV,YAAY,KAAuB,aAAoC;AACrE,UAAM,GAAG;AACT,SAAK,oBAAoB,WAAW;AACpC,SAAK,SAAS,EAAE,SAAS;AAAA,EAC3B;AAAA,EAEQ,oBAAoB,aAAoC;AAC9D,QAAI,CAAC,YAAa,OAAM,IAAI,iBAAiB,iCAAiC;AAC9E,QAAI,uBAAuB,aAAc,OAAM,IAAI,iBAAiB,0BAA0B;AAC9F,eAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,WAAW,GAAG;AACtD,UAAI,EAAE,iBAAiB;AACrB,cAAM,IAAI,iBAAiB,iDAAiD,GAAG,GAAG;AAAA,IACtF;AAAA,EACF;AACF;","names":[]}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { C as CommonSchema } from '
|
|
1
|
+
import { C as CommonSchema } from '../CommonSchema-BIe85W_A.mjs';
|
|
2
2
|
|
|
3
3
|
declare class StringSchema extends CommonSchema {
|
|
4
4
|
_string: number;
|
|
@@ -17,16 +17,4 @@ type WithString<T extends StringSchema, Y = string> = T & {
|
|
|
17
17
|
};
|
|
18
18
|
type ExtractFromString<T> = T extends WithString<StringSchema, infer Y> ? Y : never;
|
|
19
19
|
|
|
20
|
-
|
|
21
|
-
* Creates a new schema for validating string values.
|
|
22
|
-
*
|
|
23
|
-
* @returns {StringSchema} A new instance of `StringSchema` for validating strings.
|
|
24
|
-
*
|
|
25
|
-
* @example
|
|
26
|
-
* const schema = string();
|
|
27
|
-
* parseSchema(schema, 'hello'); // Validates successfully
|
|
28
|
-
* parseSchema(schema, 123); // Throws a validation error
|
|
29
|
-
*/
|
|
30
|
-
declare function string(): StringSchema;
|
|
31
|
-
|
|
32
|
-
export { type ExtractFromString as E, StringSchema as S, type WithString as W, string as s };
|
|
20
|
+
export { type ExtractFromString, StringSchema, type WithString };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { C as CommonSchema } from '
|
|
1
|
+
import { C as CommonSchema } from '../CommonSchema-BIe85W_A.js';
|
|
2
2
|
|
|
3
3
|
declare class StringSchema extends CommonSchema {
|
|
4
4
|
_string: number;
|
|
@@ -17,16 +17,4 @@ type WithString<T extends StringSchema, Y = string> = T & {
|
|
|
17
17
|
};
|
|
18
18
|
type ExtractFromString<T> = T extends WithString<StringSchema, infer Y> ? Y : never;
|
|
19
19
|
|
|
20
|
-
|
|
21
|
-
* Creates a new schema for validating string values.
|
|
22
|
-
*
|
|
23
|
-
* @returns {StringSchema} A new instance of `StringSchema` for validating strings.
|
|
24
|
-
*
|
|
25
|
-
* @example
|
|
26
|
-
* const schema = string();
|
|
27
|
-
* parseSchema(schema, 'hello'); // Validates successfully
|
|
28
|
-
* parseSchema(schema, 123); // Throws a validation error
|
|
29
|
-
*/
|
|
30
|
-
declare function string(): StringSchema;
|
|
31
|
-
|
|
32
|
-
export { type ExtractFromString as E, StringSchema as S, type WithString as W, string as s };
|
|
20
|
+
export { type ExtractFromString, StringSchema, type WithString };
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/schemas/StringSchema.ts
|
|
21
|
+
var StringSchema_exports = {};
|
|
22
|
+
__export(StringSchema_exports, {
|
|
23
|
+
StringSchema: () => StringSchema
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(StringSchema_exports);
|
|
26
|
+
|
|
27
|
+
// src/exceptions.ts
|
|
28
|
+
var ValidationError = class extends Error {
|
|
29
|
+
expected;
|
|
30
|
+
received;
|
|
31
|
+
pathToError;
|
|
32
|
+
message;
|
|
33
|
+
constructor(expected, received, pathToError, message) {
|
|
34
|
+
super();
|
|
35
|
+
this.expected = expected;
|
|
36
|
+
this.received = received;
|
|
37
|
+
this.pathToError = pathToError;
|
|
38
|
+
this.message = message;
|
|
39
|
+
}
|
|
40
|
+
};
|
|
41
|
+
function throwException(expected, received, pathToError, message) {
|
|
42
|
+
throw new ValidationError(expected, received, pathToError, message);
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
// src/asserts/common/equalTo.ts
|
|
46
|
+
var equalTo = (expected) => (received, pathToError) => {
|
|
47
|
+
if (expected !== received)
|
|
48
|
+
throwException(expected, received, pathToError, "The received value is not equal to expected");
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
// src/core.ts
|
|
52
|
+
var ctxSymbol = Symbol("contextSymbol");
|
|
53
|
+
|
|
54
|
+
// src/schemas/CommonSchema.ts
|
|
55
|
+
var CommonSchema = class {
|
|
56
|
+
[ctxSymbol];
|
|
57
|
+
constructor(ctx) {
|
|
58
|
+
this[ctxSymbol] = ctx;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* @param validators - One or more custom validation functions.
|
|
62
|
+
* @returns {this} The schema instance with the added custom validation.
|
|
63
|
+
*/
|
|
64
|
+
custom(...validators) {
|
|
65
|
+
this[ctxSymbol].requiredValidations.push(...validators);
|
|
66
|
+
return this;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Marks the schema as nullable, allowing the value to be `null`.
|
|
70
|
+
*
|
|
71
|
+
* @returns {WithNull<this>} The schema instance marked as nullable.
|
|
72
|
+
*/
|
|
73
|
+
nullable() {
|
|
74
|
+
this[ctxSymbol].isNullable = true;
|
|
75
|
+
return this;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
* Marks the schema as optional, allowing the value to be `undefined`.
|
|
79
|
+
*
|
|
80
|
+
* @returns {WithUndefined<this>}} The schema instance marked as optional.
|
|
81
|
+
*/
|
|
82
|
+
optional() {
|
|
83
|
+
this[ctxSymbol].isOptional = true;
|
|
84
|
+
return this;
|
|
85
|
+
}
|
|
86
|
+
};
|
|
87
|
+
|
|
88
|
+
// src/schemas/StringSchema.ts
|
|
89
|
+
var StringSchema = class extends CommonSchema {
|
|
90
|
+
_string = 1;
|
|
91
|
+
/**
|
|
92
|
+
* Restricts the schema to exactly match the specified value and infers the literal value as the TypeScript type.
|
|
93
|
+
*
|
|
94
|
+
* @param expectedValue - The value that the schema must exactly match.
|
|
95
|
+
* @returns - The schema instance restricted to the specified value, with the literal value inferred as the TypeScript type
|
|
96
|
+
*
|
|
97
|
+
* @example - string().equalTo('hello'); // Infers the type 'hello'
|
|
98
|
+
*/
|
|
99
|
+
equalTo(expectedValue) {
|
|
100
|
+
return this.custom(equalTo(expectedValue));
|
|
101
|
+
}
|
|
102
|
+
};
|
|
103
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
104
|
+
0 && (module.exports = {
|
|
105
|
+
StringSchema
|
|
106
|
+
});
|
|
107
|
+
//# sourceMappingURL=StringSchema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/schemas/StringSchema.ts","../../src/exceptions.ts","../../src/asserts/common/equalTo.ts","../../src/core.ts","../../src/schemas/CommonSchema.ts"],"sourcesContent":["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","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","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","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 { 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"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAO,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;;;ACSO,IAAM,UACX,CAAC,aACD,CAAC,UAAkB,gBAAwB;AACzC,MAAI,aAAa;AACf,mBAAe,UAAU,UAAU,aAAa,6CAA6C;AACjG;;;AChCK,IAAM,YAAY,OAAO,eAAe;;;ACgBxC,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;;;AJ/CO,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;","names":[]}
|