[BREAKING CHANGE] Switch to context based client

[TheEdoRan]

The current way to instantiate a new client, that supports authenticated actions is:

import { createSafeActionClient } from "next-safe-action";

export const action = createSafeActionClient({
  getAuthData: async () => {
    // return auth object
  },
});

Then, a new action that needs auth info is defined like this:

"use server";

import { z } from "zod";
import { action } from "@/lib/safe-action";

export const exampleAction = action({ input, withAuth: true },
  async (parsedInput, { userId }) => {
    console.log(userId);
    ...
  }
);

This implementation is fine for authentication/authorization purposes, but it's extremely specific too.
There's a better, easier, and generic way to implement auth actions and anything else a user needs: context.

⚠️ BREAKING CHANGE: Context based client

Using context, you can define multiple clients for different purposes. Here are two examples with a base client, and an auth one:

import { createSafeActionClient } from "next-safe-action";

export const action = createSafeActionClient();
export const authAction = createSafeActionClient({
  buildContext: async () => {
    // return your context object, for example:
    return {
      userId: "123";
    }
  },
});

Then, a new action that needs auth info would be defined like this:

"use server";

import { z } from "zod";
import { authAction } from "@/lib/safe-action"; // import `authAction` client

// We don't need to pass an object with `input` and `withAuth` keys as first argument
// to the client here, because we know by the client name (`authAction`), that
// the second argument of function that defines server action's code will be { `userId` }.
export const exampleAction = authAction(input, async (parsedInput, { userId }) => {
    console.log(userId);
    ...
  }
);

With context based clients, the second argument of server action function (in this case { userId }), will always be the context object. If you don't define a buildContext function while instantiating a safe action client, then context would be an empty object.

The idea is to include these changes in version 3.0.0 of the library.

[TheEdoRan]

You can find and experiment with these new changes with beta version.

[github-actions]

🎉 This issue has been resolved in version 3.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀