Merge pull request #211 from Saeris/feat/add-reflection-api

Add Schema Reflection API
fabian-hiller · Nov 19, 2023 · db57a67 · db57a67
2 parents fbb4ee2 + a90ac7d
commit db57a67
Show file tree

Hide file tree

Showing 276 changed files with 4,770 additions and 3,681 deletions.
diff --git a/library/CHANGELOG.md b/library/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to the library will be documented in this file.
 
+## vX.X.X (Month DD, YYYY)
+
+- Change structure of schemas, validations and transformations to make properties accessible (pull request #211)
+
 ## v0.20.1 (November 2, 2023)
 
 - Remove `never` from type signatur of strict objects and tuples (issue #234)

diff --git a/library/src/error/ValiError/ValiError.ts b/library/src/error/ValiError/ValiError.ts
@@ -1,4 +1,4 @@
-import type { Issues } from '../../types.ts';
+import type { Issues } from '../../types/index.ts';
 
 /**
  * A Valibot error with useful information.

diff --git a/library/src/error/flatten/flatten.test.ts b/library/src/error/flatten/flatten.test.ts
@@ -1,5 +1,5 @@
 import { describe, expect, test } from 'vitest';
-import type { Issue, Issues } from '../../types.ts';
+import type { Issue, Issues } from '../../types/index.ts';
 import { ValiError } from '../ValiError/index.ts';
 import { flatten } from './flatten.ts';
 

diff --git a/library/src/error/flatten/flatten.ts b/library/src/error/flatten/flatten.ts
@@ -27,7 +27,7 @@ import type {
   BaseSchemaAsync,
   Input,
   Issues,
-} from '../../types.ts';
+} from '../../types/index.ts';
 import type { ValiError } from '../ValiError/index.ts';
 
 /**

diff --git a/library/src/index.ts b/library/src/index.ts
@@ -3,6 +3,6 @@ export * from './methods/index.ts';
 export * from './regex.ts';
 export * from './schemas/index.ts';
 export * from './transformations/index.ts';
+export * from './types/index.ts';
 export * from './utils/index.ts';
 export * from './validations/index.ts';
-export * from './types.ts';
diff --git a/library/src/methods/brand/brand.test.ts b/library/src/methods/brand/brand.test.ts
@@ -1,6 +1,6 @@
 import { describe, expect, expectTypeOf, test } from 'vitest';
 import { object, string } from '../../schemas/index.ts';
-import type { Output } from '../../types.ts';
+import type { Output } from '../../types/index.ts';
 import { parse } from '../parse/index.ts';
 import { brand, type Brand } from './brand.ts';
 

diff --git a/library/src/methods/brand/brand.ts b/library/src/methods/brand/brand.ts
@@ -3,7 +3,7 @@ import type {
   BaseSchemaAsync,
   Input,
   Output,
-} from '../../types.ts';
+} from '../../types/index.ts';
 
 /**
  * Brand symbol.

diff --git a/library/src/methods/coerce/coerce.ts b/library/src/methods/coerce/coerce.ts
@@ -1,4 +1,4 @@
-import type { BaseSchema } from '../../types.ts';
+import type { BaseSchema } from '../../types/index.ts';
 
 /**
  * Coerces the input of a schema to match the required type.
@@ -14,15 +14,6 @@ export function coerce<TSchema extends BaseSchema>(
 ): TSchema {
   return {
     ...schema,
-
-    /**
-     * Parses unknown input based on its schema.
-     *
-     * @param input The input to be parsed.
-     * @param info The parse info.
-     *
-     * @returns The parsed output.
-     */
     _parse(input, info) {
       return schema._parse(action(input), info);
     },

diff --git a/library/src/methods/coerce/coerceAsync.ts b/library/src/methods/coerce/coerceAsync.ts
@@ -1,4 +1,4 @@
-import type { BaseSchemaAsync } from '../../types.ts';
+import type { BaseSchemaAsync } from '../../types/index.ts';
 
 /**
  * Coerces the input of a async schema to match the required type.
@@ -14,15 +14,6 @@ export function coerceAsync<TSchema extends BaseSchemaAsync>(
 ): TSchema {
   return {
     ...schema,
-
-    /**
-     * Parses unknown input based on its schema.
-     *
-     * @param input The input to be parsed.
-     * @param info The parse info.
-     *
-     * @returns The parsed output.
-     */
     async _parse(input, info) {
       return schema._parse(await action(input), info);
     },

diff --git a/library/src/methods/fallback/fallback.ts b/library/src/methods/fallback/fallback.ts
@@ -1,14 +1,22 @@
-import type { BaseSchema, Output } from '../../types.ts';
+import type { BaseSchema, Output } from '../../types/index.ts';
 import { getOutput } from '../../utils/index.ts';
+import { getFallback } from '../getFallback/index.ts';
 import type { FallbackInfo } from './types.ts';
 
 /**
  * Schema with fallback type.
  */
 export type SchemaWithFallback<
   TSchema extends BaseSchema = BaseSchema,
-  TFallback extends Output<TSchema> = Output<TSchema>
-> = TSchema & { getFallback: (info?: FallbackInfo) => TFallback };
+  TFallback extends
+    | Output<TSchema>
+    | ((info?: FallbackInfo) => Output<TSchema>) = Output<TSchema>
+> = TSchema & {
+  /**
+   * The fallback value.
+   */
+  fallback: TFallback;
+};
 
 /**
  * Returns a fallback value when validating the passed schema failed.
@@ -20,36 +28,21 @@ export type SchemaWithFallback<
  */
 export function fallback<
   TSchema extends BaseSchema,
-  TFallback extends Output<TSchema>
+  const TFallback extends
+    | Output<TSchema>
+    | ((info?: FallbackInfo) => Output<TSchema>)
 >(
   schema: TSchema,
-  fallback: TFallback | ((info?: FallbackInfo) => TFallback)
+  fallback: TFallback
 ): SchemaWithFallback<TSchema, TFallback> {
   return {
     ...schema,
-
-    /**
-     * Returns the fallback value.
-     */
-    getFallback(info) {
-      return typeof fallback === 'function'
-        ? (fallback as (info?: FallbackInfo) => TFallback)(info)
-        : (fallback as TFallback);
-    },
-
-    /**
-     * Parses unknown input based on its schema.
-     *
-     * @param input The input to be parsed.
-     * @param info The parse info.
-     *
-     * @returns The parsed output.
-     */
+    fallback,
     _parse(input, info) {
       const result = schema._parse(input, info);
       return getOutput(
         result.issues
-          ? this.getFallback({ input, issues: result.issues })
+          ? getFallback(this, { input, issues: result.issues })
           : result.output
       );
     },

diff --git a/library/src/methods/fallback/fallbackAsync.ts b/library/src/methods/fallback/fallbackAsync.ts
@@ -1,14 +1,24 @@
-import type { BaseSchemaAsync, Output } from '../../types.ts';
+import type { BaseSchemaAsync, Output } from '../../types/index.ts';
 import { getOutput } from '../../utils/index.ts';
+import { getFallbackAsync } from '../getFallback/index.ts';
 import type { FallbackInfo } from './types.ts';
 
 /**
  * Schema with fallback async type.
  */
 export type SchemaWithFallbackAsync<
   TSchema extends BaseSchemaAsync = BaseSchemaAsync,
-  TFallback extends Output<TSchema> = Output<TSchema>
-> = TSchema & { getFallback: (info?: FallbackInfo) => Promise<TFallback> };
+  TFallback extends
+    | Output<TSchema>
+    | ((
+        info?: FallbackInfo
+      ) => Output<TSchema> | Promise<Output<TSchema>>) = Output<TSchema>
+> = TSchema & {
+  /**
+   * The fallback value.
+   */
+  fallback: TFallback;
+};
 
 /**
  * Returns a fallback value when validating the passed schema failed.
@@ -20,40 +30,21 @@ export type SchemaWithFallbackAsync<
  */
 export function fallbackAsync<
   TSchema extends BaseSchemaAsync,
-  TFallback extends Output<TSchema>
+  const TFallback extends
+    | Output<TSchema>
+    | ((info?: FallbackInfo) => Output<TSchema> | Promise<Output<TSchema>>)
 >(
   schema: TSchema,
-  fallback:
-    | TFallback
-    | ((info?: FallbackInfo) => TFallback | Promise<TFallback>)
+  fallback: TFallback
 ): SchemaWithFallbackAsync<TSchema, TFallback> {
   return {
     ...schema,
-
-    /**
-     * Returns the default value.
-     */
-    async getFallback(info) {
-      return typeof fallback === 'function'
-        ? await (
-            fallback as (info?: FallbackInfo) => TFallback | Promise<TFallback>
-          )(info)
-        : (fallback as TFallback);
-    },
-
-    /**
-     * Parses unknown input based on its schema.
-     *
-     * @param input The input to be parsed.
-     * @param info The parse info.
-     *
-     * @returns The parsed output.
-     */
+    fallback,
     async _parse(input, info) {
       const result = await schema._parse(input, info);
       return getOutput(
         result.issues
-          ? await this.getFallback({ input, issues: result.issues })
+          ? await getFallbackAsync(this, { input, issues: result.issues })
           : result.output
       );
     },

diff --git a/library/src/methods/fallback/types.ts b/library/src/methods/fallback/types.ts
@@ -1,4 +1,4 @@
-import type { Issues } from '../../types.ts';
+import type { Issues } from '../../types/index.ts';
 
 /**
  * Fallback info type.

diff --git a/library/src/methods/getDefault/getDefault.ts b/library/src/methods/getDefault/getDefault.ts
@@ -1,11 +1,16 @@
-import type { BaseSchema, Output } from '../../types.ts';
+import type { BaseSchema, Output } from '../../types/index.ts';
 import type { DefaultValue } from './types.ts';
 
 /**
  * Schema with maybe default type.
  */
 export type SchemaWithMaybeDefault<TSchema extends BaseSchema = BaseSchema> =
-  TSchema & { getDefault?: () => Output<TSchema> };
+  TSchema & {
+    /**
+     * The optional default value.
+     */
+    default?: Output<TSchema> | (() => Output<TSchema> | undefined);
+  };
 
 /**
  * Returns the default value of the schema.
@@ -17,5 +22,7 @@ export type SchemaWithMaybeDefault<TSchema extends BaseSchema = BaseSchema> =
 export function getDefault<TSchema extends SchemaWithMaybeDefault>(
   schema: TSchema
 ): DefaultValue<TSchema> {
-  return schema.getDefault?.();
+  return typeof schema.default === 'function'
+    ? schema.default()
+    : schema.default;
 }
diff --git a/library/src/methods/getDefault/getDefaultAsync.ts b/library/src/methods/getDefault/getDefaultAsync.ts
@@ -1,4 +1,4 @@
-import type { BaseSchemaAsync, Output } from '../../types.ts';
+import type { BaseSchemaAsync, Output } from '../../types/index.ts';
 import type { SchemaWithMaybeDefault } from './getDefault.ts';
 import type { DefaultValue } from './types.ts';
 
@@ -7,7 +7,17 @@ import type { DefaultValue } from './types.ts';
  */
 export type SchemaWithMaybeDefaultAsync<
   TSchema extends BaseSchemaAsync = BaseSchemaAsync
-> = TSchema & { getDefault?: () => Promise<Output<TSchema>> };
+> = TSchema & {
+  /**
+   * The optional default value.
+   */
+  default?:
+    | Output<TSchema>
+    | (() =>
+        | Output<TSchema>
+        | Promise<Output<TSchema> | undefined>
+        | undefined);
+};
 
 /**
  * Returns the default value of the schema.
@@ -19,5 +29,7 @@ export type SchemaWithMaybeDefaultAsync<
 export async function getDefaultAsync<
   TSchema extends SchemaWithMaybeDefault | SchemaWithMaybeDefaultAsync
 >(schema: TSchema): Promise<DefaultValue<TSchema>> {
-  return schema.getDefault?.();
+  return typeof schema.default === 'function'
+    ? await schema.default()
+    : schema.default;
 }
diff --git a/library/src/methods/getDefault/types.ts b/library/src/methods/getDefault/types.ts
@@ -1,4 +1,4 @@
-import type { Output } from '../../types.ts';
+import type { Output } from '../../types/index.ts';
 import type { SchemaWithMaybeDefault } from './getDefault.ts';
 import type { SchemaWithMaybeDefaultAsync } from './getDefaultAsync.ts';
 
@@ -7,8 +7,10 @@ import type { SchemaWithMaybeDefaultAsync } from './getDefaultAsync.ts';
  */
 export type DefaultValue<
   TSchema extends SchemaWithMaybeDefault | SchemaWithMaybeDefaultAsync
-> = TSchema['getDefault'] extends () => Output<TSchema>
-  ? ReturnType<TSchema['getDefault']>
-  : TSchema['getDefault'] extends () => Promise<Output<TSchema>>
-  ? Awaited<ReturnType<TSchema['getDefault']>>
+> = TSchema['default'] extends Output<TSchema> | undefined
+  ? TSchema['default']
+  : TSchema['default'] extends () => Output<TSchema> | undefined
+  ? ReturnType<TSchema['default']>
+  : TSchema['default'] extends () => Promise<Output<TSchema> | undefined>
+  ? Awaited<ReturnType<TSchema['default']>>
   : undefined;
diff --git a/library/src/methods/getDefaults/getDefaults.ts b/library/src/methods/getDefaults/getDefaults.ts
@@ -4,8 +4,11 @@ import type {
   TupleItems,
   TupleSchema,
 } from '../../schemas/index.ts';
-import type { BaseSchema } from '../../types.ts';
-import type { SchemaWithMaybeDefault } from '../getDefault/getDefault.ts';
+import type { BaseSchema } from '../../types/index.ts';
+import {
+  getDefault,
+  type SchemaWithMaybeDefault,
+} from '../getDefault/index.ts';
 import type { DefaultValues } from './types.ts';
 
 /**
@@ -28,8 +31,8 @@ export function getDefaults<
   let defaults: any;
 
   // If schema contains a default function, set its default value
-  if (schema.getDefault) {
-    defaults = schema.getDefault();
+  if (schema.default) {
+    defaults = getDefault(schema);
 
     // Otherwise, check if schema is of kind object or tuple
   } else if ('type' in schema) {

diff --git a/library/src/methods/getDefaults/getDefaultsAsync.ts b/library/src/methods/getDefaults/getDefaultsAsync.ts
@@ -8,10 +8,11 @@ import type {
   TupleSchema,
   TupleSchemaAsync,
 } from '../../schemas/index.ts';
-import type { BaseSchema, BaseSchemaAsync } from '../../types.ts';
-import type {
-  SchemaWithMaybeDefault,
-  SchemaWithMaybeDefaultAsync,
+import type { BaseSchema, BaseSchemaAsync } from '../../types/index.ts';
+import {
+  getDefaultAsync,
+  type SchemaWithMaybeDefault,
+  type SchemaWithMaybeDefaultAsync,
 } from '../getDefault/index.ts';
 import type { DefaultValues } from './types.ts';
 
@@ -43,8 +44,8 @@ export async function getDefaultsAsync<
   let defaults: any;
 
   // If schema contains a default function, set its default value
-  if (schema.getDefault) {
-    defaults = await schema.getDefault();
+  if (schema.default) {
+    defaults = await getDefaultAsync(schema);
 
     // Otherwise, check if schema is of kind object or tuple
   } else if ('type' in schema) {