refactor: set up built-in multi validation system

TheEdoRan · TheEdoRan · commit 10143bb58f25 · 2024-07-16T10:09:04.000+02:00
diff --git a/packages/next-safe-action/package.json b/packages/next-safe-action/package.json
@@ -87,6 +87,11 @@
 		"react-dom": ">= 18.2.0",
 		"zod": ">= 3.0.0"
 	},
+	"peerDependenciesMeta": {
+		"zod": {
+			"optional": true
+		}
+	},
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/TheEdoRan/next-safe-action.git"
diff --git a/packages/next-safe-action/src/action-builder.ts b/packages/next-safe-action/src/action-builder.ts
@@ -13,7 +13,7 @@ import type {
 	StateServerCodeFn,
 } from "./index.types";
 import { ActionMetadataError, DEFAULT_SERVER_ERROR_MESSAGE, isError, zodValidate } from "./utils";
-import type { Infer, InferArray, InferIn, InferInArray, Schema } from "./utils.types";
+import type { Infer, InferArray, InferIn, InferInArray, Schema } from "./validation-adapters";
 import { ActionValidationError, buildValidationErrors } from "./validation-errors";
 import type {
 	BindArgsValidationErrors,
diff --git a/packages/next-safe-action/src/hooks-utils.ts b/packages/next-safe-action/src/hooks-utils.ts
@@ -2,7 +2,7 @@ import * as React from "react";
 import {} from "react/experimental";
 import type {} from "zod";
 import type { HookActionStatus, HookCallbacks, HookResult } from "./hooks.types";
-import type { InferIn, Schema } from "./utils.types";
+import type { InferIn, Schema } from "./validation-adapters";
 
 export const getActionStatus = <
 	ServerError,
diff --git a/packages/next-safe-action/src/hooks.ts b/packages/next-safe-action/src/hooks.ts
@@ -9,7 +9,7 @@ import type {} from "zod";
 import { getActionShorthandStatusObject, getActionStatus, useActionCallbacks } from "./hooks-utils";
 import type { HookCallbacks, HookResult, HookSafeActionFn } from "./hooks.types";
 import { isError } from "./utils";
-import type { InferIn, Schema } from "./utils.types";
+import type { InferIn, Schema } from "./validation-adapters";
 
 // HOOKS
 
diff --git a/packages/next-safe-action/src/hooks.types.ts b/packages/next-safe-action/src/hooks.types.ts
@@ -1,5 +1,6 @@
 import type { SafeActionResult } from "./index.types";
-import type { InferIn, MaybePromise, Prettify, Schema } from "./utils.types";
+import type { MaybePromise, Prettify } from "./utils.types";
+import type { InferIn, Schema } from "./validation-adapters";
 
 /**
  * Type of `result` object returned by `useAction`, `useOptimisticAction` and `useStateAction` hooks.
diff --git a/packages/next-safe-action/src/index.ts b/packages/next-safe-action/src/index.ts
@@ -1,7 +1,7 @@
 import type { DVES, SafeActionClientOpts } from "./index.types";
 import { SafeActionClient } from "./safe-action-client";
 import { DEFAULT_SERVER_ERROR_MESSAGE } from "./utils";
-import type { Infer, Schema } from "./utils.types";
+import type { Infer, Schema } from "./validation-adapters";
 import {
 	flattenBindArgsValidationErrors,
 	flattenValidationErrors,
diff --git a/packages/next-safe-action/src/index.types.ts b/packages/next-safe-action/src/index.types.ts
@@ -1,4 +1,5 @@
-import type { Infer, InferArray, InferIn, InferInArray, MaybePromise, Prettify, Schema } from "./utils.types";
+import type { MaybePromise, Prettify } from "./utils.types";
+import type { Infer, InferArray, InferIn, InferInArray, Schema } from "./validation-adapters";
 import type { BindArgsValidationErrors, ValidationErrors } from "./validation-errors.types";
 
 /**
diff --git a/packages/next-safe-action/src/safe-action-client.ts b/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 "./utils.types";
+import type { Infer, Schema } from "./validation-adapters";
 import type {
 	BindArgsValidationErrors,
 	FlattenedBindArgsValidationErrors,
diff --git a/packages/next-safe-action/src/stateful-hooks.ts b/packages/next-safe-action/src/stateful-hooks.ts
@@ -6,7 +6,7 @@ import {} from "react/experimental";
 import type {} from "zod";
 import { getActionShorthandStatusObject, getActionStatus, useActionCallbacks } from "./hooks-utils";
 import type { HookCallbacks, HookSafeStateActionFn } from "./hooks.types";
-import type { InferIn, Schema } from "./utils.types";
+import type { InferIn, Schema } from "./validation-adapters";
 /**
  * Use the stateful action from a Client Component via hook. Used for actions defined with [`stateAction`](https://next-safe-action.dev/docs/safe-action-client/instance-methods#action--stateaction).
  * @param safeActionFn The action function
diff --git a/packages/next-safe-action/src/utils.ts b/packages/next-safe-action/src/utils.ts
@@ -1,4 +1,4 @@
-import type { Infer, Schema } from "./utils.types";
+import type { Infer, Schema } from "./validation-adapters";
 
 export const DEFAULT_SERVER_ERROR_MESSAGE = "Something went wrong while executing the operation.";
 
diff --git a/packages/next-safe-action/src/utils.types.ts b/packages/next-safe-action/src/utils.types.ts
@@ -1,28 +1,7 @@
-import type { z } from "zod";
-
 // Takes an object type and makes it more readable.
 export type Prettify<T> = {
 	[K in keyof T]: T[K];
 } & {};
 
 // Returns type or promise of type.
 export type MaybePromise<T> = Promise<T> | T;
-
-// Schema type.
-export type Schema = z.ZodType;
-
-// Infers output schema type.
-export type Infer<S extends Schema> = z.infer<S>;
-
-// Infers input schema type.
-export type InferIn<S extends Schema> = z.input<S>;
-
-// Infers output schema type in array of schemas.
-export type InferArray<BAS extends readonly Schema[]> = {
-	[K in keyof BAS]: Infer<BAS[K]>;
-};
-
-// Infers input schema type in array of schemas.
-export type InferInArray<BAS extends readonly Schema[]> = {
-	[K in keyof BAS]: InferIn<BAS[K]>;
-};
diff --git a/packages/next-safe-action/src/validation-adapters/index.ts b/packages/next-safe-action/src/validation-adapters/index.ts
@@ -0,0 +1,3 @@
+export { zodAdapter } from "./libs/zod";
+
+export * from "./types";
diff --git a/packages/next-safe-action/src/validation-adapters/libs/zod.ts b/packages/next-safe-action/src/validation-adapters/libs/zod.ts
@@ -0,0 +1,24 @@
+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) {
+		const result = await schema.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;
+	}
+}
+
+export function zodAdapter() {
+	return new ZodAdapter<z.ZodType>();
+}
diff --git a/packages/next-safe-action/src/validation-adapters/types.ts b/packages/next-safe-action/src/validation-adapters/types.ts
@@ -0,0 +1,23 @@
+import type { z } from "zod";
+
+export type Schema = z.ZodType;
+export type Infer<S extends Schema> = S extends z.ZodType ? z.infer<S> : never;
+export type InferIn<S extends Schema> = S extends z.ZodType ? z.input<S> : never;
+export type InferArray<BAS extends readonly Schema[]> = {
+	[K in keyof BAS]: Infer<BAS[K]>;
+};
+export type InferInArray<BAS extends readonly Schema[]> = {
+	[K in keyof BAS]: InferIn<BAS[K]>;
+};
+
+export type ValidationIssue = {
+	message: string;
+	path?: Array<string | number | symbol>;
+};
+
+export interface ValidationAdapter<S extends Schema> {
+	validate(
+		schema: S,
+		data: unknown
+	): Promise<{ success: true; data: Infer<S> } | { success: false; issues: ValidationIssue[] }>;
+}
diff --git a/packages/next-safe-action/src/validation-errors.ts b/packages/next-safe-action/src/validation-errors.ts
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment */
 
-import type { Schema } from "./utils.types";
+import type { Schema } from "./validation-adapters";
 import type {
 	FlattenedBindArgsValidationErrors,
 	FlattenedValidationErrors,
diff --git a/packages/next-safe-action/src/validation-errors.types.ts b/packages/next-safe-action/src/validation-errors.types.ts
@@ -1,4 +1,5 @@
-import type { Infer, Prettify, Schema } from "./utils.types";
+import type { Prettify } from "./utils.types";
+import type { Infer, Schema } from "./validation-adapters";
 
 export type ValidationIssue = {
 	message: string;

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { Infer, Schema } from "./utils.types";`
	`1`	`+import type { Infer, Schema } from "./validation-adapters";`
`2`	`2`
`3`	`3`	`export const DEFAULT_SERVER_ERROR_MESSAGE = "Something went wrong while executing the operation.";`
`4`	`4`