@palmares/schemas 0.0.1 → 0.1.0

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

@@ -17,8 +17,8 @@ _export(exports, {
     }
 });
 var _schema = /*#__PURE__*/ _interop_require_default(require("./schema"));
-var _conf = require("../conf");
 var _utils = require("../utils");
+var _schema1 = require("../validators/schema");
 var _string = require("../validators/string");
 function _assert_this_initialized(self) {
     if (self === void 0) {
@@ -287,6 +287,12 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
         _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, [
@@ -305,6 +311,10 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
                                             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,
@@ -323,8 +333,13 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
                                                 minLength: _string.minLength,
                                                 endsWith: _string.endsWith,
                                                 startsWith: _string.startsWith,
+                                                email: _string.email,
+                                                uuid: _string.uuid,
+                                                is: _schema1.is,
                                                 regex: _string.regex,
-                                                includes: _string.includes
+                                                includes: _string.includes,
+                                                nullable: _schema1.nullable,
+                                                optional: _schema1.optional
                                             }, {
                                                 validatorsIfFallbackOrNotSupported: (0, _string.stringValidation)(),
                                                 shouldAddStringVersion: options.shouldAddStringVersion,
@@ -344,7 +359,7 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
                                 return function(adapter) {
                                     return _ref.apply(this, arguments);
                                 };
-                            }(), _this.__transformedSchemas, options, 'number')
+                            }(), _this, _this.__transformedSchemas, options, 'number')
                         ];
                     });
                 })();
@@ -352,7 +367,8 @@ var StringSchema = /*#__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
@@ -364,7 +380,8 @@ var StringSchema = /*#__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: [] }]
+   * // [{ 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.
@@ -400,14 +417,34 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
    *
    * @returns - The schema we are working with.
    */ key: "optional",
-            value: function optional(options) {
-                return _get(_get_prototype_of(StringSchema.prototype), "optional", this).call(this, options);
+            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.
+   * 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 +473,35 @@ var StringSchema = /*#__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(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.
+   * 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,10 @@ var StringSchema = /*#__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 +536,9 @@ var StringSchema = /*#__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 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 +583,8 @@ var StringSchema = /*#__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 +603,9 @@ var StringSchema = /*#__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
@@ -555,13 +616,13 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
    * });
    *
    * const { errors, parsed } = await numberSchema.parse(-1);
-   *
-   * console.log(errors); // [{ isValid: false, code: 'nonnegative', message: 'The number should be nonnegative', path: [] }]
+   * // [{ 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.
+   * @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 +632,9 @@ var StringSchema = /*#__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 +681,9 @@ var StringSchema = /*#__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,8 +719,9 @@ var StringSchema = /*#__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
-   * here BEFORE the validation. This pretty much transforms the value to a type that the schema adapter can understand.
+   * 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
@@ -681,7 +745,8 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * 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.
+   * 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
@@ -690,17 +755,21 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
    * const schema = p.string().is(['Argentina', 'Brazil', 'Chile']);
    *
    * schema.parse('Argentina'); // { errors: [], parsed: 'Argentina' }
-   * schema.parse('Uruguay'); // { errors: [{ code: 'invalid_value', message: 'The value should be equal to Argentina, Brazil, Chile', path: [] }], parsed: 'Uruguay' }
+   * // { 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) {
+            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;
             }
@@ -716,7 +785,9 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
    * const schema = p.string().endsWith('.com');
    *
    * schema.parse('example.com'); // { errors: [], parsed: 'example.com' }
-   * schema.parse('example.org'); // { errors: [{ code: 'endsWith', message: 'The value should end with .com', path: [] }], parsed: 'example.org' }
+   *
+   * // { 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.
@@ -744,7 +815,11 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
    * const schema = p.string().startsWith('https://');
    *
    * schema.parse('https://example.com'); // { errors: [], parsed: 'https://example.com' }
-   * schema.parse('http://example.com'); // { errors: [{ code: 'startsWith', message: 'The value should start with https://', path: [] }], parsed: 'http://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.
@@ -772,7 +847,13 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
    * const schema = p.string().includes('for babies');
    *
    * schema.parse('Computer graphics for babies'); // { errors: [], parsed: 'Computer graphics for babies' }
-   * schema.parse('Learn javascript as you were 5'); // { errors: [{ code: 'includes', message: 'The string value should include the following substring 'for babies', path: [] }], parsed: 'example.org' }
+   * // {
+   * //   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.
@@ -800,7 +881,15 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
    * const schema = p.string().regex(/^[a-z]+$/);
    *
    * schema.parse('abc'); // { errors: [], parsed: 'abc' }
-   * schema.parse('123'); // { errors: [{ code: 'regex', message: 'The value should match the following regex /^[a-z]+$/', path: [] }], parsed: '123' }
+   * // {
+   * //   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.
@@ -819,7 +908,8 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
         },
         {
             /**
-   * Validates if the string has a maximum length. Use { inclusive: true } to allow the value to have the same length as the maximum length.
+   * 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
@@ -828,7 +918,11 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
    * const schema = p.string().maxLength(5);
    *
    * schema.parse('12345'); // { errors: [], parsed: '12345' }
-   * schema.parse('123456'); // { errors: [{ code: 'maxLength', message: 'The value should have a maximum length of 5', path: [] }], parsed: '123
+   * // {
+   * //   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.
@@ -841,15 +935,15 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
             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),
-                    inclusive: typeof (options === null || options === void 0 ? void 0 : options.inclusive) === 'boolean' ? options.inclusive : false
+                    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.
+   * 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
@@ -858,7 +952,11 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
    * const schema = p.string().minLength(5);
    *
    * schema.parse('12345'); // { errors: [], parsed: '12345' }
-   * schema.parse('1234'); // { errors: [{ code: 'minLength', message: 'The value should have a minimum length of 5', path: [] }], parsed: '1234' }
+   * // {
+   * //   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.
@@ -871,8 +969,7 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
             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),
-                    inclusive: typeof (options === null || options === void 0 ? void 0 : options.inclusive) === 'boolean' ? options.inclusive : false
+                    message: (options === null || options === void 0 ? void 0 : options.message) || "The value should have a minimum length of ".concat(value)
                 };
                 return this;
             }
@@ -887,11 +984,13 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
    *
    * const schema = p.string().uuid();
    *
-   * schema.parse('550e8400-e29b-41d4-a716-446655440000'); // { errors: [], parsed: '550e8400-e29b-41d4-a716-446655440000' }
+   * // { 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'.
+   * @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",
@@ -917,7 +1016,8 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
    * ```
    *
    * @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'.
+   * @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",
@@ -933,12 +1033,6 @@ var StringSchema = /*#__PURE__*/ function(Schema) {
             key: "new",
             value: function _new() {
                 var returnValue = new StringSchema();
-                var adapterInstance = (0, _conf.getDefaultAdapter)();
-                returnValue.__transformedSchemas[adapterInstance.constructor.name] = {
-                    transformed: false,
-                    adapter: adapterInstance,
-                    schemas: []
-                };
                 return returnValue;
             }
         }