@floatingpixels/supabase-nuxt 0.1.1

package/README.md

@@ -0,0 +1,94 @@
+<!--
+Get your module up and running quickly.
+
+Find and replace all on all files (CMD+SHIFT+F):
+- Name: My Module
+- Package name: my-module
+- Description: My new Nuxt module
+-->
+
+# My Module
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+My new Nuxt module for doing amazing things.
+
+- [✨ &nbsp;Release Notes](/CHANGELOG.md)
+<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
+<!-- - [📖 &nbsp;Documentation](https://example.com) -->
+
+## Features
+
+<!-- Highlight some of the features your module provide here -->
+- ⛰ &nbsp;Foo
+- 🚠 &nbsp;Bar
+- 🌲 &nbsp;Baz
+
+## Quick Setup
+
+1. Add `my-module` dependency to your project
+
+```bash
+# Using pnpm
+pnpm add -D my-module
+
+# Using yarn
+yarn add --dev my-module
+
+# Using npm
+npm install --save-dev my-module
+```
+
+2. Add `my-module` to the `modules` section of `nuxt.config.ts`
+
+```js
+export default defineNuxtConfig({
+  modules: [
+    'my-module'
+  ]
+})
+```
+
+That's it! You can now use My Module in your Nuxt app ✨
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Generate type stubs
+npm run dev:prepare
+
+# Develop with the playground
+npm run dev
+
+# Build the playground
+npm run dev:build
+
+# Run ESLint
+npm run lint
+
+# Run Vitest
+npm run test
+npm run test:watch
+
+# Release new version
+npm run release
+```
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/my-module
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npmjs.com/package/my-module
+
+[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://npmjs.com/package/my-module
+
+[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
+[nuxt-href]: https://nuxt.com

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.mts

@@ -0,0 +1,68 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+  /**
+   * Supabase API URL
+   * @default process.env.SUPABASE_URL
+   * @example 'https://*.supabase.co'
+   * @type string
+   * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
+   */
+  url: string
+
+  /**
+   * Supabase Client API Key
+   * @default process.env.SUPABASE_KEY
+   * @example '123456789'
+   * @type string
+   * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
+   */
+  key: string
+
+  /**
+   * Supabase Service key
+   * @default process.env.SUPABASE_SERVICE_KEY
+   * @example '123456789'
+   * @type string
+   * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
+   */
+  serviceKey?: string
+
+  /**
+   * Redirect automatically to login page if user is not authenticated
+   * @default `false`
+   * @type boolean
+   */
+  redirect?: boolean
+
+  /**
+   * Redirection options, set routes for login and callback redirect
+   * @default
+   * {
+      login: '/login',
+      callback: '/confirm',
+      exclude: [],
+    }
+   * @type RedirectOptions
+   */
+  redirectOptions?: RedirectOptions
+}
+
+interface RedirectOptions {
+  /**
+   * Login route
+   * @default '/login'
+   * @type string
+   */
+  login?: string
+  /**
+   * Callback route
+   * @default []
+   * @type string[]
+   */
+  exclude?: string[]
+}
+
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { _default as default };

package/dist/module.d.ts

@@ -0,0 +1,68 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+  /**
+   * Supabase API URL
+   * @default process.env.SUPABASE_URL
+   * @example 'https://*.supabase.co'
+   * @type string
+   * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
+   */
+  url: string
+
+  /**
+   * Supabase Client API Key
+   * @default process.env.SUPABASE_KEY
+   * @example '123456789'
+   * @type string
+   * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
+   */
+  key: string
+
+  /**
+   * Supabase Service key
+   * @default process.env.SUPABASE_SERVICE_KEY
+   * @example '123456789'
+   * @type string
+   * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
+   */
+  serviceKey?: string
+
+  /**
+   * Redirect automatically to login page if user is not authenticated
+   * @default `false`
+   * @type boolean
+   */
+  redirect?: boolean
+
+  /**
+   * Redirection options, set routes for login and callback redirect
+   * @default
+   * {
+      login: '/login',
+      callback: '/confirm',
+      exclude: [],
+    }
+   * @type RedirectOptions
+   */
+  redirectOptions?: RedirectOptions
+}
+
+interface RedirectOptions {
+  /**
+   * Login route
+   * @default '/login'
+   * @type string
+   */
+  login?: string
+  /**
+   * Callback route
+   * @default []
+   * @type string[]
+   */
+  exclude?: string[]
+}
+
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { _default as default };

package/dist/module.json

@@ -0,0 +1,8 @@
+{
+  "name": "supabase-nuxt",
+  "configKey": "supabase",
+  "compatibility": {
+    "nuxt": ">3.0.0"
+  },
+  "version": "0.1.1"
+}

package/dist/module.mjs

@@ -0,0 +1,73 @@
+import { defineNuxtModule, createResolver, addPlugin, addServerHandler, addTemplate } from '@nuxt/kit';
+import { defu } from 'defu';
+
+const module = defineNuxtModule({
+  meta: {
+    name: "supabase-nuxt",
+    configKey: "supabase",
+    compatibility: {
+      nuxt: ">3.0.0"
+    }
+  },
+  // Default configuration options of the Nuxt module
+  defaults: {
+    url: process.env.SUPABASE_URL,
+    key: process.env.SUPABASE_KEY,
+    serviceKey: process.env.SUPABASE_SERVICE_KEY,
+    redirect: false,
+    redirectOptions: {
+      login: "/login",
+      exclude: []
+    }
+  },
+  setup(options, nuxt) {
+    const { resolve } = createResolver(import.meta.url);
+    console.log("Module setup function");
+    if (!options.url) {
+      console.warn("Missing `SUPABASE_URL` in `.env`");
+    }
+    if (!options.key) {
+      console.warn("Missing `SUPABASE_KEY` in `.env`");
+    }
+    nuxt.options.runtimeConfig.public.supabase = defu(nuxt.options.runtimeConfig.public.supabase, {
+      url: options.url,
+      key: options.key,
+      redirect: options.redirect,
+      redirectOptions: options.redirectOptions
+    });
+    nuxt.options.runtimeConfig.supabase = defu(nuxt.options.runtimeConfig.supabase, {
+      serviceKey: options.serviceKey
+    });
+    addPlugin(resolve("./runtime/plugins/supabase.server"));
+    addPlugin(resolve("./runtime/plugins/supabase.client"));
+    nuxt.hook("imports:dirs", (dirs) => {
+      dirs.push(resolve("./runtime/composables"));
+    });
+    addServerHandler({
+      route: "/supabase/confirm",
+      handler: resolve("./runtime/server/api/confirm.ts")
+    });
+    if (options.redirect) {
+      addPlugin(resolve("./runtime/plugins/auth-redirect"));
+    }
+    nuxt.hook("nitro:config", (nitroConfig) => {
+      nitroConfig.alias = nitroConfig.alias || {};
+      nitroConfig.alias["#supabase/server"] = resolve("./runtime/server/services");
+      nitroConfig.externals = defu(typeof nitroConfig.externals === "object" ? nitroConfig.externals : {}, {
+        inline: [resolve("./runtime")]
+      });
+    });
+    addTemplate({
+      filename: "types/supabase.d.ts",
+      getContents: () => [
+        "declare module '#supabase/server' {",
+        `  const supabaseServerClient: typeof import('${resolve("./runtime/server/services")}').supabaseServerClient`,
+        `  const supabaseServiceRole: typeof import('${resolve("./runtime/server/services")}').supabaseServiceRole`,
+        // `  const serverSupabaseUser: typeof import('${resolve('./runtime/server/services')}').serverSupabaseUser`,
+        "}"
+      ].join("\n")
+    });
+  }
+});
+
+export { module as default };

package/dist/runtime/composables/useSupabaseClient.d.ts

@@ -0,0 +1,2 @@
+import { SupabaseClient } from '@supabase/supabase-js';
+export declare const useSupabaseClient: <T>() => SupabaseClient<T, "public" extends keyof T ? keyof T & "public" : string & keyof T, T["public" extends keyof T ? keyof T & "public" : string & keyof T] extends import("@supabase/supabase-js/dist/module/lib/types").GenericSchema ? T["public" extends keyof T ? keyof T & "public" : string & keyof T] : any>;

package/dist/runtime/composables/useSupabaseClient.mjs

@@ -0,0 +1,4 @@
+import { useNuxtApp } from "#imports";
+export const useSupabaseClient = () => {
+  return useNuxtApp().$supabase?.client;
+};

package/dist/runtime/composables/useSupabaseUser.d.ts

@@ -0,0 +1 @@
+export declare const useSupabaseUser: () => Promise<import("@supabase/supabase-js").AuthUser | null>;

package/dist/runtime/composables/useSupabaseUser.mjs

@@ -0,0 +1,11 @@
+import { useSupabaseClient } from "./useSupabaseClient.mjs";
+export const useSupabaseUser = async () => {
+  const supabase = useSupabaseClient();
+  const {
+    data: { session }
+  } = await supabase.auth.getSession();
+  if (!session?.user) {
+    return null;
+  }
+  return session.user;
+};

package/dist/runtime/plugins/auth-redirect.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/dist/runtime/plugins/auth-redirect.mjs

@@ -0,0 +1,35 @@
+import { useSupabaseUser } from "../composables/useSupabaseUser.mjs";
+import {
+  defineNuxtPlugin,
+  addRouteMiddleware,
+  defineNuxtRouteMiddleware,
+  useRuntimeConfig,
+  navigateTo,
+  abortNavigation
+} from "#imports";
+export default defineNuxtPlugin({
+  name: "auth-redirect",
+  setup() {
+    addRouteMiddleware(
+      "global-auth",
+      defineNuxtRouteMiddleware(async (to) => {
+        if (to.path === "/supabase/confirm")
+          abortNavigation();
+        const config = useRuntimeConfig().public.supabase;
+        const { login, exclude } = config.redirectOptions;
+        const isExcluded = [...exclude, login, "/supabase/confirm"]?.some((path) => {
+          const regex = new RegExp(`^${path.replace(/\*/g, ".*")}$`);
+          return regex.test(to.path);
+        });
+        if (isExcluded)
+          return;
+        const user = await useSupabaseUser();
+        if (!user) {
+          if (to.path !== "/login")
+            return navigateTo("/login");
+        }
+      }),
+      { global: true }
+    );
+  }
+});

package/dist/runtime/plugins/supabase.client.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

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

@@ -0,0 +1,21 @@
+import { defineNuxtPlugin, useRuntimeConfig } from "#imports";
+import { createBrowserClient } from "@supabase/ssr";
+export default defineNuxtPlugin({
+  name: "supabase",
+  enforce: "pre",
+  async setup() {
+    const config = useRuntimeConfig().public.supabase;
+    const { url, key } = config;
+    const supabaseBrowserClient = createBrowserClient(url, key);
+    return {
+      provide: {
+        supabase: {
+          client: supabaseBrowserClient
+        }
+      }
+    };
+  },
+  env: {
+    islands: false
+  }
+});

package/dist/runtime/plugins/supabase.server.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

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

@@ -0,0 +1,28 @@
+import { defineNuxtPlugin, useRuntimeConfig, useRequestEvent } from "#imports";
+import { createServerClient } from "@supabase/ssr";
+import { getCookie } from "h3";
+export default defineNuxtPlugin({
+  name: "supabase",
+  enforce: "pre",
+  async setup() {
+    const { url, key } = useRuntimeConfig().public.supabase;
+    const event = useRequestEvent();
+    const supabaseServerClient = createServerClient(url, key, {
+      cookies: {
+        get(name) {
+          return getCookie(event, name);
+        }
+      }
+    });
+    return {
+      provide: {
+        supabase: {
+          client: supabaseServerClient
+        }
+      }
+    };
+  },
+  env: {
+    islands: true
+  }
+});

package/dist/runtime/server/api/confirm.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/dist/runtime/server/api/confirm.mjs

@@ -0,0 +1,18 @@
+import { defineEventHandler } from "#imports";
+import { createError, getQuery, sendRedirect } from "h3";
+import { supabaseServerClient } from "#supabase/server";
+export default defineEventHandler(async (event) => {
+  const query = getQuery(event);
+  const token_hash = query.token_hash;
+  const type = query.type;
+  const next = query.next ?? "/";
+  if (!token_hash || !type) {
+    throw createError({ statusMessage: "Invalid token" });
+  }
+  const supabase = await supabaseServerClient(event);
+  const { error } = await supabase.auth.verifyOtp({ type, token_hash });
+  if (error) {
+    throw createError({ statusMessage: error.message });
+  }
+  await sendRedirect(event, next, 302);
+});

package/dist/runtime/server/services/index.d.ts

@@ -0,0 +1,2 @@
+export { supabaseServerClient } from './supabaseServerClient';
+export { supabaseServiceRole } from './supabaseServiceRole';

package/dist/runtime/server/services/index.mjs

@@ -0,0 +1,2 @@
+export { supabaseServerClient } from "./supabaseServerClient.mjs";
+export { supabaseServiceRole } from "./supabaseServiceRole.mjs";

package/dist/runtime/server/services/supabaseServerClient.d.ts

@@ -0,0 +1,3 @@
+import { SupabaseClient } from '@supabase/supabase-js';
+import type { H3Event } from 'h3';
+export declare const supabaseServerClient: <T>(event: H3Event) => Promise<SupabaseClient<T, "public" extends keyof T ? keyof T & "public" : string & keyof T, T["public" extends keyof T ? keyof T & "public" : string & keyof T] extends import("@supabase/supabase-js/dist/module/lib/types").GenericSchema ? T["public" extends keyof T ? keyof T & "public" : string & keyof T] : any>>;

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

@@ -0,0 +1,26 @@
+import { createServerClient } from "@supabase/ssr";
+import { getCookie, setCookie } from "h3";
+import { useRuntimeConfig } from "#imports";
+export const supabaseServerClient = async (event) => {
+  const {
+    supabase: { url, key }
+  } = useRuntimeConfig(event).public;
+  let supabaseClient = event.context._supabaseClient;
+  if (!supabaseClient) {
+    supabaseClient = createServerClient(url, key, {
+      cookies: {
+        get(name) {
+          return getCookie(event, name);
+        },
+        set(name, value) {
+          setCookie(event, name, value);
+        },
+        remove(key2, options) {
+          setCookie(event, key2, "", { ...options, expires: 0 });
+        }
+      }
+    });
+    event.context._supabaseClient = supabaseClient;
+  }
+  return supabaseClient;
+};

package/dist/runtime/server/services/supabaseServiceRole.d.ts

@@ -0,0 +1,3 @@
+import { SupabaseClient } from '@supabase/supabase-js';
+import type { H3Event } from 'h3';
+export declare const supabaseServiceRole: <T>(event: H3Event) => Promise<SupabaseClient<T, "public" extends keyof T ? keyof T & "public" : string & keyof T, T["public" extends keyof T ? keyof T & "public" : string & keyof T] extends import("@supabase/supabase-js/dist/module/lib/types").GenericSchema ? T["public" extends keyof T ? keyof T & "public" : string & keyof T] : any>>;

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

@@ -0,0 +1,26 @@
+import { createServerClient } from "@supabase/ssr";
+import { getCookie } from "h3";
+import { useRuntimeConfig } from "#imports";
+export const supabaseServiceRole = async (event) => {
+  const {
+    supabase: { serviceKey },
+    public: {
+      supabase: { url }
+    }
+  } = useRuntimeConfig(event);
+  if (!serviceKey) {
+    throw new Error("Missing `SUPABASE_SERVICE_KEY` in `.env`");
+  }
+  let supabaseClient = event.context._supabaseServiceRole;
+  if (!supabaseClient) {
+    supabaseClient = createServerClient(url, serviceKey, {
+      cookies: {
+        get(name) {
+          return getCookie(event, name);
+        }
+      }
+    });
+    event.context._supabaseServiceRole = supabaseClient;
+  }
+  return supabaseClient;
+};

package/dist/runtime/types/index.d.ts

@@ -0,0 +1,62 @@
+export interface ModuleOptions {
+  /**
+   * Supabase API URL
+   * @default process.env.SUPABASE_URL
+   * @example 'https://*.supabase.co'
+   * @type string
+   * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
+   */
+  url: string
+
+  /**
+   * Supabase Client API Key
+   * @default process.env.SUPABASE_KEY
+   * @example '123456789'
+   * @type string
+   * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
+   */
+  key: string
+
+  /**
+   * Supabase Service key
+   * @default process.env.SUPABASE_SERVICE_KEY
+   * @example '123456789'
+   * @type string
+   * @docs https://supabase.com/docs/reference/javascript/initializing#parameters
+   */
+  serviceKey?: string
+
+  /**
+   * Redirect automatically to login page if user is not authenticated
+   * @default `false`
+   * @type boolean
+   */
+  redirect?: boolean
+
+  /**
+   * Redirection options, set routes for login and callback redirect
+   * @default
+   * {
+      login: '/login',
+      callback: '/confirm',
+      exclude: [],
+    }
+   * @type RedirectOptions
+   */
+  redirectOptions?: RedirectOptions
+}
+
+export interface RedirectOptions {
+  /**
+   * Login route
+   * @default '/login'
+   * @type string
+   */
+  login?: string
+  /**
+   * Callback route
+   * @default []
+   * @type string[]
+   */
+  exclude?: string[]
+}

package/dist/types.d.mts

@@ -0,0 +1,8 @@
+
+import type {  } from './module.js'
+
+
+
+
+
+export type { default } from './module.js'

package/dist/types.d.ts

@@ -0,0 +1,8 @@
+
+import type {  } from './module'
+
+
+
+
+
+export type { default } from './module'

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@floatingpixels/supabase-nuxt",
+  "version": "0.1.1",
+  "description": "Nuxt module for Supabase",
+  "repository": "floatingpixels/supabase-nuxt",
+  "license": "MIT",
+  "type": "module",
+  "release-it": {
+    "github": {
+      "release": true,
+      "releaseName": "v${version}",
+      "preRelease": false,
+      "draft": false,
+      "tokenRef": "GITHUB_TOKEN"
+    },
+    "npm": {
+      "publish": true,
+      "publishArgs": [
+        "--access",
+        "public"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "release": "npm run lint && npm run prepack && release-it",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.9.3",
+    "@supabase/ssr": "^0.0.10",
+    "@supabase/supabase-js": "^2.39.3",
+    "defu": "^6.1.4"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "latest",
+    "@nuxt/eslint-config": "^0.2.0",
+    "@nuxt/module-builder": "^0.5.5",
+    "@nuxt/schema": "^3.9.3",
+    "@nuxt/test-utils": "^3.10.0",
+    "@types/node": "^20.11.5",
+    "@vue/test-utils": "^2.4.3",
+    "changelogen": "^0.5.5",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "happy-dom": "^13.3.1",
+    "nuxt": "^3.9.3",
+    "playwright-core": "^1.41.1",
+    "prettier": "^3.2.4",
+    "release-it": "^17.0.3",
+    "vitest": "^1.2.1"
+  }
+}