@rebackk/pocketbase-adapter

Overview

@rebackk/pocketbase-adapter is an adapter that integrates PocketBase with NextAuth.js for authentication, enabling seamless user management and session handling using PocketBase's collections and features.

Pocketbase Setup

The Schema Used By Us For The Project is Mentioned Here

PS : Setup Roles According To Your Needs

Features

• Full integration with NextAuth.js for authentication workflows.
• Supports PocketBase collections like users, accounts, sessions, authenticators, and verification tokens.
• Fully type-safe schema, leveraging TypeScript.
• Supports various authentication strategies, including OAuth.

Installation

You can install the package via npm or yarn.

npm install @rebackk/pocketbase-adapter

or

yarn add @rebackk/pocketbase-adapter

or

pnpm add @rebackk/pocketbase-adapter

Usage

Here’s how to integrate the adapter into your NextAuth.js configuration.

Step 1: Add the adapter

In your app/api/[...next-auth]/route.ts (or .js) file, add the PocketBase adapter:

import NextAuth from "next-auth";
import { PocketBaseAdapter } from "@rebackk/pocketbase-adapter";
import PocketBase from "pocketbase";

const pb = new PocketBase("http://localhost:8090"); // Your PocketBase instance URL

export default NextAuth({
  // Configure one or more authentication providers
  providers: [
    // Add your OAuth or other providers here
  ],
  adapter: PocketBaseAdapter(pb),
});

Step 2: Configure PocketBase Schema

Ensure you have the following collections in your PocketBase instance:

1. Users: Default PocketBase users collection.
2. Accounts: For linking users with their OAuth or credentials.
3. Sessions: To manage user sessions.
4. Authenticators: To handle multi-factor authentication (MFA).
5. VerificationTokens: For managing email verification flows.

Step 3: Customize NextAuth.js

Configure any additional settings in the NextAuth.js config as required. You can leverage the full feature set of NextAuth.js, including JWT, OAuth, and more.

export default NextAuth({
  session: {
    jwt: true,
  },
  providers: [
    // Add your providers here
  ],
  adapter: PocketBaseAdapter(pb),
  secret: process.env.NEXTAUTH_SECRET,
});

Environment Variables

To secure your app, ensure that you have the following environment variables set up:

NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=your-secret

Testing

This package is fully tested using node tests. To run tests, execute:

npm run test

Contributing

We welcome contributions! To contribute:

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Submit a pull request.

Please ensure that you write tests for any new features or bug fixes.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ❤️ by Rebackk.