@palmares/schemas 0.1.25 → 0.2.0

package/dist/esm/src/model.js

@@ -1,264 +0,0 @@
-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 { string } from './schema/string';
-import { union } from './schema/union';
-async function getSchemaFromModelField(model, field, parent, definedFields, engineInstanceName, options) {
-    const fieldAsAny = field;
-    let schema = undefined;
-    if (fieldAsAny?.['$$type'] === '$PAutoField' || fieldAsAny?.['$$type'] === '$PBigAutoField') schema = number().integer().optional();
-    else if (fieldAsAny?.['$$type'] === '$PDecimalField') schema = number().decimalPlaces(field.decimalPlaces).maxDigits(field.maxDigits);
-    else if (fieldAsAny?.['$$type'] === '$PIntegerField') schema = number().integer();
-    else if (fieldAsAny?.['$$type'] === '$PBooleanField') schema = boolean();
-    else if (fieldAsAny?.['$$type'] === '$PTextField' || fieldAsAny?.['$$type'] === '$PCharField' || fieldAsAny?.['$$type'] === '$PUuidField') {
-        schema = string();
-        if (field.allowBlank === false) schema = schema.minLength(1);
-        if (fieldAsAny?.['$$type'] === '$PCharField' && typeof field.maxLength === 'number') schema = schema.maxLength(field.maxLength);
-        if (fieldAsAny?.['$$type'] === '$PUuidField') {
-            schema = schema.uuid();
-            // eslint-disable-next-line ts/no-unnecessary-condition
-            if (field.autoGenerate) schema = schema.optional();
-        }
-    } else if (fieldAsAny?.['$$type'] === '$PDateField') {
-        schema = datetime().allowString();
-        // eslint-disable-next-line ts/no-unnecessary-condition
-        if (field.autoNow || field.autoNowAdd) schema = schema.optional();
-    } else if (fieldAsAny?.['$$type'] === '$PEnumField') {
-        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 (fieldAsAny?.['$$type'] === '$PForeignKeyField') {
-        const fieldAsForeignKey = field;
-        const doesADefinedFieldExistWithRelatedName = parent && fieldAsForeignKey.relatedName && parent.__data?.[fieldAsForeignKey.relatedName];
-        const doesADefinedFieldExistWithRelationName = definedFields && fieldAsForeignKey.relationName && definedFields[fieldAsForeignKey.relationName];
-        const fieldWithRelatedName = doesADefinedFieldExistWithRelatedName ? parent.__data?.[fieldAsForeignKey.relatedName] : undefined;
-        const fieldWithRelationName = doesADefinedFieldExistWithRelationName ? definedFields[fieldAsForeignKey.relationName] : undefined;
-        const isFieldWithRelatedNameAModelField = fieldWithRelatedName?.['$$type'] === '$PSchema' && fieldWithRelatedName.__model !== undefined;
-        const isFieldWithRelationNameAModelField = fieldWithRelationName?.['$$type'] === '$PSchema' && fieldWithRelationName.__model !== undefined;
-        const relatedToModel = fieldAsForeignKey.relatedTo;
-        const toField = fieldAsForeignKey.toField;
-        if (Object.keys(model._initialized).length > 0) {
-            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['$$type'] === '$PArraySchema',
-                    model: fieldWithRelatedName.__model,
-                    fieldToSearchOnModel: fieldAsForeignKey.fieldName,
-                    fieldToGetFromData: fieldAsForeignKey.toField,
-                    relationOrRelatedName: fieldAsForeignKey.relatedName
-                };
-            } else if (isFieldWithRelationNameAModelField) {
-                if (typeof options !== 'object') options = {};
-                options.foreignKeyRelation = {
-                    isArray: fieldWithRelationName['$$type'] === '$PArraySchema',
-                    model: fieldWithRelationName.__model,
-                    fieldToSearchOnModel: fieldAsForeignKey.toField,
-                    fieldToGetFromData: field.fieldName,
-                    relationOrRelatedName: fieldAsForeignKey.relationName
-                };
-            }
-            return getSchemaFromModelField(relatedToModelInstance, modelFieldsOfRelatedModel, parent, definedFields, engineInstanceName, options);
-        }
-    } else if (fieldAsAny?.['$$type'] === '$PTranslatableField' && field.customAttributes.schema) {
-        if (field.customAttributes.schema?.['$$type'] === '$PSchema' === 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 });
- *   },
- *   // The `companyId` field on the 'User' model is tied to the `id` field on the 'Company' model so 'id' is required.
- *   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.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 ()=>{
-        const promise = new Promise((resolve)=>{
-            const fieldsOfModels = model._fields();
-            const fieldsAsEntries = Object.entries(fieldsOfModels);
-            const fieldsWithAutomaticRelations = new Map();
-            const fields = fieldsAsObject;
-            Promise.all(fieldsAsEntries.map(async ([key, value])=>{
-                if (omitAsSet.has(key)) return;
-                if (showAsSet.size > 0 && !showAsSet.has(key)) return;
-                let schema = fieldsAsObject[key];
-                const optionsForForeignKeyRelation = {};
-                if (!schema || value?.['$$type'] === '$PForeignKeyField') {
-                    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);
-                }
-                fieldsAsObject[key] = schema;
-                return fieldsAsObject;
-            })).then(async ()=>{
-                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);
-                }));
-                resolve(undefined);
-            });
-        });
-        if (parentSchema.__alreadyAppliedModel) return parentSchema.__alreadyAppliedModel;
-        parentSchema.__alreadyAppliedModel = promise;
-        return promise;
-    };
-    if (options?.ignoreExtraneousFields !== true) lazyModelSchema.removeExtraneous();
-    return parentSchema;
-}

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

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

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

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

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

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