@next-safe-action/adapter-react-hook-form/dist/index-BvAQR3Jf.d.mts

This adapter offers a way to seamlessly integrate next-safe-action with react-hook-form.

import { FieldErrors } from "react-hook-form";
import { ValidationErrors } from "next-safe-action";

//#region src/index.types.d.ts
/**
 * Props for `mapToHookFormErrors`. Also used by the hooks.
 */
type ErrorMapperProps = {
  joinBy?: string;
};
//#endregion
//#region src/standard-schema.d.ts
/** The Standard Schema interface. */
interface StandardSchemaV1<Input = unknown, Output = Input> {
  /** The Standard Schema properties. */
  readonly "~standard": StandardSchemaV1.Props<Input, Output>;
}
declare namespace StandardSchemaV1 {
  /** The Standard Schema properties interface. */
  interface Props<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) => Result<Output> | Promise<Result<Output>>;
    /** Inferred types associated with the schema. */
    readonly types?: Types<Input, Output> | undefined;
  }
  /** The result interface of the validate function. */
  type Result<Output> = SuccessResult<Output> | FailureResult;
  /** The result interface if validation succeeds. */
  interface SuccessResult<Output> {
    /** The typed output value. */
    readonly value: Output;
    /** The non-existent issues. */
    readonly issues?: undefined;
  }
  /** The result interface if validation fails. */
  interface FailureResult {
    /** The issues of failed validation. */
    readonly issues: ReadonlyArray<Issue>;
  }
  /** The issue interface of the failure output. */
  interface Issue {
    /** The error message of the issue. */
    readonly message: string;
    /** The path of the issue, if any. */
    readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
  }
  /** The path segment interface of the issue. */
  interface PathSegment {
    /** The key representing a path segment. */
    readonly key: PropertyKey;
  }
  /** The Standard Schema types interface. */
  interface Types<Input = unknown, Output = Input> {
    /** The input type of the schema. */
    readonly input: Input;
    /** The output type of the schema. */
    readonly output: Output;
  }
  /** Infers the input type of a Standard Schema. */
  type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema["~standard"]["types"]>["input"];
  /** Infers the output type of a Standard Schema. */
  type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema["~standard"]["types"]>["output"];
}
/** Infer the input type of a Standard Schema, or a default type if the schema is undefined. */
type InferInputOrDefault<MaybeSchema, Default> = MaybeSchema extends StandardSchemaV1 ? StandardSchemaV1.InferInput<MaybeSchema> : Default;
/** Infer the output type of a Standard Schema, or a default type if the schema is undefined. */
type InferOutputOrDefault<MaybeSchema, Default> = MaybeSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<MaybeSchema> : Default;
//#endregion
//#region src/index.d.ts
/**
 * Maps a validation errors object to an object of `FieldErrors` compatible with react-hook-form.
 * You should only call this function directly for advanced use cases, and prefer exported hooks.
 */
declare function mapToHookFormErrors<Schema extends StandardSchemaV1 | undefined>(validationErrors: ValidationErrors<Schema> | undefined, props?: ErrorMapperProps): FieldErrors<InferOutputOrDefault<Schema, any>> | undefined;
//#endregion
export { ErrorMapperProps as a, StandardSchemaV1 as i, InferInputOrDefault as n, InferOutputOrDefault as r, mapToHookFormErrors as t };
//# sourceMappingURL=index-BvAQR3Jf.d.mts.map