bguard 0.1.1 → 0.2.0

package/README.md

@@ -30,7 +30,12 @@ Let's define a schema for a Student object:
 
 ```typeScript
 
-import { InferType, string, number, array, object, boolean } from 'bguard';
+import { InferType } from 'bguard';
+import { object } from 'bguard/object';
+import { array } from 'bguard/array';
+import { number } from 'bguard/number';
+import { string } from 'bguard/string';
+import { boolean } from 'bguard/boolean';
 import { email } from 'bguard/string/email';
 import { min } from 'bguard/number/min';
 import { max } from 'bguard/number/max';
@@ -399,6 +404,7 @@ We have two sets of translations: common errors and specific assertions.
 'c:requiredProperty': 'Missing required property in the object',
 'c:invalidType': 'Invalid type of data',
 'c:isBoolean': 'The received value is not {{e}}',
+'c:date': 'The received value is not a valid instance of Date',
 ```
 
 <b>Custom Assertion Translations</b>:
@@ -418,6 +424,7 @@ Keys are constructed as `'{typeId}:{functionName}'`, where `typeId` represents:
 - f - function
 - bi - bigint
 - m - mixed
+- dt - date
 
 Each `typeId` maps to the folder from which custom assertions are retrieved (except 'common', as explained above).
 
@@ -444,9 +451,176 @@ console.log(maxLength.message); // Output: 'The received value length is greater
 
 <b>3.</b> IDE Support:
 Each key and message will be visible in text editors that support JSDoc IntelliSense.
+
 ### Built-in Custom Assert Documentation {#builtin_custom_assert_documentation} 
 
+#### bigint
+   
+ <b>Prerequisites</b>
+   
+```typescript
+import { bigint } from 'bguard/bigint';
+```
+   
+* _Description_ Creates a new schema for validating bigint values.
+* _Example_
+```typescript
+ const schema = bigint();
+ parseOrFail(schema, 42n); // Validates successfully
+ parseOrFail(schema, 42); // Throws a validation error
+ parseOrFail(schema, '42'); // Throws a validation error
+```
+   
+        
+##### bigintMax (bigint)
+        
+```typescript
+import { bigintMax } from 'bguard/bigint/bigintMax';
+```
+        
+* _Description_ Asserts that a bigint value does not exceed a specified maximum value.
+* _Param_ {bigint} expected The maximum allowable value.
+* _Throws_ {ValidationError} if the received value exceeds the expected maximum value.
+* _Example_
+```typescript
+ const schema = bigint().custom(bigintMax(100n));
+ parseOrFail(schema, 99n);  // Valid
+ parseOrFail(schema, 100n); // Valid
+ parseOrFail(schema, 101n); // Throws an error: 'The received value is greater than expected'
+```
+* _See_ Error Translation Key = 'bi:max'
+        
+        
+##### bigintMaxExcluded (bigint)
+        
+```typescript
+import { bigintMaxExcluded } from 'bguard/bigint/bigintMaxExcluded';
+```
+        
+* _Description_ - Asserts that a bigint value is strictly less than a specified maximum value (i.e., the maximum value is excluded).
+* _Param_ {bigint} expected - The maximum allowable value, which is excluded.
+* _Throws_ {ValidationError} if the received value is greater than or equal to the expected maximum value.
+* _Example_
+```typescript
+ const schema = bigint().custom(bigintMaxExcluded(100n));
+ parseOrFail(schema, 99n);  // Valid
+ parseOrFail(schema, 100n); // Throws an error: 'The received value is greater than or equal to expected'
+ parseOrFail(schema, 101n); // Throws an error: 'The received value is greater than or equal to expected'
+```
+* _See_ Error Translation Key = 'bi:maxExcluded'
+        
+        
+##### bigintMin (bigint)
+        
+```typescript
+import { bigintMin } from 'bguard/bigint/bigintMin';
+```
+        
+* _Description_ Asserts that a bigint value is not less than a specified minimum value.
+* _Param_ {bigint} expected The minimum allowable value.
+* _Throws_ {ValidationError} if the received value is less than the expected minimum value.
+* _Example_
+```typescript
+ const schema = bigint().custom(bigintMin(10n));
+ parseOrFail(schema, 11n);  // Valid
+ parseOrFail(schema, 10n);  // Valid
+ parseOrFail(schema, 9n);   // Throws an error: 'The received value is less than expected'
+```
+* _See_ Error Translation Key = 'bi:min'
+        
+        
+##### bigintMinExcluded (bigint)
+        
+```typescript
+import { bigintMinExcluded } from 'bguard/bigint/bigintMinExcluded';
+```
+        
+* _Description_ Asserts that a bigint value is strictly greater than a specified minimum value (i.e., the minimum value is excluded).
+* _Param_ {bigint} expected The minimum allowable value, which is excluded.
+* _Throws_ {ValidationError} if the received value is less than or equal to the expected minimum value.
+* _Example_
+```typescript
+ const schema = bigint().custom(bigintMinExcluded(10n));
+ parseOrFail(schema, 11n);  // Valid
+ parseOrFail(schema, 10n); // Throws an error: 'The received value is less than or equal to expected'
+ parseOrFail(schema, 9n);  // Throws an error: 'The received value is less than or equal to expected'
+```
+* _See_ Error Translation Key = 'bi:minExcluded'
+        
+#### date
+   
+ <b>Prerequisites</b>
+   
+```typescript
+import { date } from 'bguard/date';
+```
+   
+* _Description_ Creates a new schema for validating date values.
+* _Example_
+```typescript
+ const schema = date();
+ parseOrFail(schema, true); // Validates successfully
+ parseOrFail(schema, 'true'); // Throws a validation error
+```
+   
+        
+##### dateMax (date)
+        
+```typescript
+import { dateMax } from 'bguard/date/dateMax';
+```
+        
+* _Description_ Asserts that a date value is not greater than a specified maximum value.
+* _Param_ {Date | string} expected The maximum allowable value.
+* _Throws_ {ValidationError} if the received value is greater than the expected maximum value.
+* _Example_
+```typescript
+ const schema = date().custom(dateMax('2024-12-31'));
+ parseOrFail(schema, new Date('2024-12-30'));  // Valid
+ parseOrFail(schema, new Date('2024-12-31'));  // Valid
+ parseOrFail(schema, new Date('2025-01-01'));  // Throws an error: 'The received value is greater than expected'
+```
+* _See_ Error Translation Key = 'dt:max'
+        
+        
+##### dateMin (date)
+        
+```typescript
+import { dateMin } from 'bguard/date/dateMin';
+```
+        
+* _Description_ Asserts that a number value is not less than a specified minimum value.
+* _Param_ {Date | string} expected The minimum allowable value.
+* _Throws_ {ValidationError} if the received value is less than the expected minimum value.
+* _Example_
+```typescript
+ const schema = date().custom(dateMin('2023-01-01'));
+ parseOrFail(schema, new Date('2023-01-02'));  // Valid
+ parseOrFail(schema, new Date('2023-01-01'));  // Valid
+ parseOrFail(schema, new Date('2022-12-31'));  // Throws an error: 'The received value is less than expected'
+```
+* _See_ Error Translation Key = 'dt:min'
+        
 #### mix
+   
+ <b>Prerequisites</b>
+   
+```typescript
+import { oneOfTypes } from 'bguard/mix';
+```
+   
+* _Description_ Creates a new schema for validating values that can match any one of the specified primitive types.
+
+ 
+* _Param_ {T} valueTypes - An array of primitive types that the value can match.
+* _Example_
+```typescript
+ const schema = oneOfTypes(['string', 'number']);
+ parseOrFail(schema, 'hello'); // Validates successfully
+ parseOrFail(schema, 42); // Validates successfully
+ parseOrFail(schema, true); // Throws a validation error
+```
+   
         
 ##### equalTo (mix)
         
@@ -455,7 +629,7 @@ import { equalTo } from 'bguard/mix/equalTo';
 ```
         
 * _Description_ Creates a custom assertion that checks if a value is equal to the expected value.
-* > **Notice:** It has already been implemented in the number and string schema. There is no need to use it as a custom assert.
+* > **Notice:** It has already been implemented in the number, bigint and string schema. There is no need to use it as a custom assert.
 * _Param_ {unknown} expected The value that the received value is expected to match.
 * _Throws_ {ValidationError} If the received value does not match the expected value.
 * _Example_
@@ -474,7 +648,7 @@ import { oneOfValues } from 'bguard/mix/oneOfValues';
 ```
         
 * _Description_ Creates a custom assertion that checks if a value is equal to the one of expected values.
-* > **Notice:** It has already been implemented in the number and string schema. There is no need to use it as a custom assert.
+* > **Notice:** It has already been implemented in the number, bigint and string schema. There is no need to use it as a custom assert.
 * _Param_ {unknown} expected The value that the received value is expected to match.
 * _Throws_ {ValidationError} If the received value does not match at least one of the expected values.
 * _Example_
@@ -487,6 +661,21 @@ import { oneOfValues } from 'bguard/mix/oneOfValues';
 * _See_ Error Translation Key = 'm:oneOfValues'
         
 #### number
+   
+ <b>Prerequisites</b>
+   
+```typescript
+import { number } from 'bguard/number';
+```
+   
+* _Description_ Creates a new schema for validating number values.
+* _Example_
+```typescript
+ const schema = number();
+ parseOrFail(schema, 42); // Validates successfully
+ parseOrFail(schema, '42'); // Throws a validation error
+```
+   
         
 ##### max (number)
         
@@ -600,6 +789,21 @@ import { positive } from 'bguard/number/positive';
 * _See_ Error Translation Key = 'n:positive'
         
 #### string
+   
+ <b>Prerequisites</b>
+   
+```typescript
+import { string } from 'bguard/string';
+```
+   
+* _Description_ Creates a new schema for validating string values.
+* _Example_
+```typescript
+ const schema = string();
+ parseOrFail(schema, 'hello'); // Validates successfully
+ parseOrFail(schema, 123); // Throws a validation error
+```
+   
         
 ##### atLeastOneDigit (string)
         
@@ -963,4 +1167,4 @@ import { validUrl } from 'bguard/string/validUrl';
 * _See_ Error Translation Key = 's:url'
         
 ### Contributing
-Contributions are welcome! Please open an issue or submit a pull request for any bugs or feature requests.
+Contributions are welcome! Please open an issue or submit a pull request for any bugs or feature requests.

package/lib/{CommonSchema-BbGNki0L.d.ts → CommonSchema-9RtxTxdX.d.ts}

@@ -15,6 +15,7 @@ interface ValidatorContext {
     allowUnrecognizedObjectProps?: boolean;
     strictType?: boolean;
     strictTypeValue?: unknown;
+    date?: boolean;
 }
 declare class CommonSchema {
     [ctxSymbol]: ValidatorContext;
@@ -33,7 +34,7 @@ declare class CommonSchema {
     /**
      * Marks the schema as optional, allowing the value to be `undefined`.
      *
-     * @returns {WithUndefined<this>}} The schema instance marked as optional.
+     * @returns {WithUndefined<this>} The schema instance marked as optional.
      */
     optional(): WithUndefined<this>;
 }
@@ -59,4 +60,4 @@ type WithMix<Y = unknown> = CommonSchema & {
 type ExtractFromMix<T> = T extends WithMix<infer X> ? X : never;
 type MapMixTypes<T extends PrimitiveType[]> = T extends (infer U)[] ? U extends keyof TypeMapping ? TypeMapping[U] : never : never;
 
-export { CommonSchema as C, type ExtractFromMix as E, type MapMixTypes as M, type ObjectShapeSchemaType as O, type ValidatorContext as V, type WithUndefined as W, type WithNull as a, type WithMix as b, ctxSymbol as c, innerCheck as i };
+export { CommonSchema as C, type ExtractFromMix as E, type MapMixTypes as M, type ObjectShapeSchemaType as O, type ValidatorContext as V, type WithMix as W, type WithUndefined as a, type WithNull as b, ctxSymbol as c, innerCheck as i };

package/lib/{CommonSchema-CjsYE4dC.d.mts → CommonSchema-DJmQ3F_9.d.mts}

@@ -15,6 +15,7 @@ interface ValidatorContext {
     allowUnrecognizedObjectProps?: boolean;
     strictType?: boolean;
     strictTypeValue?: unknown;
+    date?: boolean;
 }
 declare class CommonSchema {
     [ctxSymbol]: ValidatorContext;
@@ -33,7 +34,7 @@ declare class CommonSchema {
     /**
      * Marks the schema as optional, allowing the value to be `undefined`.
      *
-     * @returns {WithUndefined<this>}} The schema instance marked as optional.
+     * @returns {WithUndefined<this>} The schema instance marked as optional.
      */
     optional(): WithUndefined<this>;
 }
@@ -59,4 +60,4 @@ type WithMix<Y = unknown> = CommonSchema & {
 type ExtractFromMix<T> = T extends WithMix<infer X> ? X : never;
 type MapMixTypes<T extends PrimitiveType[]> = T extends (infer U)[] ? U extends keyof TypeMapping ? TypeMapping[U] : never : never;
 
-export { CommonSchema as C, type ExtractFromMix as E, type MapMixTypes as M, type ObjectShapeSchemaType as O, type ValidatorContext as V, type WithUndefined as W, type WithNull as a, type WithMix as b, ctxSymbol as c, innerCheck as i };
+export { CommonSchema as C, type ExtractFromMix as E, type MapMixTypes as M, type ObjectShapeSchemaType as O, type ValidatorContext as V, type WithMix as W, type WithUndefined as a, type WithNull as b, ctxSymbol as c, innerCheck as i };

package/lib/InferType.d.mts

@@ -1,12 +1,15 @@
 import { ArraySchema, ExtractFromArray } from './schemas/ArraySchema.mjs';
+import { WithBigInt, BigIntSchema, ExtractFromBigInt } from './schemas/BigIntSchema.mjs';
 import { WithBoolean, BooleanSchema, ExtractFromBoolean } from './schemas/BooleanSchema.mjs';
-import { W as WithUndefined, a as WithNull, b as WithMix, E as ExtractFromMix, C as CommonSchema } from './CommonSchema-CjsYE4dC.mjs';
+import { W as WithMix, E as ExtractFromMix, a as WithUndefined, C as CommonSchema, b as WithNull } from './CommonSchema-DJmQ3F_9.mjs';
+import { DateSchema } from './schemas/DateSchema.mjs';
 import { WithNumber, NumberSchema, ExtractFromNumber } from './schemas/NumberSchema.mjs';
 import { ObjectSchema, WithObject } from './schemas/ObjectSchema.mjs';
 import { WithString, StringSchema, ExtractFromString } from './schemas/StringSchema.mjs';
 import './commonTypes.mjs';
 
-type InferType<T> = T extends WithUndefined<WithNull<WithString<StringSchema>>> ? ExtractFromString<T> | null | undefined : T extends WithUndefined<WithString<StringSchema>> ? ExtractFromString<T> | undefined : T extends WithNull<WithString<StringSchema>> ? ExtractFromString<T> | null : T extends WithString<StringSchema> ? ExtractFromString<T> : T extends WithUndefined<WithNull<StringSchema>> ? string | null | undefined : T extends WithUndefined<StringSchema> ? string | undefined : T extends WithNull<StringSchema> ? string | null : T extends StringSchema ? string : T extends WithUndefined<WithNull<WithNumber<NumberSchema>>> ? ExtractFromNumber<T> | null | undefined : T extends WithUndefined<WithNumber<NumberSchema>> ? ExtractFromNumber<T> | undefined : T extends WithNull<WithNumber<NumberSchema>> ? ExtractFromNumber<T> | null : T extends WithNumber<NumberSchema> ? ExtractFromNumber<T> : T extends WithUndefined<WithNull<NumberSchema>> ? number | null | undefined : T extends WithUndefined<NumberSchema> ? number | undefined : T extends WithNull<NumberSchema> ? number | null : T extends NumberSchema ? number : T extends WithUndefined<WithNull<WithBoolean<BooleanSchema>>> ? ExtractFromBoolean<T> | null | undefined : T extends WithUndefined<WithBoolean<BooleanSchema>> ? ExtractFromBoolean<T> | undefined : T extends WithNull<WithBoolean<BooleanSchema>> ? ExtractFromBoolean<T> | null : T extends WithBoolean<BooleanSchema> ? ExtractFromBoolean<T> : T extends WithUndefined<WithNull<BooleanSchema>> ? boolean | null | undefined : T extends WithUndefined<BooleanSchema> ? boolean | undefined : T extends WithNull<BooleanSchema> ? boolean | null : T extends BooleanSchema ? boolean : T extends WithUndefined<WithNull<ArraySchema>> ? InferType<ExtractFromArray<T>>[] | null | undefined : T extends WithUndefined<ArraySchema> ? InferType<ExtractFromArray<T>>[] | undefined : T extends WithNull<ArraySchema> ? InferType<ExtractFromArray<T>>[] | null : T extends ArraySchema ? InferType<ExtractFromArray<T>>[] : T extends WithUndefined<WithNull<ObjectSchema>> ? ExtractFromObject<T> | null | undefined : T extends WithUndefined<ObjectSchema> ? ExtractFromObject<T> | undefined : T extends WithNull<ObjectSchema> ? ExtractFromObject<T> | null : T extends ObjectSchema ? ExtractFromObject<T> : T extends WithUndefined<WithNull<WithMix>> ? ExtractFromMix<T> | null | undefined : T extends WithUndefined<WithMix> ? ExtractFromMix<T> | undefined : T extends WithNull<WithMix> ? ExtractFromMix<T> | null : T extends WithMix ? ExtractFromMix<T> : unknown;
+type ResolveNullish<T, Y> = T extends WithUndefined<WithNull<CommonSchema>> ? Y | null | undefined : T extends WithUndefined<CommonSchema> ? Y | undefined : T extends WithNull<CommonSchema> ? Y | null : Y;
+type InferType<T> = T extends WithString<StringSchema> ? ResolveNullish<T, ExtractFromString<T>> : T extends StringSchema ? ResolveNullish<T, string> : T extends WithNumber<NumberSchema> ? ResolveNullish<T, ExtractFromNumber<T>> : T extends NumberSchema ? ResolveNullish<T, number> : T extends WithBoolean<BooleanSchema> ? ResolveNullish<T, ExtractFromBoolean<T>> : T extends BooleanSchema ? ResolveNullish<T, boolean> : T extends ArraySchema ? ResolveNullish<T, InferType<ExtractFromArray<T>>[]> : T extends ObjectSchema ? ResolveNullish<T, ExtractFromObject<T>> : T extends WithMix ? ResolveNullish<T, ExtractFromMix<T>> : T extends WithBigInt<BigIntSchema> ? ResolveNullish<T, ExtractFromBigInt<T>> : T extends BigIntSchema ? ResolveNullish<T, bigint> : T extends DateSchema ? ResolveNullish<T, Date> : unknown;
 type Merge<T> = T extends infer U ? {
     [K in keyof U]: U[K];
 } : never;

package/lib/InferType.d.ts

@@ -1,12 +1,15 @@
 import { ArraySchema, ExtractFromArray } from './schemas/ArraySchema.js';
+import { WithBigInt, BigIntSchema, ExtractFromBigInt } from './schemas/BigIntSchema.js';
 import { WithBoolean, BooleanSchema, ExtractFromBoolean } from './schemas/BooleanSchema.js';
-import { W as WithUndefined, a as WithNull, b as WithMix, E as ExtractFromMix, C as CommonSchema } from './CommonSchema-BbGNki0L.js';
+import { W as WithMix, E as ExtractFromMix, a as WithUndefined, C as CommonSchema, b as WithNull } from './CommonSchema-9RtxTxdX.js';
+import { DateSchema } from './schemas/DateSchema.js';
 import { WithNumber, NumberSchema, ExtractFromNumber } from './schemas/NumberSchema.js';
 import { ObjectSchema, WithObject } from './schemas/ObjectSchema.js';
 import { WithString, StringSchema, ExtractFromString } from './schemas/StringSchema.js';
 import './commonTypes.js';
 
-type InferType<T> = T extends WithUndefined<WithNull<WithString<StringSchema>>> ? ExtractFromString<T> | null | undefined : T extends WithUndefined<WithString<StringSchema>> ? ExtractFromString<T> | undefined : T extends WithNull<WithString<StringSchema>> ? ExtractFromString<T> | null : T extends WithString<StringSchema> ? ExtractFromString<T> : T extends WithUndefined<WithNull<StringSchema>> ? string | null | undefined : T extends WithUndefined<StringSchema> ? string | undefined : T extends WithNull<StringSchema> ? string | null : T extends StringSchema ? string : T extends WithUndefined<WithNull<WithNumber<NumberSchema>>> ? ExtractFromNumber<T> | null | undefined : T extends WithUndefined<WithNumber<NumberSchema>> ? ExtractFromNumber<T> | undefined : T extends WithNull<WithNumber<NumberSchema>> ? ExtractFromNumber<T> | null : T extends WithNumber<NumberSchema> ? ExtractFromNumber<T> : T extends WithUndefined<WithNull<NumberSchema>> ? number | null | undefined : T extends WithUndefined<NumberSchema> ? number | undefined : T extends WithNull<NumberSchema> ? number | null : T extends NumberSchema ? number : T extends WithUndefined<WithNull<WithBoolean<BooleanSchema>>> ? ExtractFromBoolean<T> | null | undefined : T extends WithUndefined<WithBoolean<BooleanSchema>> ? ExtractFromBoolean<T> | undefined : T extends WithNull<WithBoolean<BooleanSchema>> ? ExtractFromBoolean<T> | null : T extends WithBoolean<BooleanSchema> ? ExtractFromBoolean<T> : T extends WithUndefined<WithNull<BooleanSchema>> ? boolean | null | undefined : T extends WithUndefined<BooleanSchema> ? boolean | undefined : T extends WithNull<BooleanSchema> ? boolean | null : T extends BooleanSchema ? boolean : T extends WithUndefined<WithNull<ArraySchema>> ? InferType<ExtractFromArray<T>>[] | null | undefined : T extends WithUndefined<ArraySchema> ? InferType<ExtractFromArray<T>>[] | undefined : T extends WithNull<ArraySchema> ? InferType<ExtractFromArray<T>>[] | null : T extends ArraySchema ? InferType<ExtractFromArray<T>>[] : T extends WithUndefined<WithNull<ObjectSchema>> ? ExtractFromObject<T> | null | undefined : T extends WithUndefined<ObjectSchema> ? ExtractFromObject<T> | undefined : T extends WithNull<ObjectSchema> ? ExtractFromObject<T> | null : T extends ObjectSchema ? ExtractFromObject<T> : T extends WithUndefined<WithNull<WithMix>> ? ExtractFromMix<T> | null | undefined : T extends WithUndefined<WithMix> ? ExtractFromMix<T> | undefined : T extends WithNull<WithMix> ? ExtractFromMix<T> | null : T extends WithMix ? ExtractFromMix<T> : unknown;
+type ResolveNullish<T, Y> = T extends WithUndefined<WithNull<CommonSchema>> ? Y | null | undefined : T extends WithUndefined<CommonSchema> ? Y | undefined : T extends WithNull<CommonSchema> ? Y | null : Y;
+type InferType<T> = T extends WithString<StringSchema> ? ResolveNullish<T, ExtractFromString<T>> : T extends StringSchema ? ResolveNullish<T, string> : T extends WithNumber<NumberSchema> ? ResolveNullish<T, ExtractFromNumber<T>> : T extends NumberSchema ? ResolveNullish<T, number> : T extends WithBoolean<BooleanSchema> ? ResolveNullish<T, ExtractFromBoolean<T>> : T extends BooleanSchema ? ResolveNullish<T, boolean> : T extends ArraySchema ? ResolveNullish<T, InferType<ExtractFromArray<T>>[]> : T extends ObjectSchema ? ResolveNullish<T, ExtractFromObject<T>> : T extends WithMix ? ResolveNullish<T, ExtractFromMix<T>> : T extends WithBigInt<BigIntSchema> ? ResolveNullish<T, ExtractFromBigInt<T>> : T extends BigIntSchema ? ResolveNullish<T, bigint> : T extends DateSchema ? ResolveNullish<T, Date> : unknown;
 type Merge<T> = T extends infer U ? {
     [K in keyof U]: U[K];
 } : never;

package/lib/asserts/array/index.d.mts

@@ -1,18 +1,18 @@
 import { WithArray } from '../../schemas/ArraySchema.mjs';
-import { C as CommonSchema } from '../../CommonSchema-CjsYE4dC.mjs';
+import { C as CommonSchema } from '../../CommonSchema-DJmQ3F_9.mjs';
 import '../../commonTypes.mjs';
 
 /**
- * Creates a new schema for validating arrays where each element must match the specified schema.
- *
+ * @description Creates a new schema for validating arrays where each element must match the specified schema.
  * @template T
  * @param {T} arraySchema - The schema that each element of the array must match.
  * @returns {WithArray<T>} A new instance of `ArraySchema` for validating arrays of elements that match the specified schema.
- *
  * @example
  * const schema = array(string());
  * parseOrFail(schema, ['hello', 'world']); // Validates successfully
  * parseOrFail(schema, ['hello', 123]); // Throws a validation error
+ *
+ * @instance Of ArraySchema
  */
 declare function array<T extends CommonSchema>(arraySchema: T): WithArray<T>;
 

package/lib/asserts/array/index.d.ts

@@ -1,18 +1,18 @@
 import { WithArray } from '../../schemas/ArraySchema.js';
-import { C as CommonSchema } from '../../CommonSchema-BbGNki0L.js';
+import { C as CommonSchema } from '../../CommonSchema-9RtxTxdX.js';
 import '../../commonTypes.js';
 
 /**
- * Creates a new schema for validating arrays where each element must match the specified schema.
- *
+ * @description Creates a new schema for validating arrays where each element must match the specified schema.
  * @template T
  * @param {T} arraySchema - The schema that each element of the array must match.
  * @returns {WithArray<T>} A new instance of `ArraySchema` for validating arrays of elements that match the specified schema.
- *
  * @example
  * const schema = array(string());
  * parseOrFail(schema, ['hello', 'world']); // Validates successfully
  * parseOrFail(schema, ['hello', 123]); // Throws a validation error
+ *
+ * @instance Of ArraySchema
  */
 declare function array<T extends CommonSchema>(arraySchema: T): WithArray<T>;
 

package/lib/asserts/array/index.js

@@ -1,11 +1,16 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkIEUXIOL6js = require('../../chunk-IEUXIOL6.js');
-require('../../chunk-RRQOET3X.js');
-require('../../chunk-EGEHSELT.js');
-require('../../chunk-IRG4OQAB.js');
+var _chunk2OINKFOAjs = require('../../chunk-2OINKFOA.js');
+require('../../chunk-EQNVYAKS.js');
+require('../../chunk-7GIRQ5EA.js');
+require('../../chunk-356HMXOP.js');
 require('../../chunk-WK4O3HH4.js');
 
+// src/asserts/array/index.ts
+function array(arraySchema) {
+  return new (0, _chunk2OINKFOAjs.ArraySchema)({ type: [], requiredValidations: [] }, arraySchema);
+}
 
-exports.array = _chunkIEUXIOL6js.array;
+
+exports.array = array;
 //# sourceMappingURL=index.js.map

package/lib/asserts/array/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["/home/runner/work/bguard/bguard/lib/asserts/array/index.js"],"names":[],"mappings":"AAAA;AACE;AACF,0DAAgC;AAChC,mCAAgC;AAChC,mCAAgC;AAChC,mCAAgC;AAChC,mCAAgC;AAChC;AACE;AACF,uCAAC","file":"/home/runner/work/bguard/bguard/lib/asserts/array/index.js"}
+{"version":3,"sources":["/home/runner/work/bguard/bguard/lib/asserts/array/index.js","../../../src/asserts/array/index.ts"],"names":[],"mappings":"AAAA;AACE;AACF,0DAAgC;AAChC,mCAAgC;AAChC,mCAAgC;AAChC,mCAAgC;AAChC,mCAAgC;AAChC;AACA;ACOO,SAAS,KAAA,CAA8B,WAAA,EAA8B;AAC1E,EAAA,OAAO,IAAI,iCAAA,CAAY,EAAE,IAAA,EAAM,CAAC,CAAA,EAAG,mBAAA,EAAqB,CAAC,EAAE,CAAA,EAAG,WAAW,CAAA;AAC3E;ADLA;AACE;AACF,sBAAC","file":"/home/runner/work/bguard/bguard/lib/asserts/array/index.js","sourcesContent":[null,"import { ArraySchema, WithArray } from '../../schemas/ArraySchema';\nimport { CommonSchema } from '../../schemas/CommonSchema';\n\n/**\n * @description Creates a new schema for validating arrays where each element must match the specified schema.\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 * @example\n * const schema = array(string());\n * parseOrFail(schema, ['hello', 'world']); // Validates successfully\n * parseOrFail(schema, ['hello', 123]); // Throws a validation error\n *\n * @instance Of ArraySchema\n */\nexport function array<T extends CommonSchema>(arraySchema: T): WithArray<T> {\n  return new ArraySchema({ type: [], requiredValidations: [] }, arraySchema) as WithArray<T>;\n}\n"]}

package/lib/asserts/array/index.mjs

@@ -1,10 +1,15 @@
 import {
-  array
-} from "../../chunk-JDGZCBXF.mjs";
-import "../../chunk-NDQM5OL4.mjs";
-import "../../chunk-DPBE7TAQ.mjs";
-import "../../chunk-PH2PMUZP.mjs";
+  ArraySchema
+} from "../../chunk-PEWNA24X.mjs";
+import "../../chunk-4UF67IQ2.mjs";
+import "../../chunk-XZTZC73V.mjs";
+import "../../chunk-GDSB7CDN.mjs";
 import "../../chunk-7XFLH6R2.mjs";
+
+// src/asserts/array/index.ts
+function array(arraySchema) {
+  return new ArraySchema({ type: [], requiredValidations: [] }, arraySchema);
+}
 export {
   array
 };

package/lib/asserts/array/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"version":3,"sources":["../../../src/asserts/array/index.ts"],"sourcesContent":["import { ArraySchema, WithArray } from '../../schemas/ArraySchema';\nimport { CommonSchema } from '../../schemas/CommonSchema';\n\n/**\n * @description Creates a new schema for validating arrays where each element must match the specified schema.\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 * @example\n * const schema = array(string());\n * parseOrFail(schema, ['hello', 'world']); // Validates successfully\n * parseOrFail(schema, ['hello', 123]); // Throws a validation error\n *\n * @instance Of ArraySchema\n */\nexport function array<T extends CommonSchema>(arraySchema: T): WithArray<T> {\n  return new ArraySchema({ type: [], requiredValidations: [] }, arraySchema) as WithArray<T>;\n}\n"],"mappings":";;;;;;;;;AAeO,SAAS,MAA8B,aAA8B;AAC1E,SAAO,IAAI,YAAY,EAAE,MAAM,CAAC,GAAG,qBAAqB,CAAC,EAAE,GAAG,WAAW;AAC3E;","names":[]}

package/lib/asserts/bigint/bigintMax.d.mts

@@ -0,0 +1,22 @@
+import { RequiredValidation } from '../../commonTypes.mjs';
+
+/**
+ * @description Asserts that a bigint value does not exceed a specified maximum value.
+ * @param {bigint} expected The maximum allowable value.
+ * @returns {RequiredValidation} A validation function that takes a received bigint and an exception context.
+ * @throws {ValidationError} if the received value exceeds the expected maximum value.
+ * @example
+ * const schema = bigint().custom(bigintMax(100n));
+ * parseOrFail(schema, 99n);  // Valid
+ * parseOrFail(schema, 100n); // Valid
+ * parseOrFail(schema, 101n); // Throws an error: 'The received value is greater than expected'
+ *
+ * @translation Error Translation Key = 'bi:max'
+ */
+declare const bigintMax: {
+    (expected: bigint): RequiredValidation;
+    key: string;
+    message: string;
+};
+
+export { bigintMax };

package/lib/asserts/bigint/bigintMax.d.ts

@@ -0,0 +1,22 @@
+import { RequiredValidation } from '../../commonTypes.js';
+
+/**
+ * @description Asserts that a bigint value does not exceed a specified maximum value.
+ * @param {bigint} expected The maximum allowable value.
+ * @returns {RequiredValidation} A validation function that takes a received bigint and an exception context.
+ * @throws {ValidationError} if the received value exceeds the expected maximum value.
+ * @example
+ * const schema = bigint().custom(bigintMax(100n));
+ * parseOrFail(schema, 99n);  // Valid
+ * parseOrFail(schema, 100n); // Valid
+ * parseOrFail(schema, 101n); // Throws an error: 'The received value is greater than expected'
+ *
+ * @translation Error Translation Key = 'bi:max'
+ */
+declare const bigintMax: {
+    (expected: bigint): RequiredValidation;
+    key: string;
+    message: string;
+};
+
+export { bigintMax };

package/lib/asserts/bigint/bigintMax.js

@@ -0,0 +1,20 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkCQWI6YRIjs = require('../../chunk-CQWI6YRI.js');
+
+
+var _chunkWK4O3HH4js = require('../../chunk-WK4O3HH4.js');
+
+// src/asserts/bigint/bigintMax.ts
+var bigintMaxErrorMessage = "The received value is greater than expected";
+var bigintMaxErrorKey = "bi:max";
+var bigintMax = (expected) => (received, ctx) => {
+  if (expected < received) _chunkWK4O3HH4js.guardException.call(void 0, expected, received, ctx, bigintMaxErrorKey);
+};
+bigintMax.key = bigintMaxErrorKey;
+bigintMax.message = bigintMaxErrorMessage;
+_chunkCQWI6YRIjs.setToDefaultLocale.call(void 0, bigintMax);
+
+
+exports.bigintMax = bigintMax;
+//# sourceMappingURL=bigintMax.js.map

package/lib/asserts/bigint/bigintMax.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/bguard/bguard/lib/asserts/bigint/bigintMax.js","../../../src/asserts/bigint/bigintMax.ts"],"names":[],"mappings":"AAAA;AACE;AACF,0DAAgC;AAChC;AACE;AACF,0DAAgC;AAChC;AACA;ACHA,IAAM,sBAAA,EAAwB,6CAAA;AAC9B,IAAM,kBAAA,EAAoB,QAAA;AAenB,IAAM,UAAA,EACX,CAAC,QAAA,EAAA,GACD,CAAC,QAAA,EAAkB,GAAA,EAAA,GAA0B;AAC3C,EAAA,GAAA,CAAI,SAAA,EAAW,QAAA,EAAU,6CAAA,QAAe,EAAU,QAAA,EAAU,GAAA,EAAK,iBAAiB,CAAA;AACpF,CAAA;AAEF,SAAA,CAAU,IAAA,EAAM,iBAAA;AAChB,SAAA,CAAU,QAAA,EAAU,qBAAA;AACpB,iDAAA,SAA4B,CAAA;ADZ5B;AACE;AACF,8BAAC","file":"/home/runner/work/bguard/bguard/lib/asserts/bigint/bigintMax.js","sourcesContent":[null,"import { setToDefaultLocale } from '../../translationMap';\nimport { guardException } from '../../exceptions';\nimport { ExceptionContext, RequiredValidation } from '../../commonTypes';\n\nconst bigintMaxErrorMessage = 'The received value is greater than expected';\nconst bigintMaxErrorKey = 'bi:max';\n\n/**\n * @description Asserts that a bigint value does not exceed a specified maximum value.\n * @param {bigint} expected The maximum allowable value.\n * @returns {RequiredValidation} A validation function that takes a received bigint and an exception context.\n * @throws {ValidationError} if the received value exceeds the expected maximum value.\n * @example\n * const schema = bigint().custom(bigintMax(100n));\n * parseOrFail(schema, 99n);  // Valid\n * parseOrFail(schema, 100n); // Valid\n * parseOrFail(schema, 101n); // Throws an error: 'The received value is greater than expected'\n *\n * @translation Error Translation Key = 'bi:max'\n */\nexport const bigintMax =\n  (expected: bigint): RequiredValidation =>\n  (received: bigint, ctx: ExceptionContext) => {\n    if (expected < received) guardException(expected, received, ctx, bigintMaxErrorKey);\n  };\n\nbigintMax.key = bigintMaxErrorKey;\nbigintMax.message = bigintMaxErrorMessage;\nsetToDefaultLocale(bigintMax);\n"]}

package/lib/asserts/bigint/bigintMax.mjs

@@ -0,0 +1,20 @@
+import {
+  setToDefaultLocale
+} from "../../chunk-QV4JDW3T.mjs";
+import {
+  guardException
+} from "../../chunk-7XFLH6R2.mjs";
+
+// src/asserts/bigint/bigintMax.ts
+var bigintMaxErrorMessage = "The received value is greater than expected";
+var bigintMaxErrorKey = "bi:max";
+var bigintMax = (expected) => (received, ctx) => {
+  if (expected < received) guardException(expected, received, ctx, bigintMaxErrorKey);
+};
+bigintMax.key = bigintMaxErrorKey;
+bigintMax.message = bigintMaxErrorMessage;
+setToDefaultLocale(bigintMax);
+export {
+  bigintMax
+};
+//# sourceMappingURL=bigintMax.mjs.map

package/lib/asserts/bigint/bigintMax.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/asserts/bigint/bigintMax.ts"],"sourcesContent":["import { setToDefaultLocale } from '../../translationMap';\nimport { guardException } from '../../exceptions';\nimport { ExceptionContext, RequiredValidation } from '../../commonTypes';\n\nconst bigintMaxErrorMessage = 'The received value is greater than expected';\nconst bigintMaxErrorKey = 'bi:max';\n\n/**\n * @description Asserts that a bigint value does not exceed a specified maximum value.\n * @param {bigint} expected The maximum allowable value.\n * @returns {RequiredValidation} A validation function that takes a received bigint and an exception context.\n * @throws {ValidationError} if the received value exceeds the expected maximum value.\n * @example\n * const schema = bigint().custom(bigintMax(100n));\n * parseOrFail(schema, 99n);  // Valid\n * parseOrFail(schema, 100n); // Valid\n * parseOrFail(schema, 101n); // Throws an error: 'The received value is greater than expected'\n *\n * @translation Error Translation Key = 'bi:max'\n */\nexport const bigintMax =\n  (expected: bigint): RequiredValidation =>\n  (received: bigint, ctx: ExceptionContext) => {\n    if (expected < received) guardException(expected, received, ctx, bigintMaxErrorKey);\n  };\n\nbigintMax.key = bigintMaxErrorKey;\nbigintMax.message = bigintMaxErrorMessage;\nsetToDefaultLocale(bigintMax);\n"],"mappings":";;;;;;;;AAIA,IAAM,wBAAwB;AAC9B,IAAM,oBAAoB;AAenB,IAAM,YACX,CAAC,aACD,CAAC,UAAkB,QAA0B;AAC3C,MAAI,WAAW,SAAU,gBAAe,UAAU,UAAU,KAAK,iBAAiB;AACpF;AAEF,UAAU,MAAM;AAChB,UAAU,UAAU;AACpB,mBAAmB,SAAS;","names":[]}

package/lib/asserts/bigint/bigintMaxExcluded.d.mts

@@ -0,0 +1,22 @@
+import { RequiredValidation } from '../../commonTypes.mjs';
+
+/**
+ * @description - Asserts that a bigint value is strictly less than a specified maximum value (i.e., the maximum value is excluded).
+ * @param {bigint} expected - The maximum allowable value, which is excluded.
+ * @returns {RequiredValidation} -  A validation function that takes a received bigint and an exception context.
+ * @throws {ValidationError} if the received value is greater than or equal to the expected maximum value.
+ * @example
+ * const schema = bigint().custom(bigintMaxExcluded(100n));
+ * parseOrFail(schema, 99n);  // Valid
+ * parseOrFail(schema, 100n); // Throws an error: 'The received value is greater than or equal to expected'
+ * parseOrFail(schema, 101n); // Throws an error: 'The received value is greater than or equal to expected'
+ *
+ * @translation Error Translation Key = 'bi:maxExcluded'
+ */
+declare const bigintMaxExcluded: {
+    (expected: bigint): RequiredValidation;
+    key: string;
+    message: string;
+};
+
+export { bigintMaxExcluded };

package/lib/asserts/bigint/bigintMaxExcluded.d.ts

@@ -0,0 +1,22 @@
+import { RequiredValidation } from '../../commonTypes.js';
+
+/**
+ * @description - Asserts that a bigint value is strictly less than a specified maximum value (i.e., the maximum value is excluded).
+ * @param {bigint} expected - The maximum allowable value, which is excluded.
+ * @returns {RequiredValidation} -  A validation function that takes a received bigint and an exception context.
+ * @throws {ValidationError} if the received value is greater than or equal to the expected maximum value.
+ * @example
+ * const schema = bigint().custom(bigintMaxExcluded(100n));
+ * parseOrFail(schema, 99n);  // Valid
+ * parseOrFail(schema, 100n); // Throws an error: 'The received value is greater than or equal to expected'
+ * parseOrFail(schema, 101n); // Throws an error: 'The received value is greater than or equal to expected'
+ *
+ * @translation Error Translation Key = 'bi:maxExcluded'
+ */
+declare const bigintMaxExcluded: {
+    (expected: bigint): RequiredValidation;
+    key: string;
+    message: string;
+};
+
+export { bigintMaxExcluded };

package/lib/asserts/bigint/bigintMaxExcluded.js

@@ -0,0 +1,20 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkCQWI6YRIjs = require('../../chunk-CQWI6YRI.js');
+
+
+var _chunkWK4O3HH4js = require('../../chunk-WK4O3HH4.js');
+
+// src/asserts/bigint/bigintMaxExcluded.ts
+var bigintMaxExcludedErrorMessage = "The received value is greater than or equal to expected";
+var bigintMaxExcludedErrorKey = "bi:maxExcluded";
+var bigintMaxExcluded = (expected) => (received, ctx) => {
+  if (expected <= received) _chunkWK4O3HH4js.guardException.call(void 0, expected, received, ctx, bigintMaxExcludedErrorKey);
+};
+bigintMaxExcluded.key = bigintMaxExcludedErrorKey;
+bigintMaxExcluded.message = bigintMaxExcludedErrorMessage;
+_chunkCQWI6YRIjs.setToDefaultLocale.call(void 0, bigintMaxExcluded);
+
+
+exports.bigintMaxExcluded = bigintMaxExcluded;
+//# sourceMappingURL=bigintMaxExcluded.js.map