@palmares/schemas 0.1.21 → 0.1.22

package/src/adapter/types.ts

@@ -1,276 +0,0 @@
-import type { Schema } from '../schema/schema';
-import type { SupportedSchemas } from '../types';
-import type { withFallbackFactory } from '../utils';
-
-export type NonToTranslateArgs<TType extends SupportedSchemas> = {
-  withFallback: ReturnType<typeof withFallbackFactory<TType>>;
-};
-
-export type AdapterToStringArgs = {
-  parsers: {
-    optional: Schema['__optional']['allow'];
-    nullable: Schema['__nullable']['allow'];
-  };
-  type: Schema['__type'];
-  optional: Schema['__optional'];
-  nullable: Schema['__nullable'];
-};
-
-export type AdapterTranslateArgs<TType extends SupportedSchemas = SupportedSchemas> = AdapterToStringArgs &
-  NonToTranslateArgs<TType>;
-
-export type DatetimeAdapterTranslateArgs = {
-  allowString: boolean | undefined;
-  above:
-    | {
-        value: Date;
-        inclusive: boolean;
-        message: string;
-      }
-    | undefined;
-  below:
-    | {
-        value: Date;
-        inclusive: boolean;
-        message: string;
-      }
-    | undefined;
-} & AdapterTranslateArgs<'datetime'>;
-
-export type BooleanAdapterTranslateArgs = {
-  parsers: {
-    allowString: boolean | undefined;
-    allowNumber: boolean | undefined;
-    trueValues: any[] | undefined;
-    falseValues: any[] | undefined;
-  } & AdapterTranslateArgs<'boolean'>['parsers'];
-  is:
-    | {
-        value: boolean;
-        message: string;
-      }
-    | undefined;
-} & AdapterTranslateArgs<'boolean'>;
-
-export type ArrayAdapterTranslateArgs = {
-  schemas: any[];
-  minLength:
-    | {
-        value: number;
-        inclusive: boolean;
-        message: string;
-      }
-    | undefined;
-  maxLength:
-    | {
-        value: number;
-        inclusive: boolean;
-        message: string;
-      }
-    | undefined;
-  nonEmpty:
-    | {
-        message: string;
-      }
-    | undefined;
-
-  isTuple: boolean;
-} & (
-  | {
-      isTuple: true;
-      schemas: [any, ...any[]];
-    }
-  | { isTuple: false; schemas: [any] }
-) &
-  AdapterTranslateArgs<'array'>;
-
-export type NumberAdapterTranslateArgs = {
-  parsers: {
-    allowString: boolean | undefined;
-  } & AdapterTranslateArgs<'number'>['parsers'];
-  is:
-    | {
-        value: number[];
-        message: string;
-      }
-    | undefined;
-  min:
-    | {
-        value: number;
-        inclusive: boolean;
-        message: string;
-      }
-    | undefined;
-  max:
-    | {
-        value: number;
-        inclusive: boolean;
-        message: string;
-      }
-    | undefined;
-  maxDigits:
-    | {
-        value: number;
-        message: string;
-      }
-    | undefined;
-  decimalPlaces:
-    | {
-        value: number;
-        message: string;
-      }
-    | undefined;
-  integer:
-    | {
-        message: string;
-      }
-    | undefined;
-} & AdapterTranslateArgs<'number'>;
-
-export type StringAdapterToStringArgs = Omit<StringAdapterTranslateArgs, keyof NonToTranslateArgs<'string'>>;
-
-export type StringAdapterTranslateArgsWithoutNonTranslateArgs = Omit<
-  StringAdapterTranslateArgs,
-  keyof NonToTranslateArgs<'string'>
->;
-
-export type StringAdapterTranslateArgs = {
-  is:
-    | {
-        value: string[] | string;
-        message: string;
-      }
-    | undefined;
-  uuid:
-    | {
-        message: string;
-      }
-    | undefined;
-  email: { message: string } | undefined;
-  minLength:
-    | {
-        value: number;
-        message: string;
-      }
-    | undefined;
-  maxLength:
-    | {
-        value: number;
-        message: string;
-      }
-    | undefined;
-  regex:
-    | {
-        value: RegExp;
-        message: string;
-      }
-    | undefined;
-  endsWith:
-    | {
-        value: string;
-        message: string;
-      }
-    | undefined;
-  startsWith:
-    | {
-        value: string;
-        message: string;
-      }
-    | undefined;
-  includes:
-    | {
-        value: string;
-        message: string;
-      }
-    | undefined;
-} & AdapterTranslateArgs<'string'>;
-
-export type NumberAdapterToStringArgs = Omit<NumberAdapterTranslateArgs, keyof NonToTranslateArgs<'number'>>;
-
-export type NumberAdapterTranslateArgsWithoutNonTranslateArgs = Omit<
-  NumberAdapterTranslateArgs,
-  keyof NonToTranslateArgs<'number'>
->;
-
-export type ObjectAdapterTranslateArgs = {
-  data: Record<string, any>;
-} & AdapterTranslateArgs<'object'>;
-
-export type ObjectAdapterToStringArgs = {
-  data: Record<string, string>;
-} & AdapterToStringArgs;
-
-export type UnionAdapterTranslateArgs<TSchemasType = any> = {
-  schemas: TSchemasType;
-} & AdapterTranslateArgs<'union'>;
-
-export type UnionAdapterToStringArgs = {
-  schemas: [string, string, ...string[]];
-} & AdapterToStringArgs;
-
-export type UnionAdapterTranslateArgsWithoutNonTranslateArgs = Omit<
-  UnionAdapterTranslateArgs,
-  keyof NonToTranslateArgs<'union'>
->;
-
-export type ObjectAdapterTranslateArgsWithoutNonTranslateArgs = Omit<
-  ObjectAdapterTranslateArgs,
-  keyof NonToTranslateArgs<'object'>
->;
-
-export type ArrayAdapterTranslateArgsWithoutNonTranslateArgs = Omit<
-  ArrayAdapterTranslateArgs,
-  keyof NonToTranslateArgs<'array'>
->;
-
-export type BooleanAdapterTranslateArgsWithoutNonTranslateArgs = Omit<
-  BooleanAdapterTranslateArgs,
-  keyof NonToTranslateArgs<'boolean'>
->;
-
-export type DatetimeAdapterTranslateArgsWithoutNonTranslateArgs = Omit<
-  DatetimeAdapterTranslateArgs,
-  keyof NonToTranslateArgs<'datetime'>
->;
-export type ValidationDataBasedOnType<TType> = TType extends 'number'
-  ? NumberAdapterTranslateArgsWithoutNonTranslateArgs
-  : TType extends 'union'
-    ? UnionAdapterTranslateArgsWithoutNonTranslateArgs
-    : TType extends 'string'
-      ? StringAdapterTranslateArgsWithoutNonTranslateArgs
-      : TType extends 'array'
-        ? ArrayAdapterTranslateArgsWithoutNonTranslateArgs
-        : TType extends 'boolean'
-          ? BooleanAdapterTranslateArgsWithoutNonTranslateArgs
-          : TType extends 'datetime'
-            ? DatetimeAdapterTranslateArgsWithoutNonTranslateArgs
-            : ObjectAdapterTranslateArgsWithoutNonTranslateArgs;
-
-export type ErrorCodes =
-  | 'max'
-  | 'maxDigits'
-  | 'decimalPlaces'
-  | 'min'
-  | 'integer'
-  | 'required'
-  | 'null'
-  | 'object'
-  | 'number'
-  | 'string'
-  | 'array'
-  | 'tuple'
-  | 'nonEmpty'
-  | 'datetime'
-  | 'is'
-  | 'above'
-  | 'below'
-  | 'boolean'
-  | 'minLength'
-  | 'maxLength'
-  | 'regex'
-  | 'uuid'
-  | 'email'
-  | 'includes'
-  | 'endsWith'
-  | 'startsWith'
-  | `customError${string}`;

package/src/compile.ts

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

package/src/conf.ts

@@ -1,30 +0,0 @@
-import { NoAdapterFoundError } from './exceptions';
-
-import type { SchemaAdapter } from './adapter';
-
-declare global {
-  // eslint-disable-next-line no-var
-  var $PSchemasAdapter: SchemaAdapter | undefined;
-}
-
-/**
- * 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: SchemaAdapter) {
-  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(): SchemaAdapter {
-  if (!globalThis.$PSchemasAdapter) throw new NoAdapterFoundError();
-
-  return globalThis.$PSchemasAdapter;
-}

package/src/constants.ts

@@ -1,7 +0,0 @@
-export const DEFAULT_NUMBER_MAX_EXCEPTION = (max: number, inclusive: boolean) =>
-  `The number is greater than the allowed ${max}.${inclusive ? ` The value ${max} is accepted as well.` : ''}`;
-export const DEFAULT_NUMBER_MIN_EXCEPTION = (min: number, inclusive: boolean) =>
-  `The number is less than the allowed ${min}.${inclusive ? ` The value ${min} is accepted as well.` : ''}`;
-export const DEFAULT_NUMBER_POSITIVE_EXCEPTION = (allowZero: boolean) =>
-  `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/src/domain.ts

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

package/src/exceptions.ts

@@ -1,17 +0,0 @@
-export class SchemaAdapterNotImplementedError extends Error {
-  constructor(args: { className: string; functionName: string }) {
-    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: string) {
-    super(`TranslatableField '${fieldName}' did not implement the 'schema' key on 'customAttributes'`);
-  }
-}

package/src/index.ts

@@ -1,318 +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';
-
-import type { DefinitionsOfSchemaType, ExtractTypeFromObjectOfSchemas } from './schema/types';
-import type { Narrow } from '@palmares/core';
-import type { Model, ModelFields } from '@palmares/databases';
-
-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 type { Infer as infer } from './types';
-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<TAdapter extends SchemaAdapter>() {
-  return {
-    number: () => NumberSchema.new<{ schemaAdapter: TAdapter; schemaType: 'number'; hasSave: false }>(),
-    string: () => StringSchema.new<{ schemaAdapter: TAdapter; schemaType: 'string'; hasSave: false }>(),
-    array: <TSchemas extends readonly [Schema, ...Schema[]] | [[Schema]]>(...schemas: TSchemas) =>
-      array<TSchemas, { schemaAdapter: TAdapter; schemaType: 'array'; hasSave: false }>(...schemas),
-    boolean: () => BooleanSchema.new<{ schemaAdapter: TAdapter; schemaType: 'boolean'; hasSave: false }>(),
-    object: <TData extends Record<any, Schema<any, any>>>(data: TData) =>
-      ObjectSchema.new<TData, { schemaAdapter: TAdapter; schemaType: 'object'; hasSave: false }>(data),
-    union: <TSchemas extends readonly [Schema<any, any>, Schema<any, any>, ...Schema<any, any>[]]>(
-      ...schemas: Narrow<TSchemas>
-    ) => UnionSchema.new<TSchemas, { schemaAdapter: TAdapter; schemaType: 'union'; hasSave: false }>(schemas),
-    datetime: () => DatetimeSchema.new<{ 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<
-                // eslint-disable-next-line ts/ban-types
-                TFields extends undefined ? {} : TFields,
-                'input'
-              >
-            > &
-              ExtractTypeFromObjectOfSchemas<
-                // eslint-disable-next-line ts/ban-types
-                TFields extends undefined ? {} : TFields,
-                'input'
-              >;
-        output: TFields extends undefined
-          ? TFieldsOnModel
-          : Omit<
-              TFieldsOnModel,
-              keyof ExtractTypeFromObjectOfSchemas<
-                // eslint-disable-next-line ts/ban-types
-                TFields extends undefined ? {} : TFields,
-                'output'
-              >
-            > &
-              ExtractTypeFromObjectOfSchemas<
-                // eslint-disable-next-line ts/ban-types
-                TFields extends undefined ? {} : TFields,
-                'output'
-              >;
-        internal: TFields extends undefined
-          ? TFieldsOnModel
-          : Omit<
-              TFieldsOnModel,
-              keyof ExtractTypeFromObjectOfSchemas<
-                // eslint-disable-next-line ts/ban-types
-                TFields extends undefined ? {} : TFields,
-                'internal'
-              >
-            > &
-              ExtractTypeFromObjectOfSchemas<
-                // eslint-disable-next-line ts/ban-types
-                TFields extends undefined ? {} : TFields,
-                'internal'
-              >;
-        representation: TFields extends undefined
-          ? TFieldsOnModel
-          : Omit<
-              TFieldsOnModel,
-              keyof ExtractTypeFromObjectOfSchemas<
-                // eslint-disable-next-line ts/ban-types
-                TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> ? TFields : {},
-                'representation'
-              >
-            > &
-              ExtractTypeFromObjectOfSchemas<
-                // eslint-disable-next-line ts/ban-types
-                TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> ? TFields : {},
-                'representation'
-              >;
-        validate: TFields extends undefined
-          ? TFieldsOnModel
-          : Omit<
-              TFieldsOnModel,
-              keyof ExtractTypeFromObjectOfSchemas<
-                // eslint-disable-next-line ts/ban-types
-                TFields extends Record<any, Schema<any, DefinitionsOfSchemaType>> ? TFields : {},
-                'validate'
-              >
-            > &
-              ExtractTypeFromObjectOfSchemas<
-                // eslint-disable-next-line ts/ban-types
-                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>
-        > =>
-      modelSchema<
-        TModel,
-        TOmit,
-        TShow,
-        TMany,
-        TFields,
-        TAllModelFields,
-        {
-          schemaAdapter: TAdapter;
-          schemaType: 'object';
-          hasSave: false;
-        },
-        TFieldsOnModel,
-        TReturnType
-      >(model, options)
-  };
-}