Mini migration guide: 0.8.4

[pilcrowonpaper]

Make sure to use v0.8.5!

Since 0.8.4 introduces a lot of breaking changes, I thought I might write a mini-migration guide as well as some context behind the changes.

Hooks

Hooks no longer handle tokens and play a (super) vital role in Lucia, so it's now renamed to handleHooks. I also thought it's more natural to call a function than just reference it.

-export const handle = auth.handleAuth
+export const handle = auth.handleHooks()

Load functions

This is where a lot of the changes happened.

Root layout server load function

+import { handleSession } from "lucia-sveltekit"

-export const load = auth.load
+export const load = auth.handleServerLoad(handleSession())

Load functions

No more waiting for parent()! ...kinda. On a server context, getSession() waits for the parent load function (similar as before) but in a browser context, it now won't, allowing you to run load functions in parallel in certain context! You can still call await parent() inside it as well, it's just a normal load function with added params.

-export const load = async ({ parent }) => {
-    const { lucia } = await parent()
-}

+import { handleLoad } from "lucia-sveltekit/load"

+export const load = handleLoad( async ({ getSession }) => {
+    const session = await getSession()
+}

Supports multiple load functions too (same for the server version):

export const load = handleLoad(load1, load2)

Server load functions

Server load functions are similar to normal load functions, except that getSession() will not wait for the parent load function.

-export const load = async ({ parent }) => {
-    const { lucia } = await parent()
-}

+export const load = auth.handleServerLoad( async ({ getSession }) => {
+    const session = await getSession()
+}

Set cookies

With the recent changes to SvelteKit, cookies can only be set with cookies instead of setHeaders in actions.

-export const POST = async ({ setHeaders }) => {
-    const userSession = await auth.createUser()
-    setHeaders("set-cookie", userSession.cookies.join())
-}

+import { setCookie } from "lucia-sveltekit"

+export const actions = {
+    default: async ({ cookies }) => {
+        const userSession = await auth.createUser()
+        setCookie(cookies, ...userSession.cookies)
+    }
+}

Client

No more wrapper component!

-<Lucia>
-    <slot/>
-</Lucia>

Silent refresh

Only needed in the root layout component (no onMount() needed!).

handleSilentRefresh()

Get session store

Unlike before, getSession() doesn't have to called inside the wrapper component.

import { getSession } from "lucia-sveltekit/load"

const session = getSession()

Other small changes are listed in the changelog.