@palmares/schemas 0.0.1 → 0.1.0

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

@@ -1,7 +1,7 @@
 import Schema from './schema';
-import { getDefaultAdapter } from '../conf';
 import { defaultTransform, defaultTransformToAdapter } from '../utils';
-import { endsWith, includes, maxLength, minLength, regex, startsWith, stringValidation } from '../validators/string';
+import { is, nullable, optional } from '../validators/schema';
+import { email, endsWith, includes, maxLength, minLength, regex, startsWith, stringValidation, uuid } from '../validators/string';
 export default class StringSchema extends Schema {
     __is;
     __email;
@@ -12,9 +12,19 @@ export default class StringSchema extends Schema {
     __endsWith;
     __startsWith;
     __includes;
+    __type = {
+        message: 'Invalid type',
+        check: (value)=>{
+            return typeof value === 'string';
+        }
+    };
     async __transformToAdapter(options) {
         return defaultTransformToAdapter(async (adapter)=>{
             return defaultTransform('string', this, adapter, adapter.string, ()=>({
+                    type: this.__type,
+                    is: this.__is,
+                    email: this.__email,
+                    uuid: this.__uuid,
                     minLength: this.__minLength,
                     maxLength: this.__maxLength,
                     regex: this.__regex,
@@ -32,8 +42,13 @@ export default class StringSchema extends Schema {
                 minLength,
                 endsWith,
                 startsWith,
+                email,
+                uuid,
+                is,
                 regex,
-                includes
+                includes,
+                nullable,
+                optional
             }, {
                 validatorsIfFallbackOrNotSupported: stringValidation(),
                 shouldAddStringVersion: options.shouldAddStringVersion,
@@ -42,10 +57,11 @@ export default class StringSchema extends Schema {
                     return [];
                 }
             });
-        }, this.__transformedSchemas, options, 'number');
+        }, 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.
+   * 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
@@ -57,7 +73,8 @@ export default class StringSchema extends 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.
@@ -89,12 +106,29 @@ export default class StringSchema extends Schema {
    * ```
    *
    * @returns - The schema we are working with.
-   */ optional(options) {
-        return super.optional(options);
+   */ optional() {
+        return super.optional();
     }
     /**
-   * 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.
+   */ nonOptional(options) {
+        return super.optional({
+            message: 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
@@ -120,14 +154,32 @@ export default class StringSchema extends Schema {
         return super.nullable(options);
     }
     /**
-   * 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.
+   */ nonNullable(options) {
+        return super.nullable({
+            message: 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
@@ -149,18 +201,19 @@ export default class StringSchema extends 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.
    */ omit(args) {
         return super.omit(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.
+   * 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.
    *
@@ -202,7 +255,8 @@ export default class StringSchema extends Schema {
         return super.onSave(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.
+   * 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
@@ -218,8 +272,9 @@ export default class StringSchema extends Schema {
         return super.default(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.
+   * 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
@@ -230,21 +285,22 @@ export default class StringSchema extends 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.
    */ extends(callback, toStringCallback) {
         return super.extends(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.
+   * 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
@@ -288,8 +344,9 @@ export default class StringSchema extends Schema {
         return super.toRepresentation(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.
+   * 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
@@ -322,8 +379,9 @@ export default class StringSchema extends Schema {
         return super.toInternal(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.
+   * 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
@@ -344,7 +402,8 @@ export default class StringSchema extends Schema {
         return super.toValidate(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.
+   * 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
@@ -353,16 +412,20 @@ export default class StringSchema extends 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
-   */ is(value) {
+   */ is(value, options) {
         this.__is = {
             value,
-            message: `The value should be equal to ${value.join(', ')}`
+            message: typeof options?.message === 'string' ? options.message : `The value should be equal to ${value.join(', ')}`
         };
         return this;
     }
@@ -376,7 +439,9 @@ export default class StringSchema extends 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.
@@ -401,7 +466,11 @@ export default class StringSchema extends 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.
@@ -426,7 +495,13 @@ export default class StringSchema extends 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.
@@ -451,7 +526,15 @@ export default class StringSchema extends 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.
@@ -467,7 +550,8 @@ export default class StringSchema extends Schema {
         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.
+   * 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
@@ -476,7 +560,11 @@ export default class StringSchema extends 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.
@@ -488,13 +576,13 @@ export default class StringSchema extends Schema {
    */ maxLength(value, options) {
         this.__maxLength = {
             value,
-            message: options?.message || `The value should have a maximum length of ${value}`,
-            inclusive: typeof options?.inclusive === 'boolean' ? options.inclusive : false
+            message: options?.message || `The value should have a maximum length of ${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
@@ -503,7 +591,11 @@ export default class StringSchema extends 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.
@@ -515,8 +607,7 @@ export default class StringSchema extends Schema {
    */ minLength(value, options) {
         this.__minLength = {
             value,
-            message: options?.message || `The value should have a minimum length of ${value}`,
-            inclusive: typeof options?.inclusive === 'boolean' ? options.inclusive : false
+            message: options?.message || `The value should have a minimum length of ${value}`
         };
         return this;
     }
@@ -529,11 +620,13 @@ export default class StringSchema extends 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.
    */ uuid(options) {
@@ -556,7 +649,8 @@ export default class StringSchema extends 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.
    */ email(options) {
@@ -567,12 +661,6 @@ export default class StringSchema extends Schema {
     }
     static new() {
         const returnValue = new StringSchema();
-        const adapterInstance = getDefaultAdapter();
-        returnValue.__transformedSchemas[adapterInstance.constructor.name] = {
-            transformed: false,
-            adapter: adapterInstance,
-            schemas: []
-        };
         return returnValue;
     }
 }