feat: built-in support for multiple validation libraries (#202)

Make use of built-in modular support for multiple validation libraries, instead of TypeSchema.
TheEdoRan · Jul 20, 2024 · baff76b · baff76b
1 parent e00829a
commit baff76b
Show file tree

Hide file tree

Showing 54 changed files with 612 additions and 2,817 deletions.
diff --git a/apps/playground/package.json b/apps/playground/package.json
@@ -21,14 +21,14 @@
 		"zod-form-data": "^2.0.2"
 	},
 	"devDependencies": {
-		"@types/node": "^20.12.10",
+		"@types/node": "^20.14.11",
 		"@types/react": "^18.3.1",
 		"@types/react-dom": "18.3.0",
 		"autoprefixer": "10.4.19",
 		"eslint": "^8.57.0",
 		"eslint-config-next": "15.0.0-canary.25",
 		"postcss": "8.4.38",
 		"tailwindcss": "3.4.3",
-		"typescript": "^5.4.5"
+		"typescript": "^5.5.3"
 	}
 }
diff --git a/apps/playground/src/lib/safe-action.ts b/apps/playground/src/lib/safe-action.ts
@@ -2,11 +2,13 @@ import {
 	DEFAULT_SERVER_ERROR_MESSAGE,
 	createSafeActionClient,
 } from "next-safe-action";
+import { zodAdapter } from "next-safe-action/adapters/zod";
 import { z } from "zod";
 
 export class ActionError extends Error {}
 
 export const action = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	// You can provide a custom logging function, otherwise the lib will use `console.error`
 	// as the default logging system. If you want to disable server errors logging,
 	// just pass an empty Promise.

diff --git a/packages/next-safe-action/package.json b/packages/next-safe-action/package.json
@@ -11,23 +11,23 @@
 	],
 	"exports": {
 		".": "./dist/index.mjs",
-		"./typeschema": "./dist/typeschema.mjs",
 		"./hooks": "./dist/hooks.mjs",
-		"./stateful-hooks": "./dist/stateful-hooks.mjs"
+		"./stateful-hooks": "./dist/stateful-hooks.mjs",
+		"./adapters/*": "./dist/adapters/*.mjs"
 	},
 	"typesVersions": {
 		"*": {
 			".": [
 				"./dist/index.d.mts"
 			],
-			"typeschema": [
-				"./dist/typeschema.d.mts"
-			],
 			"hooks": [
 				"./dist/hooks.d.mts"
 			],
 			"stateful-hooks": [
 				"./dist/stateful-hooks.d.mts"
+			],
+			"adapters/*": [
+				"./dist/adapters/*.d.mts"
 			]
 		}
 	},
@@ -43,7 +43,7 @@
 	],
 	"scripts": {
 		"lint": "tsc && prettier --write . && eslint .",
-		"test": "node --import tsx --test ./src/__tests__/*.test.ts ./src/__tests__/typeschema/*.test.ts",
+		"test": "node --import tsx --test ./src/__tests__/*.test.ts",
 		"build": "tsup",
 		"deploy": "semantic-release"
 	},
@@ -67,10 +67,9 @@
 	},
 	"devDependencies": {
 		"@eslint/js": "^9.2.0",
-		"@types/node": "^20.12.10",
+		"@types/node": "^20.14.11",
 		"@types/react": "^18.3.1",
 		"@types/react-dom": "18.3.0",
-		"@typeschema/core": "^0.13.2",
 		"eslint": "^8.57.0",
 		"eslint-config-prettier": "^9.1.0",
 		"eslint-define-config": "^2.1.0",
@@ -82,26 +81,30 @@
 		"semantic-release": "^23.0.8",
 		"tsup": "^8.0.2",
 		"tsx": "^4.11.2",
-		"typescript": "^5.4.5",
-		"typescript-eslint": "^7.8.0"
+		"typescript": "^5.5.3",
+		"typescript-eslint": "^7.8.0",
+		"valibot": "^0.36.0",
+		"yup": "^1.4.0",
+		"zod": "^3.23.6"
 	},
 	"peerDependencies": {
 		"next": ">= 14.0.0",
 		"react": ">= 18.2.0",
 		"react-dom": ">= 18.2.0",
-		"zod": ">= 3.0.0"
+		"valibot": ">= 0.36.0",
+		"zod": ">= 3.0.0",
+		"yup": ">= 1.0.0"
 	},
 	"peerDependenciesMeta": {
 		"zod": {
 			"optional": true
+		},
+		"valibot": {
+			"optional": true
 		}
 	},
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/TheEdoRan/next-safe-action.git"
-	},
-	"dependencies": {
-		"@typeschema/main": "^0.13.10",
-		"@typeschema/zod": "^0.13.3"
 	}
 }
diff --git a/packages/next-safe-action/src/__tests__/action-callbacks.test.ts b/packages/next-safe-action/src/__tests__/action-callbacks.test.ts
@@ -4,8 +4,10 @@ import assert from "node:assert";
 import { test } from "node:test";
 import { z } from "zod";
 import { DEFAULT_SERVER_ERROR_MESSAGE, createSafeActionClient, returnValidationErrors } from "..";
+import { zodAdapter } from "../adapters/zod";
 
 const ac = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	defineMetadataSchema() {
 		return z.object({
 			actionName: z.string(),

diff --git a/packages/next-safe-action/src/__tests__/bind-args-validation-errors.test.ts b/packages/next-safe-action/src/__tests__/bind-args-validation-errors.test.ts
@@ -4,10 +4,13 @@ import assert from "node:assert";
 import { test } from "node:test";
 import { z } from "zod";
 import { createSafeActionClient, flattenBindArgsValidationErrors, formatBindArgsValidationErrors } from "..";
+import { zodAdapter } from "../adapters/zod";
 
 // Default client tests.
 
-const dac = createSafeActionClient();
+const dac = createSafeActionClient({
+	validationAdapter: zodAdapter(),
+});
 
 test("action with invalid bind args input gives back an object with correct `bindArgsValidationErrors` (default formatted shape)", async () => {
 	const bindArgsSchemas: [age: z.ZodNumber, userId: z.ZodString, product: z.ZodObject<{ id: z.ZodString }>] = [
@@ -87,6 +90,7 @@ test("action with invalid bind args input gives back an object with correct `bin
 // Formatted shape tests (same as default).
 
 const foac = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	defaultValidationErrorsShape: "formatted",
 });
 
@@ -168,6 +172,7 @@ test("action with invalid bind args input gives back an object with correct `bin
 // Flattened shape tests.
 
 const flac = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	defaultValidationErrorsShape: "flattened",
 });
 

diff --git a/packages/next-safe-action/src/__tests__/combined-validation-errors.test.ts b/packages/next-safe-action/src/__tests__/combined-validation-errors.test.ts
@@ -10,10 +10,13 @@ import {
 	formatBindArgsValidationErrors,
 	formatValidationErrors,
 } from "..";
+import { zodAdapter } from "../adapters/zod";
 
 // Default client tests.
 
-const dac = createSafeActionClient();
+const dac = createSafeActionClient({
+	validationAdapter: zodAdapter(),
+});
 
 test("action with invalid bind args input and valid main input gives back an object with correct `bindArgsValidationErrors` (default formatted shape)", async () => {
 	const schema = z.object({
@@ -110,6 +113,7 @@ test("action with invalid bind args input and invalid main input gives back an o
 // Formatted shape tests (same as default).
 
 const foac = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	defaultValidationErrorsShape: "formatted",
 });
 
@@ -209,6 +213,7 @@ test("action with invalid bind args input and valid main input gives back an obj
 // Flattened shape tests.
 
 const flac = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	defaultValidationErrorsShape: "flattened",
 });
 

diff --git a/packages/next-safe-action/src/__tests__/happy-path.test.ts b/packages/next-safe-action/src/__tests__/happy-path.test.ts
@@ -4,8 +4,11 @@ import assert from "node:assert";
 import { test } from "node:test";
 import { z } from "zod";
 import { createSafeActionClient } from "..";
+import { zodAdapter } from "../adapters/zod";
 
-const ac = createSafeActionClient();
+const ac = createSafeActionClient({
+	validationAdapter: zodAdapter(),
+});
 
 test("action with no input schema returns empty object", async () => {
 	const action = ac.action(async () => {

diff --git a/packages/next-safe-action/src/__tests__/metadata.test.ts b/packages/next-safe-action/src/__tests__/metadata.test.ts
@@ -4,8 +4,10 @@ import assert from "node:assert";
 import { test } from "node:test";
 import { z } from "zod";
 import { DEFAULT_SERVER_ERROR_MESSAGE, createSafeActionClient } from "..";
+import { zodAdapter } from "../adapters/zod";
 
 const ac = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	handleServerErrorLog() {}, // disable server errors logging for these tests
 	defineMetadataSchema() {
 		return z.object({

diff --git a/packages/next-safe-action/src/__tests__/middleware.test.ts b/packages/next-safe-action/src/__tests__/middleware.test.ts
@@ -9,8 +9,10 @@ import {
 	formatValidationErrors,
 	returnValidationErrors,
 } from "..";
+import { zodAdapter } from "../adapters/zod";
 
 const ac = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	handleServerErrorLog() {}, // disable server errors logging for these tests
 	handleReturnedServerError(e) {
 		return {
@@ -292,6 +294,7 @@ test("server validation errors in execution result from middleware are correct",
 // Flattened validation errors shape.
 
 const flac = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	handleServerErrorLog() {}, // disable server errors logging for these tests
 	defaultValidationErrorsShape: "flattened",
 });

diff --git a/packages/next-safe-action/src/__tests__/server-error.test.ts b/packages/next-safe-action/src/__tests__/server-error.test.ts
@@ -3,6 +3,7 @@
 import assert from "node:assert";
 import { test } from "node:test";
 import { DEFAULT_SERVER_ERROR_MESSAGE, createSafeActionClient } from "..";
+import { zodAdapter } from "../adapters/zod";
 
 class ActionError extends Error {
 	constructor(message: string) {
@@ -11,6 +12,7 @@ class ActionError extends Error {
 }
 
 const ac1 = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	handleServerErrorLog: () => {}, // disable server errors logging for these tests
 	handleReturnedServerError(e) {
 		if (e instanceof ActionError) {
@@ -93,6 +95,7 @@ test("known error occurred in middleware function is unmasked", async () => {
 
 // Server error is an object with a 'message' property.
 const ac2 = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	handleServerErrorLog: () => {}, // disable server errors logging for these tests
 	handleReturnedServerError(e) {
 		return {
@@ -138,6 +141,7 @@ test("error occurred in middleware function has the correct shape defined by `ha
 
 // Rethrow all server errors.
 const ac3 = createSafeActionClient({
+	validationAdapter: zodAdapter(),
 	handleServerErrorLog: () => {}, // disable server errors logging for these tests
 	handleReturnedServerError(e) {
 		throw e;