@palmares/schemas 0.1.25 → 0.2.0

package/dist/cjs/src/schema/string.js

@@ -1,1038 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    StringSchema: function() {
-        return StringSchema;
-    },
-    string: function() {
-        return string;
-    }
-});
-var _schema = require("./schema");
-var _utils = require("../utils");
-var _schema1 = require("../validators/schema");
-var _string = require("../validators/string");
-function _assert_this_initialized(self) {
-    if (self === void 0) {
-        throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
-    }
-    return self;
-}
-function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
-    try {
-        var info = gen[key](arg);
-        var value = info.value;
-    } catch (error) {
-        reject(error);
-        return;
-    }
-    if (info.done) {
-        resolve(value);
-    } else {
-        Promise.resolve(value).then(_next, _throw);
-    }
-}
-function _async_to_generator(fn) {
-    return function() {
-        var self = this, args = arguments;
-        return new Promise(function(resolve, reject) {
-            var gen = fn.apply(self, args);
-            function _next(value) {
-                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
-            }
-            function _throw(err) {
-                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
-            }
-            _next(undefined);
-        });
-    };
-}
-function _class_call_check(instance, Constructor) {
-    if (!(instance instanceof Constructor)) {
-        throw new TypeError("Cannot call a class as a function");
-    }
-}
-function _defineProperties(target, props) {
-    for(var i = 0; i < props.length; i++){
-        var descriptor = props[i];
-        descriptor.enumerable = descriptor.enumerable || false;
-        descriptor.configurable = true;
-        if ("value" in descriptor) descriptor.writable = true;
-        Object.defineProperty(target, descriptor.key, descriptor);
-    }
-}
-function _create_class(Constructor, protoProps, staticProps) {
-    if (protoProps) _defineProperties(Constructor.prototype, protoProps);
-    if (staticProps) _defineProperties(Constructor, staticProps);
-    return Constructor;
-}
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-function _get(target, property, receiver) {
-    if (typeof Reflect !== "undefined" && Reflect.get) {
-        _get = Reflect.get;
-    } else {
-        _get = function get(target, property, receiver) {
-            var base = _super_prop_base(target, property);
-            if (!base) return;
-            var desc = Object.getOwnPropertyDescriptor(base, property);
-            if (desc.get) {
-                return desc.get.call(receiver || target);
-            }
-            return desc.value;
-        };
-    }
-    return _get(target, property, receiver || target);
-}
-function _get_prototype_of(o) {
-    _get_prototype_of = Object.setPrototypeOf ? Object.getPrototypeOf : function getPrototypeOf(o) {
-        return o.__proto__ || Object.getPrototypeOf(o);
-    };
-    return _get_prototype_of(o);
-}
-function _inherits(subClass, superClass) {
-    if (typeof superClass !== "function" && superClass !== null) {
-        throw new TypeError("Super expression must either be null or a function");
-    }
-    subClass.prototype = Object.create(superClass && superClass.prototype, {
-        constructor: {
-            value: subClass,
-            writable: true,
-            configurable: true
-        }
-    });
-    if (superClass) _set_prototype_of(subClass, superClass);
-}
-function _possible_constructor_return(self, call) {
-    if (call && (_type_of(call) === "object" || typeof call === "function")) {
-        return call;
-    }
-    return _assert_this_initialized(self);
-}
-function _set_prototype_of(o, p) {
-    _set_prototype_of = Object.setPrototypeOf || function setPrototypeOf(o, p) {
-        o.__proto__ = p;
-        return o;
-    };
-    return _set_prototype_of(o, p);
-}
-function _super_prop_base(object, property) {
-    while(!Object.prototype.hasOwnProperty.call(object, property)){
-        object = _get_prototype_of(object);
-        if (object === null) break;
-    }
-    return object;
-}
-function _type_of(obj) {
-    "@swc/helpers - typeof";
-    return obj && typeof Symbol !== "undefined" && obj.constructor === Symbol ? "symbol" : typeof obj;
-}
-function _is_native_reflect_construct() {
-    if (typeof Reflect === "undefined" || !Reflect.construct) return false;
-    if (Reflect.construct.sham) return false;
-    if (typeof Proxy === "function") return true;
-    try {
-        Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function() {}));
-        return true;
-    } catch (e) {
-        return false;
-    }
-}
-function _create_super(Derived) {
-    var hasNativeReflectConstruct = _is_native_reflect_construct();
-    return function _createSuperInternal() {
-        var Super = _get_prototype_of(Derived), result;
-        if (hasNativeReflectConstruct) {
-            var NewTarget = _get_prototype_of(this).constructor;
-            result = Reflect.construct(Super, arguments, NewTarget);
-        } else {
-            result = Super.apply(this, arguments);
-        }
-        return _possible_constructor_return(this, result);
-    };
-}
-function _ts_generator(thisArg, body) {
-    var f, y, t, g, _ = {
-        label: 0,
-        sent: function() {
-            if (t[0] & 1) throw t[1];
-            return t[1];
-        },
-        trys: [],
-        ops: []
-    };
-    return g = {
-        next: verb(0),
-        "throw": verb(1),
-        "return": verb(2)
-    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
-        return this;
-    }), g;
-    function verb(n) {
-        return function(v) {
-            return step([
-                n,
-                v
-            ]);
-        };
-    }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while(_)try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [
-                op[0] & 2,
-                t.value
-            ];
-            switch(op[0]){
-                case 0:
-                case 1:
-                    t = op;
-                    break;
-                case 4:
-                    _.label++;
-                    return {
-                        value: op[1],
-                        done: false
-                    };
-                case 5:
-                    _.label++;
-                    y = op[1];
-                    op = [
-                        0
-                    ];
-                    continue;
-                case 7:
-                    op = _.ops.pop();
-                    _.trys.pop();
-                    continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
-                        _ = 0;
-                        continue;
-                    }
-                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
-                        _.label = op[1];
-                        break;
-                    }
-                    if (op[0] === 6 && _.label < t[1]) {
-                        _.label = t[1];
-                        t = op;
-                        break;
-                    }
-                    if (t && _.label < t[2]) {
-                        _.label = t[2];
-                        _.ops.push(op);
-                        break;
-                    }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop();
-                    continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) {
-            op = [
-                6,
-                e
-            ];
-            y = 0;
-        } finally{
-            f = t = 0;
-        }
-        if (op[0] & 5) throw op[1];
-        return {
-            value: op[0] ? op[1] : void 0,
-            done: true
-        };
-    }
-}
-var StringSchema = /*#__PURE__*/ function(Schema) {
-    "use strict";
-    _inherits(StringSchema, Schema);
-    var _super = _create_super(StringSchema);
-    function StringSchema() {
-        _class_call_check(this, StringSchema);
-        var _this;
-        _this = _super.apply(this, arguments);
-        _define_property(_assert_this_initialized(_this), "fieldType", 'string');
-        _define_property(_assert_this_initialized(_this), "__is", void 0);
-        _define_property(_assert_this_initialized(_this), "__email", void 0);
-        _define_property(_assert_this_initialized(_this), "__uuid", void 0);
-        _define_property(_assert_this_initialized(_this), "__minLength", void 0);
-        _define_property(_assert_this_initialized(_this), "__maxLength", void 0);
-        _define_property(_assert_this_initialized(_this), "__regex", void 0);
-        _define_property(_assert_this_initialized(_this), "__endsWith", void 0);
-        _define_property(_assert_this_initialized(_this), "__startsWith", void 0);
-        _define_property(_assert_this_initialized(_this), "__includes", void 0);
-        _define_property(_assert_this_initialized(_this), "__type", {
-            message: 'Invalid type',
-            check: function(value) {
-                return typeof value === 'string';
-            }
-        });
-        return _this;
-    }
-    _create_class(StringSchema, [
-        {
-            key: "__transformToAdapter",
-            value: function __transformToAdapter(options) {
-                var _this = this;
-                return _async_to_generator(function() {
-                    return _ts_generator(this, function(_state) {
-                        return [
-                            2,
-                            (0, _utils.defaultTransformToAdapter)(function() {
-                                var _ref = _async_to_generator(function(adapter) {
-                                    return _ts_generator(this, function(_state) {
-                                        return [
-                                            2,
-                                            (0, _utils.defaultTransform)('string', _this, adapter, adapter.string, function() {
-                                                return {
-                                                    type: _this.__type,
-                                                    is: _this.__is,
-                                                    email: _this.__email,
-                                                    uuid: _this.__uuid,
-                                                    minLength: _this.__minLength,
-                                                    maxLength: _this.__maxLength,
-                                                    regex: _this.__regex,
-                                                    endsWith: _this.__endsWith,
-                                                    startsWith: _this.__startsWith,
-                                                    includes: _this.__includes,
-                                                    nullable: _this.__nullable,
-                                                    optional: _this.__optional,
-                                                    parsers: {
-                                                        nullable: _this.__nullable.allow,
-                                                        optional: _this.__optional.allow
-                                                    }
-                                                };
-                                            }, {
-                                                maxLength: _string.maxLength,
-                                                minLength: _string.minLength,
-                                                endsWith: _string.endsWith,
-                                                startsWith: _string.startsWith,
-                                                email: _string.email,
-                                                uuid: _string.uuid,
-                                                is: _schema1.is,
-                                                regex: _string.regex,
-                                                includes: _string.includes,
-                                                nullable: _schema1.nullable,
-                                                optional: _schema1.optional
-                                            }, {
-                                                validatorsIfFallbackOrNotSupported: (0, _string.stringValidation)(),
-                                                shouldAddStringVersion: options.shouldAddStringVersion,
-                                                // eslint-disable-next-line ts/require-await
-                                                fallbackIfNotSupported: /*#__PURE__*/ _async_to_generator(function() {
-                                                    return _ts_generator(this, function(_state) {
-                                                        return [
-                                                            2,
-                                                            []
-                                                        ];
-                                                    });
-                                                })
-                                            })
-                                        ];
-                                    });
-                                });
-                                return function(adapter) {
-                                    return _ref.apply(this, arguments);
-                                };
-                            }(), _this, _this.__transformedSchemas, options, 'number')
-                        ];
-                    });
-                })();
-            }
-        },
-        {
-            /**
-   * This let's you refine the schema with custom validations. This is useful when you want to validate something that
-   * is not supported by default by the schema adapter.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schemas';
-   *
-   * const numberSchema = p.number().refine((value) => {
-   *   if (value < 0) return { code: 'invalid_number', message: 'The number should be greater than 0' };
-   * });
-   *
-   * const { errors, parsed } = await numberSchema.parse(-1);
-   *
-   * // [{ isValid: false, code: 'invalid_number', message: 'The number should be greater than 0', path: [] }]
-   * console.log(errors);
-   * ```
-   *
-   * @param refinementCallback - The callback that will be called to validate the value.
-   * @param options - Options for the refinement.
-   * @param options.isAsync - Whether the callback is async or not. Defaults to true.
-   */ key: "refine",
-            value: function refine(refinementCallback) {
-                return _get(_get_prototype_of(StringSchema.prototype), "refine", this).call(this, refinementCallback);
-            }
-        },
-        {
-            /**
-   * Allows the value to be either undefined or null.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schemas';
-   *
-   * const numberSchema = p.number().optional();
-   *
-   * const { errors, parsed } = await numberSchema.parse(undefined);
-   *
-   * console.log(parsed); // undefined
-   *
-   * const { errors, parsed } = await numberSchema.parse(null);
-   *
-   * console.log(parsed); // null
-   *
-   * const { errors, parsed } = await numberSchema.parse(1);
-   *
-   * console.log(parsed); // 1
-   * ```
-   *
-   * @returns - The schema we are working with.
-   */ key: "optional",
-            value: function optional() {
-                return _get(_get_prototype_of(StringSchema.prototype), "optional", this).call(this);
-            }
-        },
-        {
-            /**
-   * Just adds a message when the value is undefined. It's just a syntax sugar for
-   *
-   * ```typescript
-   * p.string().optional({ message: 'This value cannot be null', allow: false })
-   * ```
-   *
-   * @param options - The options of nonOptional function
-   * @param options.message - A custom message if the value is undefined.
-   *
-   * @returns - The schema.
-   */ key: "nonOptional",
-            value: function nonOptional(options) {
-                return _get(_get_prototype_of(StringSchema.prototype), "optional", this).call(this, {
-                    message: options === null || options === void 0 ? void 0 : options.message,
-                    allow: false
-                });
-            }
-        },
-        {
-            /**
-   * Allows the value to be null and ONLY null. You can also use this function to set a custom message when the value
-   * is NULL by setting the { message: 'Your custom message', allow: false } on the options.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schemas';
-   *
-   * const numberSchema = p.number().nullable();
-   *
-   * const { errors, parsed } = await numberSchema.parse(null);
-   *
-   * console.log(parsed); // null
-   *
-   * const { errors, parsed } = await numberSchema.parse(undefined);
-   *
-   * console.log(errors); // [{ isValid: false, code: 'invalid_type', message: 'Invalid type', path: [] }]
-   * ```
-   *
-   * @param options - The options for the nullable function.
-   * @param options.message - The message to be shown when the value is not null. Defaults to 'Cannot be null'.
-   * @param options.allow - Whether the value can be null or not. Defaults to true.
-   *
-   * @returns The schema.
-   */ key: "nullable",
-            value: function nullable(options) {
-                return _get(_get_prototype_of(StringSchema.prototype), "nullable", this).call(this, options);
-            }
-        },
-        {
-            /**
-   * Just adds a message when the value is null. It's just a syntax sugar for
-   *
-   * ```typescript
-   * p.string().nullable({ message: 'This value cannot be null', allow: false })
-   * ```
-   *
-   * @param options - The options of nonNullable function
-   * @param options.message - A custom message if the value is null.
-   *
-   * @returns - The schema.
-   */ key: "nonNullable",
-            value: function nonNullable(options) {
-                return _get(_get_prototype_of(StringSchema.prototype), "nullable", this).call(this, {
-                    message: (options === null || options === void 0 ? void 0 : options.message) || '',
-                    allow: false
-                });
-            }
-        },
-        {
-            /**
-   * This method will remove the value from the representation of the schema. If the value is undefined it will keep
-   * that way otherwise it will set the value to undefined after it's validated.
-   * This is used in conjunction with the {@link data} function, the {@link parse} function or {@link validate}
-   * function. This will remove the value from the representation of the schema.
-   *
-   * By default, the value will be removed just from the representation, in other words, when you call the {@link data}
-   * function. But if you want to remove the value from the internal representation, you can pass the argument
-   * `toInternal` as true. Then if you still want to remove the value from the representation, you will need to pass
-   * the argument `toRepresentation` as true as well.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schemas';
-   *
-   * const userSchema = p.object({
-   *   id: p.number().optional(),
-   *   name: p.string(),
-   *   password: p.string().omit()
-   * });
-   *
-   * const user = await userSchema.data({
-   *  id: 1,
-   *  name: 'John Doe',
-   *  password: '123456'
-   * });
-   *
-   * console.log(user); // { id: 1, name: 'John Doe' }
-   * ```
-   *
-   *
-   * @param args - By default, the value will be removed just from the representation, in other words, when you call
-   * the {@link data} function. But if you want to remove the value from the internal representation, you can pass the
-   * argument `toInternal` as true. Then if you still want to remove the value from the representation, you will need
-   * to pass the argument `toRepresentation` as true as well.
-   *
-   * @returns The schema.
-   */ key: "omit",
-            value: function omit(args) {
-                return _get(_get_prototype_of(StringSchema.prototype), "omit", this).call(this, args);
-            }
-        },
-        {
-            /**
-   * This function is used in conjunction with the {@link validate} function. It's used to save a value to an external
-   * source like a database. You should always return the schema after you save the value, that way we will always have
-   * the correct type of the schema after the save operation.
-   *
-   * You can use the {@link toRepresentation} function to transform and clean the value it returns after the save.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schemas';
-   *
-   * import { User } from './models';
-   *
-   * const userSchema = p.object({
-   *   id: p.number().optional(),
-   *   name: p.string(),
-   *   email: p.string().email(),
-   * }).onSave(async (value) => {
-   *   // Create or update the user on the database using palmares models or any other library of your choice.
-   *   if (value.id)
-   *      await User.default.set(value, { search: { id: value.id } });
-   *   else
-   *      await User.default.set(value);
-   *
-   *   return value;
-   * });
-   *
-   *
-   * // Then, on your controller, do something like this:
-   * const { isValid, save, errors } = await userSchema.validate(req.body);
-   * if (isValid) {
-   *    const savedValue = await save();
-   *    return Response.json(savedValue, { status: 201 });
-   * }
-   *
-   * return Response.json({ errors }, { status: 400 });
-   * ```
-   *
-   * @param callback - The callback that will be called to save the value on an external source.
-   *
-   * @returns The schema.
-   */ key: "onSave",
-            value: function onSave(callback) {
-                return _get(_get_prototype_of(StringSchema.prototype), "onSave", this).call(this, callback);
-            }
-        },
-        {
-            /**
-   * This function is used to add a default value to the schema. If the value is either undefined or null, the default
-   * value will be used.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schemas';
-   *
-   * const numberSchema = p.number().default(0);
-   *
-   * const { errors, parsed } = await numberSchema.parse(undefined);
-   *
-   * console.log(parsed); // 0
-   * ```
-   */ key: "default",
-            value: function _default(defaultValueOrFunction) {
-                return _get(_get_prototype_of(StringSchema.prototype), "default", this).call(this, defaultValueOrFunction);
-            }
-        },
-        {
-            /**
-   * This function let's you customize the schema your own way. After we translate the schema on the adapter we call
-   * this function to let you customize the custom schema your own way. Our API does not support passthrough?
-   * No problem, you can use this function to customize the zod schema.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schemas';
-   *
-   * const numberSchema = p.number().extends((schema) => {
-   *   return schema.nonnegative();
-   * });
-   *
-   * const { errors, parsed } = await numberSchema.parse(-1);
-   * // [{ isValid: false, code: 'nonnegative', message: 'The number should be nonnegative', path: [] }]
-   * console.log(errors);
-   * ```
-   *
-   * @param callback - The callback that will be called to customize the schema.
-   * @param toStringCallback - The callback that will be called to transform the schema to a string when you want to
-   * compile the underlying schema to a string so you can save it for future runs.
-   *
-   * @returns The schema.
-   */ key: "extends",
-            value: function _extends(callback, toStringCallback) {
-                return _get(_get_prototype_of(StringSchema.prototype), "extends", this).call(this, callback, toStringCallback);
-            }
-        },
-        {
-            /**
-   * This function is used to transform the value to the representation of the schema. When using the {@link data}
-   * function. With this function you have full control to add data cleaning for example, transforming the data and
-   * whatever. Another use case is when you want to return deeply nested recursive data.
-   * The schema maps to itself.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schemas';
-   *
-   * const recursiveSchema = p.object({
-   *   id: p.number().optional(),
-   *   name: p.string(),
-   * }).toRepresentation(async (value) => {
-   *    return {
-   *      id: value.id,
-   *      name: value.name,
-   *      children: await Promise.all(value.children.map(async (child) => await recursiveSchema.data(child)))
-   *    }
-   * });
-   *
-   * const data = await recursiveSchema.data({
-   *    id: 1,
-   *    name: 'John Doe',
-   * });
-   * ```
-   *
-   * @example
-   * ```
-   * import * as p from '@palmares/schemas';
-   *
-   * const colorToRGBSchema = p.string().toRepresentation(async (value) => {
-   *    switch (value) {
-   *      case 'red': return { r: 255, g: 0, b: 0 };
-   *      case 'green': return { r: 0, g: 255, b: 0 };
-   *      case 'blue': return { r: 0, g: 0, b: 255 };
-   *      default: return { r: 0, g: 0, b: 0 };
-   *   }
-   * });
-   * ```
-   * @param toRepresentationCallback - The callback that will be called to transform the value to the representation.
-   *
-   * @returns The schema with a new return type
-   */ key: "toRepresentation",
-            value: function toRepresentation(toRepresentationCallback) {
-                return _get(_get_prototype_of(StringSchema.prototype), "toRepresentation", this).call(this, toRepresentationCallback);
-            }
-        },
-        {
-            /**
-   * This function is used to transform the value to the internal representation of the schema. This is useful when
-   * you want to transform the value to a type that the schema adapter can understand. For example, you might want
-   * to transform a string to a date. This is the function you use.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schemas';
-   *
-   * const dateSchema = p.string().toInternal((value) => {
-   *   return new Date(value);
-   * });
-   *
-   * const date = await dateSchema.parse('2021-01-01');
-   *
-   * console.log(date); // Date object
-   *
-   * const rgbToColorSchema = p.object({
-   *   r: p.number().min(0).max(255),
-   *   g: p.number().min(0).max(255),
-   *   b: p.number().min(0).max(255),
-   * }).toInternal(async (value) => {
-   *    if (value.r === 255 && value.g === 0 && value.b === 0) return 'red';
-   *    if (value.r === 0 && value.g === 255 && value.b === 0) return 'green';
-   *    if (value.r === 0 && value.g === 0 && value.b === 255) return 'blue';
-   *    return `rgb(${value.r}, ${value.g}, ${value.b})`;
-   * });
-   * ```
-   *
-   * @param toInternalCallback - The callback that will be called to transform the value to the internal representation.
-   *
-   * @returns The schema with a new return type.
-   */ key: "toInternal",
-            value: function toInternal(toInternalCallback) {
-                return _get(_get_prototype_of(StringSchema.prototype), "toInternal", this).call(this, toInternalCallback);
-            }
-        },
-        {
-            /**
-   * Called before the validation of the schema. Let's say that you want to validate a date that might receive a string,
-   * you can convert that string to a date here BEFORE the validation. This pretty much transforms the value to a
-   * type that the schema adapter can understand.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schemas';
-   * import * as z from 'zod';
-   *
-   * const customRecordToMapSchema = p.schema().appendSchema(z.map()).toValidate(async (value) => {
-   *    return new Map(value); // Before validating we transform the value to a map.
-   * });
-   *
-   * const { errors, parsed } = await customRecordToMapSchema.parse({ key: 'value' });
-   * ```
-   *
-   * @param toValidateCallback - The callback that will be called to validate the value.
-   *
-   * @returns The schema with a new return type.
-   */ key: "toValidate",
-            value: function toValidate(toValidateCallback) {
-                return _get(_get_prototype_of(StringSchema.prototype), "toValidate", this).call(this, toValidateCallback);
-            }
-        },
-        {
-            /**
-   * Defines a list of strings that are allowed, it's useful when you want to restrict the values that are allowed.
-   * Like a selector or a Choice field.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schema';
-   *
-   * const schema = p.string().is(['Argentina', 'Brazil', 'Chile']);
-   *
-   * schema.parse('Argentina'); // { errors: [], parsed: 'Argentina' }
-   * // { errors: [{
-   * //   code: 'invalid_value',
-   * //   message: 'The value should be equal to Argentina, Brazil, Chile',
-   * //   path: [] }], parsed: 'Uruguay' }
-   * schema.parse('Uruguay');
-   * ```
-   *
-   * @param value - The list of numbers that are allowed
-   *
-   * @returns - The schema instance
-   */ key: "is",
-            value: function is(value, options) {
-                this.__is = {
-                    value: value,
-                    message: typeof (options === null || options === void 0 ? void 0 : options.message) === 'string' ? options.message : "The value should be equal to ".concat(value.join(', '))
-                };
-                return this;
-            }
-        },
-        {
-            /**
-   * Validates if the string ends with a specific value.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schema';
-   *
-   * const schema = p.string().endsWith('.com');
-   *
-   * schema.parse('example.com'); // { errors: [], parsed: 'example.com' }
-   *
-   * // { errors: [{ code: 'endsWith', message: 'The value should end with .com', path: [] }], parsed: 'example.org' }
-   * schema.parse('example.org');
-   * ```
-   *
-   * @param value - The value that the string should end with.
-   * @param options - The options for the endsWith function.
-   * @param options.message - The message to be shown when the value does not end with the value.
-   *
-   * @returns - The schema instance.
-   */ key: "endsWith",
-            value: function endsWith(value, options) {
-                this.__endsWith = {
-                    value: value,
-                    message: (options === null || options === void 0 ? void 0 : options.message) || "The value should end with ".concat(value)
-                };
-                return this;
-            }
-        },
-        {
-            /**
-   * Validates if the string starts with a specific value.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schema';
-   *
-   * const schema = p.string().startsWith('https://');
-   *
-   * schema.parse('https://example.com'); // { errors: [], parsed: 'https://example.com' }
-   * // {
-   * //   errors: [{ code: 'startsWith', message: 'The value should start with https://', path: [] }],
-   * //   parsed: 'http://example.com'
-   * // }
-   * schema.parse('http://example.com');
-   * ```
-   *
-   * @param value - The value that the string should start with.
-   * @param options - The options for the startsWith function.
-   * @param options.message - The message to be shown when the value does not start with the value.
-   *
-   * @returns - The schema instance.
-   */ key: "startsWith",
-            value: function startsWith(value, options) {
-                this.__startsWith = {
-                    value: value,
-                    message: (options === null || options === void 0 ? void 0 : options.message) || "The value should start with ".concat(value)
-                };
-                return this;
-            }
-        },
-        {
-            /**
-   * Checks if the string includes a specific substring.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schema';
-   *
-   * const schema = p.string().includes('for babies');
-   *
-   * schema.parse('Computer graphics for babies'); // { errors: [], parsed: 'Computer graphics for babies' }
-   * // {
-   * //   errors: [{
-   * //     code: 'includes',
-   * //     message: 'The string value should include the following substring 'for babies',
-   * //     path: []
-   * //   }], parsed: 'example.org' }
-   * schema.parse('Learn javascript as you were 5');
-   * ```
-   *
-   * @param value - The value that the string should include.
-   * @param options - The options for the includes function.
-   * @param options.message - The message to be shown when the value does not include the value.
-   *
-   * @returns - The schema instance.
-   */ key: "includes",
-            value: function includes(value, options) {
-                this.__includes = {
-                    value: value,
-                    message: (options === null || options === void 0 ? void 0 : options.message) || "The string value should include the following substring '".concat(value, "'")
-                };
-                return this;
-            }
-        },
-        {
-            /**
-   * Validates if the string matches a specific regex.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schema';
-   *
-   * const schema = p.string().regex(/^[a-z]+$/);
-   *
-   * schema.parse('abc'); // { errors: [], parsed: 'abc' }
-   * // {
-   * //   errors: [{
-   * //     code: 'regex',
-   * //     message: 'The value should match the following regex /^[a-z]+$/',
-   * //     path: []
-   * //   }],
-   * //   parsed: '123'
-   * // }
-   * schema.parse('123');
-   * ```
-   *
-   * @param value - The regex that the string should match.
-   * @param options - The options for the regex function.
-   * @param options.message - The message to be shown when the value does not match the regex.
-   *
-   * @returns - The schema instance.
-   */ key: "regex",
-            value: function regex(value, options) {
-                this.__regex = {
-                    value: value,
-                    message: (options === null || options === void 0 ? void 0 : options.message) || "The value should match the following regex '".concat(value.toString(), "'")
-                };
-                return this;
-            }
-        },
-        {
-            /**
-   * Validates if the string has a maximum length. Use { inclusive: true } to allow the value to have the same length
-   * as the maximum length.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schema';
-   *
-   * const schema = p.string().maxLength(5);
-   *
-   * schema.parse('12345'); // { errors: [], parsed: '12345' }
-   * // {
-   * //   errors: [{ code: 'maxLength', message: 'The value should have a maximum length of 5', path: [] }],
-   * //   parsed: '123
-   * //   }
-   * schema.parse('123456');
-   * ```
-   *
-   * @param value - The maximum length that the string should have.
-   * @param options - The options for the maxLength function.
-   * @param options.message - The message to be shown when the value has a length greater than the maximum length.
-   * @param options.inclusive - Whether the value can have the same length as the maximum length. Defaults to false.
-   *
-   * @returns - The schema instance.
-   */ key: "maxLength",
-            value: function maxLength(value, options) {
-                this.__maxLength = {
-                    value: value,
-                    message: (options === null || options === void 0 ? void 0 : options.message) || "The value should have a maximum length of ".concat(value)
-                };
-                return this;
-            }
-        },
-        {
-            /**
-   * Validates if the string has a minimum length. Use { inclusive: true } to allow the value to have the same length
-   * as the minimum length.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schema';
-   *
-   * const schema = p.string().minLength(5);
-   *
-   * schema.parse('12345'); // { errors: [], parsed: '12345' }
-   * // {
-   * //   errors: [{ code: 'minLength', message: 'The value should have a minimum length of 5', path: [] }],
-   * //   parsed: '1234'
-   * // }
-   * schema.parse('1234');
-   * ```
-   *
-   * @param value - The minimum length that the string should have.
-   * @param options - The options for the minLength function.
-   * @param options.message - The message to be shown when the value has a length less than the minimum length.
-   * @param options.inclusive - Whether the value can have the same length as the minimum length. Defaults to false.
-   *
-   * @returns - The schema instance.
-   */ key: "minLength",
-            value: function minLength(value, options) {
-                this.__minLength = {
-                    value: value,
-                    message: (options === null || options === void 0 ? void 0 : options.message) || "The value should have a minimum length of ".concat(value)
-                };
-                return this;
-            }
-        },
-        {
-            /**
-   * Validates if the string is a valid UUID.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schema';
-   *
-   * const schema = p.string().uuid();
-   *
-   * // { errors: [], parsed: '550e8400-e29b-41d4-a716-446655440000' }
-   * schema.parse('550e8400-e29b-41d4-a716-446655440000');
-   * ```
-   *
-   * @param options - The options for the uuid function.
-   * @param options.message - The message to be shown when the value is not a valid UUID. Defaults to
-   * 'The value should be a valid UUID'.
-   *
-   * @returns - The schema instance.
-   */ key: "uuid",
-            value: function uuid(options) {
-                this.__uuid = {
-                    message: (options === null || options === void 0 ? void 0 : options.message) || 'The value should be a valid UUID'
-                };
-                return this;
-            }
-        },
-        {
-            /**
-   * Validates if the string is a valid email or not
-   *
-   * @example
-   * ```typescript
-   *
-   * import * as p from '@palmares/schema';
-   *
-   * const schema = p.string().email();
-   *
-   * schema.parse('john.doe@example.com'); // { errors: [], parsed: 'john.doe@example.com' }
-   * ```
-   *
-   * @param options - The options for the email function.
-   * @param options.message - The message to be shown when the value is not a valid email.
-   * Defaults to 'The value should be a valid email'.
-   *
-   * @returns - The schema instance.
-   */ key: "email",
-            value: function email(options) {
-                this.__email = {
-                    message: (options === null || options === void 0 ? void 0 : options.message) || 'The value should be a valid email'
-                };
-                return this;
-            }
-        }
-    ], [
-        {
-            key: "new",
-            value: function _new() {
-                var returnValue = new StringSchema();
-                return returnValue;
-            }
-        }
-    ]);
-    return StringSchema;
-}(_schema.Schema);
-var string = StringSchema.new;