@palmares/schemas 0.0.1 → 0.1.1

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

@@ -17,10 +17,11 @@ _export(exports, {
     }
 });
 var _schema = /*#__PURE__*/ _interop_require_default(require("./schema"));
-var _conf = require("../conf");
 var _constants = require("../constants");
+var _parsers = require("../parsers");
 var _utils = require("../utils");
 var _number = require("../validators/number");
+var _schema1 = require("../validators/schema");
 function _assert_this_initialized(self) {
     if (self === void 0) {
         throw new ReferenceError("this hasn't been initialised - super() hasn't been called");
@@ -279,14 +280,21 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         _class_call_check(this, NumberSchema);
         var _this;
         _this = _super.apply(this, arguments);
+        _define_property(_assert_this_initialized(_this), "__allowString", void 0);
         _define_property(_assert_this_initialized(_this), "__is", void 0);
         _define_property(_assert_this_initialized(_this), "__integer", void 0);
         _define_property(_assert_this_initialized(_this), "__maxDigits", void 0);
         _define_property(_assert_this_initialized(_this), "__decimalPlaces", void 0);
         _define_property(_assert_this_initialized(_this), "__max", void 0);
         _define_property(_assert_this_initialized(_this), "__min", void 0);
-        _define_property(_assert_this_initialized(_this), "__allowNegative", void 0);
-        _define_property(_assert_this_initialized(_this), "__allowPositive", void 0);
+        _define_property(_assert_this_initialized(_this), "__type", {
+            message: 'Invalid type',
+            check: function(value) {
+                var isNumber = new RegExp('^-?\\d*(\\.\\d+)?$').test(value);
+                if (typeof value === 'string' && _this.__allowString && isNumber) return true;
+                return typeof value === 'number';
+            }
+        });
         return _this;
     }
     _create_class(NumberSchema, [
@@ -307,22 +315,28 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
                                                 return {
                                                     is: _this.__is,
                                                     min: _this.__min,
-                                                    allowNegative: _this.__allowNegative,
-                                                    allowPositive: _this.__allowPositive,
                                                     max: _this.__max,
                                                     integer: _this.__integer,
                                                     optional: _this.__optional,
                                                     nullable: _this.__nullable,
                                                     maxDigits: _this.__maxDigits,
                                                     decimalPlaces: _this.__decimalPlaces,
+                                                    type: _this.__type,
                                                     parsers: {
+                                                        allowString: _this.__allowString,
                                                         nullable: _this.__nullable.allow,
                                                         optional: _this.__optional.allow
                                                     }
                                                 };
                                             }, {
                                                 max: _number.max,
-                                                min: _number.min
+                                                min: _number.min,
+                                                maxDigits: _number.maxDigits,
+                                                is: _schema1.is,
+                                                optional: _schema1.optional,
+                                                nullable: _schema1.nullable,
+                                                decimalPlaces: _number.decimalPlaces,
+                                                integer: _number.integer
                                             }, {
                                                 validatorsIfFallbackOrNotSupported: (0, _number.numberValidation)(),
                                                 shouldAddStringVersion: options.shouldAddStringVersion,
@@ -342,7 +356,7 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
                                 return function(adapter) {
                                     return _ref.apply(this, arguments);
                                 };
-                            }(), _this.__transformedSchemas, options, 'number')
+                            }(), _this, _this.__transformedSchemas, options, 'number')
                         ];
                     });
                 })();
@@ -350,7 +364,8 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * 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.
+   * 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
@@ -362,7 +377,8 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
    *
    * const { errors, parsed } = await numberSchema.parse(-1);
    *
-   * console.log(errors); // [{ isValid: false, code: 'invalid_number', message: 'The number should be greater than 0', path: [] }]
+   * console.log(errors);
+   * // [{ isValid: false, code: 'invalid_number', message: 'The number should be greater than 0', path: [] }]
    * ```
    *
    * @param refinementCallback - The callback that will be called to validate the value.
@@ -406,8 +422,28 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * 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.
+   * 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(NumberSchema.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
@@ -436,14 +472,36 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * 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.
+   * 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(NumberSchema.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.
+   * 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
@@ -465,9 +523,11 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
    * ```
    *
    *
-   * @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.
+   * @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",
@@ -477,9 +537,32 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * 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.
+   * This will allow the value to be a string, it does not validate, it just parses inputs as strings and allows the
+   * result to be a string as well.
+   *
+   * @example
+   * ```ts
+   * number().allowString().parse('true') // true
+   * ```
+   *
+   * @returns - The schema instance
+   */ key: "allowString",
+            value: function allowString() {
+                this.__allowString = true;
+                this.__parsers.low.set('allowString', (0, _parsers.convertFromStringBuilder)(function(value) {
+                    return {
+                        value: Number(value),
+                        preventNextParsers: false
+                    };
+                }));
+                return this;
+            }
+        },
+        {
+            /**
+   * 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.
    *
@@ -524,7 +607,8 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * 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.
+   * 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
@@ -543,8 +627,9 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * 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.
+   * 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
@@ -556,12 +641,13 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
    *
    * const { errors, parsed } = await numberSchema.parse(-1);
    *
-   * console.log(errors); // [{ isValid: false, code: 'nonnegative', message: 'The number should be nonnegative', path: [] }]
+   * console.log(errors);
+   * // [{ isValid: false, code: 'nonnegative', message: 'The number should be nonnegative', path: [] }]
    * ```
    *
    * @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.
+   * @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",
@@ -571,8 +657,9 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * 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.
+   * 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
@@ -619,8 +706,9 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * 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.
+   * 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
@@ -656,7 +744,8 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * 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
+   * 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
@@ -700,17 +789,18 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
    *
    * @returns - The schema instance
    */ key: "is",
-            value: function is(value) {
+            value: function is(value, options) {
                 this.__is = {
                     value: value,
-                    message: "The value should be equal to ".concat(value.join(','))
+                    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;
             }
         },
         {
             /**
-   * Allows only numbers that are less than the value passed. If you want to allow the number to be equal to the value, you can pass the option `inclusive` as `true`.
+   * Allows only numbers that are less than the value passed. If you want to allow the number to be equal to the value,
+   * you can pass the option `inclusive` as `true`.
    * Otherwise, it will only allow numbers less than the value.
    *
    * @example
@@ -747,7 +837,8 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * This method will validate if the number is greater than the value passed. If you want to allow the number to be equal to the value, you can pass the option `inclusive` as `true`.
+   * This method will validate if the number is greater than the value passed. If you want to allow the number to be
+   * equal to the value, you can pass the option `inclusive` as `true`.
    * Otherwise, it will only allow numbers greater than the value.
    *
    * @example
@@ -784,74 +875,8 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * Allows only negative numbers. If you want to allow zero, you can pass the option `allowZero` as `true`. Otherwise, it will only allow negative numbers.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schema';
-   *
-   * const schema = p.number().negative();
-   *
-   * schema.parse(-10); // { errors: [], parsed: -10 }
-   * schema.parse(0); // { errors: [{ code: 'negative', message: 'The number should be negative' }], parsed: 0 }
-   *
-   * const schema = p.number().negative({ allowZero: true });
-   *
-   * schema.parse(0); // { errors: [], parsed: 0 }
-   * ```
-   *
-   * @param options - The options to be passed to the validation
-   * @param options.allowZero - If you want to allow zero, you can pass this option as `true`. Otherwise, it will only allow negative numbers.
-   * @param options.message - The message to be returned if the validation fails
-   *
-   * @returns - The schema instance
-   */ key: "negative",
-            value: function negative(options) {
-                var allowZero = typeof (options === null || options === void 0 ? void 0 : options.allowZero) === 'boolean' ? options.allowZero : true;
-                var message = typeof (options === null || options === void 0 ? void 0 : options.message) === 'string' ? options.message : (0, _constants.DEFAULT_NUMBER_NEGATIVE_EXCEPTION)(allowZero);
-                this.__allowNegative = {
-                    allowZero: allowZero,
-                    message: message
-                };
-                return this;
-            }
-        },
-        {
-            /**
-   * Allows only positive numbers. If you want to allow zero, you can pass the option `allowZero` as `true`. Otherwise, it will only allow positive numbers greater than zero.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schema';
-   *
-   * const schema = p.number().positive();
-   *
-   * schema.parse(10); // { errors: [], parsed: 10 }
-   * schema.parse(0); // { errors: [{ code: 'positive', message: 'The number should be positive' }], parsed: 0 }
-   *
-   * const schema = p.number().positive({ allowZero: true });
-   * schema.parse(0); // { errors: [], parsed: 0 }
-   * ```
-   *
-   * @param options - The options to be passed to the validation
-   * @param options.allowZero - If you want to allow zero, you can pass this option as `true`. Otherwise, it will only allow positive numbers greater than zero.
-   * @param options.message - The message to be returned if the validation fails
-   *
-   * @returns - The schema instance
-   */ key: "positive",
-            value: function positive(options) {
-                var allowZero = typeof (options === null || options === void 0 ? void 0 : options.allowZero) === 'boolean' ? options.allowZero : true;
-                var message = typeof (options === null || options === void 0 ? void 0 : options.message) === 'string' ? options.message : (0, _constants.DEFAULT_NUMBER_NEGATIVE_EXCEPTION)(allowZero);
-                this.__allowPositive = {
-                    allowZero: allowZero,
-                    message: message
-                };
-                return this;
-            }
-        },
-        {
-            /**
-   * This method will validate the number to have the exact number of decimal places. It's usually useful for decimal numbers like currencies.
+   * This method will validate the number to have the exact number of decimal places. It's usually useful for decimal
+   * numbers like currencies.
    *
    * @example
    * ```
@@ -859,7 +884,8 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
    *
    * schema.parse(10.00); // { errors: [], parsed: 10.00}
    *
-   * schema.parse(10.000); // { errors: [{ code: 'decimal_places', message: 'The number should have 2 decimal places' }], parsed: 10.000}
+   * schema.parse(10.000);
+   * // { errors: [{ code: 'decimal_places', message: 'The number should have 2 decimal places' }], parsed: 10.000}
    * ```
    *
    * @param value - The number of decimal places.
@@ -879,8 +905,8 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * This method will validate the number to have at most the number of digits specified. If used in conjunction with {@link decimalPlaces}, this number should be bigger than the
-   * value of the decimal places.
+   * This method will validate the number to have at most the number of digits specified. If used in conjunction with
+   * {@link decimalPlaces}, this number should be bigger than the value of the decimal places.
    *
    * Think about that
    *
@@ -943,12 +969,6 @@ var NumberSchema = /*#__PURE__*/ function(Schema) {
             key: "new",
             value: function _new() {
                 var returnValue = new NumberSchema();
-                var adapterInstance = (0, _conf.getDefaultAdapter)();
-                returnValue.__transformedSchemas[adapterInstance.constructor.name] = {
-                    transformed: false,
-                    adapter: adapterInstance,
-                    schemas: []
-                };
                 return returnValue;
             }
         }