@palmares/schemas 0.1.25 → 0.2.0

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

@@ -1,487 +0,0 @@
-import { Schema } from './schema';
-import { defaultTransform, defaultTransformToAdapter, shouldRunDataOnComplexSchemas, transformSchemaAndCheckIfShouldBeHandledByFallbackOnComplexSchemas } from '../utils';
-import { arrayValidation, maxLength, minLength, nonEmpty } from '../validators/array';
-import { nullable, optional } from '../validators/schema';
-import { Validator } from '../validators/utils';
-export class ArraySchema extends Schema {
-    $$type = '$PArraySchema';
-    fieldType = 'array';
-    __schemas;
-    __type = {
-        message: 'Invalid type',
-        check: (value)=>Array.isArray(value)
-    };
-    __minLength;
-    __maxLength;
-    __nonEmpty;
-    constructor(...schemas){
-        super();
-        this.__schemas = schemas;
-    }
-    async __transformToAdapter(options) {
-        return defaultTransformToAdapter(async (adapter)=>{
-            const schemas = Array.isArray(this.__schemas[0]) ? this.__schemas[0] : this.__schemas;
-            const transformedSchemasAsString = [];
-            const transformedSchemas = [];
-            let shouldBeHandledByFallback = false;
-            await Promise.all(schemas.map(async (schema)=>{
-                const [transformedData, shouldAddFallbackValidationForThisSchema] = await transformSchemaAndCheckIfShouldBeHandledByFallbackOnComplexSchemas(schema, options);
-                if (shouldAddFallbackValidationForThisSchema) shouldBeHandledByFallback = true;
-                for (const transformedSchema of transformedData){
-                    transformedSchemasAsString.push(transformedSchema.asString);
-                    transformedSchemas.push(transformedSchema.transformed);
-                }
-            }));
-            // eslint-disable-next-line ts/no-unnecessary-condition
-            if (shouldBeHandledByFallback) Validator.createAndAppendFallback(this, arrayValidation(Array.isArray(this.__schemas[0]) === false, Array.isArray(this.__schemas[0]) ? this.__schemas[0] : this.__schemas));
-            return defaultTransform('array', this, adapter, adapter.array, ()=>({
-                    isTuple: Array.isArray(this.__schemas[0]) === false,
-                    nullable: this.__nullable,
-                    optional: this.__optional,
-                    maxLength: this.__maxLength,
-                    minLength: this.__minLength,
-                    nonEmpty: this.__nonEmpty,
-                    schemas: transformedSchemas,
-                    type: this.__type,
-                    parsers: {
-                        nullable: this.__nullable.allow,
-                        optional: this.__optional.allow
-                    }
-                }), {
-                optional,
-                nullable,
-                minLength,
-                maxLength,
-                nonEmpty
-            }, {
-                shouldAddStringVersion: options.shouldAddStringVersion,
-                // eslint-disable-next-line ts/require-await
-                fallbackIfNotSupported: async ()=>[]
-            });
-        }, this, this.__transformedSchemas, options, 'array');
-    }
-    /**
-   * 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.
-   */ refine(refinementCallback) {
-        return super.refine(refinementCallback);
-    }
-    /**
-   * Allows the value to be either undefined or null. Different from the `optional` method on other schemas, You can
-   * pass `outputOnly` as `true` to this method.
-   * This will allow you to pass `null` or `undefined` as a value on the {@link Schema.data} method, but it will not
-   * allow the value to be `null` or `undefined`. This is useful for typing purposes.
-   *
-   * @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
-   *
-   * const companySchema = p.object({ id: p.number(), name: p.string() });
-   * const userSchema = p.object({
-   *   id: p.number(),
-   *   name: p.string(),
-   *   company: companySchema.optional({ outputOnly: true })
-   * });
-   *
-   * // Will not allow the company to be null or undefined on a typing level.
-   * const { errors, parsed } = await userSchema.data({ id: 1, name: 'John Doe' });
-   * // Will allow the company to be null or undefined on a typing level
-   * const value = await userSchema.data({ id: 1, name: 'John Doe' });
-   * ```
-   *
-   * @returns - The schema we are working with.
-   */ optional(options) {
-        return options?.outputOnly ? this : super.optional(options);
-    }
-    /**
-   * Just adds a message when the value is undefined. It's just a syntax sugar for
-   *
-   * ```typescript
-   * p.datetime().optional({ message: 'This value should be defined', 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
-   * 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.
-   */ nullable(options) {
-        return super.nullable(options);
-    }
-    /**
-   * Just adds a message when the value is null. It's just a syntax sugar for
-   *
-   * ```typescript
-   * p.datetime().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.
-   *
-   * @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.
-   */ 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.
-   *
-   * 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.
-   */ onSave(callback) {
-        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.
-   *
-   * @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
-   * ```
-   */ default(defaultValueOrFunction) {
-        return super.default(defaultValueOrFunction);
-    }
-    /**
-   * This function is used to transform the value to the representation without validating it.
-   * This is useful when you want to return a data from a query directly to the user. But for example
-   * you are returning the data of a user, you can clean the password or any other sensitive data.
-   *
-   * @example
-   * ```typescript
-   * import * as p from '@palmares/schemas';
-   *
-   * const userSchema = p.object({
-   *   id: p.number().optional(),
-   *   name: p.string(),
-   *   email: p.string().email(),
-   *   password: p.string().optional()
-   * }).toRepresentation(async (value) => {
-   *   return {
-   *    id: value.id,
-   *    name: value.name,
-   *   email: value.email
-   *  }
-   * });
-   *
-   * const user = await userSchema.data({
-   *   id: 1,
-   *   name: 'John Doe',
-   *   email: 'john@gmail.com',
-   *   password: '123456'
-   * });
-   * ```
-   */ async data(value) {
-        let parsedValue = await super.data(value);
-        if (Array.isArray(parsedValue)) {
-            parsedValue = await Promise.all(Array.isArray(this.__schemas[0]) ? parsedValue.map((value)=>{
-                const schema = this.__schemas[0][0];
-                return shouldRunDataOnComplexSchemas(schema) ? schema.data(value) : value;
-            }) : this.__schemas.map(async (schema)=>{
-                return shouldRunDataOnComplexSchemas(schema) ? schema.data(value) : value;
-            }));
-        }
-        return parsedValue;
-    }
-    /**
-   * 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.
-   */ 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.
-   * 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
-   */ toRepresentation(toRepresentationCallback) {
-        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.
-   *
-   * @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.
-   */ toInternal(toInternalCallback) {
-        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.
-   *
-   * @example
-   * ```
-   * 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.
-   */ toValidate(toValidateCallback) {
-        return super.toValidate(toValidateCallback);
-    }
-    minLength(value, options) {
-        const message = options?.message || `The array must have a minimum length of ${value}`;
-        this.__minLength = {
-            value: value,
-            inclusive: typeof options?.inclusive === 'boolean' ? options.inclusive : true,
-            message: message
-        };
-        return this;
-    }
-    maxLength(value, options) {
-        const message = options?.message || `The array must have a maximum length of ${value}`;
-        this.__maxLength = {
-            value: value,
-            inclusive: typeof options?.inclusive === 'boolean' ? options.inclusive : true,
-            message: message
-        };
-        return this;
-    }
-    static new(...schemas) {
-        const returnValue = new ArraySchema(...schemas);
-        return returnValue;
-    }
-}
-export const array = (...schemas)=>ArraySchema.new(...schemas);