feat: use modular built-in multi validation system

Author: TheEdoRan

packages/next-safe-action/src/action-builder.ts

@@ -12,8 +12,8 @@ import type {
 	ServerCodeFn,
 	StateServerCodeFn,
 } from "./index.types";
-import { ActionMetadataError, DEFAULT_SERVER_ERROR_MESSAGE, isError, zodValidate } from "./utils";
-import type { Infer, InferArray, InferIn, InferInArray, Schema } from "./validation-adapters";
+import { ActionMetadataError, DEFAULT_SERVER_ERROR_MESSAGE, isError } from "./utils";
+import type { Infer, InferArray, InferIn, InferInArray, Schema, ValidationAdapter } from "./validation-adapters";
 import { ActionValidationError, buildValidationErrors } from "./validation-errors";
 import type {
 	BindArgsValidationErrors,
@@ -35,6 +35,7 @@ export function actionBuilder<
 >(args: {
 	schemaFn?: SF;
 	bindArgsSchemas?: BAS;
+	validationAdapter: ValidationAdapter;
 	handleValidationErrorsShape: HandleValidationErrorsShapeFn<S, CVE>;
 	handleBindArgsValidationErrorsShape: HandleBindArgsValidationErrorsShapeFn<BAS, CBAVE>;
 	metadataSchema: MetadataSchema;
@@ -104,7 +105,7 @@ export function actionBuilder<
 							if (idx === 0) {
 								if (args.metadataSchema) {
 									// Validate metadata input.
-									if (!(await zodValidate(args.metadataSchema, args.metadata)).success) {
+									if (!(await args.validationAdapter.validate(args.metadataSchema, args.metadata)).success) {
 										throw new ActionMetadataError(
 											"Invalid metadata input. Please be sure to pass metadata via `metadata` method before defining the action."
 										);
@@ -141,11 +142,11 @@ export function actionBuilder<
 											}
 
 											// Otherwise, parse input with the schema.
-											return zodValidate(await args.schemaFn(), input);
+											return args.validationAdapter.validate(await args.schemaFn(), input);
 										}
 
 										// Otherwise, we're processing bind args client inputs.
-										return zodValidate(bindArgsSchemas[i]!, input);
+										return args.validationAdapter.validate(bindArgsSchemas[i]!, input);
 									})
 								);
 

packages/next-safe-action/src/index.ts

@@ -53,12 +53,18 @@ export const createSafeActionClient = <
 			SafeActionClientOpts<ServerError, MetadataSchema, ODVES>["handleReturnedServerError"]
 		>);
 
+	// FIXME: require validation adapter
+	if (!createOpts?.validationAdapter) {
+		throw new Error("Validation adapter is required");
+	}
+
 	return new SafeActionClient({
 		middlewareFns: [async ({ next }) => next({ ctx: undefined })],
 		handleServerErrorLog,
 		handleReturnedServerError,
 		schemaFn: undefined,
 		bindArgsSchemas: [],
+		validationAdapter: createOpts.validationAdapter(),
 		ctxType: undefined,
 		metadataSchema: (createOpts?.defineMetadataSchema?.() ?? undefined) as MetadataSchema,
 		metadata: undefined as MetadataSchema extends Schema ? Infer<MetadataSchema> : undefined,

packages/next-safe-action/src/index.types.ts

@@ -1,5 +1,5 @@
 import type { MaybePromise, Prettify } from "./utils.types";
-import type { Infer, InferArray, InferIn, InferInArray, Schema } from "./validation-adapters";
+import type { Infer, InferArray, InferIn, InferInArray, Schema, ValidationAdapter } from "./validation-adapters";
 import type { BindArgsValidationErrors, ValidationErrors } from "./validation-errors.types";
 
 /**
@@ -26,6 +26,7 @@ export type SafeActionClientOpts<
 	MetadataSchema extends Schema | undefined,
 	ODVES extends DVES | undefined,
 > = {
+	validationAdapter: () => ValidationAdapter;
 	defineMetadataSchema?: () => MetadataSchema;
 	handleReturnedServerError?: (
 		error: Error,

packages/next-safe-action/src/safe-action-client.ts

@@ -8,7 +8,7 @@ import type {
 	ServerCodeFn,
 	StateServerCodeFn,
 } from "./index.types";
-import type { Infer, Schema } from "./validation-adapters";
+import type { Infer, Schema, ValidationAdapter } from "./validation-adapters";
 import type {
 	BindArgsValidationErrors,
 	FlattenedBindArgsValidationErrors,
@@ -42,6 +42,7 @@ export class SafeActionClient<
 	readonly #metadata: MD;
 	readonly #schemaFn: SF;
 	readonly #bindArgsSchemas: BAS;
+	readonly #validationAdapter: ValidationAdapter;
 	readonly #handleValidationErrorsShape: HandleValidationErrorsShapeFn<S, CVE>;
 	readonly #handleBindArgsValidationErrorsShape: HandleBindArgsValidationErrorsShapeFn<BAS, CBAVE>;
 	readonly #defaultValidationErrorsShape: ODVES;
@@ -54,6 +55,7 @@ export class SafeActionClient<
 			metadata: MD;
 			schemaFn: SF;
 			bindArgsSchemas: BAS;
+			validationAdapter: ValidationAdapter;
 			handleValidationErrorsShape: HandleValidationErrorsShapeFn<S, CVE>;
 			handleBindArgsValidationErrorsShape: HandleBindArgsValidationErrorsShapeFn<BAS, CBAVE>;
 			ctxType: Ctx;
@@ -71,6 +73,7 @@ export class SafeActionClient<
 		this.#metadata = opts.metadata;
 		this.#schemaFn = (opts.schemaFn ?? undefined) as SF;
 		this.#bindArgsSchemas = opts.bindArgsSchemas ?? [];
+		this.#validationAdapter = opts.validationAdapter;
 		this.#handleValidationErrorsShape = opts.handleValidationErrorsShape;
 		this.#handleBindArgsValidationErrorsShape = opts.handleBindArgsValidationErrorsShape;
 		this.#defaultValidationErrorsShape = opts.defaultValidationErrorsShape;
@@ -92,6 +95,7 @@ export class SafeActionClient<
 			metadata: this.#metadata,
 			schemaFn: this.#schemaFn,
 			bindArgsSchemas: this.#bindArgsSchemas,
+			validationAdapter: this.#validationAdapter,
 			handleValidationErrorsShape: this.#handleValidationErrorsShape,
 			handleBindArgsValidationErrorsShape: this.#handleBindArgsValidationErrorsShape,
 			ctxType: undefined as NextCtx,
@@ -115,6 +119,7 @@ export class SafeActionClient<
 			metadata: data,
 			schemaFn: this.#schemaFn,
 			bindArgsSchemas: this.#bindArgsSchemas,
+			validationAdapter: this.#validationAdapter,
 			handleValidationErrorsShape: this.#handleValidationErrorsShape,
 			handleBindArgsValidationErrorsShape: this.#handleBindArgsValidationErrorsShape,
 			ctxType: undefined as Ctx,
@@ -155,6 +160,7 @@ export class SafeActionClient<
 					}
 				: async () => schema) as SF,
 			bindArgsSchemas: this.#bindArgsSchemas,
+			validationAdapter: this.#validationAdapter,
 			handleValidationErrorsShape: (utils?.handleValidationErrorsShape ??
 				this.#handleValidationErrorsShape) as HandleValidationErrorsShapeFn<AS, OCVE>,
 			handleBindArgsValidationErrorsShape: this.#handleBindArgsValidationErrorsShape,
@@ -188,6 +194,7 @@ export class SafeActionClient<
 			metadata: this.#metadata,
 			schemaFn: this.#schemaFn,
 			bindArgsSchemas,
+			validationAdapter: this.#validationAdapter,
 			handleValidationErrorsShape: this.#handleValidationErrorsShape,
 			handleBindArgsValidationErrorsShape: (utils?.handleBindArgsValidationErrorsShape ??
 				this.#handleBindArgsValidationErrorsShape) as HandleBindArgsValidationErrorsShapeFn<OBAS, OCBAVE>,
@@ -217,6 +224,7 @@ export class SafeActionClient<
 			metadata: this.#metadata,
 			schemaFn: this.#schemaFn,
 			bindArgsSchemas: this.#bindArgsSchemas,
+			validationAdapter: this.#validationAdapter,
 			handleValidationErrorsShape: this.#handleValidationErrorsShape,
 			handleBindArgsValidationErrorsShape: this.#handleBindArgsValidationErrorsShape,
 			throwValidationErrors: this.#throwValidationErrors,
@@ -244,6 +252,7 @@ export class SafeActionClient<
 			metadata: this.#metadata,
 			schemaFn: this.#schemaFn,
 			bindArgsSchemas: this.#bindArgsSchemas,
+			validationAdapter: this.#validationAdapter,
 			handleValidationErrorsShape: this.#handleValidationErrorsShape,
 			handleBindArgsValidationErrorsShape: this.#handleBindArgsValidationErrorsShape,
 			throwValidationErrors: this.#throwValidationErrors,

packages/next-safe-action/src/utils.ts

@@ -1,26 +1,7 @@
-import type { Infer, Schema } from "./validation-adapters";
-
 export const DEFAULT_SERVER_ERROR_MESSAGE = "Something went wrong while executing the operation.";
 
 export const isError = (error: unknown): error is Error => error instanceof Error;
 
-// Validate with Zod.
-export async function zodValidate<S extends Schema>(s: S, data: unknown) {
-	const result = await s.safeParseAsync(data);
-
-	if (result.success) {
-		return {
-			success: true,
-			data: result.data as Infer<S>,
-		} as const;
-	}
-
-	return {
-		success: false,
-		issues: result.error.issues.map(({ message, path }) => ({ message, path })),
-	} as const;
-}
-
 /**
  * This error is thrown when an action's metadata input is invalid, i.e. when there's a mismatch between the
  * type of the metadata schema returned from `defineMetadataSchema` and the actual input.

packages/next-safe-action/src/validation-adapters/libs/zod.ts

@@ -1,8 +1,8 @@
 import type { z } from "zod";
 import type { Infer, ValidationAdapter } from "../types";
 
-class ZodAdapter<S extends z.ZodType> implements ValidationAdapter<S> {
-	async validate(schema: S, data: unknown) {
+class ZodAdapter implements ValidationAdapter {
+	async validate<S extends z.ZodType>(schema: S, data: unknown) {
 		const result = await schema.safeParseAsync(data);
 
 		if (result.success) {
@@ -20,5 +20,5 @@ class ZodAdapter<S extends z.ZodType> implements ValidationAdapter<S> {
 }
 
 export function zodAdapter() {
-	return new ZodAdapter<z.ZodType>();
+	return new ZodAdapter();
 }

packages/next-safe-action/src/validation-adapters/types.ts

@@ -15,8 +15,8 @@ export type ValidationIssue = {
 	path?: Array<string | number | symbol>;
 };
 
-export interface ValidationAdapter<S extends Schema> {
-	validate(
+export interface ValidationAdapter {
+	validate<S extends Schema>(
 		schema: S,
 		data: unknown
 	): Promise<{ success: true; data: Infer<S> } | { success: false; issues: ValidationIssue[] }>;