@palmares/schemas 0.0.1 → 0.1.0

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

@@ -1,11 +1,15 @@
 import { getDefaultAdapter } from '../conf';
 import { formatErrorFromParseMethod } from '../utils';
 export default class Schema {
-    // Those functions will assume control of the validation process on adapters, instead of the schema. Why this is used? The idea is that the Schema has NO idea
-    // that one of it's children might be an UnionSchema for example. The adapter might not support unions, so then we give control to the union. The parent schema
-    // Will already have an array of translated adapter schemas. This means for a union with Number and String it'll generate two schemas, one for number and one for the value as String.
-    // Of course this gets multiplied. So if we have a union with Number and String. We should take those two schemas from the array and validate them individually. This logic is
-    // handled by the union schema. If we have an intersection type for example, instead of validating One schema OR the other, we validate one schema AND the other. This will be handled
+    // Those functions will assume control of the validation process on adapters, instead of the schema.
+    // Why this is used? The idea is that the Schema has NO idea
+    // that one of it's children might be an UnionSchema for example. The adapter might not support unions,
+    // so then we give control to the union. The parent schema will already have an array of translated
+    // adapter schemas. This means for a union with Number and String it'll generate two schemas, one for number
+    // and one for the value as String. Of course this gets multiplied. So if we have a union with Number and String.
+    // We should take those two schemas from the array and validate them individually. This logic is
+    // handled by the union schema. If we have an intersection type for example, instead of validating
+    // One schema OR the other, we validate one schema AND the other. This will be handled
     // by the schema that contains that intersection logic.
     __beforeValidationCallbacks = new Map();
     __cachedGetParent;
@@ -15,7 +19,7 @@ export default class Schema {
     get __getParent() {
         return this.__cachedGetParent;
     }
-    __alreadyAppliedModel = false;
+    __alreadyAppliedModel;
     __runBeforeParseAndData;
     __rootFallbacksValidator;
     __saveCallback;
@@ -45,21 +49,33 @@ export default class Schema {
         message: 'Invalid type',
         check: ()=>true
     };
+    __getDefaultTransformedSchemas() {
+        const adapterInstance = getDefaultAdapter();
+        // eslint-disable-next-line ts/no-unnecessary-condition
+        if (this.__transformedSchemas[adapterInstance.constructor.name] === undefined) this.__transformedSchemas[adapterInstance.constructor.name] = {
+            transformed: false,
+            adapter: adapterInstance,
+            schemas: []
+        };
+    }
     /**
-   * This will validate the data with the fallbacks, so internally, without relaying on the schema adapter. This is nice because we can support things that the schema adapter is not able to support by default.
+   * This will validate the data with the fallbacks, so internally, without relaying on the schema adapter.
+   * This is nice because we can support things that the schema adapter is not able to support by default.
    *
    * @param errorsAsHashedSet - The errors as a hashed set. This is used to prevent duplicate errors.
    * @param path - The path of the error.
    * @param parseResult - The result of the parse method.
    */ async __validateByFallbacks(path, parseResult, options) {
         // eslint-disable-next-line ts/no-unnecessary-condition
-        if (this.__rootFallbacksValidator) return this.__rootFallbacksValidator.validate(options.errorsAsHashedSet || new Set(), path, parseResult, options);
+        if (this.__rootFallbacksValidator) return this.__rootFallbacksValidator.validate(options.errorsAsHashedSet, path, parseResult, options);
         return parseResult;
     }
     /**
-   * This will validate by the adapter. In other words, we send the data to the schema adapter and then we validate that data.
-   * So understand that, first we send the data to the adapter, the adapter validates it, then, after we validate from the adapter
-   * we validate with the fallbacks so we can do all of the extra validations not handled by the adapter.
+   * This will validate by the adapter. In other words, we send the data to the schema adapter and then we validate
+   * that data.
+   * So understand that, first we send the data to the adapter, the adapter validates it, then, after we validate
+   * from the adapter we validate with the fallbacks so we can do all of the extra validations not handled by
+   * the adapter.
    *
    * @param value - The value to be validated.
    * @param errorsAsHashedSet - The errors as a hashed set. This is used to prevent duplicate errors on the validator.
@@ -80,11 +96,12 @@ export default class Schema {
         const adapterParseResult = await fieldAdapter.parse(adapter, adapter.field, schema.transformed, value, options.args);
         parseResult.parsed = adapterParseResult.parsed;
         if (adapterParseResult.errors) {
-            if (Array.isArray(adapterParseResult.errors)) parseResult.errors = await Promise.all(adapterParseResult.errors.map(async (error)=>formatErrorFromParseMethod(adapter, fieldAdapter, error, path, options.errorsAsHashedSet || new Set())));
+            if (Array.isArray(adapterParseResult.errors)) parseResult.errors = await Promise.all(adapterParseResult.errors.map(async (error)=>formatErrorFromParseMethod(adapter, fieldAdapter, error, value, schema.transformed, path, options.errorsAsHashedSet || new Set())));
             else parseResult.errors = [
-                await formatErrorFromParseMethod(adapter, fieldAdapter, parseResult.errors, path, options.errorsAsHashedSet || new Set())
+                await formatErrorFromParseMethod(adapter, fieldAdapter, parseResult.errors, value, schema.transformed, path, options.errorsAsHashedSet || new Set())
             ];
         }
+        parseResult.errors = parseResult.errors.filter((error)=>typeof error !== 'undefined');
         return parseResult;
     }
     // eslint-disable-next-line ts/require-await
@@ -121,11 +138,15 @@ export default class Schema {
         return value;
     }
     async __parse(value, path = [], options) {
+        this.__getDefaultTransformedSchemas();
         if (typeof this.__runBeforeParseAndData === 'function') await this.__runBeforeParseAndData(this);
-        // This is used to run the toInternal command. If we didn't do this, we would need to parse through all of the schemas to run the toInternal command,
-        // from the leafs (ObjectSchemas) to the root schema. This is not a good idea, so what we do is that during validation the leafs attach a function to
-        // the options.toInternalToBubbleUp like `options.toInternalToBubbleUp.push(async () => (value[key] = await (schema as any).__toInternal(parsed)));``
-        // This way, when the root schema finishes the validation, it will run all of the functions in the toInternalToBubbleUp array, modifying the parsed value.
+        // This is used to run the toInternal command. If we didn't do this, we would need to parse through all of
+        // the schemas to run the toInternal command, from the leafs (ObjectSchemas) to the root schema. This is not
+        // a good idea, so what we do is that during validation the leafs attach a function to the
+        // options.toInternalToBubbleUp like
+        // `options.toInternalToBubbleUp.push(async () => (value[key] = await (schema as any).__toInternal(parsed)));``
+        // This way, when the root schema finishes the validation, it will run all of the functions in the
+        // toInternalToBubbleUp array, modifying the parsed value.
         const shouldRunToInternalToBubbleUp = options.toInternalToBubbleUp === undefined;
         if (shouldRunToInternalToBubbleUp) options.toInternalToBubbleUp = [];
         if (options.errorsAsHashedSet instanceof Set === false) options.errorsAsHashedSet = new Set();
@@ -138,25 +159,31 @@ export default class Schema {
             errors: [],
             parsed: value
         };
-        if (options.appendFallbacksBeforeAdapterValidation === undefined) options.appendFallbacksBeforeAdapterValidation = (name, callback)=>{
-            this.__beforeValidationCallbacks.set(name, callback);
+        value = await this.__parsersToTransformValue(value, this.__parsers._fallbacks);
+        if (options.appendFallbacksBeforeAdapterValidation === undefined) options.appendFallbacksBeforeAdapterValidation = (schema, name, callback)=>{
+            // We just need this if the union adapter is net defined but the parent is not of the same type.
+            // For example, it's a union child of o object schema
+            if (this !== schema) this.__beforeValidationCallbacks.set(name, callback);
         };
         if (this.__transformedSchemas[options.schemaAdapter?.constructor.name || getDefaultAdapter().constructor.name].transformed === false) await this.__transformToAdapter(options);
-        value = await this.__parsersToTransformValue(value, this.__parsers._fallbacks);
         const adapterToUse = options.schemaAdapter ? options.schemaAdapter : Object.values(this.__transformedSchemas)[0].adapter;
         const parsedResultsAfterFallbacks = await this.__validateByFallbacks(path, {
-            errors: [],
+            errors: parseResult.errors,
             parsed: value
         }, options);
         parseResult.parsed = parsedResultsAfterFallbacks.parsed;
         // eslint-disable-next-line ts/no-unnecessary-condition
         parseResult.errors = (parseResult.errors || []).concat(parsedResultsAfterFallbacks.errors || []);
-        // With this, the children takes control of validating by the adapter. For example on a union schema we want to validate all of the schemas and choose the one that has no errors.
+        // With this, the children takes control of validating by the adapter. For example on a union schema we
+        // want to validate all of the schemas and choose the one that has no errors.
         if (this.__beforeValidationCallbacks.size > 0) {
             for (const callback of this.__beforeValidationCallbacks.values()){
                 const parsedValuesAfterValidationCallbacks = await callback(adapterToUse, adapterToUse[schemaAdapterFieldType], this, this.__transformedSchemas[adapterToUse.constructor.name].schemas, value, path, options);
                 parseResult.parsed = parsedValuesAfterValidationCallbacks.parsed;
-                parseResult.errors = parsedValuesAfterValidationCallbacks.errors;
+                parseResult.errors = Array.isArray(parseResult.errors) && Array.isArray(parsedValuesAfterValidationCallbacks.errors) ? [
+                    ...parseResult.errors,
+                    ...parsedValuesAfterValidationCallbacks.errors
+                ] : Array.isArray(parseResult.errors) ? parseResult.errors : parsedValuesAfterValidationCallbacks.errors;
             }
         } else {
             const parsedValuesAfterValidatingByAdapter = await this.__validateByAdapter(adapterToUse, adapterToUse[schemaAdapterFieldType], this.__transformedSchemas[adapterToUse.constructor.name].schemas[0], value, path, options);
@@ -164,9 +191,8 @@ export default class Schema {
             // eslint-disable-next-line ts/no-unnecessary-condition
             parseResult.errors = (parseResult.errors || []).concat(parsedValuesAfterValidatingByAdapter.errors);
         }
-        const doesNotHaveErrors = !Array.isArray(parseResult.errors) || parseResult.errors.length === 0;
         const hasToInternalCallback = typeof this.__toInternal === 'function';
-        const shouldCallToInternalDuringParse = doesNotHaveErrors && hasToInternalCallback && Array.isArray(options.toInternalToBubbleUp) === false;
+        const shouldCallToInternalDuringParse = hasToInternalCallback && (options.toInternalToBubbleUp?.length === 0 || Array.isArray(options.toInternalToBubbleUp) === false);
         // eslint-disable-next-line ts/no-unnecessary-condition
         const hasNoErrors = parseResult.errors === undefined || (parseResult.errors || []).length === 0;
         await Promise.all(this.__refinements.map(async (refinement)=>{
@@ -176,6 +202,7 @@ export default class Schema {
                 isValid: false,
                 code: errorOrNothing.code,
                 message: errorOrNothing.message,
+                received: parseResult.parsed,
                 path
             });
         }));
@@ -184,7 +211,8 @@ export default class Schema {
         return parseResult;
     }
     /**
-   * 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
@@ -196,7 +224,8 @@ export default class Schema {
    *
    * const { errors, parsed } = await numberSchema.parse(-1);
    *
-   * console.log(errors); // [{ isValid: false, code: 'invalid_number', message: 'The number should be greater than 0', path: [] }]
+   * console.log(errors);
+   * // [{ isValid: false, code: 'invalid_number', message: 'The number should be greater than 0', path: [] }]
    * ```
    *
    * @param refinementCallback - The callback that will be called to validate the value.
@@ -237,8 +266,8 @@ export default class Schema {
         return this;
     }
     /**
-   * 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
@@ -270,8 +299,8 @@ export default class Schema {
     /**
    * Appends a custom schema to the schema, this way it will bypass the creation of the schema in runtime.
    *
-   * By default when validating, on the first validation we create the schema. Just during the first validation. With this function, you bypass that,
-   * so you can speed up the validation process.
+   * By default when validating, on the first validation we create the schema. Just during the first validation.
+   * With this function, you bypass that, so you can speed up the validation process.
    *
    * @example
    * ```typescript
@@ -300,14 +329,15 @@ export default class Schema {
         return this;
     }
     /**
-   * 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 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
@@ -329,9 +359,11 @@ export default class 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) {
@@ -360,9 +392,9 @@ export default class Schema {
         return this;
     }
     /**
-   * This function is used in conjunction with the {@link validate} function. It's used to save a value to an external source
-   * like a database. You should always return the schema after you save the value, that way we will always have the correct type
-   * of the schema after the save operation.
+   * 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.
    *
@@ -408,10 +440,11 @@ export default class Schema {
    * This function is used to validate the schema and save the value to the database. It is used in
    * conjunction with the {@link onSave} function.
    *
-   * Different from other validation libraries, palmares schemas is aware that you want to save. On your routes/functions
-   * we recommend to ALWAYS use this function instead of {@link parse} directly. This is because this function by default
-   * will return an object with the property `save` or the `errors`. If the errors are present, you can return the errors
-   * to the user. If the save property is present, you can use to save the value to an external source. e.g. a database.
+   * Different from other validation libraries, palmares schemas is aware that you want to save. On your
+   * routes/functions we recommend to ALWAYS use this function instead of {@link parse} directly. This is because
+   * this function by default will return an object with the property `save` or the `errors`. If the errors are present,
+   * you can return the errors to the user. If the save property is present, you can use to save the value to an
+   * external source. e.g. a database.
    *
    * @example
    * ```typescript
@@ -524,6 +557,7 @@ export default class Schema {
    * });
    * ```
    */ async data(value) {
+        this.__getDefaultTransformedSchemas();
         if (typeof this.__runBeforeParseAndData === 'function') await this.__runBeforeParseAndData(this);
         value = await this.__parsersToTransformValue(value);
         if (this.__toRepresentation) value = await Promise.resolve(this.__toRepresentation(value));
@@ -536,7 +570,8 @@ export default class Schema {
         return this;
     }
     /**
-   * 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
@@ -555,8 +590,9 @@ export default class Schema {
         return this;
     }
     /**
-   * 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
@@ -568,12 +604,13 @@ export default class Schema {
    *
    * const { errors, parsed } = await numberSchema.parse(-1);
    *
-   * console.log(errors); // [{ isValid: false, code: 'nonnegative', message: 'The number should be nonnegative', path: [] }]
+   * console.log(errors);
+   * // [{ isValid: false, code: 'nonnegative', message: 'The number should be nonnegative', path: [] }]
    * ```
    *
    * @param callback - The callback that will be called to customize the schema.
-   * @param toStringCallback - The callback that will be called to transform the schema to a string when you want to compile the underlying schema
-   * to a string so you can save it for future runs.
+   * @param toStringCallback - The callback that will be called to transform the schema to a string when you want
+   * to compile the underlying schema to a string so you can save it for future runs.
    *
    * @returns The schema.
    */ extends(callback, toStringCallback) {
@@ -584,8 +621,9 @@ export default class Schema {
         return this;
     }
     /**
-   * 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
@@ -624,15 +662,16 @@ export default class Schema {
    * ```
    * @param toRepresentationCallback - The callback that will be called to transform the value to the representation.
    * @param options - Options for the toRepresentation function.
-   * @param options.after - Whether the toRepresentationCallback should be called after the existing toRepresentationCallback. Defaults to true.
-   * @param options.before - Whether the toRepresentationCallback should be called before the existing toRepresentationCallback. Defaults to true.
+   * @param options.after - Whether the toRepresentationCallback should be called after the existing
+   * toRepresentationCallback. Defaults to true.
+   * @param options.before - Whether the toRepresentationCallback should be called before the existing
+   * toRepresentationCallback. Defaults to true.
    *
    * @returns The schema with a new return type
    */ toRepresentation(toRepresentationCallback, options) {
         if (this.__toRepresentation) {
             const before = typeof options?.before === 'boolean' ? options.before : typeof options?.after === 'boolean' ? !options.after : true;
             const existingToRepresentation = this.__toRepresentation;
-            console.log('existing to representation', existingToRepresentation, before, options?.after);
             this.__toRepresentation = async (value)=>{
                 if (before) return toRepresentationCallback(await existingToRepresentation(value));
                 else return existingToRepresentation(await toRepresentationCallback(value));
@@ -641,8 +680,9 @@ export default class Schema {
         return this;
     }
     /**
-   * 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
@@ -682,8 +722,9 @@ export default class Schema {
         return this;
     }
     /**
-   * 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
    * ```
@@ -716,12 +757,6 @@ export default class Schema {
     }
     static new(..._args) {
         const result = new Schema();
-        const adapterInstance = getDefaultAdapter();
-        result.__transformedSchemas[adapterInstance.constructor.name] = {
-            transformed: false,
-            adapter: adapterInstance,
-            schemas: []
-        };
         return result;
     }
 }