@palmares/schemas 0.0.1

package/dist/esm/src/model.js

@@ -0,0 +1,255 @@
+import { AutoField, BigAutoField, BooleanField, CharField, DateField, DecimalField, EnumField, ForeignKeyField, IntegerField, TextField, TranslatableField, UuidField } from '@palmares/databases';
+import { TranslatableFieldNotImplementedError } from './exceptions';
+import { number } from './schema';
+import ArraySchema from './schema/array';
+import { boolean } from './schema/boolean';
+import { datetime } from './schema/datetime';
+import ObjectSchema from './schema/object';
+import Schema from './schema/schema';
+import { string } from './schema/string';
+import { union } from './schema/union';
+async function getSchemaFromModelField(model, field, parent, definedFields, engineInstanceName, options) {
+    let schema = undefined;
+    if (field instanceof AutoField || field instanceof BigAutoField) schema = number().integer().optional();
+    else if (field instanceof DecimalField) schema = number().decimalPlaces(field.decimalPlaces).maxDigits(field.maxDigits);
+    else if (field instanceof IntegerField) schema = number().integer();
+    else if (field instanceof BooleanField) schema = boolean();
+    else if (field instanceof TextField || field instanceof CharField || field instanceof UuidField) {
+        schema = string();
+        if (field.allowBlank === false) schema = schema.minLength(1);
+        if (field instanceof CharField && typeof field.maxLength === 'number') schema = schema.maxLength(field.maxLength);
+        if (field instanceof UuidField) {
+            schema = schema.uuid();
+            if (field.autoGenerate) schema = schema.optional();
+        }
+    } else if (field instanceof DateField) {
+        schema = datetime().allowString();
+        if (field.autoNow || field.autoNowAdd) schema = schema.optional();
+    } else if (field instanceof EnumField) {
+        const allChoicesOfTypeStrings = field.choices.filter((choice)=>typeof choice === 'string');
+        const allChoicesOfTypeNumbers = field.choices.filter((choice)=>typeof choice === 'number');
+        let schemaForChoicesAsStrings = undefined;
+        let schemaForChoicesAsNumbers = undefined;
+        if (allChoicesOfTypeStrings.length > 0) schemaForChoicesAsStrings = string().is([
+            ...allChoicesOfTypeStrings
+        ]);
+        if (allChoicesOfTypeNumbers.length > 0) schemaForChoicesAsNumbers = number().is([
+            ...allChoicesOfTypeNumbers
+        ]);
+        if (schemaForChoicesAsStrings && schemaForChoicesAsNumbers) schema = union([
+            schemaForChoicesAsStrings,
+            schemaForChoicesAsNumbers
+        ]);
+        else if (schemaForChoicesAsStrings) schema = schemaForChoicesAsStrings;
+        else if (schemaForChoicesAsNumbers) schema = schemaForChoicesAsNumbers;
+    } else if (field instanceof ForeignKeyField) {
+        const doesADefinedFieldExistWithRelatedName = parent && field.relatedName && parent.__data?.[field.relatedName];
+        const doesADefinedFieldExistWithRelationName = definedFields && field.relationName && definedFields[field.relationName];
+        const fieldWithRelatedName = doesADefinedFieldExistWithRelatedName ? parent.__data?.[field.relatedName] : undefined;
+        const fieldWithRelationName = doesADefinedFieldExistWithRelationName ? definedFields[field.relationName] : undefined;
+        const isFieldWithRelatedNameAModelField = fieldWithRelatedName instanceof Schema && fieldWithRelatedName.__model !== undefined;
+        const isFieldWithRelationNameAModelField = fieldWithRelationName instanceof Schema && fieldWithRelationName.__model !== undefined;
+        const relatedToModel = field.relatedTo;
+        const toField = field.toField;
+        const engineInstance = await model.default.getEngineInstance(engineInstanceName);
+        const relatedToModelInstance = engineInstance.__modelsOfEngine[relatedToModel];
+        const modelFieldsOfRelatedModel = relatedToModelInstance.__cachedFields[toField];
+        if (isFieldWithRelatedNameAModelField) {
+            if (typeof options !== 'object') options = {};
+            options.foreignKeyRelation = {
+                schema: parent,
+                isArray: fieldWithRelatedName instanceof ArraySchema,
+                model: fieldWithRelatedName.__model,
+                fieldToSearchOnModel: field.fieldName,
+                fieldToGetFromData: field.toField,
+                relationOrRelatedName: field.relatedName
+            };
+        } else if (isFieldWithRelationNameAModelField) {
+            if (typeof options !== 'object') options = {};
+            options.foreignKeyRelation = {
+                isArray: fieldWithRelationName instanceof ArraySchema,
+                model: fieldWithRelationName.__model,
+                fieldToSearchOnModel: field.toField,
+                fieldToGetFromData: field.fieldName,
+                relationOrRelatedName: field.relationName
+            };
+        }
+        return getSchemaFromModelField(relatedToModelInstance, modelFieldsOfRelatedModel, parent, definedFields, engineInstanceName, options);
+    } else if (field instanceof TranslatableField && field.customAttributes.schema) {
+        if (field.customAttributes.schema instanceof Schema === false) throw new TranslatableFieldNotImplementedError(field.fieldName);
+        schema = field.customAttributes.schema;
+    }
+    if (field.allowNull && schema) schema = schema.nullable().optional();
+    if (field.defaultValue && schema) schema = schema.default(field.defaultValue);
+    return schema || string();
+}
+/**
+ * Different from other schemas, this function is a factory function that returns either an ObjectSchema or an ArraySchema.
+ * The idea is to build the schema of a model dynamically based on its fields.
+ *
+ * Another feature is that it can automatically add the foreign key relation to the schema, but for that you need to define
+ * the fields of the related model in the fields object.
+ *
+ * For example: A User model have a field `companyId` that is a ForeignKeyField to the Company model. The `relationName`
+ * is the direct relation from the User model to the Company model, and the `relatedName` is the reverse relation from the
+ * Company model to the User model. If you define the fieldName as either the relatedName or the relationName it will fetch
+ * the data automatically.
+ *
+ * **Important**: We build the schema dynamically but also lazily, if you don't try to parse or validate the schema, it won't be built.
+ * After the first time it's built, it's cached and never built again.
+ *
+ * **Important 2**: If you want to use the automatic relation feature, you need to define guarantee that the foreignKey field fieldName
+ * exists on `show` array, or that it doesn't exist on `omit` array.
+ *
+ * Like: `{ options: { show: ['id', 'name', 'companyId'] }}` or `{ options: { omit: ['id'] }}` it **will work**.
+ *
+ * If you do `{ options: { show: ['id', 'name'] }}` or `{ options: { omit: ['companyId']} }` it **won't work**.
+ *
+ * **Important 3**: If you want to return an array instead of an object, you need to pass the `many` option as true.
+ *
+ * @example
+ * ```typescript
+ * import { auto, choice, foreignKey, Model, define } from '@palmares/databases';
+ * import * as p from '@palmares/schemas';
+ *
+ * const Company = define('Company', {
+ *   fields: {
+ *     id: auto(),
+ *     name: text(),
+ *   },
+ *   options: {
+ *     tableName: 'company',
+ *   }
+ * });
+ *
+ * class User extends Model<User>() {
+ *    fields = {
+ *     id: auto(),
+ *     type: choice({ choices: ['user', 'admin'] }),
+ *     companyId: foreignKey({
+ *        relatedTo: Company,
+ *        relationName: 'company',
+ *        relatedName: 'usersOfCompany',
+ *        toField: 'id',
+ *        onDelete: 'CASCADE',
+ *      }),
+ *   }
+ *
+ *   options = {
+ *     tableName: 'user',
+ *   }
+ * }
+ *
+ * const userSchema = p.modelSchema(User, {
+ *   fields: {
+ *      company: p.modelSchema(Company).optional({ outputOnly: true });
+ *   },
+ *   show: ['type', 'companyId'], // 'companyId' is required for the automatic relation to work, otherwise it won't show
+ *   omitRelation: ['company']
+ * });
+ *
+ * const companySchema = p.modelSchema(Company, {
+ *   fields: {
+ *      usersOfCompany: p.modelSchema(User, { many: true }).optional({ outputOnly: true });
+ *   },
+ *   show: ['id', 'type'] // The `companyId` field on the 'User' model is tied to the `id` field on the 'Company' model so 'id' is required.
+ * });
+ *```
+ * @param model - The model that you want to build the schema from.
+ * @param options - The options to build the schema.
+ * @param options.ignoreExtraneousFields - If you want to ignore extraneous fields set this to true.
+ * @param options.engineInstance - What engine instance you want to use to fetch the data. Defaults to the first one.
+ * @param options.omitRelation - Fields that you want to omit from the relation. For example, on the example above, on the
+ * `userSchema` you can omit the `companyId` field from the relation by just passing `['company']`, on the `companySchema`
+ * you can omit the `id` field from company by passing `['usersOfCompany']`.
+ *
+ * @param options.fields - Extra fields that you want to add to the schema. If it has the same name as the model field,
+ * We will not create a schema for that field and use the one you have defined here.
+ * @param options.omit - Fields that you want to omit from the schema. If that is defined, we ignore `show` option.
+ * @param options.show - Fields that you want to show on the schema. If that is defined, we ignore `omit` option.
+ * @param options.many - If you want to return an array instead of an object, set this to true. With that we create
+ * an ArraySchema instead of an ObjectSchema.
+ *
+ * @returns - If you pass the `many` option as true, we return an ArraySchema, otherwise we return an ObjectSchema.
+ */ export function modelSchema(model, options) {
+    const lazyModelSchema = ObjectSchema.new({});
+    const parentSchema = options?.many === true ? ArraySchema.new([
+        lazyModelSchema
+    ]) : lazyModelSchema;
+    const omitRelationAsSet = new Set(options?.omitRelation || []);
+    const omitAsSet = new Set(options?.omit || []);
+    const showAsSet = new Set(options?.show || []);
+    const fieldsAsObject = options?.fields || {};
+    const customFieldValues = Object.values(fieldsAsObject);
+    // We need to add it to the instance to be able to access it on the `toRepresentation` callback
+    lazyModelSchema.__omitRelation = omitRelationAsSet;
+    parentSchema.__model = model;
+    lazyModelSchema.__model = model;
+    // Add this callback to transform the model fields
+    parentSchema.__runBeforeParseAndData = async ()=>{
+        if (parentSchema.__alreadyAppliedModel) return;
+        parentSchema.__alreadyAppliedModel = true;
+        const fieldsOfModels = model._fields();
+        const fieldsAsEntries = Object.entries(fieldsOfModels);
+        const fieldsWithAutomaticRelations = new Map();
+        const fields = await fieldsAsEntries.reduce(async (accumulatorAsPromise, [key, value])=>{
+            if (omitAsSet.has(key)) return accumulatorAsPromise;
+            if (showAsSet.size > 0 && !showAsSet.has(key)) return accumulatorAsPromise;
+            let schema = fieldsAsObject[key];
+            const optionsForForeignKeyRelation = {};
+            if (!schema || value instanceof ForeignKeyField) {
+                const newSchema = await getSchemaFromModelField(model, value, parentSchema?.__getParent?.(), options?.fields, options?.engineInstance, optionsForForeignKeyRelation);
+                if (!schema) schema = newSchema;
+            }
+            // Appends the foreign key relation to the schema automatically.
+            if (optionsForForeignKeyRelation.foreignKeyRelation) {
+                const rootSchema = optionsForForeignKeyRelation?.foreignKeyRelation?.schema || lazyModelSchema;
+                const existingRelations = fieldsWithAutomaticRelations.get(rootSchema) || [];
+                existingRelations.push({
+                    relationOrRelatedName: optionsForForeignKeyRelation.foreignKeyRelation.relationOrRelatedName,
+                    isArray: optionsForForeignKeyRelation.foreignKeyRelation.isArray,
+                    model: optionsForForeignKeyRelation.foreignKeyRelation.model,
+                    fieldToSearchOnModel: optionsForForeignKeyRelation.foreignKeyRelation.fieldToSearchOnModel,
+                    fieldToGetFromData: optionsForForeignKeyRelation.foreignKeyRelation.fieldToGetFromData
+                });
+                fieldsWithAutomaticRelations.set(rootSchema, existingRelations);
+            }
+            const accumulator = await accumulatorAsPromise;
+            accumulator[key] = schema;
+            return accumulator;
+        }, Promise.resolve(fieldsAsObject));
+        if (fieldsWithAutomaticRelations.size > 0) {
+            // This way we can get all of the relations concurrently with Promise.all
+            for (const [schema, relations] of fieldsWithAutomaticRelations.entries()){
+                schema.toRepresentation(async (data)=>{
+                    const allData = Array.isArray(data) ? data : [
+                        data
+                    ];
+                    // since we are changing the data by reference, just return the data itself.
+                    await Promise.all(allData.map(async (data)=>Promise.all(relations.map(async (relation)=>{
+                            // Ignore if the data of the relation already exists
+                            if (relation.relationOrRelatedName in data) return;
+                            let relationData = await relation.model.default.get({
+                                search: {
+                                    [relation.fieldToSearchOnModel]: data[relation.fieldToGetFromData]
+                                }
+                            });
+                            if (relation.isArray !== true) relationData = relationData[0];
+                            data[relation.relationOrRelatedName] = relationData;
+                            if (schema.__omitRelation.has(relation.relationOrRelatedName)) delete data[relation.fieldToGetFromData];
+                        }))));
+                    return data;
+                }, {
+                    after: true
+                });
+            }
+        }
+        lazyModelSchema.__data = fields;
+        await Promise.all(customFieldValues.map(async (schema)=>{
+            schema['__getParent'] = ()=>lazyModelSchema;
+            if (schema['__runBeforeParseAndData']) await schema['__runBeforeParseAndData'](schema);
+        }));
+    };
+    if (options?.ignoreExtraneousFields !== true) lazyModelSchema.removeExtraneous();
+    return parentSchema;
+}

package/dist/esm/src/parsers/convert-from-number.js

@@ -0,0 +1,8 @@
+/**
+ * This will convert a value from a number to any other type.
+ *
+ * @param callback
+ * @returns
+ */ export default function convertFromNumberBuilder(callback) {
+    return (value)=>callback(value);
+}

package/dist/esm/src/parsers/convert-from-string.js

@@ -0,0 +1,14 @@
+/**
+ * This will convert a value from a string to any other type.
+ *
+ * @param callback
+ * @returns
+ */ export default function convertFromStringBuilder(callback) {
+    return (value)=>{
+        if (typeof value === 'string') return callback(value);
+        return {
+            value,
+            preventNextParsers: false
+        };
+    };
+}

package/dist/esm/src/parsers/index.js

@@ -0,0 +1,2 @@
+export { default as convertFromNumberBuilder } from './convert-from-number';
+export { default as convertFromStringBuilder } from './convert-from-string';

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

@@ -0,0 +1,403 @@
+import Schema from './schema';
+import { getDefaultAdapter } from '../conf';
+import { defaultTransform, defaultTransformToAdapter, transformSchemaAndCheckIfShouldBeHandledByFallbackOnComplexSchemas } from '../utils';
+import { arrayValidation, maxLength, minLength, nonEmpty } from '../validators/array';
+import { nullable, optional } from '../validators/schema';
+import Validator from '../validators/utils';
+export default class ArraySchema extends Schema {
+    __schemas;
+    __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,
+                    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.__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);
+   *
+   * 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.
+   * @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 })
+   * });
+   *
+   * const { errors, parsed } = await userSchema.data({ id: 1, name: 'John Doe' }); // Will not allow the company to be null or undefined on a typing level.
+   * const value = await userSchema.data({ id: 1, name: 'John Doe' }); // Will allow the company to be null or undefined on a typing level
+   * ```
+   *
+   * @returns - The schema we are working with.
+   */ optional(options) {
+        return options?.outputOnly ? this : super.optional(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
+   * 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);
+    }
+    /**
+   * 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 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);
+   *
+   * 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.
+   *
+   * @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, inclusive = true, message) {
+        message = message || `The array must have a minimum length of ${value}`;
+        this.__minLength = {
+            value: value,
+            inclusive: inclusive,
+            message: message
+        };
+        return this;
+    }
+    maxLength(value, inclusive = true, message) {
+        message = message || `The array must have a maximum length of ${value}`;
+        this.__maxLength = {
+            value: value,
+            inclusive: inclusive,
+            message: message
+        };
+        return this;
+    }
+    nonEmpty(message) {
+        message = message || 'The array must not be empty';
+        this.__nonEmpty = {
+            message: message
+        };
+        return this;
+    }
+    static new(...schemas) {
+        const returnValue = new ArraySchema(...schemas);
+        const adapterInstance = getDefaultAdapter();
+        returnValue.__transformedSchemas[adapterInstance.constructor.name] = {
+            transformed: false,
+            adapter: adapterInstance,
+            schemas: []
+        };
+        return returnValue;
+    }
+}
+export const array = (...schemas)=>ArraySchema.new(...schemas);