nuxt-supabase-user-attributes

Persistent user attributes with Supabase and Nuxt.

Introduction

This module extends the @nuxtjs/supabase module to allow for user attribute tables (such as profiles and metadata) to be used in a Nuxt3 application with a similar interface to useSupabaseUser() via a single composable:

<script setup>
  const {metadata, profile} = useSupabaseUserAttributes(); 
  if(metadata.role != "admin") {navigateTo("/")}
</script>

Setup and Installation

This module requires a Supabase DB with one or more user attribute tables. Each of these tables must have a column referencing auth.users.id. See /supabase/migrations/0_users_profiles.sql for an example of two such user attribute tables, complete with Postgres triggers and row level security policies. Once the database has been set up (and started if running locally), add a SUPABASE_URL and SUPABASE_KEY to a .env file. Next, follow the steps below:

• Install the Supabase module: yarn add @nuxtjs/supabase
• Install the use attributes module: yarn add nuxt-supabase-user-attributes
• Add both modules to your nuxt.config.ts file:

export default defineNuxtConfig({
  ...
  modules: ["nuxt-supabase-user-attributes", "@nuxtjs/supabase"],
  supabaseUserAttributes: {
    tables: [
      {
        name: "user_metadata",
        alias: "metadata",
        user_id_column: "id",
        multiple: false,
      }
    ]
  },
  ...
});

supabaseUserAttributes.tables defines an array tables with the following variables:

• name: The name of the user attribute table. (required)
• alias: An alias used to reference the attribute. (optional: defaults to the table name)
• user_id_column: The column of the user attribute table which references auth.users.id. (optional: defaults to 'id')
• multiple: Whether to return the user attributes as an array or single element. (optional: defaults to false)

For example, the following configuration:

supabaseUserAttributes: {
  tables: [
    {
      name: "user_metadata",
      alias: "metadata",
      user_id_column: "id",
      multiple: false,
    },
  ];
}

Allows for the current user's metadata to be accessed at any point in the application (both client and server-side) using the following composable:

const { metadata } = useSupabaseUserAttributes();

Development

We include a development playground with an example database schema able to be initialised locally with the Supabase CLI (supabase start). This example includes two example users ([email protected] and [email protected] - both using the password 12345678) with different roles and privileges as defined in /supabase/migrations/0_users_profiles.sql. Once the local database is running, use yarn to develop and build the module:

• Run yarn to install required dependencies.
• Run yarn dev:prepare to generate type stubs.
• Use yarn dev to start playground in development mode.
• Use yarn prepack to build the module.