sidebase/nuxt-auth 0.8.0-alpha.3

on GitHub

Upgrade guide

This release contains breaking changes for all providers.

// nuxt.config.ts

export default defineNuxtConfig({
	modules: ['@sidebase/nuxt-auth'],
	auth: {
-		session: {
-			enableRefreshOnWindowFocus: true,
-			enableRefreshPeriodically: 10000,
- 			refreshHandler: RefreshHandler
- 		}
+		sessionRefresh: {
+			enableOnWindowFocus: true,
+			enablePeriodically: 10000,
+			refreshHandler: RefreshHandler
+		}
	}
})

RefreshHandler

In #715, we took the first step to improve the behavior and possibilities to customize the Refresh behaviour of your application. In #766 we finalized these changes and improved the previous configuration options. You can define the location of a custom RefreshHandler inside your Nuxt config under auth.sessionRefresh.refreshHandler.

To customize the session refreshing you can provide a refresh handler. A custom RefreshHandler requires an init- and a destroy-function.

• init will be called when the nuxt application is mounted. Here you may add event listeners and initialize custom refresh behaviour. The method will receive a RefreshHandlerConfig. The type consists of enablePeriodically & enableOnWindowFocus.
• destroy will be called when your app is unmounted. Here you may run your clean up routine e.g. to remove your event listeners.

import type { RefreshHandler } from '@sidebase/nuxt-auth'

// You may also use a plain object with `satisfies RefreshHandler`, of course!
class CustomRefreshHandler implements RefreshHandler {
  init (): void {
    console.info('Use the full power of classes to customize refreshHandler!')
  }

  destroy (): void {
    console.info(
      'Hover above class properties or go to their definition ' +
      'to learn more about how to craft a refreshHandler'
    )
  }
}

export default new CustomRefreshHandler()

If no custom RefreshHandler is defined, the build-in handler will be used.

What's Changed

• 📝 docs: add session config.md by @blumewas in #758
• docs: fix broken links and minor rewording by @morehawes in #767
• enh(#765): refactor refreshHandler and session refreshing; fix refresh provider refreshing by @phoenix-ru in #766
• fix: await sendRedirect in auth handler by @DavidDeSloovere in #769
• fix: Added getCurrentInstance check to conditionally register onMounted in useAuthState. by @cip8 in #771
• release: 0.8.0-alpha.3 by @zoey-kaiser in #778

New Contributors

• @morehawes made their first contribution in #767
• @DavidDeSloovere made their first contribution in #769
• @cip8 made their first contribution in #771

Full Changelog: 0.8.0-alpha.2...0.8.0-alpha.3