bguard 0.5.0 → 0.7.0

package/lib/toJSONSchema.d.mts

@@ -0,0 +1,44 @@
+import { CommonSchema } from './core.mjs';
+import './commonTypes.mjs';
+import './InferType.mjs';
+import './helpers/constants.mjs';
+import './standardSchema.mjs';
+
+interface JSONSchema {
+    [keyword: string]: unknown;
+}
+interface ToJSONSchemaOptions {
+    /**
+     * The dialect to declare in `$schema`. Pass `null` to leave it out, which is what you want when the
+     * result is embedded in a larger document such as an OpenAPI `components.schemas` entry.
+     * @default 'https://json-schema.org/draft/2020-12/schema'
+     */
+    dialect?: string | null;
+}
+/**
+ * Renders a schema as a JSON Schema document, for OpenAPI, form generators and tool definitions.
+ *
+ * What is represented: types, object properties and which of them are required, arrays, tuples,
+ * records, unions, literals and enums, nullability, defaults, `description()`, and recursive schemas
+ * via `$defs` and `$ref`. Assertions that map onto a JSON Schema keyword — string lengths and patterns,
+ * numeric bounds, array lengths — are included; those with no equivalent are not, because JSON Schema
+ * has no way to express them.
+ *
+ * `bigint` and `symbol` have no JSON Schema counterpart and raise a `BuildSchemaError` rather than
+ * being quietly emitted as something they are not. A `date()` becomes `{ type: 'string', format:
+ * 'date-time' }`, since JSON has no date type.
+ *
+ * @example
+ * const schema = object({ name: string().custom(minLength(2)), age: number().optional() });
+ * toJSONSchema(schema);
+ * // {
+ * //   $schema: 'https://json-schema.org/draft/2020-12/schema',
+ * //   type: 'object',
+ * //   properties: { name: { type: 'string', minLength: 2 }, age: { type: 'number' } },
+ * //   required: ['name'],
+ * //   additionalProperties: false,
+ * // }
+ */
+declare function toJSONSchema(schema: CommonSchema, options?: ToJSONSchemaOptions): JSONSchema;
+
+export { type JSONSchema, type ToJSONSchemaOptions, toJSONSchema };

package/lib/toJSONSchema.d.ts

@@ -0,0 +1,44 @@
+import { CommonSchema } from './core.js';
+import './commonTypes.js';
+import './InferType.js';
+import './helpers/constants.js';
+import './standardSchema.js';
+
+interface JSONSchema {
+    [keyword: string]: unknown;
+}
+interface ToJSONSchemaOptions {
+    /**
+     * The dialect to declare in `$schema`. Pass `null` to leave it out, which is what you want when the
+     * result is embedded in a larger document such as an OpenAPI `components.schemas` entry.
+     * @default 'https://json-schema.org/draft/2020-12/schema'
+     */
+    dialect?: string | null;
+}
+/**
+ * Renders a schema as a JSON Schema document, for OpenAPI, form generators and tool definitions.
+ *
+ * What is represented: types, object properties and which of them are required, arrays, tuples,
+ * records, unions, literals and enums, nullability, defaults, `description()`, and recursive schemas
+ * via `$defs` and `$ref`. Assertions that map onto a JSON Schema keyword — string lengths and patterns,
+ * numeric bounds, array lengths — are included; those with no equivalent are not, because JSON Schema
+ * has no way to express them.
+ *
+ * `bigint` and `symbol` have no JSON Schema counterpart and raise a `BuildSchemaError` rather than
+ * being quietly emitted as something they are not. A `date()` becomes `{ type: 'string', format:
+ * 'date-time' }`, since JSON has no date type.
+ *
+ * @example
+ * const schema = object({ name: string().custom(minLength(2)), age: number().optional() });
+ * toJSONSchema(schema);
+ * // {
+ * //   $schema: 'https://json-schema.org/draft/2020-12/schema',
+ * //   type: 'object',
+ * //   properties: { name: { type: 'string', minLength: 2 }, age: { type: 'number' } },
+ * //   required: ['name'],
+ * //   additionalProperties: false,
+ * // }
+ */
+declare function toJSONSchema(schema: CommonSchema, options?: ToJSONSchemaOptions): JSONSchema;
+
+export { type JSONSchema, type ToJSONSchemaOptions, toJSONSchema };

package/lib/toJSONSchema.js

@@ -0,0 +1,12 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkSVRCKC65js = require('./chunk-SVRCKC65.js');
+require('./chunk-6LUSV3SS.js');
+require('./chunk-ZJGY6EOE.js');
+require('./chunk-VBTWYDEM.js');
+require('./chunk-LHEU4XAC.js');
+require('./chunk-ZWFSAKQK.js');
+
+
+exports.toJSONSchema = _chunkSVRCKC65js.toJSONSchema;
+//# sourceMappingURL=toJSONSchema.js.map

package/lib/toJSONSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/bguard/bguard/lib/toJSONSchema.js"],"names":[],"mappings":"AAAA;AACE;AACF,sDAA4B;AAC5B,+BAA4B;AAC5B,+BAA4B;AAC5B,+BAA4B;AAC5B,+BAA4B;AAC5B,+BAA4B;AAC5B;AACE;AACF,qDAAC","file":"/home/runner/work/bguard/bguard/lib/toJSONSchema.js"}

package/lib/toJSONSchema.mjs

@@ -0,0 +1,12 @@
+import {
+  toJSONSchema
+} from "./chunk-NM3VRT77.mjs";
+import "./chunk-LDZFOOWN.mjs";
+import "./chunk-65X7NTUS.mjs";
+import "./chunk-YBVMP4EI.mjs";
+import "./chunk-C76DLZFD.mjs";
+import "./chunk-O2WD4JBG.mjs";
+export {
+  toJSONSchema
+};
+//# sourceMappingURL=toJSONSchema.mjs.map

package/lib/toJSONSchema.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/lib/translationMap.d.mts

@@ -1,5 +1,8 @@
 import { TranslationErrorMap } from './commonTypes.mjs';
-import { RequiredValidation } from './ExceptionContext.mjs';
+import { RequiredValidation } from './core.mjs';
+import './InferType.mjs';
+import './helpers/constants.mjs';
+import './standardSchema.mjs';
 
 declare function setToDefaultLocale({ key, message, }: {
     (expected: any): RequiredValidation;
@@ -7,6 +10,12 @@ declare function setToDefaultLocale({ key, message, }: {
     message: string;
 }): void;
 declare function setLocale(lng: string, custom: Partial<TranslationErrorMap>): void;
+/**
+ * Drops every locale and returns the default one to its registered messages.
+ *
+ * Assert registrations are deliberately kept: they describe the schemas, not a translation, and
+ * clearing them would leave every built-in assert reporting its key instead of a message.
+ */
 declare function clearLocales(): void;
 declare function getTranslationByLocale(lng?: string): TranslationErrorMap;
 

package/lib/translationMap.d.ts

@@ -1,5 +1,8 @@
 import { TranslationErrorMap } from './commonTypes.js';
-import { RequiredValidation } from './ExceptionContext.js';
+import { RequiredValidation } from './core.js';
+import './InferType.js';
+import './helpers/constants.js';
+import './standardSchema.js';
 
 declare function setToDefaultLocale({ key, message, }: {
     (expected: any): RequiredValidation;
@@ -7,6 +10,12 @@ declare function setToDefaultLocale({ key, message, }: {
     message: string;
 }): void;
 declare function setLocale(lng: string, custom: Partial<TranslationErrorMap>): void;
+/**
+ * Drops every locale and returns the default one to its registered messages.
+ *
+ * Assert registrations are deliberately kept: they describe the schemas, not a translation, and
+ * clearing them would leave every built-in assert reporting its key instead of a message.
+ */
 declare function clearLocales(): void;
 declare function getTranslationByLocale(lng?: string): TranslationErrorMap;
 

package/lib/translationMap.js

@@ -3,12 +3,12 @@
 
 
 
-var _chunkEXVTHIT5js = require('./chunk-EXVTHIT5.js');
-require('./chunk-FIDPCCCW.js');
+var _chunkZJGY6EOEjs = require('./chunk-ZJGY6EOE.js');
+require('./chunk-ZWFSAKQK.js');
 
 
 
 
 
-exports.clearLocales = _chunkEXVTHIT5js.clearLocales; exports.getTranslationByLocale = _chunkEXVTHIT5js.getTranslationByLocale; exports.setLocale = _chunkEXVTHIT5js.setLocale; exports.setToDefaultLocale = _chunkEXVTHIT5js.setToDefaultLocale;
+exports.clearLocales = _chunkZJGY6EOEjs.clearLocales; exports.getTranslationByLocale = _chunkZJGY6EOEjs.getTranslationByLocale; exports.setLocale = _chunkZJGY6EOEjs.setLocale; exports.setToDefaultLocale = _chunkZJGY6EOEjs.setToDefaultLocale;
 //# sourceMappingURL=translationMap.js.map

package/lib/translationMap.mjs

@@ -3,8 +3,8 @@ import {
   getTranslationByLocale,
   setLocale,
   setToDefaultLocale
-} from "./chunk-QWPHP26D.mjs";
-import "./chunk-ZTCXXAKD.mjs";
+} from "./chunk-65X7NTUS.mjs";
+import "./chunk-O2WD4JBG.mjs";
 export {
   clearLocales,
   getTranslationByLocale,

package/package.json

@@ -2,16 +2,17 @@
   "name": "bguard",
   "private": false,
   "license": "MIT",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "main": "lib/index.js",
   "module": "lib/index.mjs",
   "types": "lib/index.d.ts",
+  "sideEffects": false,
   "files": [
     "/lib"
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/NBlasko/bguard.git"
+    "url": "git+https://github.com/NBlasko/bguard.git"
   },
   "bugs": {
     "url": "https://github.com/NBlasko/bguard/issues"
@@ -43,35 +44,36 @@
     "test:coverage": "jest --watchAll=false --runInBand --config=./jest/config.ts --coverage",
     "lint": "eslint \"src/**/*.ts\"",
     "lint:fix": "eslint \"src/**/*.ts\" --fix",
-    "prettier": "prettier --check src",
-    "prettier:fix": "prettier --write src",
+    "prettier": "prettier --check src jest scripts",
+    "prettier:fix": "prettier --write src jest scripts",
     "lint:check": "npm run prettier && npm run lint",
     "release:package": "npm run build:package && changeset publish",
     "change:start": "changeset",
     "change:version": "changeset version",
     "change:publish": "changeset publish",
-    "arethetypeswrong": "npx @arethetypeswrong/cli",
+    "arethetypeswrong": "attw --pack . --ignore-rules no-resolution",
+    "check:exports": "node scripts/check-exports.mjs",
+    "check:package": "npm run check:exports && npm run check:docs && npm run arethetypeswrong",
     "docs:join-assert": "node scripts/join-assert-docs.mjs",
-    "test:before": "ts-node jest/assets/generateStaticTypes"
+    "test:before": "ts-node jest/assets/generateStaticTypes",
+    "check:docs": "node scripts/check-docs.mjs"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.27.8",
-    "@eslint/eslintrc": "^3.1.0",
-    "@eslint/js": "^9.9.1",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^22.5.4",
-    "@typescript-eslint/eslint-plugin": "^8.4.0",
-    "@typescript-eslint/parser": "^8.4.0",
-    "eslint": "^9.9.1",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-jest": "^28.8.3",
-    "globals": "^15.9.0",
-    "jest": "^29.7.0",
-    "prettier": "^3.3.3",
-    "ts-jest": "^29.2.5",
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@changesets/cli": "^2.31.1",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^26.1.2",
+    "@typescript-eslint/eslint-plugin": "^8.65.0",
+    "@typescript-eslint/parser": "^8.65.0",
+    "eslint": "^10.8.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^17.8.0",
+    "jest": "^30.4.2",
+    "prettier": "^3.9.6",
+    "ts-jest": "^29.4.12",
     "ts-node": "^10.9.2",
-    "tsup": "^8.2.4",
-    "typescript": "^5.5.4"
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
   },
   "tsup": {
     "entry": [
@@ -90,64 +92,204 @@
   },
   "exports": {
     ".": {
+      "types": {
+        "import": "./lib/index.d.mts",
+        "require": "./lib/index.d.ts"
+      },
       "import": "./lib/index.mjs",
-      "require": "./lib/index.js",
-      "types": "./lib/index.d.ts"
+      "require": "./lib/index.js"
+    },
+    "./codeGen": {
+      "types": {
+        "import": "./lib/codeGen.d.mts",
+        "require": "./lib/codeGen.d.ts"
+      },
+      "import": "./lib/codeGen.mjs",
+      "require": "./lib/codeGen.js"
+    },
+    "./string": {
+      "types": {
+        "import": "./lib/asserts/string/index.d.mts",
+        "require": "./lib/asserts/string/index.d.ts"
+      },
+      "import": "./lib/asserts/string/index.mjs",
+      "require": "./lib/asserts/string/index.js"
     },
     "./string/*": {
+      "types": {
+        "import": "./lib/asserts/string/*.d.mts",
+        "require": "./lib/asserts/string/*.d.ts"
+      },
       "import": "./lib/asserts/string/*.mjs",
-      "require": "./lib/asserts/string/*.js",
-      "types": "./lib/asserts/string/*.d.ts"
+      "require": "./lib/asserts/string/*.js"
+    },
+    "./number": {
+      "types": {
+        "import": "./lib/asserts/number/index.d.mts",
+        "require": "./lib/asserts/number/index.d.ts"
+      },
+      "import": "./lib/asserts/number/index.mjs",
+      "require": "./lib/asserts/number/index.js"
     },
     "./number/*": {
+      "types": {
+        "import": "./lib/asserts/number/*.d.mts",
+        "require": "./lib/asserts/number/*.d.ts"
+      },
       "import": "./lib/asserts/number/*.mjs",
-      "require": "./lib/asserts/number/*.js",
-      "types": "./lib/asserts/number/*.d.ts"
+      "require": "./lib/asserts/number/*.js"
+    },
+    "./boolean": {
+      "types": {
+        "import": "./lib/asserts/boolean/index.d.mts",
+        "require": "./lib/asserts/boolean/index.d.ts"
+      },
+      "import": "./lib/asserts/boolean/index.mjs",
+      "require": "./lib/asserts/boolean/index.js"
+    },
+    "./coerce": {
+      "types": {
+        "import": "./lib/asserts/coerce/index.d.mts",
+        "require": "./lib/asserts/coerce/index.d.ts"
+      },
+      "import": "./lib/asserts/coerce/index.mjs",
+      "require": "./lib/asserts/coerce/index.js"
     },
     "./boolean/*": {
+      "types": {
+        "import": "./lib/asserts/boolean/*.d.mts",
+        "require": "./lib/asserts/boolean/*.d.ts"
+      },
       "import": "./lib/asserts/boolean/*.mjs",
-      "require": "./lib/asserts/boolean/*.js",
-      "types": "./lib/asserts/boolean/*.d.ts"
+      "require": "./lib/asserts/boolean/*.js"
+    },
+    "./array": {
+      "types": {
+        "import": "./lib/asserts/array/index.d.mts",
+        "require": "./lib/asserts/array/index.d.ts"
+      },
+      "import": "./lib/asserts/array/index.mjs",
+      "require": "./lib/asserts/array/index.js"
     },
     "./array/*": {
+      "types": {
+        "import": "./lib/asserts/array/*.d.mts",
+        "require": "./lib/asserts/array/*.d.ts"
+      },
       "import": "./lib/asserts/array/*.mjs",
-      "require": "./lib/asserts/array/*.js",
-      "types": "./lib/asserts/array/*.d.ts"
+      "require": "./lib/asserts/array/*.js"
+    },
+    "./object": {
+      "types": {
+        "import": "./lib/asserts/object/index.d.mts",
+        "require": "./lib/asserts/object/index.d.ts"
+      },
+      "import": "./lib/asserts/object/index.mjs",
+      "require": "./lib/asserts/object/index.js"
+    },
+    "./record": {
+      "types": {
+        "import": "./lib/asserts/record/index.d.mts",
+        "require": "./lib/asserts/record/index.d.ts"
+      },
+      "import": "./lib/asserts/record/index.mjs",
+      "require": "./lib/asserts/record/index.js"
+    },
+    "./intersection": {
+      "types": {
+        "import": "./lib/asserts/intersection/index.d.mts",
+        "require": "./lib/asserts/intersection/index.d.ts"
+      },
+      "import": "./lib/asserts/intersection/index.mjs",
+      "require": "./lib/asserts/intersection/index.js"
     },
     "./object/*": {
+      "types": {
+        "import": "./lib/asserts/object/*.d.mts",
+        "require": "./lib/asserts/object/*.d.ts"
+      },
       "import": "./lib/asserts/object/*.mjs",
-      "require": "./lib/asserts/object/*.js",
-      "types": "./lib/asserts/object/*.d.ts"
+      "require": "./lib/asserts/object/*.js"
+    },
+    "./mix": {
+      "types": {
+        "import": "./lib/asserts/mix/index.d.mts",
+        "require": "./lib/asserts/mix/index.d.ts"
+      },
+      "import": "./lib/asserts/mix/index.mjs",
+      "require": "./lib/asserts/mix/index.js"
+    },
+    "./union": {
+      "types": {
+        "import": "./lib/asserts/union/index.d.mts",
+        "require": "./lib/asserts/union/index.d.ts"
+      },
+      "import": "./lib/asserts/union/index.mjs",
+      "require": "./lib/asserts/union/index.js"
+    },
+    "./tuple": {
+      "types": {
+        "import": "./lib/asserts/tuple/index.d.mts",
+        "require": "./lib/asserts/tuple/index.d.ts"
+      },
+      "import": "./lib/asserts/tuple/index.mjs",
+      "require": "./lib/asserts/tuple/index.js"
+    },
+    "./lazy": {
+      "types": {
+        "import": "./lib/asserts/lazy/index.d.mts",
+        "require": "./lib/asserts/lazy/index.d.ts"
+      },
+      "import": "./lib/asserts/lazy/index.mjs",
+      "require": "./lib/asserts/lazy/index.js"
     },
     "./mix/*": {
+      "types": {
+        "import": "./lib/asserts/mix/*.d.mts",
+        "require": "./lib/asserts/mix/*.d.ts"
+      },
       "import": "./lib/asserts/mix/*.mjs",
-      "require": "./lib/asserts/mix/*.js",
-      "types": "./lib/asserts/mix/*.d.ts"
-    },
-    "./function/*": {
-      "import": "./lib/asserts/function/*.mjs",
-      "require": "./lib/asserts/function/*.js",
-      "types": "./lib/asserts/function/*.d.ts"
+      "require": "./lib/asserts/mix/*.js"
     },
-    "./symbol/*": {
-      "import": "./lib/asserts/symbol/*.mjs",
-      "require": "./lib/asserts/symbol/*.js",
-      "types": "./lib/asserts/symbol/*.d.ts"
+    "./bigint": {
+      "types": {
+        "import": "./lib/asserts/bigint/index.d.mts",
+        "require": "./lib/asserts/bigint/index.d.ts"
+      },
+      "import": "./lib/asserts/bigint/index.mjs",
+      "require": "./lib/asserts/bigint/index.js"
     },
     "./bigint/*": {
+      "types": {
+        "import": "./lib/asserts/bigint/*.d.mts",
+        "require": "./lib/asserts/bigint/*.d.ts"
+      },
       "import": "./lib/asserts/bigint/*.mjs",
-      "require": "./lib/asserts/bigint/*.js",
-      "types": "./lib/asserts/bigint/*.d.ts"
+      "require": "./lib/asserts/bigint/*.js"
+    },
+    "./date": {
+      "types": {
+        "import": "./lib/asserts/date/index.d.mts",
+        "require": "./lib/asserts/date/index.d.ts"
+      },
+      "import": "./lib/asserts/date/index.mjs",
+      "require": "./lib/asserts/date/index.js"
     },
     "./date/*": {
+      "types": {
+        "import": "./lib/asserts/date/*.d.mts",
+        "require": "./lib/asserts/date/*.d.ts"
+      },
       "import": "./lib/asserts/date/*.mjs",
-      "require": "./lib/asserts/date/*.js",
-      "types": "./lib/asserts/date/*.d.ts"
+      "require": "./lib/asserts/date/*.js"
     },
     "./*": {
-      "import": "./*.mjs",
-      "require": "./*.js",
-      "types": "./*.d.ts"
+      "types": {
+        "import": "./lib/*.d.mts",
+        "require": "./lib/*.d.ts"
+      },
+      "import": "./lib/*.mjs",
+      "require": "./lib/*.js"
     }
   }
 }

package/lib/CommonSchema-BIfYCtcQ.d.mts

@@ -1,110 +0,0 @@
-import { ExceptionContext, RequiredValidation } from './ExceptionContext.mjs';
-import { InferType } from './InferType.mjs';
-import { BaseType, MetaContext, TransformCallback, WithNull, WithUndefined } from './commonTypes.mjs';
-
-declare const ctxSymbol: unique symbol;
-declare function innerCheck(schema: CommonSchema, receivedValue: unknown, exCtx: ExceptionContext): unknown;
-
-type ObjectShapeSchemaType = Record<string, CommonSchema>;
-interface ValidatorContext {
-    type: BaseType[];
-    isNullable?: boolean;
-    isOptional?: boolean;
-    requiredValidations: RequiredValidation[];
-    array?: CommonSchema;
-    object?: ObjectShapeSchemaType;
-    allowUnrecognizedObjectProps?: boolean;
-    strictType?: boolean;
-    strictTypeValue?: unknown;
-    date?: boolean;
-    defaultValue?: unknown;
-    meta?: MetaContext;
-    transformListBefore?: TransformCallback<any, any>[];
-}
-declare class CommonSchema {
-    [ctxSymbol]: ValidatorContext;
-    constructor(ctx: ValidatorContext);
-    /**
-     * @param validators - One or more custom validation functions.
-     * @returns {this} The schema instance with the added custom validation.
-     */
-    custom(...validators: RequiredValidation[]): this;
-    /**
-     * Marks the schema as nullable, allowing the value to be `null`.
-     *
-     * @returns {WithNull<this>} The schema instance marked as nullable.
-     */
-    nullable(): WithNull<this>;
-    /**
-     * Marks the schema as optional, allowing the value to be `undefined`.
-     *
-     * @returns {WithUndefined<this>} The schema instance marked as optional.
-     */
-    optional(): WithUndefined<this>;
-    /**
-     * Marks the schema as optional, allowing the value to be `undefined`.
-     *
-     * @returns {this} The schema instance. This method should be used as a last one because it does the check of previous methods and
-     */
-    default(defaultValue: InferType<this>): this;
-    /**
-     * Applies a transformation to the input value before any validation occurs.
-     * The transformation should return a value of the same type as the inferred type of the schema,
-     * ensuring that the overall type is not altered.
-     *
-     * @template In - The type of the input value before transformation (defaults to `unknown`).
-     * @param {TransformCallback<In, InferType<this>>} cb - The callback function that performs the transformation.
-     * @returns {this} The updated schema with the applied transformation.
-     *
-     * @example
-     * const schema = string()
-     *   .nullable()
-     *   .transformBeforeValidation((val) => val + '') // Ensure the value is a string
-     *   .transformBeforeValidation((val: string) => (val === '' ? null : val)); // Convert empty strings to null
-     *
-     * // Parse 'test' will pass as 'test' is a valid string longer than 3 characters.
-     * parseOrFail(schema, 'test');
-     *
-     * // Parsing '' will be transformed to null and will pass due to .nullable().
-     * parseOrFail(schema, '');
-     */
-    transformBeforeValidation<In>(cb: TransformCallback<In, InferType<this>>): this;
-    /**
-     * Assigns a unique identifier to the schema.
-     * This ID can be used to track or map validation errors back to specific fields
-     * in a form or other structures.
-     *
-     * @param {string} value - The unique identifier for the schema.
-     * @returns {this} The updated schema with the assigned ID.
-     *
-     * @example
-     * const schema = string().id('username');
-     */
-    id(value: string): this;
-    /**
-     * Provides a description for the schema, offering additional context or information.
-     * The description can be used when displaying validation errors or for documentation purposes.
-     *
-     * @param {string} value - The description for the schema.
-     * @returns {this} The updated schema with the added description.
-     *
-     * @example
-     * const schema = string().description('The username of the account holder.');
-     */
-    description(value: string): this;
-    private meta;
-    protected defaultValueCheck(): void;
-}
-type TypeMapping = {
-    number: number;
-    string: string;
-    boolean: boolean;
-    undefined: undefined;
-    object: object;
-    function: Function;
-    symbol: symbol;
-    bigint: bigint;
-};
-type MapMixTypes<T extends BaseType[]> = T extends (infer U)[] ? U extends keyof TypeMapping ? TypeMapping[U] : never : never;
-
-export { CommonSchema as C, type MapMixTypes as M, type ObjectShapeSchemaType as O, type ValidatorContext as V, ctxSymbol as c, innerCheck as i };