@tanstack/form-core 0.40.0 → 0.40.2

package/src/standardSchemaValidator.ts

@@ -3,16 +3,15 @@ import type {
   Validator,
   ValidatorAdapterParams,
 } from './types'
-import type { v1 } from '@standard-schema/spec'
 
-type Params = ValidatorAdapterParams<v1.StandardIssue>
+type Params = ValidatorAdapterParams<StandardSchemaV1Issue>
 type TransformFn = NonNullable<Params['transformErrors']>
 
 function prefixSchemaToErrors(
-  issues: readonly v1.StandardIssue[],
+  issues: readonly StandardSchemaV1Issue[],
   transformErrors: TransformFn,
 ) {
-  const schema = new Map<string, v1.StandardIssue[]>()
+  const schema = new Map<string, StandardSchemaV1Issue[]>()
 
   for (const issue of issues) {
     const path = [...(issue.path ?? [])]
@@ -39,18 +38,18 @@ function prefixSchemaToErrors(
 }
 
 function defaultFormTransformer(transformErrors: TransformFn) {
-  return (issues: readonly v1.StandardIssue[]) => ({
-    form: transformErrors(issues as v1.StandardIssue[]),
+  return (issues: readonly StandardSchemaV1Issue[]) => ({
+    form: transformErrors(issues as StandardSchemaV1Issue[]),
     fields: prefixSchemaToErrors(issues, transformErrors),
   })
 }
 
 export const standardSchemaValidator =
-  (params: Params = {}): Validator<unknown, v1.StandardSchema<any, any>> =>
+  (params: Params = {}): Validator<unknown, StandardSchemaV1<any>> =>
   () => {
     const transformFieldErrors =
       params.transformErrors ??
-      ((issues: v1.StandardIssue[]) =>
+      ((issues: StandardSchemaV1Issue[]) =>
         issues.map((issue) => issue.message).join(', '))
 
     const getTransformStrategy = (validationSource: 'form' | 'field') =>
@@ -70,7 +69,7 @@ export const standardSchemaValidator =
 
         const transformer = getTransformStrategy(validationSource)
 
-        return transformer(result.issues as v1.StandardIssue[])
+        return transformer(result.issues as StandardSchemaV1Issue[])
       },
       async validateAsync({ value, validationSource }, fn) {
         const result = await fn['~standard'].validate(value)
@@ -79,12 +78,111 @@ export const standardSchemaValidator =
 
         const transformer = getTransformStrategy(validationSource)
 
-        return transformer(result.issues as v1.StandardIssue[])
+        return transformer(result.issues as StandardSchemaV1Issue[])
       },
     }
   }
 
 export const isStandardSchemaValidator = (
   validator: unknown,
-): validator is v1.StandardSchema =>
+): validator is StandardSchemaV1 =>
   !!validator && '~standard' in (validator as object)
+
+/**
+ * The Standard Schema interface.
+ */
+export type StandardSchemaV1<Input = unknown, Output = Input> = {
+  /**
+   * The Standard Schema properties.
+   */
+  readonly '~standard': StandardSchemaV1Props<Input, Output>
+}
+
+/**
+ * The Standard Schema properties interface.
+ */
+interface StandardSchemaV1Props<Input = unknown, Output = Input> {
+  /**
+   * The version number of the standard.
+   */
+  readonly version: 1
+  /**
+   * The vendor name of the schema library.
+   */
+  readonly vendor: string
+  /**
+   * Validates unknown input values.
+   */
+  readonly validate: (
+    value: unknown,
+  ) => StandardSchemaV1Result<Output> | Promise<StandardSchemaV1Result<Output>>
+  /**
+   * Inferred types associated with the schema.
+   */
+  readonly types?: StandardSchemaV1Types<Input, Output> | undefined
+}
+/**
+ * The result interface of the validate function.
+ */
+type StandardSchemaV1Result<Output> =
+  | StandardSchemaV1SuccessResult<Output>
+  | StandardSchemaV1FailureResult
+/**
+ * The result interface if validation succeeds.
+ */
+interface StandardSchemaV1SuccessResult<Output> {
+  /**
+   * The typed output value.
+   */
+  readonly value: Output
+  /**
+   * The non-existent issues.
+   */
+  readonly issues?: undefined
+}
+/**
+ * The result interface if validation fails.
+ */
+interface StandardSchemaV1FailureResult {
+  /**
+   * The issues of failed validation.
+   */
+  readonly issues: ReadonlyArray<StandardSchemaV1Issue>
+}
+/**
+ * The issue interface of the failure output.
+ */
+interface StandardSchemaV1Issue {
+  /**
+   * The error message of the issue.
+   */
+  readonly message: string
+  /**
+   * The path of the issue, if any.
+   */
+  readonly path?:
+    | ReadonlyArray<PropertyKey | StandardSchemaV1PathSegment>
+    | undefined
+}
+/**
+ * The path segment interface of the issue.
+ */
+interface StandardSchemaV1PathSegment {
+  /**
+   * The key representing a path segment.
+   */
+  readonly key: PropertyKey
+}
+/**
+ * The Standard Schema types interface.
+ */
+interface StandardSchemaV1Types<Input = unknown, Output = Input> {
+  /**
+   * The input type of the schema.
+   */
+  readonly input: Input
+  /**
+   * The output type of the schema.
+   */
+  readonly output: Output
+}