@palmares/schemas 0.0.1 → 0.1.0

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

@@ -1,11 +1,14 @@
 import Schema from './schema';
-import { getDefaultAdapter } from '../conf';
 import { defaultTransform, defaultTransformToAdapter, transformSchemaAndCheckIfShouldBeHandledByFallbackOnComplexSchemas } from '../utils';
 import { objectValidation } from '../validators/object';
 import Validator from '../validators/utils';
 export default class ObjectSchema extends Schema {
     __data;
     __cachedDataAsEntries;
+    __type = {
+        message: 'Invalid type',
+        check: (value)=>typeof value === 'object' && value !== null
+    };
     constructor(data){
         super();
         this.__data = data;
@@ -64,6 +67,7 @@ export default class ObjectSchema extends Schema {
                         data: isStringVersion ? asString : transformed,
                         nullable: this.__nullable,
                         optional: this.__optional,
+                        type: this.__type,
                         parsers: {
                             nullable: this.__nullable.allow,
                             optional: this.__optional.allow
@@ -71,11 +75,13 @@ export default class ObjectSchema extends Schema {
                     }), {}, {
                     shouldAddStringVersion: options.shouldAddStringVersion
                 })))).flat();
-        }, this.__transformedSchemas, options, 'object');
+        }, this, this.__transformedSchemas, options, 'object');
     }
     /**
-   * Transform the data to the representation without validating it. This is useful when you want to return a data from a query directly to the user. The core idea of this is that you can join the data
-   * from the database "by hand". In other words, you can do the joins by yourself directly on code. For more complex cases, this can be really helpful.
+   * Transform the data to the representation without validating it. This is useful when you want to return a data
+   * from a query directly to the user. The core idea of this is that you can join the data from the database "by hand".
+   * In other words, you can do the joins by yourself directly on code. For more complex cases, this can be really
+   * helpful.
    *
    * @param value - The value to be transformed.
    *
@@ -96,7 +102,8 @@ export default class ObjectSchema extends Schema {
         return parsedValue;
     }
     /**
-   * 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
@@ -108,7 +115,8 @@ export default class ObjectSchema 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.
@@ -118,9 +126,10 @@ export default class ObjectSchema extends Schema {
         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
+   * 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
@@ -148,8 +157,11 @@ export default class ObjectSchema extends Schema {
    *   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
+   * // 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.
@@ -157,7 +169,25 @@ export default class ObjectSchema extends Schema {
         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
+   * 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
@@ -184,14 +214,34 @@ export default class ObjectSchema 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.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.
+   * 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
@@ -213,18 +263,21 @@ export default class ObjectSchema 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.
    *
@@ -266,7 +319,8 @@ export default class ObjectSchema 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
@@ -282,8 +336,9 @@ export default class ObjectSchema 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
@@ -295,20 +350,22 @@ export default class ObjectSchema 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
@@ -347,16 +404,19 @@ export default class ObjectSchema extends 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) {
         return super.toRepresentation(toRepresentationCallback, options);
     }
     /**
-   * 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
@@ -389,8 +449,9 @@ export default class ObjectSchema 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
    * ```
@@ -452,12 +513,6 @@ export default class ObjectSchema extends Schema {
     }
     static new(data) {
         const returnValue = new ObjectSchema(data);
-        const adapterInstance = getDefaultAdapter();
-        returnValue.__transformedSchemas[adapterInstance.constructor.name] = {
-            transformed: false,
-            adapter: adapterInstance,
-            schemas: []
-        };
         return returnValue;
     }
 }