@floatingpixels/supabase-nuxt 0.2.10 → 0.3.1

package/README.md

@@ -31,14 +31,16 @@ export default defineNuxtConfig({
 })
 ```
 
-Add `SUPABASE_URL` and `SUPABASE_KEY` to the `.env`:
+Add `SUPABASE_URL` and `SUPABASE_ANON_KEY` to `.env`:
 
 ```zsh
-SUPABASE_URL="https://example.supabase.co"
-SUPABASE_KEY="<your_key>"
+NUXT_PUBLIC_SUPABASE_URL="https://example.supabase.co"
+NUXT_PUBLIC_SUPABASE_ANON_KEY=""
 ```
 
-Alternatively, you can prefix the environment variables with `NUXT_PUBLIC_` in order to use `runtimeConfig`.
+When dynamically setting the variables during in an environment, make sure to prefix the environment variables with `NUXT_PUBLIC_` in order to use `runtimeConfig`.
+
+The public keys are required to be set in the environment for the module to work. If the service role is needed, you should also set `NUXT_SUPABASE_SERVICE_ROLE_KEY` in the environment, which will be only available on the server side as a private runtime variable.
 
 ## Options
 
@@ -55,19 +57,19 @@ export default defineNuxtConfig({
 
 ### `url`
 
-Default: `process.env.SUPABASE_URL` (ex: `https://example.supabase.co`)
+Default: `process.env.NUXT_PUBLIC_SUPABASE_URL` (e.g.: `https://example.supabase.co`)
 
 The unique Supabase URL which is supplied when you create a new project in your project dashboard.
 
 ### `key`
 
-Default: `process.env.SUPABASE_KEY`
+Default: `process.env.NUXT_PUBLIC_SUPABASE_ANON_KEY`
 
 Supabase 'anon key', used to bypass the Supabase API gateway and interact with your Supabase database making use of user JWT to apply RLS Policies.
 
 ### `serviceKey`
 
-Default: `process.env.SUPABASE_SERVICE_KEY`
+Default: `process.env.NUXT_SUPABASE_SERVICE_ROLE_KEY`
 
 Supabase 'service role key', has super admin rights and can bypass your Row Level Security.
 
@@ -387,7 +389,7 @@ Make requests with super admin rights to the Supabase API with the `supabaseServ
 
 It provides similar functionality as the `supabaseServerClient` but it provides a client with super admin rights that can bypass your [Row Level Security](https://supabase.com/docs/guides/auth/row-level-security).
 
-The client is initialized with the `SUPABASE_SERVICE_KEY` you must have in your `.env` file. Checkout the doc if you want to know more about [Supabase keys](https://supabase.com/docs/learn/auth-deep-dive/auth-deep-dive-jwts#jwts-in-supabase).
+The client is initialized with the `SUPABASE_SERVICE_ROLE_KEY` you must have in your environment. Checkout the doc if you want to know more about [Supabase keys](https://supabase.com/docs/learn/auth-deep-dive/auth-deep-dive-jwts#jwts-in-supabase).
 
 > ⚠️ The service key gives admin access to your database, be careful to not expose it in your client side code or in your git repository.
 

package/dist/module.d.mts

@@ -5,8 +5,8 @@ declare module '@nuxt/schema' {
     interface PublicRuntimeConfig {
         supabase: {
             url: string;
-            key: string;
-            serviceKey: string;
+            anonKey: string;
+            serviceRoleKey: string;
             redirect: boolean;
             redirectOptions: RedirectOptions;
             clientOptions: SupabaseClientOptions<string>;
@@ -43,7 +43,7 @@ interface ModuleOptions {
      * @type string
      * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
      */
-    key: string;
+    anonKey: string;
     /**
      * Supabase Service key
      * @default process.env.SUPABASE_SERVICE_KEY
@@ -51,7 +51,7 @@ interface ModuleOptions {
      * @type string
      * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
      */
-    serviceKey?: string;
+    serviceRoleKey?: string;
     /**
      * Redirect automatically to login page if user is not authenticated
      * @default `false`

package/dist/module.d.ts

@@ -5,8 +5,8 @@ declare module '@nuxt/schema' {
     interface PublicRuntimeConfig {
         supabase: {
             url: string;
-            key: string;
-            serviceKey: string;
+            anonKey: string;
+            serviceRoleKey: string;
             redirect: boolean;
             redirectOptions: RedirectOptions;
             clientOptions: SupabaseClientOptions<string>;
@@ -43,7 +43,7 @@ interface ModuleOptions {
      * @type string
      * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
      */
-    key: string;
+    anonKey: string;
     /**
      * Supabase Service key
      * @default process.env.SUPABASE_SERVICE_KEY
@@ -51,7 +51,7 @@ interface ModuleOptions {
      * @type string
      * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
      */
-    serviceKey?: string;
+    serviceRoleKey?: string;
     /**
      * Redirect automatically to login page if user is not authenticated
      * @default `false`

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": ">3.0.0"
   },
-  "version": "0.2.10",
+  "version": "0.3.1",
   "builder": {
     "@nuxt/module-builder": "0.8.4",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -11,9 +11,9 @@ const module = defineNuxtModule({
   },
   // Default configuration options of the Nuxt module
   defaults: {
-    url: process.env.SUPABASE_URL,
-    key: process.env.SUPABASE_KEY,
-    serviceKey: process.env.SUPABASE_SERVICE_KEY,
+    url: process.env.NUXT_PUBLIC_SUPABASE_URL,
+    anonKey: process.env.NUXT_PUBLIC_SUPABASE_ANON_KEY,
+    serviceRoleKey: process.env.NUXT_SUPABASE_SERVICE_ROLE,
     redirect: false,
     redirectOptions: {
       login: "/login",
@@ -31,20 +31,20 @@ const module = defineNuxtModule({
   setup(options, nuxt) {
     const { resolve } = createResolver(import.meta.url);
     if (!options.url) {
-      console.warn("Missing `SUPABASE_URL` in environmewnt");
+      console.warn("Missing `SUPABASE_URL` in environment");
     }
-    if (!options.key) {
-      console.warn("Missing `SUPABASE_KEY` in environment");
+    if (!options.anonKey) {
+      console.warn("Missing `SUPABASE_ANON_KEY` in environment");
     }
     nuxt.options.runtimeConfig.public.supabase = defu(nuxt.options.runtimeConfig.public.supabase, {
       url: options.url,
-      key: options.key,
+      anonKey: options.anonKey,
       redirect: options.redirect,
       redirectOptions: options.redirectOptions,
       clientOptions: options.clientOptions
     });
     nuxt.options.runtimeConfig.supabase = defu(nuxt.options.runtimeConfig.supabase, {
-      serviceKey: options.serviceKey
+      serviceRoleKey: options.serviceRoleKey
     });
     addServerHandler({
       route: "/supabase/auth/confirm",

package/dist/runtime/plugins/supabase.client.js

@@ -5,8 +5,8 @@ export default defineNuxtPlugin({
   enforce: "pre",
   async setup() {
     const config = useRuntimeConfig().public.supabase;
-    const { url, key } = config;
-    const supabaseBrowserClient = createBrowserClient(url, key);
+    const { url, anonKey } = config;
+    const supabaseBrowserClient = createBrowserClient(url, anonKey);
     return {
       provide: {
         supabase: {

package/dist/runtime/plugins/supabase.server.js

@@ -5,12 +5,12 @@ export default defineNuxtPlugin({
   name: "supabase",
   enforce: "pre",
   async setup() {
-    const { url, key } = useRuntimeConfig().public.supabase;
+    const { url, anonKey } = useRuntimeConfig().public.supabase;
     const event = useRequestEvent();
     if (!event) {
       throw new Error("No request event found");
     }
-    const supabaseServerClient = createServerClient(url, key, {
+    const supabaseServerClient = createServerClient(url, anonKey, {
       cookies: {
         getAll: async () => {
           return parseCookieHeader(getHeader(event, "Cookie") ?? "");

package/dist/runtime/server/services/supabaseServerClient.js

@@ -3,11 +3,11 @@ import { setCookie, getHeader } from "h3";
 import { useRuntimeConfig } from "#imports";
 export const supabaseServerClient = async (event) => {
   const {
-    supabase: { url, key }
+    supabase: { url, anonKey }
   } = useRuntimeConfig().public;
   let supabaseClient = event.context._supabaseClient;
   if (!supabaseClient) {
-    supabaseClient = createServerClient(url, key, {
+    supabaseClient = createServerClient(url, anonKey, {
       cookies: {
         getAll: async () => {
           return parseCookieHeader(getHeader(event, "Cookie") ?? "");

package/dist/runtime/server/services/supabaseServiceRole.js

@@ -3,17 +3,17 @@ import { setCookie, getHeader } from "h3";
 import { useRuntimeConfig } from "#imports";
 export const supabaseServiceRole = async (event) => {
   const {
-    supabase: { serviceKey },
+    supabase: { serviceRoleKey },
     public: {
       supabase: { url }
     }
   } = useRuntimeConfig();
-  if (!serviceKey) {
+  if (!serviceRoleKey) {
     throw new Error("Missing `SUPABASE_SERVICE_KEY` in `.env`");
   }
   let supabaseClient = event.context._supabaseServiceRole;
   if (!supabaseClient) {
-    supabaseClient = createServerClient(url, serviceKey, {
+    supabaseClient = createServerClient(url, serviceRoleKey, {
       cookies: {
         getAll: async () => {
           return parseCookieHeader(getHeader(event, "Cookie") ?? "");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@floatingpixels/supabase-nuxt",
-  "version": "0.2.10",
+  "version": "0.3.1",
   "description": "Supabase module for Nuxt",
   "repository": "floatingpixels/supabase-nuxt",
   "license": "MIT",
@@ -59,35 +59,35 @@
   },
   "dependencies": {
     "@supabase/ssr": "^0.5.2",
-    "@supabase/supabase-js": "^2.47.8",
+    "@supabase/supabase-js": "^2.47.12",
     "defu": "^6.1.4"
   },
   "devDependencies": {
-    "@nuxt/devtools": "^1.6.4",
-    "@nuxt/eslint-config": "^0.7.3",
-    "@nuxt/kit": "^3.15.0",
+    "@nuxt/devtools": "^1.7.0",
+    "@nuxt/eslint-config": "^0.7.5",
+    "@nuxt/kit": "^3.15.1",
     "@nuxt/module-builder": "^0.8.4",
-    "@nuxt/schema": "^3.15.0",
-    "@nuxt/test-utils": "^3.15.1",
+    "@nuxt/schema": "^3.15.1",
+    "@nuxt/test-utils": "3.15.1",
     "@playwright/test": "^1.49.1",
-    "@snaplet/copycat": "^5.1.0",
+    "@snaplet/copycat": "^5.1.1",
     "@snaplet/seed": "^0.98.0",
     "@types/eslint-config-prettier": "^6.11.3",
-    "@types/node": "^22.10.2",
+    "@types/node": "^22.10.5",
     "@vitest/coverage-v8": "2.1.8",
     "@vue/test-utils": "^2.4.6",
     "changelogen": "^0.5.7",
     "eslint": "^9.17.0",
     "eslint-config-prettier": "^9.1.0",
-    "happy-dom": "^15.11.7",
-    "nuxt": "^3.15.0",
+    "happy-dom": "^16.5.3",
+    "nuxt": "^3.15.1",
     "playwright-core": "^1.49.1",
     "postgres": "^3.4.5",
     "prettier": "^3.4.2",
-    "release-it": "^17.10.0",
-    "supabase": "^2.1.1",
-    "typescript": "5.6.2",
+    "release-it": "^18.1.1",
+    "supabase": "^2.2.1",
+    "typescript": "5.7.3",
     "vitest": "^2.1.8",
-    "vue-tsc": "^2.1.10"
+    "vue-tsc": "^2.2.0"
   }
 }