AdonisJS Supabase authorization

This package lets you automatically integrate supabase to turn your adonis api into a “resource server”. The api will only verify the token provided by the client, authentication will have to be done beforehand by the webapp or application. Many articles talk about the difference between authentication and authorization, e.g. this article

This package generates only the files needed for the api to manage authorization

Installation

This package installs only the dependencies and generates only the files required for supabase integration. It can be removed from package.json once configuration is complete. If you don't want to use this package and do the installation yourself, you'll find a guide here

Otherwise, you can install the package in your project

node ace add adonisjs-supabase-auth

or with npm:

npm i adonisjs-supabase-auth
node ace configure adonisjs-supabase-auth

Usage

To protect a route, simply use the authentication middleware:

import { middleware } from './kernel.js'

[...]

router
  .get([...])
  .use(middleware.auth()) // here

or:

router
  .group(() => {[...]})
  .use([middleware.auth()])

Then, it is possible to get the user:

async foo({ auth }: HttpContext) {
  const user = auth.getUserOrFail() // type: CustomSupabaseUser defined in the guard
  // your logic here
}

Samples

A list of examples is available here to show the possible implementations/modifications of the classes generated by the package. They also show how to test the application with a supabase mock

1. classic: unmodified version of the package with tests - README
2. with-custom-details: modified version of the package with user details, more information here - README
3. with-internal-profile: modified version of the package with an internal profile (stored in a sqlite database) - README
4. with-both-and-role-based: version combining the above 2 samples, adding a decorator to build a role access based application - README

License

This project is Open Source software released under the MIT license.