chore: improve types. (#255)

* chore: improve types.

* chore: types and changeset.

.changeset/sixty-kangaroos-drop.md

@@ -0,0 +1,7 @@
+---
+'@supabase/auth-helpers-nextjs': patch
+'@supabase/auth-helpers-react': patch
+'@supabase/auth-helpers-shared': patch
+---
+
+chore: improve types.

packages/nextjs/src/index.ts

@@ -4,15 +4,20 @@ import {
 } from '@supabase/auth-helpers-shared';
 
 // Types
-export type { User } from '@supabase/supabase-js';
+export type { Session, User, SupabaseClient } from '@supabase/supabase-js';
 
 // Methods
 export * from './middleware';
 export { default as withPageAuth } from './utils/withPageAuth';
 export { default as withApiAuth } from './utils/withApiAuth';
 export { default as logger } from './utils/log';
 
-export function createBrowserSupabaseClient({
+export function createBrowserSupabaseClient<
+  Database = any,
+  SchemaName extends string & keyof Database = 'public' extends keyof Database
+    ? 'public'
+    : string & keyof Database
+>({
   cookieOptions
 }: {
   cookieOptions?: CookieOptions;
@@ -26,7 +31,7 @@ export function createBrowserSupabaseClient({
     );
   }
 
-  return _createBrowserSupabaseClient({
+  return _createBrowserSupabaseClient<Database, SchemaName>({
     supabaseUrl: process.env.NEXT_PUBLIC_SUPABASE_URL,
     supabaseKey: process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY,
     cookieOptions

packages/nextjs/src/middleware/withMiddlewareAuth.ts

@@ -4,7 +4,7 @@ import {
   CookieOptions,
   createServerSupabaseClient
 } from '@supabase/auth-helpers-shared';
-import { User } from '@supabase/supabase-js';
+import { SupabaseClient, User } from '@supabase/supabase-js';
 
 class NoPermissionError extends Error {
   constructor(message: string) {
@@ -26,7 +26,7 @@ export interface withMiddlewareAuthOptions {
   redirectTo?: string;
   cookieOptions?: CookieOptions;
   authGuard?: {
-    isPermitted: (user: User) => Promise<boolean>;
+    isPermitted: (user: User, supabase: SupabaseClient) => Promise<boolean>;
     redirectTo: string;
   };
 }
@@ -77,7 +77,7 @@ export const withMiddlewareAuth: withMiddlewareAuth =
         throw new Error('No auth session, redirecting');
       } else if (
         options.authGuard &&
-        !(await options.authGuard.isPermitted(session.user))
+        !(await options.authGuard.isPermitted(session.user, supabase))
       ) {
         throw new NoPermissionError('User is not permitted, redirecting');
       }

packages/react/src/index.tsx

@@ -1,2 +1,5 @@
+// Types
+export type { Session, User, SupabaseClient } from '@supabase/supabase-js';
+
 // Methods & Components
 export * from './components/SessionContext';

packages/shared/src/supabase-browser.ts

@@ -3,22 +3,28 @@ import { parse, serialize } from 'cookie';
 import { CookieOptions } from './types';
 import { isBrowser } from './utils/helpers';
 
-export function createBrowserSupabaseClient({
+export function createBrowserSupabaseClient<
+  Database = any,
+  SchemaName extends string & keyof Database = 'public' extends keyof Database
+    ? 'public'
+    : string & keyof Database
+>({
   supabaseUrl,
   supabaseKey,
   cookieOptions: {
     name = 'supabase-auth-token',
     domain,
     path = '/',
     sameSite = 'lax',
-    secure = false
+    secure,
+    maxAge = 1000 * 60 * 60 * 24 * 365
   } = {}
 }: {
   supabaseUrl: string;
   supabaseKey: string;
   cookieOptions?: CookieOptions;
 }) {
-  return createClient(supabaseUrl, supabaseKey, {
+  return createClient<Database, SchemaName>(supabaseUrl, supabaseKey, {
     auth: {
       storageKey: name,
       storage: {
@@ -44,12 +50,11 @@ export function createBrowserSupabaseClient({
           document.cookie = serialize(key, value, {
             domain,
             path,
-            maxAge: 1000 * 60 * 60 * 24 * 365,
+            maxAge,
             // Allow supabase-js on the client to read the cookie as well
             httpOnly: false,
             sameSite,
-            // TODO: set this secure based on the browser location
-            secure
+            secure: secure ?? document.location?.protocol === 'https:'
           });
         },
         removeItem(key: string) {

packages/shared/src/supabase-server.ts

@@ -4,7 +4,12 @@ import { CookieOptions } from './types';
 import { filterCookies, isSecureEnvironment } from './utils/cookies';
 import { ensureArray } from './utils/helpers';
 
-export function createServerSupabaseClient({
+export function createServerSupabaseClient<
+  Database = any,
+  SchemaName extends string & keyof Database = 'public' extends keyof Database
+    ? 'public'
+    : string & keyof Database
+>({
   supabaseUrl,
   supabaseKey,
   getRequestHeader,
@@ -15,7 +20,8 @@ export function createServerSupabaseClient({
     domain,
     path = '/',
     sameSite = 'lax',
-    secure
+    secure,
+    maxAge = 1000 * 60 * 60 * 24 * 365
   } = {}
 }: {
   supabaseUrl: string;
@@ -51,7 +57,7 @@ export function createServerSupabaseClient({
       });
   }
 
-  return createClient(supabaseUrl, supabaseKey, {
+  return createClient<Database, SchemaName>(supabaseUrl, supabaseKey, {
     auth: {
       detectSessionInUrl: false,
       autoRefreshToken: false,
@@ -81,7 +87,7 @@ export function createServerSupabaseClient({
           const newSessionStr = serialize(key, value, {
             domain,
             path,
-            maxAge: 1000 * 60 * 60 * 24 * 365,
+            maxAge,
             // Allow supabase-js on the client to read the cookie as well
             httpOnly: false,
             sameSite,

packages/shared/src/types.ts

@@ -2,5 +2,5 @@ import type { CookieSerializeOptions } from 'cookie';
 
 export type CookieOptions = { name?: string } & Pick<
   CookieSerializeOptions,
-  'domain' | 'secure' | 'path' | 'sameSite'
+  'domain' | 'secure' | 'path' | 'sameSite' | 'maxAge'
 >;