refactor: use Zod as the default validation library (#144)

TypeSchema supports multiple validation libraries, but it can cause some issues with Vercel deployments and edge runtime. This commit moves the support for multiple validation libraries to `/typeschema` path, and root path now requires Zod as validation library.

re #105, #140

Author: TheEdoRan

README.md

@@ -3,7 +3,7 @@
   <a href="https://github.com/TheEdoRan/next-safe-action"><h1>next-safe-action</h1></a>
 </div>
 
-**next-safe-action** is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features, using validation libraries of your choice, to let you define **type safe** Server Actions and execute them inside React Components.
+**next-safe-action** is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features to let you define **type safe** Server Actions and execute them inside React Components.
 
 ## How does it work?
 

apps/playground/package.json

@@ -11,7 +11,6 @@
 	"author": "Edoardo Ranghieri",
 	"dependencies": {
 		"@hookform/resolvers": "^3.3.4",
-		"@typeschema/zod": "^0.13.3",
 		"lucide-react": "^0.378.0",
 		"next": "14.3.0-canary.42",
 		"next-safe-action": "workspace:*",

packages/next-safe-action/README.md

@@ -3,7 +3,7 @@
   <a href="https://github.com/TheEdoRan/next-safe-action"><h1>next-safe-action</h1></a>
 </div>
 
-**next-safe-action** is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features, using validation libraries of your choice, to let you define **type safe** Server Actions and execute them inside React Components.
+**next-safe-action** is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features to let you define **type safe** Server Actions and execute them inside React Components.
 
 ## How does it work?
 

packages/next-safe-action/package.json

@@ -11,16 +11,16 @@
 	],
 	"exports": {
 		".": "./dist/index.mjs",
-		"./zod": "./dist/zod.mjs",
+		"./typeschema": "./dist/typeschema.mjs",
 		"./hooks": "./dist/hooks.mjs"
 	},
 	"typesVersions": {
 		"*": {
 			".": [
 				"./dist/index.d.mts"
 			],
-			"zod": [
-				"./dist/zod.d.mts"
+			"typeschema": [
+				"./dist/typeschema.d.mts"
 			],
 			"hooks": [
 				"./dist/hooks.d.mts"
@@ -80,22 +80,19 @@
 	"peerDependencies": {
 		"next": ">= 14.3.0-canary.42",
 		"react": ">= 18.3.1",
-		"@typeschema/zod": "^0.13.3",
 		"zod": "^3.23.6"
 	},
 	"peerDependenciesMeta": {
 		"zod": {
 			"optional": true
-		},
-		"@typeschema/zod": {
-			"optional": true
 		}
 	},
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/TheEdoRan/next-safe-action.git"
 	},
 	"dependencies": {
+		"@typeschema/zod": "^0.13.3",
 		"@typeschema/main": "^0.13.9"
 	}
 }

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

@@ -1,5 +1,4 @@
 import { validate, type Infer, type Schema } from "@typeschema/main";
-import { validate as zodValidate } from "@typeschema/zod";
 import { isNotFoundError } from "next/dist/client/components/not-found.js";
 import { isRedirectError } from "next/dist/client/components/redirect.js";
 import type {} from "zod";
@@ -23,6 +22,22 @@ import type {
 	ValidationErrors,
 } from "./validation-errors.types";
 
+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;
+}
+
 export function actionBuilder<
 	ServerError,
 	S extends Schema | undefined = undefined,

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

@@ -11,6 +11,8 @@ export type * from "./validation-errors.types";
 
 /**
  * Create a new safe action client.
+ * Note: this client only works with Zod as the validation library.
+ * If you want to use a validation library supported by [TypeSchema](https://typeschema.com), import this client from `/typeschema` path.
  * @param createOpts Optional initialization options
  *
  * {@link https://next-safe-action.dev/docs/safe-action-client/initialization-options See docs for more information}
@@ -42,6 +44,6 @@ export const createSafeActionClient = <ServerError = string, MetadataSchema exte
 		middlewareFns: [async ({ next }) => next({ ctx: undefined })],
 		handleServerErrorLog,
 		handleReturnedServerError,
-		validationStrategy: "typeschema",
+		validationStrategy: "zod",
 	});
 };

packages/next-safe-action/src/zod.ts packages/next-safe-action/src/typeschema.ts

@@ -11,9 +11,8 @@ export type * from "./validation-errors.types";
 
 /**
  * Create a new safe action client.
- * Note: this client only works with Zod as the validation library.
- * This is needed when TypeSchema causes problems in your application.
- * Check out the [troubleshooting](https://next-safe-action.dev/docs/troubleshooting/errors-with-typeschema) page of the docs for more information.
+ * This client supports multiple validation libraries via [TypeSchema](https://typeschema.com). If you experience
+ * issues when using this, switch to the main client exported from `next-safe-action`, which just supports Zod.
  * @param createOpts Optional initialization options
  *
  * {@link https://next-safe-action.dev/docs/safe-action-client/initialization-options See docs for more information}
@@ -45,6 +44,6 @@ export const createSafeActionClient = <ServerError = string, MetadataSchema exte
 		middlewareFns: [async ({ next }) => next({ ctx: undefined })],
 		handleServerErrorLog,
 		handleReturnedServerError,
-		validationStrategy: "zod",
+		validationStrategy: "typeschema",
 	});
 };

packages/next-safe-action/tsup.config.ts

@@ -1,7 +1,7 @@
 import { defineConfig } from "tsup";
 
 export default defineConfig({
-	entry: ["src/index.ts", "src/zod.ts", "src/hooks.ts"],
+	entry: ["src/index.ts", "src/typeschema.ts", "src/hooks.ts"],
 	format: ["esm"],
 	clean: true,
 	splitting: false,

pnpm-lock.yaml

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 10
+sidebar_position: 9
 description: Learn how to contribute to next-safe-action via GitHub.
 ---
 

website/docs/contributing.md

@@ -9,28 +9,35 @@ description: Getting started with next-safe-action version 7.
 
 - Next.js >= 14.3.0-canary.40
 - TypeScript >= 5.0.0
-- a validation library supported by [TypeSchema](https://typeschema.com/#coverage)
+- Zod or a validation library supported by [TypeSchema](https://typeschema.com/#coverage)
 :::
 
 **next-safe-action** provides a typesafe Server Actions implementation for Next.js App Router.
 
-## Validation libraries support
-
-We will use Zod as our validation library in this documentation, but since version 6 of next-safe-action, you can use your validation library of choice, or even multiple and custom ones at the same time, thanks to the **TypeSchema** library. Note that we also need to install the related TypeSchema adapter for our validation library of choice. You can find supported libraries and related adapters [here](https://typeschema.com/#coverage).
-
-:::info
-If you experience an issue related to TypeSchema, check out the ["Errors with TypeSchema"](/docs/troubleshooting/errors-with-typeschema) section of the troubleshooting page to see how to fix it.
-:::
-
 ## Installation
 
 For Next.js >= 14, assuming you want to use Zod as your validation library, use the following command:
 
 ```bash npm2yarn
-npm i next-safe-action@next zod @typeschema/zod
+npm i next-safe-action@next zod
+```
+
+:::note
+Zod is the default validation library for next-safe-action, because TypeSchema can cause some issues with deployments, so this documentation uses it for that reason. If you know what you're doing, though, you can use your validation library of choice, or even multiple ones at the same time, thanks to the **TypeSchema** package.
+
+To use this feature, you just need to update the import path for the safe client initialization function from:
+```typescript
+import { createSafeActionClient } from "next-safe-action";
+```
+
+to:
+
+```typescript
+import { createSafeActionClient } from "next-safe-action/typeschema";
 ```
 
-Find the adapter for your validation library of choice in the [TypeSchema documentation](https://typeschema.com/#coverage).
+and install the related [TypeSchema adapter](https://typeschema.com/#coverage).
+:::
 
 ## Usage
 

website/docs/getting-started.md

@@ -1,11 +1,11 @@
 ---
 sidebar_position: 1
-description: next-safe-action is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features, using validation libraries of your choice, to let you define type safe Server Actions and execute them inside React Components.
+description: next-safe-action is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features to let you define type safe Server Actions and execute them inside React Components.
 ---
 
 # Introduction
 
-**next-safe-action** is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features, using validation libraries of your choice, to let you define **type safe** Server Actions and execute them inside React Components.
+**next-safe-action** is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features to let you define **type safe** Server Actions and execute them inside React Components.
 
 ## How does it work?
 

website/docs/introduction.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 9
+sidebar_position: 8
 description: Learn how to migrate from a version to the next one.
 ---
 

website/docs/migrations/index.md

@@ -14,8 +14,6 @@ Well, pretty much everything. Version 7 now works using methods; you might be fa
 
 _But please still read this migration guide carefully before upgrading to v7._
 
-First, install the [TypeSchema adapter](https://typeschema.com/#coverage) for the validation library of your choice to use next-safe-action v7.
-
 Assuming you're using Zod, in previous versions, you'd define an auth action client and then an action like this:
 
 ```typescript title="action-client-v6.ts"
@@ -185,7 +183,7 @@ In version 6, you could pass metadata to actions via the third argument of the s
 
 ### TypeSchema update
 
-TypeSchema was updated to v0.13, so now you need to install the [TypeSchema adapter](https://typeschema.com/#coverage) for the validation library of your choice to use next-safe-action.
+TypeSchema was updated to v0.13, so now, if you want to use a validation library other than Zod, you also need to install the related [TypeSchema adapter](https://typeschema.com/#coverage).
 
 ## Requirements
 

website/docs/migrations/v6-to-v7.md

@@ -24,8 +24,7 @@ const features: { title: string; description: string }[] = [
 	},
 	{
 		title: "Input validation using multiple validation libraries",
-		description:
-			"Input passed from the client to the server is validated using libraries of your choice.",
+		description: `Input passed from the client to the server is validated using Zod or other validation libraries supported by <a href="https://typeschema.com" target="_blank" rel="noopener noreferrer">TypeSchema</a>.`,
 	},
 	{
 		title: "Advanced server error handling",