@palmares/schemas 0.1.25 → 0.2.0

package/dist/esm/src/adapter/fields/array.js

@@ -1,13 +0,0 @@
-import { FieldAdapter } from '.';
-export function arrayFieldAdapter(args) {
-    class CustomArrayFieldAdapter extends ArrayFieldAdapter {
-        translate = args.translate;
-        toString = args.toString;
-        formatError = args.formatError;
-        parse = args.parse;
-    }
-    return CustomArrayFieldAdapter;
-}
-export class ArrayFieldAdapter extends FieldAdapter {
-    translate(_fieldAdapter, _args) {}
-}

package/dist/esm/src/adapter/fields/boolean.js

@@ -1,20 +0,0 @@
-import { FieldAdapter } from '.';
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-export function booleanFieldAdapter(args) {
-    class CustomBooleanFieldAdapter extends BooleanFieldAdapter {
-        translate = args.translate;
-        toString = args.toString;
-        formatError = args.formatError;
-        parse = args.parse;
-    }
-    return CustomBooleanFieldAdapter;
-}
-export class BooleanFieldAdapter extends FieldAdapter {
-    translate(_fieldAdapter, _args) {}
-    parse(_adapter, _fieldAdapter, _result, _value, _args) {
-        throw new SchemaAdapterNotImplementedError({
-            className: this.constructor.name,
-            functionName: 'parse'
-        });
-    }
-}

package/dist/esm/src/adapter/fields/datetime.js

@@ -1,20 +0,0 @@
-import { FieldAdapter } from '.';
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-export function datetimeFieldAdapter(args) {
-    class CustomDatetimeFieldAdapter extends DatetimeFieldAdapter {
-        translate = args.translate;
-        toString = args.toString;
-        formatError = args.formatError;
-        parse = args.parse;
-    }
-    return CustomDatetimeFieldAdapter;
-}
-export class DatetimeFieldAdapter extends FieldAdapter {
-    translate(_fieldAdapter, _args) {}
-    parse(_adapter, _fieldAdapter, _result, _value, _args) {
-        throw new SchemaAdapterNotImplementedError({
-            className: this.constructor.name,
-            functionName: 'parse'
-        });
-    }
-}

package/dist/esm/src/adapter/fields/index.js

@@ -1,37 +0,0 @@
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-export function fieldAdapter(args) {
-    class CustomFieldAdapter extends FieldAdapter {
-        translate = args.translate;
-        toString = args.toString;
-        formatError = args.formatError;
-        parse = args.parse;
-    }
-    return CustomFieldAdapter;
-}
-export class FieldAdapter {
-    translate(_fieldAdapter, _args, _base) {
-        throw new SchemaAdapterNotImplementedError({
-            className: this.constructor.name,
-            functionName: 'translate'
-        });
-    }
-    parse(_adapter, _fieldAdapter, _schema, _value, _args) {
-        throw new SchemaAdapterNotImplementedError({
-            className: this.constructor.name,
-            functionName: 'parse'
-        });
-    }
-    toString(_adapter, _fieldAdapter, _args, _base) {
-        throw new SchemaAdapterNotImplementedError({
-            className: this.constructor.name,
-            functionName: 'toString'
-        });
-    }
-    // eslint-disable-next-line ts/require-await
-    async formatError(_adapter, _fieldAdapter, _schema, _error, _metadata) {
-        throw new SchemaAdapterNotImplementedError({
-            className: this.constructor.name,
-            functionName: 'formatError'
-        });
-    }
-}

package/dist/esm/src/adapter/fields/number.js

@@ -1,20 +0,0 @@
-import { FieldAdapter } from '.';
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-export function numberFieldAdapter(args) {
-    class CustomNumberFieldAdapter extends NumberFieldAdapter {
-        translate = args.translate;
-        toString = args.toString;
-        formatError = args.formatError;
-        parse = args.parse;
-    }
-    return CustomNumberFieldAdapter;
-}
-export class NumberFieldAdapter extends FieldAdapter {
-    translate(_fieldAdapter, _args) {}
-    parse(_adapter, _fieldAdapter, _result, _value, _args) {
-        throw new SchemaAdapterNotImplementedError({
-            className: this.constructor.name,
-            functionName: 'parse'
-        });
-    }
-}

package/dist/esm/src/adapter/fields/object.js

@@ -1,26 +0,0 @@
-import { FieldAdapter } from '.';
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-export function objectFieldAdapter(args) {
-    class CustomObjectFieldAdapter extends ObjectFieldAdapter {
-        translate = args.translate;
-        toString = args.toString;
-        formatError = args.formatError;
-        parse = args.parse;
-    }
-    return CustomObjectFieldAdapter;
-}
-export class ObjectFieldAdapter extends FieldAdapter {
-    translate(_fieldAdapter, _args) {}
-    parse(_adapter, _fieldAdapter, _result, _value, _args) {
-        throw new SchemaAdapterNotImplementedError({
-            className: this.constructor.name,
-            functionName: 'parse'
-        });
-    }
-    toString(_adapter, _fieldAdapter, _args, _base) {
-        throw new SchemaAdapterNotImplementedError({
-            className: this.constructor.name,
-            functionName: 'toString'
-        });
-    }
-}

package/dist/esm/src/adapter/fields/string.js

@@ -1,20 +0,0 @@
-import { FieldAdapter } from '.';
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-export function stringFieldAdapter(args) {
-    class CustomStringFieldAdapter extends StringFieldAdapter {
-        translate = args.translate;
-        toString = args.toString;
-        formatError = args.formatError;
-        parse = args.parse;
-    }
-    return CustomStringFieldAdapter;
-}
-export class StringFieldAdapter extends FieldAdapter {
-    translate(_fieldAdapter, _args) {}
-    parse(_adapter, _fieldAdapter, _result, _value, _args) {
-        throw new SchemaAdapterNotImplementedError({
-            className: this.constructor.name,
-            functionName: 'parse'
-        });
-    }
-}

package/dist/esm/src/adapter/fields/union.js

@@ -1,20 +0,0 @@
-import { FieldAdapter } from '.';
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-export function unionFieldAdapter(args) {
-    class CustomUnionFieldAdapter extends UnionFieldAdapter {
-        translate = args.translate;
-        toString = args.toString;
-        formatError = args.formatError;
-        parse = args.parse;
-    }
-    return CustomUnionFieldAdapter;
-}
-export class UnionFieldAdapter extends FieldAdapter {
-    translate(_fieldAdapter, _args) {}
-    parse(_adapter, _fieldAdapter, _result, _value, _args) {
-        throw new SchemaAdapterNotImplementedError({
-            className: this.constructor.name,
-            functionName: 'parse'
-        });
-    }
-}

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

@@ -1,21 +0,0 @@
-import { SchemaAdapterNotImplementedError } from '../exceptions';
-export class SchemaAdapter {
-    $$type = '$PSchemaAdapter';
-    name;
-    field;
-    number;
-    object;
-    union;
-    string;
-    array;
-    boolean;
-    datetime;
-    adapterInstance;
-    // eslint-disable-next-line ts/require-await
-    async formatError(_error, _metadata) {
-        throw new SchemaAdapterNotImplementedError({
-            className: 'SchemaAdapter',
-            functionName: 'formatError'
-        });
-    }
-}

package/dist/esm/src/adapter/types.js

@@ -1 +0,0 @@
-export { };

package/dist/esm/src/compile.js

@@ -1,10 +0,0 @@
-import { getDefaultStd } from '@palmares/core';
-import { getDefaultAdapter } from './conf';
-export async function compile(schemas) {
-    const schemasAsEntries = Object.entries(schemas);
-    const adapter = getDefaultAdapter();
-    const std = getDefaultStd();
-    for (const [keyName, schema] of schemasAsEntries){
-        console.log(await schema.compile(adapter));
-    }
-}

package/dist/esm/src/conf.js

@@ -1,18 +0,0 @@
-import { NoAdapterFoundError } from './exceptions';
-/**
- * Sets the default adapter to be used by all of your schemas.
- *
- * @param adapter - The adapter to use when you define schemas.
- */ export function setDefaultAdapter(adapter) {
-    globalThis.$PSchemasAdapter = adapter;
-}
-/**
- * Gets the default adapter to be used by all of your schemas.
- *
- * @throws {NoAdapterFoundError} - If no adapter has been set.
- *
- * @returns The default adapter.
- */ export function getDefaultAdapter() {
-    if (!globalThis.$PSchemasAdapter) throw new NoAdapterFoundError();
-    return globalThis.$PSchemasAdapter;
-}

package/dist/esm/src/constants.js

@@ -1,4 +0,0 @@
-export const DEFAULT_NUMBER_MAX_EXCEPTION = (max, inclusive)=>`The number is greater than the allowed ${max}.${inclusive ? ` The value ${max} is accepted as well.` : ''}`;
-export const DEFAULT_NUMBER_MIN_EXCEPTION = (min, inclusive)=>`The number is less than the allowed ${min}.${inclusive ? ` The value ${min} is accepted as well.` : ''}`;
-export const DEFAULT_NUMBER_POSITIVE_EXCEPTION = (allowZero)=>`The number should be positive.${allowZero ? ` The value 0 is accepted as well.` : ''}`;
-export const DEFAULT_NUMBER_INTEGER_EXCEPTION = ()=>`The number should be an integer.`;

package/dist/esm/src/domain.js

@@ -1,11 +0,0 @@
-import { domain } from '@palmares/core';
-import { getDefaultAdapter, setDefaultAdapter } from './conf';
-export const schemasDomain = domain('@palmares/schemas', '', {
-    commands: {},
-    // eslint-disable-next-line ts/require-await
-    load: async (settings)=>{
-        setDefaultAdapter(new settings.schemaAdapter());
-        const schemaAdapter = getDefaultAdapter();
-        return undefined;
-    }
-});

package/dist/esm/src/exceptions.js

@@ -1,15 +0,0 @@
-export class SchemaAdapterNotImplementedError extends Error {
-    constructor(args){
-        super(`Schema adapter did not implement ${args.functionName} in ${args.className}`);
-    }
-}
-export class NoAdapterFoundError extends Error {
-    constructor(){
-        super('No adapter found, please define an adapter using setDefaultAdapter() before using any schema.');
-    }
-}
-export class TranslatableFieldNotImplementedError extends Error {
-    constructor(fieldName){
-        super(`TranslatableField '${fieldName}' did not implement the 'schema' key on 'customAttributes'`);
-    }
-}

package/dist/esm/src/index.js

@@ -1,126 +0,0 @@
-import { SchemaAdapter } from './adapter';
-import { schemasDomain as SchemaDomain } from './domain';
-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';
-export { FieldAdapter, fieldAdapter } from './adapter/fields';
-export { NumberFieldAdapter, numberFieldAdapter } from './adapter/fields/number';
-export { ObjectFieldAdapter, objectFieldAdapter } from './adapter/fields/object';
-export { UnionFieldAdapter, unionFieldAdapter } from './adapter/fields/union';
-export { StringFieldAdapter, stringFieldAdapter } from './adapter/fields/string';
-export { ArrayFieldAdapter, arrayFieldAdapter } from './adapter/fields/array';
-export { BooleanFieldAdapter, booleanFieldAdapter } from './adapter/fields/boolean';
-export { DatetimeFieldAdapter, datetimeFieldAdapter } from './adapter/fields/datetime';
-export { setDefaultAdapter, getDefaultAdapter } 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 { compile } from './compile';
-export { schemaHandler } from './middleware';
-export { modelSchema };
-export { SchemaDomain };
-export default SchemaDomain;
-export function getSchemasWithDefaultAdapter() {
-    return {
-        number: ()=>NumberSchema.new(),
-        string: ()=>StringSchema.new(),
-        array: (...schemas)=>array(...schemas),
-        boolean: ()=>BooleanSchema.new(),
-        object: (data)=>ObjectSchema.new(data),
-        union: (...schemas)=>UnionSchema.new(schemas),
-        datetime: ()=>DatetimeSchema.new(),
-        /**
-     * 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: (model, options)=>modelSchema(model, options)
-    };
-}

package/dist/esm/src/middleware.js

@@ -1,29 +0,0 @@
-import { Response } from '@palmares/server';
-/**
- * Validates the request body and returns a response automatically, don't need to do anything else.
- */ export function schemaHandler(input, output) {
-    return async (request)=>{
-        const data = await request.json();
-        const validatedData = await input.validate(data, {
-            request
-        });
-        if (validatedData.isValid) {
-            const savedData = await validatedData.save();
-            const status = request.method === 'POST' ? 201 : 200;
-            if (output) return Response.json(await output.data(savedData), {
-                status: status
-            });
-            return Response.json(savedData, {
-                status,
-                headers: {
-                    'content-type': 'application/json'
-                }
-            });
-        }
-        return Response.json({
-            errors: validatedData.errors
-        }, {
-            status: 400
-        });
-    };
-}