0.2.1 β€’ Published 12 months ago

@hedystia/better-auth-admin v0.2.1

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

The developers of better auth already added the ability to have roles in their admin plugin, use that addon instead of this one

🌟 Features

  • πŸ” Role-based Access Control: Define and manage user roles and permissions
  • πŸ‘₯ Advanced User Management: Create, update, list, and remove users with ease
  • 🚫 User Banning: Temporarily or permanently restrict user access
  • πŸ‘€ User Impersonation: Securely access user accounts for support purposes
  • πŸ” Flexible User Search: Find users quickly with powerful search and filter options
  • πŸ› οΈ Customizable Configuration: Tailor the admin features to your project needs

πŸš€ Quick Start

  1. Install the package:
npm install @hedystia/better-auth-admin
  1. Import the plugin in your auth.ts file:
import { admin } from "@hedystia/better-auth-admin";
import { betterAuth } from "better-auth";

export const auth = betterAuth({
  plugins: [
    // Other plugins...
    admin({
      // Configuration options
    }),
  ],
});
  1. Add the plugin to your authClient.ts file:
import { adminClient } from "@hedystia/better-auth-admin/client";
import { createAuthClient } from "better-auth/client";

export default createAuthClient({
  plugins: [
    // Other plugins...
    adminClient()
  ],
});

🎨 Configuration

The admin plugin accepts an optional configuration object with the following properties:

admin({
  defaultRole: "user",
  adminRole: "admin",
  defaultBanReason: "No reason",
  defaultBanExpiresIn: 60 * 60 * 24 * 7, // 1 week
  impersonationSessionDuration: 60 * 60, // 1 hour
  permissions: {
    global: "*",
    createRole: "create_role",
    listPermissions: "list_permissions",
    listRoles: "list_roles",
    updateRole: "update_role",
    getRole: "get_role",
    setRole: "set_role",
    banUser: "ban_user",
    unBanUser: "un_ban_user",
    impersonateUser: "impersonate_user",
    stopImpersonating: "stop_impersonating",
    createUser: "create_user",
    updateUser: "update_user",
    deleteUser: "delete_user",
    listUsers: "list_users",
    setUserRole: "set_user_role",
    listUserSessions: "list_user_sessions",
    revokeUserSession: "revoke_user_session",
    revokeUserSessions: "revoke_user_sessions",
    linkUser: "link_user",
    unlinkUser: "unlink_user",
    removeUser: "remove_user",
  },
});

🌟 Why use this plugin?

This plugin is a fork of the original better-auth β€œadmin” plugin but enhanced to support permissions for each role.

πŸ“ License

This project is licensed under the MIT License.

πŸ™ Acknowledgements

0.2.1

12 months ago

0.2.0

1 year ago

0.1.1

1 year ago

0.1.0

1 year ago

0.0.5

1 year ago

0.0.5-dev.1

1 year ago

0.0.5-dev.0

1 year ago

0.0.4

1 year ago

0.0.3

1 year ago

0.0.2

1 year ago

0.0.1

1 year ago

0.0.1-dev.1

1 year ago

0.0.1-dev.0

1 year ago