@palmares/schemas 0.0.1

package/dist/cjs/types/index.d.ts

@@ -0,0 +1,240 @@
+import SchemaAdapter from './adapter';
+import { modelSchema } from './model';
+import ArraySchema, { array } from './schema/array';
+import BooleanSchema, { boolean } from './schema/boolean';
+import DatetimeSchema, { datetime } from './schema/datetime';
+import NumberSchema, { number } from './schema/number';
+import ObjectSchema, { object } from './schema/object';
+import Schema, { schema } from './schema/schema';
+import StringSchema, { string } from './schema/string';
+import UnionSchema, { union } from './schema/union';
+import type { DefinitionsOfSchemaType, ExtractTypeFromObjectOfSchemas } from "./schema/types";
+import type { Narrow } from '@palmares/core';
+import type { Model, ModelFields } from "@palmares/databases";
+export { default as default } from './domain';
+export { default as FieldAdapter } from './adapter/fields';
+export { default as NumberAdapter } from './adapter/fields/number';
+export { default as ObjectFieldAdapter } from './adapter/fields/object';
+export { default as UnionFieldAdapter } from './adapter/fields/union';
+export { default as StringFieldAdapter } from './adapter/fields/string';
+export { default as ArrayFieldAdapter } from './adapter/fields/array';
+export { default as BooleanFieldAdapter } from './adapter/fields/boolean';
+export { default as DatetimeFieldAdapter } from './adapter/fields/datetime';
+export { setDefaultAdapter } from './conf';
+export * from './adapter/types';
+export * from './schema';
+export { SchemaAdapter, NumberSchema, ObjectSchema, UnionSchema, StringSchema, ArraySchema, BooleanSchema, DatetimeSchema, Schema, };
+export { schema, number, object, union, string, array, datetime, boolean };
+export { default as compile } from './compile';
+export { modelSchema };
+export declare function getSchemasWithDefaultAdapter<TAdapter extends SchemaAdapter>(): {
+    number: () => NumberSchema<{
+        input: number | bigint;
+        output: number | bigint;
+        internal: number | bigint;
+        representation: number | bigint;
+        validate: number | bigint;
+    }, {
+        schemaAdapter: TAdapter;
+        schemaType: "number";
+        hasSave: false;
+    }>;
+    string: () => StringSchema<{
+        input: string;
+        output: string;
+        internal: string;
+        representation: string;
+        validate: string;
+    }, {
+        schemaAdapter: TAdapter;
+        schemaType: "string";
+        hasSave: false;
+    }>;
+    array: <TSchemas extends readonly [Schema, ...Schema[]] | [Schema[]]>(...schemas: TSchemas) => ArraySchema<{
+        input: import("./schema/types").ExtractTypeFromArrayOfSchemas<TSchemas, "input", []>;
+        validate: import("./schema/types").ExtractTypeFromArrayOfSchemas<TSchemas, "validate", []>;
+        internal: import("./schema/types").ExtractTypeFromArrayOfSchemas<TSchemas, "internal", []>;
+        output: import("./schema/types").ExtractTypeFromArrayOfSchemas<TSchemas, "output", []>;
+        representation: import("./schema/types").ExtractTypeFromArrayOfSchemas<TSchemas, "representation", []>;
+    }, {
+        schemaAdapter: TAdapter;
+        schemaType: "array";
+        hasSave: false;
+    }, TSchemas>;
+    boolean: () => BooleanSchema<{
+        input: boolean;
+        validate: boolean;
+        internal: boolean;
+        output: boolean;
+        representation: boolean;
+    }, {
+        schemaAdapter: TAdapter;
+        schemaType: "boolean";
+        hasSave: false;
+    }>;
+    object: <TData extends Record<any, Schema<any, any>>>(data: TData) => ObjectSchema<{
+        input: ExtractTypeFromObjectOfSchemas<TData, "input">;
+        validate: ExtractTypeFromObjectOfSchemas<TData, "validate">;
+        internal: ExtractTypeFromObjectOfSchemas<TData, "internal">;
+        representation: ExtractTypeFromObjectOfSchemas<TData, "representation">;
+        output: ExtractTypeFromObjectOfSchemas<TData, "output">;
+    }, {
+        schemaAdapter: TAdapter;
+        schemaType: "object";
+        hasSave: false;
+    }, TData>;
+    union: <TSchemas extends readonly [Schema<any, any>, Schema<any, any>, ...Schema<any, any>[]]>(...schemas: Narrow<TSchemas>) => UnionSchema<TSchemas[number] extends Schema<infer TType extends {
+        input: any;
+        validate: any;
+        internal: any;
+        output: any;
+        representation: any;
+    }, any> ? TType : never, DefinitionsOfSchemaType, [Schema<any, any>, Schema<any, any>, ...Schema<any, any>[]]>;
+    datetime: () => DatetimeSchema<{
+        input: Date;
+        validate: Date;
+        internal: Date;
+        output: Date;
+        representation: Date;
+    }, {
+        schemaAdapter: TAdapter;
+        schemaType: "datetime";
+        hasSave: false;
+    }>;
+    /**
+     * Different from other models, 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']
+     * });
+     *
+     * const companySchema = p.modelSchema(Company, {
+     *   fields: {
+     *      usersOfCompany: p.modelSchema(User, { many: true }).optional({ outputOnly: true });
+     *   },
+     *   show: ['id', 'type']
+     * });
+     *```
+    * @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.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.
+    */
+    modelSchema: <TModel extends ReturnType<typeof Model>, const TOmit extends readonly (keyof ModelFields<InstanceType<TModel>>)[] | undefined[] = undefined[], const TShow extends readonly (keyof ModelFields<InstanceType<TModel>>)[] | undefined[] = undefined[], TMany extends boolean = false, TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> | undefined = undefined, TAllModelFields = ModelFields<InstanceType<TModel>>, TFieldsOnModel = TOmit extends undefined[] ? TShow extends undefined[] ? TAllModelFields : Pick<TAllModelFields, TShow[number] extends keyof TAllModelFields ? TShow[number] : never> : Omit<TAllModelFields, TOmit[number] extends keyof TAllModelFields ? TOmit[number] : never>, TReturnType extends {
+        input: any;
+        output: any;
+        validate: any;
+        internal: any;
+        representation: any;
+    } = {
+        input: TFields extends undefined ? TFieldsOnModel : Omit<TFieldsOnModel, keyof ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, "input">> & ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, "input">;
+        output: TFields extends undefined ? TFieldsOnModel : (Omit<TFieldsOnModel, keyof ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, "output">> & ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, "output">);
+        internal: TFields extends undefined ? TFieldsOnModel : (Omit<TFieldsOnModel, keyof ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, "internal">> & ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, "internal">);
+        representation: TFields extends undefined ? TFieldsOnModel : (Omit<TFieldsOnModel, keyof ExtractTypeFromObjectOfSchemas<TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> ? TFields : {}, "representation">> & ExtractTypeFromObjectOfSchemas<TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> ? TFields : {}, "representation">);
+        validate: TFields extends undefined ? TFieldsOnModel : Omit<TFieldsOnModel, keyof ExtractTypeFromObjectOfSchemas<TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> ? TFields : {}, "validate">> & ExtractTypeFromObjectOfSchemas<TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> ? TFields : {}, "validate">;
+    }>(model: TModel, options?: {
+        ignoreExtraneousFields?: boolean;
+        engineInstance?: string;
+        fields?: TFields;
+        omit?: TOmit;
+        omitRelation?: readonly (keyof TFields)[];
+        show?: TShow;
+        many?: TMany;
+    }) => TMany extends true ? ArraySchema<{
+        input: TReturnType["input"][];
+        output: TReturnType["output"][];
+        internal: TReturnType["internal"][];
+        representation: TReturnType["representation"][];
+        validate: TReturnType["validate"][];
+    }, {
+        schemaAdapter: TAdapter;
+        schemaType: "object";
+        hasSave: false;
+    }, [ObjectSchema<{
+        input: TReturnType["input"];
+        output: TReturnType["output"];
+        internal: TReturnType["internal"];
+        representation: TReturnType["representation"];
+        validate: TReturnType["validate"];
+    }, {
+        schemaAdapter: TAdapter;
+        schemaType: "object";
+        hasSave: false;
+    }, Record<any, any>>[]]> : ObjectSchema<{
+        input: TReturnType["input"];
+        output: TReturnType["output"];
+        internal: TReturnType["internal"];
+        representation: TReturnType["representation"];
+        validate: TReturnType["validate"];
+    }, {
+        schemaAdapter: TAdapter;
+        schemaType: "object";
+        hasSave: false;
+    }, Record<any, any>>;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,WAAW,EAAE,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,aAAa,EAAE,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,cAAc,EAAE,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,YAAY,EAAE,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,YAAY,EAAE,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,YAAY,EAAE,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,WAAW,EAAE,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEpD,OAAO,KAAK,EAAE,uBAAuB,EAAE,8BAA8B,EAAE,MAAM,gBAAgB,CAAC;AAC9F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EACV,KAAK,EACL,WAAW,EAAC,MAAM,qBAAqB,CAAC;AAE1C,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC1E,OAAO,EAAE,OAAO,IAAI,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAE5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAC3C,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,OAAO,EACL,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,WAAW,EACX,aAAa,EACb,cAAc,EACd,MAAM,GACP,CAAC;AACF,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AAC3E,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAE/C,OAAO,EAAE,WAAW,EAAE,CAAC;AAEvB,wBAAgB,4BAA4B,CAAC,QAAQ,SAAS,aAAa;;;;;;;;uBAEvB,QAAQ;oBAAc,QAAQ;iBAAW,KAAK;;;;;;;;;uBAC9C,QAAQ;oBAAc,QAAQ;iBAAW,KAAK;;YACtF,QAAQ,SAAS,SAAS,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,cAAc,QAAQ;;;;;;;uBACvD,QAAQ;oBAAc,OAAO;iBAAW,KAAK;;;;;;;;;uBAC9B,QAAQ;oBAAc,SAAS;iBAAW,KAAK;;aACxF,KAAK,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,KAAK;;;;;;;uBACtB,QAAQ;oBAAc,QAAQ;iBAAW,KAAK;;YACjF,QAAQ,SAAS,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,cAC/E,MAAM,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;uBAEsB,QAAQ;oBAAc,UAAU;iBAAW,KAAK;;IACpG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAmFE;kBAEA,MAAM,SAAS,UAAU,CAAC,OAAO,KAAK,CAAC,QACjC,KAAK,SAAS,SAAS,CAAC,MAAM,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,sBAChF,KAAK,SAAS,SAAS,CAAC,MAAM,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,gBACtF,KAAK,SAAS,OAAO,UACrB,OAAO,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,GAAG,SAAS,cAC7E,eAAe,sCACf,cAAc,sQAWd,WAAW,SAAS;QAClB,KAAK,EAAE,GAAG,CAAC;QACX,MAAM,EAAE,GAAG,CAAC;QACZ,QAAQ,EAAE,GAAG,CAAC;QACd,QAAQ,EAAE,GAAG,CAAC;QACd,cAAc,EAAE,GAAG,CAAC;KACrB;eACQ,OAAO,SAAS,SAAS,GAAG,cAAc,GAC/C,IAAI,CACJ,cAAc,EACZ,MAAM,8BAA8B,CAElC,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,OAAO,CACR,CACF,GACD,8BAA8B,CAE5B,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,OAAO,CACR;gBACK,OAAO,SAAS,SAAS,GAAG,cAAc,GAChD,CAAC,IAAI,CACH,cAAc,EACd,MAAM,8BAA8B,CAElC,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,QAAQ,CACT,CACF,GACD,8BAA8B,CAE5B,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,QAAQ,CACT,CAAC;kBACM,OAAO,SAAS,SAAS,GAAG,cAAc,GAClD,CAAC,IAAI,CACH,cAAc,EACd,MAAM,8BAA8B,CAElC,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,UAAU,CACX,CACF,GACD,8BAA8B,CAE5B,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,UAAU,CACX,CAAC;wBACY,OAAO,SAAS,SAAS,GAAG,cAAc,GACxD,CAAC,IAAI,CACH,cAAc,EACd,MAAM,8BAA8B,CAElC,OAAO,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,GAAG,OAAO,GAAG,EAAE,EAChF,gBAAgB,CACjB,CACF,GACD,8BAA8B,CAE5B,OAAO,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,GAAG,OAAO,GAAG,EAAE,EAChF,gBAAgB,CACjB,CAAC;kBACM,OAAO,SAAS,SAAS,GAAG,cAAc,GAClD,IAAI,CACJ,cAAc,EACZ,MAAM,8BAA8B,CAElC,OAAO,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,GAAG,OAAO,GAAG,EAAE,EAChF,UAAU,CACX,CACF,GACD,8BAA8B,CAE5B,OAAO,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,GAAG,OAAO,GAAG,EAAE,EAChF,UAAU,CACX;cAGE,MAAM,YACH;QACV,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,YAAY,CAAC,EAAE,SAAS,CAAC,MAAM,OAAO,CAAC,EAAE,CAAC;QAC1C,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,IAAI,CAAC,EAAE,KAAK,CAAA;KACb,KAAG,KAAK,SAAS,IAAI,GAAG,WAAW,CAAC;QACnC,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChC,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;QACpC,cAAc,EAAE,WAAW,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAChD,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;KACrC,EAAE;QACD,aAAa,EAAE,QAAQ,CAAC;QACxB,UAAU,EAAE,QAAQ,CAAC;QACrB,OAAO,EAAE,KAAK,CAAA;KACf,EAAE,CACD,YAAY,CAAC;QACT,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QAC5B,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC9B,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;QAClC,cAAc,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAC9C,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;KACnC,EAAE;QACD,aAAa,EAAE,QAAQ,CAAC;QACxB,UAAU,EAAE,QAAQ,CAAC;QACrB,OAAO,EAAE,KAAK,CAAA;KACf,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CACvB,CAAC,GAAG,YAAY,CAAC;QAClB,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QAC5B,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC9B,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;QAClC,cAAc,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAC9C,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;KACnC,EAAE;QACD,aAAa,EAAE,QAAQ,CAAC;QACxB,UAAU,EAAE,QAAQ,CAAC;QACrB,OAAO,EAAE,KAAK,CAAA;KACf,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;EAgBvB"}

package/dist/cjs/types/model.d.ts

@@ -0,0 +1,136 @@
+import { type Model, type ModelFields } from '@palmares/databases';
+import ArraySchema from './schema/array';
+import ObjectSchema from './schema/object';
+import Schema from './schema/schema';
+import type { DefinitionsOfSchemaType, ExtractTypeFromObjectOfSchemas } from './schema/types';
+/**
+ * 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 declare function modelSchema<TModel extends ReturnType<typeof Model>, const TOmit extends readonly (keyof ModelFields<InstanceType<TModel>>)[] | undefined[] = undefined[], const TShow extends readonly (keyof ModelFields<InstanceType<TModel>>)[] | undefined[] = undefined[], TMany extends boolean = false, TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> | undefined = undefined, TAllModelFields = ModelFields<InstanceType<TModel>>, TDefinitionsOfSchemaType extends DefinitionsOfSchemaType = DefinitionsOfSchemaType, TFieldsOnModel = TOmit extends undefined[] ? TShow extends undefined[] ? TAllModelFields : Pick<TAllModelFields, TShow[number] extends keyof TAllModelFields ? TShow[number] : never> : Omit<TAllModelFields, TOmit[number] extends keyof TAllModelFields ? TOmit[number] : never>, TReturnType extends {
+    input: any;
+    output: any;
+    validate: any;
+    internal: any;
+    representation: any;
+} = {
+    input: TFields extends undefined ? TFieldsOnModel : Omit<TFieldsOnModel, keyof ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, 'input'>> & ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, 'input'>;
+    output: TFields extends undefined ? TFieldsOnModel : Omit<TFieldsOnModel, keyof ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, 'output'>> & ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, 'output'>;
+    internal: TFields extends undefined ? TFieldsOnModel : Omit<TFieldsOnModel, keyof ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, 'internal'>> & ExtractTypeFromObjectOfSchemas<TFields extends undefined ? {} : TFields, 'internal'>;
+    representation: TFields extends undefined ? TFieldsOnModel : Omit<TFieldsOnModel, keyof ExtractTypeFromObjectOfSchemas<TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> ? TFields : {}, 'representation'>> & ExtractTypeFromObjectOfSchemas<TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> ? TFields : {}, 'representation'>;
+    validate: TFields extends undefined ? TFieldsOnModel : Omit<TFieldsOnModel, keyof ExtractTypeFromObjectOfSchemas<TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> ? TFields : {}, 'validate'>> & ExtractTypeFromObjectOfSchemas<TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> ? TFields : {}, 'validate'>;
+}>(model: TModel, options?: {
+    ignoreExtraneousFields?: boolean;
+    engineInstance?: string;
+    fields?: TFields;
+    omit?: TOmit;
+    show?: TShow;
+    omitRelation?: readonly (keyof TFields)[];
+    many?: TMany;
+}): TMany extends true ? ArraySchema<{
+    input: TReturnType['input'][];
+    output: TReturnType['output'][];
+    internal: TReturnType['internal'][];
+    representation: TReturnType['representation'][];
+    validate: TReturnType['validate'][];
+}, TDefinitionsOfSchemaType, [
+    ObjectSchema<{
+        input: TReturnType['input'];
+        output: TReturnType['output'];
+        internal: TReturnType['internal'];
+        representation: TReturnType['representation'];
+        validate: TReturnType['validate'];
+    }, TDefinitionsOfSchemaType, Record<any, any>>[]
+]> : ObjectSchema<{
+    input: TReturnType['input'];
+    output: TReturnType['output'];
+    internal: TReturnType['internal'];
+    representation: TReturnType['representation'];
+    validate: TReturnType['validate'];
+}, TDefinitionsOfSchemaType, Record<any, any>>;
+//# sourceMappingURL=model.d.ts.map

package/dist/cjs/types/model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../../../src/model.ts"],"names":[],"mappings":"AAAA,OAAO,EAYL,KAAK,KAAK,EACV,KAAK,WAAW,EAIjB,MAAM,qBAAqB,CAAC;AAI7B,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAGzC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,MAAM,MAAM,iBAAiB,CAAC;AAIrC,OAAO,KAAK,EAAE,uBAAuB,EAAE,8BAA8B,EAAE,MAAM,gBAAgB,CAAC;AA8G9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwFG;AACH,wBAAgB,WAAW,CACzB,MAAM,SAAS,UAAU,CAAC,OAAO,KAAK,CAAC,EACvC,KAAK,CAAC,KAAK,SAAS,SAAS,CAAC,MAAM,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,GAAG,SAAS,EAAE,EACpG,KAAK,CAAC,KAAK,SAAS,SAAS,CAAC,MAAM,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,GAAG,SAAS,EAAE,EACpG,KAAK,SAAS,OAAO,GAAG,KAAK,EAC7B,OAAO,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,GAAG,SAAS,GAAG,SAAS,EACzF,eAAe,GAAG,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EACnD,wBAAwB,SAAS,uBAAuB,GAAG,uBAAuB,EAClF,cAAc,GAAG,KAAK,SAAS,SAAS,EAAE,GACtC,KAAK,SAAS,SAAS,EAAE,GACvB,eAAe,GACf,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,GAC5F,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,EAC9F,WAAW,SAAS;IAClB,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,GAAG,CAAC;IACd,QAAQ,EAAE,GAAG,CAAC;IACd,cAAc,EAAE,GAAG,CAAC;CACrB,GAAG;IACF,KAAK,EAAE,OAAO,SAAS,SAAS,GAC5B,cAAc,GACd,IAAI,CACF,cAAc,EACd,MAAM,8BAA8B,CAElC,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,OAAO,CACR,CACF,GACC,8BAA8B,CAE5B,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,OAAO,CACR,CAAC;IACR,MAAM,EAAE,OAAO,SAAS,SAAS,GAC7B,cAAc,GACd,IAAI,CACF,cAAc,EACd,MAAM,8BAA8B,CAElC,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,QAAQ,CACT,CACF,GACC,8BAA8B,CAE5B,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,QAAQ,CACT,CAAC;IACR,QAAQ,EAAE,OAAO,SAAS,SAAS,GAC/B,cAAc,GACd,IAAI,CACF,cAAc,EACd,MAAM,8BAA8B,CAElC,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,UAAU,CACX,CACF,GACC,8BAA8B,CAE5B,OAAO,SAAS,SAAS,GAAG,EAAE,GAAG,OAAO,EACxC,UAAU,CACX,CAAC;IACR,cAAc,EAAE,OAAO,SAAS,SAAS,GACrC,cAAc,GACd,IAAI,CACF,cAAc,EACd,MAAM,8BAA8B,CAElC,OAAO,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,GAAG,OAAO,GAAG,EAAE,EAChF,gBAAgB,CACjB,CACF,GACC,8BAA8B,CAE5B,OAAO,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,GAAG,OAAO,GAAG,EAAE,EAChF,gBAAgB,CACjB,CAAC;IACR,QAAQ,EAAE,OAAO,SAAS,SAAS,GAC/B,cAAc,GACd,IAAI,CACF,cAAc,EACd,MAAM,8BAA8B,CAElC,OAAO,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,GAAG,OAAO,GAAG,EAAE,EAChF,UAAU,CACX,CACF,GACC,8BAA8B,CAE5B,OAAO,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,GAAG,OAAO,GAAG,EAAE,EAChF,UAAU,CACX,CAAC;CACT,EAED,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;IACR,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,YAAY,CAAC,EAAE,SAAS,CAAC,MAAM,OAAO,CAAC,EAAE,CAAC;IAC1C,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,GACA,KAAK,SAAS,IAAI,GACjB,WAAW,CACT;IACE,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9B,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;IAChC,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;IACpC,cAAc,EAAE,WAAW,CAAC,gBAAgB,CAAC,EAAE,CAAC;IAChD,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;CACrC,EACD,wBAAwB,EACxB;IACE,YAAY,CACV;QACE,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;QAC5B,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC9B,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;QAClC,cAAc,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAC;QAC9C,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;KACnC,EACD,wBAAwB,EACxB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CACjB,EAAE;CACJ,CACF,GACD,YAAY,CACV;IACE,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IAC5B,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC9B,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;IAClC,cAAc,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAC9C,QAAQ,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;CACnC,EACD,wBAAwB,EACxB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CACjB,CAmIJ"}

package/dist/cjs/types/parsers/convert-from-number.d.ts

@@ -0,0 +1,15 @@
+import type Schema from '../schema/schema';
+/**
+ * This will convert a value from a number to any other type.
+ *
+ * @param callback
+ * @returns
+ */
+export default function convertFromNumberBuilder(callback: (value: number) => Awaited<ReturnType<Parameters<Schema['__parsers']['high']['set']>[1]>>): (value: any) => {
+    value: any;
+    preventNextParsers: boolean;
+} | {
+    value: any;
+    preventNextParsers: boolean;
+};
+//# sourceMappingURL=convert-from-number.d.ts.map

package/dist/cjs/types/parsers/convert-from-number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert-from-number.d.ts","sourceRoot":"","sources":["../../../../src/parsers/convert-from-number.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,kBAAkB,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,wBAAwB,CAC9C,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAEpF,GAAG;;;;;;EACnB"}

package/dist/cjs/types/parsers/convert-from-string.d.ts

@@ -0,0 +1,9 @@
+import type Schema from '../schema/schema';
+/**
+ * This will convert a value from a string to any other type.
+ *
+ * @param callback
+ * @returns
+ */
+export default function convertFromStringBuilder(callback: (value: string) => Awaited<ReturnType<Parameters<Schema['__parsers']['high']['set']>[1]>>): Parameters<Schema['__parsers']['high']['set']>[1];
+//# sourceMappingURL=convert-from-string.d.ts.map

package/dist/cjs/types/parsers/convert-from-string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert-from-string.d.ts","sourceRoot":"","sources":["../../../../src/parsers/convert-from-string.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,kBAAkB,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,wBAAwB,CAC9C,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAClG,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAQnD"}

package/dist/cjs/types/parsers/index.d.ts

@@ -0,0 +1,3 @@
+export { default as convertFromNumberBuilder } from './convert-from-number';
+export { default as convertFromStringBuilder } from './convert-from-string';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/types/parsers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/parsers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAC5E,OAAO,EAAE,OAAO,IAAI,wBAAwB,EAAE,MAAM,uBAAuB,CAAC"}