@palmares/schemas 0.1.20 → 0.1.22

package/src/adapter/fields/index.ts

@@ -1,72 +0,0 @@
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-
-import type { SupportedSchemas } from '../../types';
-import type { WithFallback } from '../../utils';
-import type { SchemaAdapter } from '../index';
-import type { AdapterToStringArgs, AdapterTranslateArgs, ErrorCodes } from '../types';
-
-export function fieldAdapter<
-  TTranslate extends FieldAdapter['translate'],
-  TToString extends FieldAdapter['toString'],
-  TFormatError extends FieldAdapter['formatError'],
-  TParse extends FieldAdapter['parse']
->(args: { translate: TTranslate; toString?: TToString; formatError?: TFormatError; parse?: TParse }) {
-  class CustomFieldAdapter extends FieldAdapter {
-    translate = args.translate;
-    toString = args.toString as TToString;
-    formatError = args.formatError as TFormatError;
-    parse = args.parse as TParse;
-  }
-
-  return CustomFieldAdapter as typeof FieldAdapter & {
-    new (): FieldAdapter & {
-      translate: TTranslate;
-      toString: TToString;
-      formatError: TFormatError;
-      parse: TParse;
-    };
-  };
-}
-export class FieldAdapter {
-  translate(
-    _fieldAdapter: FieldAdapter,
-    _args: AdapterTranslateArgs<SupportedSchemas>,
-    _base?: any
-  ): any | WithFallback<SupportedSchemas> {
-    throw new SchemaAdapterNotImplementedError({ className: this.constructor.name, functionName: 'translate' });
-  }
-
-  parse(
-    _adapter: SchemaAdapter,
-    _fieldAdapter: FieldAdapter,
-    _schema: any,
-    _value: any,
-    _args: Omit<AdapterTranslateArgs<SupportedSchemas>, 'withFallback'>
-  ): Promise<{ errors: any; parsed: any }> {
-    throw new SchemaAdapterNotImplementedError({ className: this.constructor.name, functionName: 'parse' });
-  }
-
-  toString(
-    _adapter: SchemaAdapter,
-    _fieldAdapter: FieldAdapter,
-    _args: AdapterToStringArgs,
-    _base?: any
-  ): Promise<string> {
-    throw new SchemaAdapterNotImplementedError({ className: this.constructor.name, functionName: 'toString' });
-  }
-
-  // eslint-disable-next-line ts/require-await
-  async formatError(
-    _adapter: SchemaAdapter,
-    _fieldAdapter: FieldAdapter,
-    _schema: any,
-    _error: any,
-    _metadata?: any
-  ): Promise<{
-    message: string;
-    path: (string | number)[];
-    code: ErrorCodes;
-  }> {
-    throw new SchemaAdapterNotImplementedError({ className: this.constructor.name, functionName: 'formatError' });
-  }
-}

package/src/adapter/fields/number.ts

@@ -1,43 +0,0 @@
-import { FieldAdapter } from '.';
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-
-import type { SchemaAdapter } from '..';
-import type { WithFallback } from '../../utils';
-import type { NumberAdapterTranslateArgs } from '../types';
-
-export function numberFieldAdapter<
-  TTranslate extends NumberFieldAdapter['translate'],
-  TToString extends NumberFieldAdapter['toString'],
-  TFormatError extends NumberFieldAdapter['formatError'],
-  TParse extends NumberFieldAdapter['parse']
->(args: { translate: TTranslate; toString?: TToString; formatError?: TFormatError; parse?: TParse }) {
-  class CustomNumberFieldAdapter extends NumberFieldAdapter {
-    translate = args.translate;
-    toString = args.toString as TToString;
-    formatError = args.formatError as TFormatError;
-    parse = args.parse as TParse;
-  }
-
-  return CustomNumberFieldAdapter as typeof NumberFieldAdapter & {
-    new (): NumberFieldAdapter & {
-      translate: TTranslate;
-      toString: TToString;
-      formatError: TFormatError;
-      parse: TParse;
-    };
-  };
-}
-
-export class NumberFieldAdapter extends FieldAdapter {
-  translate(_fieldAdapter: FieldAdapter, _args: NumberAdapterTranslateArgs): any | WithFallback<'number'> {}
-
-  parse(
-    _adapter: SchemaAdapter,
-    _fieldAdapter: FieldAdapter,
-    _result: any,
-    _value: any,
-    _args: NumberAdapterTranslateArgs
-  ): Promise<{ errors: any; parsed: any }> {
-    throw new SchemaAdapterNotImplementedError({ className: this.constructor.name, functionName: 'parse' });
-  }
-}

package/src/adapter/fields/object.ts

@@ -1,52 +0,0 @@
-import { FieldAdapter } from '.';
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-
-import type { SchemaAdapter } from '..';
-import type { WithFallback } from '../../utils';
-import type { ObjectAdapterToStringArgs, ObjectAdapterTranslateArgs } from '../types';
-
-export function objectFieldAdapter<
-  TTranslate extends ObjectFieldAdapter['translate'],
-  TToString extends ObjectFieldAdapter['toString'],
-  TFormatError extends ObjectFieldAdapter['formatError'],
-  TParse extends ObjectFieldAdapter['parse']
->(args: { translate: TTranslate; toString?: TToString; formatError?: TFormatError; parse?: TParse }) {
-  class CustomObjectFieldAdapter extends ObjectFieldAdapter {
-    translate = args.translate;
-    toString = args.toString as TToString;
-    formatError = args.formatError as TFormatError;
-    parse = args.parse as TParse;
-  }
-
-  return CustomObjectFieldAdapter as typeof ObjectFieldAdapter & {
-    new (): ObjectFieldAdapter & {
-      translate: TTranslate;
-      toString: TToString;
-      formatError: TFormatError;
-      parse: TParse;
-    };
-  };
-}
-
-export class ObjectFieldAdapter extends FieldAdapter {
-  translate(_fieldAdapter: FieldAdapter, _args: ObjectAdapterTranslateArgs): any | WithFallback<'object'> {}
-
-  parse(
-    _adapter: SchemaAdapter,
-    _fieldAdapter: FieldAdapter,
-    _result: any,
-    _value: any,
-    _args: ObjectAdapterTranslateArgs
-  ): Promise<{ errors: any; parsed: any }> {
-    throw new SchemaAdapterNotImplementedError({ className: this.constructor.name, functionName: 'parse' });
-  }
-
-  toString(
-    _adapter: SchemaAdapter,
-    _fieldAdapter: FieldAdapter,
-    _args: ObjectAdapterToStringArgs,
-    _base?: any
-  ): Promise<string> {
-    throw new SchemaAdapterNotImplementedError({ className: this.constructor.name, functionName: 'toString' });
-  }
-}

package/src/adapter/fields/string.ts

@@ -1,43 +0,0 @@
-import { FieldAdapter } from '.';
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-
-import type { SchemaAdapter } from '..';
-import type { WithFallback } from '../../utils';
-import type { StringAdapterTranslateArgs } from '../types';
-
-export function stringFieldAdapter<
-  TTranslate extends StringFieldAdapter['translate'],
-  TToString extends StringFieldAdapter['toString'],
-  TFormatError extends StringFieldAdapter['formatError'],
-  TParse extends StringFieldAdapter['parse']
->(args: { translate: TTranslate; toString?: TToString; formatError?: TFormatError; parse?: TParse }) {
-  class CustomStringFieldAdapter extends StringFieldAdapter {
-    translate = args.translate;
-    toString = args.toString as TToString;
-    formatError = args.formatError as TFormatError;
-    parse = args.parse as TParse;
-  }
-
-  return CustomStringFieldAdapter as typeof StringFieldAdapter & {
-    new (): StringFieldAdapter & {
-      translate: TTranslate;
-      toString: TToString;
-      formatError: TFormatError;
-      parse: TParse;
-    };
-  };
-}
-
-export class StringFieldAdapter extends FieldAdapter {
-  translate(_fieldAdapter: FieldAdapter, _args: StringAdapterTranslateArgs): any | WithFallback<'string'> {}
-
-  parse(
-    _adapter: SchemaAdapter,
-    _fieldAdapter: FieldAdapter,
-    _result: any,
-    _value: any,
-    _args: StringAdapterTranslateArgs
-  ): Promise<{ errors: any; parsed: any }> {
-    throw new SchemaAdapterNotImplementedError({ className: this.constructor.name, functionName: 'parse' });
-  }
-}

package/src/adapter/fields/union.ts

@@ -1,43 +0,0 @@
-import { FieldAdapter } from '.';
-import { SchemaAdapterNotImplementedError } from '../../exceptions';
-
-import type { SchemaAdapter } from '..';
-import type { WithFallback } from '../../utils';
-import type { UnionAdapterTranslateArgs } from '../types';
-
-export function unionFieldAdapter<
-  TTranslate extends UnionFieldAdapter['translate'],
-  TToString extends UnionFieldAdapter['toString'],
-  TFormatError extends UnionFieldAdapter['formatError'],
-  TParse extends UnionFieldAdapter['parse']
->(args: { translate: TTranslate; toString?: TToString; formatError?: TFormatError; parse?: TParse }) {
-  class CustomUnionFieldAdapter extends UnionFieldAdapter {
-    translate = args.translate;
-    toString = args.toString as TToString;
-    formatError = args.formatError as TFormatError;
-    parse = args.parse as TParse;
-  }
-
-  return CustomUnionFieldAdapter as typeof UnionFieldAdapter & {
-    new (): UnionFieldAdapter & {
-      translate: TTranslate;
-      toString: TToString;
-      formatError: TFormatError;
-      parse: TParse;
-    };
-  };
-}
-
-export class UnionFieldAdapter extends FieldAdapter {
-  translate(_fieldAdapter: FieldAdapter, _args: UnionAdapterTranslateArgs): any | WithFallback<'union'> {}
-
-  parse(
-    _adapter: SchemaAdapter,
-    _fieldAdapter: FieldAdapter,
-    _result: any,
-    _value: any,
-    _args: UnionAdapterTranslateArgs
-  ): Promise<{ errors: any; parsed: any }> {
-    throw new SchemaAdapterNotImplementedError({ className: this.constructor.name, functionName: 'parse' });
-  }
-}

package/src/adapter/index.ts

@@ -1,35 +0,0 @@
-import { SchemaAdapterNotImplementedError } from '../exceptions';
-
-import type { FieldAdapter } from './fields';
-import type { ArrayFieldAdapter } from './fields/array';
-import type { BooleanFieldAdapter } from './fields/boolean';
-import type { DatetimeFieldAdapter } from './fields/datetime';
-import type { NumberFieldAdapter } from './fields/number';
-import type { ObjectFieldAdapter } from './fields/object';
-import type { StringFieldAdapter } from './fields/string';
-import type { UnionFieldAdapter } from './fields/union';
-import type { ErrorCodes } from './types';
-
-export class SchemaAdapter {
-  field!: FieldAdapter;
-  number?: NumberFieldAdapter;
-  object!: ObjectFieldAdapter;
-  union?: UnionFieldAdapter;
-  string?: StringFieldAdapter;
-  array?: ArrayFieldAdapter;
-  boolean?: BooleanFieldAdapter;
-  datetime?: DatetimeFieldAdapter;
-  adapterInstance: any;
-
-  // eslint-disable-next-line ts/require-await
-  async formatError(
-    _error: any,
-    _metadata?: any
-  ): Promise<{
-    message: string;
-    path: (string | number)[];
-    code: ErrorCodes;
-  }> {
-    throw new SchemaAdapterNotImplementedError({ className: 'SchemaAdapter', functionName: 'formatError' });
-  }
-}

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,27 +0,0 @@
-import { NoAdapterFoundError } from './exceptions';
-
-import type { SchemaAdapter } from './adapter';
-
-let cachedAdapter: SchemaAdapter | null = null;
-
-/**
- * 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) {
-  cachedAdapter = 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 (!cachedAdapter) throw new NoAdapterFoundError();
-
-  return cachedAdapter;
-}

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'`);
-  }
-}