Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependency @sidebase/nuxt-auth to ^0.10.0 #14

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Mar 7, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
@sidebase/nuxt-auth (source) ^0.6.0-beta.5 -> ^0.10.0 age adoption passing confidence
@sidebase/nuxt-auth (source) ^0.6.0-beta.6 -> ^0.10.0 age adoption passing confidence

Release Notes

sidebase/nuxt-auth (@​sidebase/nuxt-auth)

v0.10.0

Compare Source

Upgrading

Hi everyone 👋

This release contains breaking changes for the default middleware and the configuration of baseURL and AUTH_ORIGIN.
We prepared a full upgrade guide, that can be found here.

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.9.4...0.10.0

v0.9.4

Compare Source

What's Changed

Full Changelog: sidebase/nuxt-auth@0.9.3...0.9.4

v0.9.3

Compare Source

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.9.2...0.9.3

v0.9.2

Compare Source

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.9.1...0.9.2

v0.9.1

Compare Source

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.9.0...0.9.1

v0.9.0

Compare Source

Upgrade guide

Hi everyone 👋

In #​821 we made a breaking change where we unified the local and refresh providers into one!
Therefore, anyone using the refresh provider, will need to update their configuration after upgrading @sidebase/nuxt-auth.

We prepared a full upgrade guide, that can be read here.

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.8.2...0.9.0

v0.8.2

Compare Source

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.8.1...0.8.2

v0.8.1

Compare Source

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.8.0...0.8.1

v0.8.0

Compare Source

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

New Contributors

Full Changelog: sidebase/nuxt-auth@0.7.2...0.8.0

v0.7.2

Compare Source

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.7.1...0.7.2

v0.7.1

Compare Source

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.7.0...0.7.1

v0.7.0

Compare Source

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.6.7...0.7.0

v0.6.7

Compare Source

This release reverts the changes made in https://github.com/sidebase/nuxt-auth/releases/tag/0.6.6, which could result in content flashes.

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.6.5...0.6.6

v0.6.6

Compare Source

WARNING: Please do not use this release, as the change in #​644 can result in Content flashes on first load. Please skip this release and use 0.6.7!

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.6.5...0.6.6

v0.6.5

Compare Source

What's Changed

Full Changelog: sidebase/nuxt-auth@0.6.4...0.6.5

v0.6.4

Compare Source

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.6.3...0.6.4

v0.6.3

Compare Source

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.6.2...0.6.3

v0.6.2

Compare Source

What's Changed

Full Changelog: sidebase/nuxt-auth@0.6.1...0.6.2

v0.6.1

Compare Source

Hello everyone! 0.6.1 is a small patch version to accomplish two things that have happened since the release of 0.6.0.

  • We renamed our module to sidebase-auth in the internal modules structure of Nuxt. Therefore we need to change the name, to allow Nuxt Devtools to properly register our module again. However, you will not need to change anything in your code, this is only an internal identifier and does not affect you in anyway.
  • We allowed you to disable the signout route, in case you do not want to make an API call when logging someone out and only want to clear the session on the browser.

What's Changed

New Contributors

Full Changelog: sidebase/nuxt-auth@0.6.0...0.6.1

v0.6.0

Compare Source

🔐 nuxt-auth is an authentication package for Nuxt 3. It provides oauth sign-in, credential sign-in and magic-email sign-in flows. Read more: https://sidebase.io/nuxt-auth/getting-started

This is release v0.6.0 of the nuxt-auth module. Notably, it introduces:

  • static Nuxt 3 app support
  • local provider support
  • multi-provider support to facilitate the above -> extensible for future providers
  • new and improved docs

To use the new version follow the installation instructions. Here's a small spoiler of what the new module has in store: image

Example: Provider authjs

This is what <= v0.5 used as the only possible provider.

export default defineNuxtConfig({
    modules: ['@&#8203;sidebase/nuxt-auth'],
    auth: {
        provider: {
            type: 'authjs'
        }
    }
})

Example: Provider local

This is the new provider that supports static username + password flows. Static OAuth is not yet supported.

export default defineNuxtConfig({
    modules: ['@&#8203;sidebase/nuxt-auth'],
    auth: {
        provider: {
            type: 'local'
        }
    }
})

Breaking changes?

There's a few breaking changes in comparison to v0.5.0 of the module. If you are used to v0.5 or below the biggest change will be:

  • the module-config-structure.
  • using authjs to identify next-auth

What's Changed


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot force-pushed the renovate/sidebase-nuxt-auth-0.x branch from 65c000e to fd77ddd Compare July 4, 2024 18:47
@renovate renovate bot changed the title Update dependency @sidebase/nuxt-auth to ^0.7.0 Update dependency @sidebase/nuxt-auth to ^0.8.0 Jul 4, 2024
@renovate renovate bot force-pushed the renovate/sidebase-nuxt-auth-0.x branch from fd77ddd to 02cd224 Compare August 22, 2024 20:44
@renovate renovate bot changed the title Update dependency @sidebase/nuxt-auth to ^0.8.0 Update dependency @sidebase/nuxt-auth to ^0.9.0 Aug 22, 2024
@renovate renovate bot force-pushed the renovate/sidebase-nuxt-auth-0.x branch from 02cd224 to 9e9581f Compare December 19, 2024 19:37
@renovate renovate bot changed the title Update dependency @sidebase/nuxt-auth to ^0.9.0 Update dependency @sidebase/nuxt-auth to ^0.10.0 Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants