From f810ffde073ac2077de0d22b4cb39e3b15cccd37 Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Fri, 18 Aug 2023 13:38:46 +0100 Subject: [PATCH 1/7] Improve session helper docs --- README.md | 34 ++--- ...ssion_get_access_token.GetAccessToken.html | 27 +++- .../types/session_get_session.GetSession.html | 29 +++- .../session_touch_session.TouchSession.html | 27 +++- .../session_update_session.UpdateSession.html | 26 +++- src/session/get-access-token.ts | 110 ++++++++++++++- src/session/get-session.ts | 108 ++++++++++++++- src/session/touch-session.ts | 103 +++++++++++++- src/session/update-session.ts | 127 +++++++++++++++++- 9 files changed, 553 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 5c4908c46..411ec7e79 100644 --- a/README.md +++ b/README.md @@ -249,33 +249,33 @@ For other comprehensive examples, see the [EXAMPLES.md](https://github.com/auth0 `import * from @auth0/nextjs-auth0/edge` -- [Configuration Options and Environment variables](https://auth0.github.io/nextjs-auth0/modules/config.html) -- [initAuth0](https://auth0.github.io/nextjs-auth0/modules/index.html#initauth0) -- [handleAuth](https://auth0.github.io/nextjs-auth0/modules/handlers_auth.html) -- [handleLogin](https://auth0.github.io/nextjs-auth0/modules/handlers_login.html#handlelogin) -- [handleCallback](https://auth0.github.io/nextjs-auth0/modules/handlers_callback.html) -- [handleLogout](https://auth0.github.io/nextjs-auth0/modules/handlers_logout.html) -- [handleProfile](https://auth0.github.io/nextjs-auth0/modules/handlers_profile.html) -- [withApiAuthRequired](https://auth0.github.io/nextjs-auth0/modules/helpers_with_api_auth_required.html) -- [withPageAuthRequired](https://auth0.github.io/nextjs-auth0/modules/helpers_with_page_auth_required.html#withpageauthrequired) -- [getSession](https://auth0.github.io/nextjs-auth0/modules/session_get_session.html) -- [updateSession](https://auth0.github.io/nextjs-auth0/modules/session_update_session.html) -- [getAccessToken](https://auth0.github.io/nextjs-auth0/modules/session_get_access_token.html) -- [withMiddlewareAuthRequired](https://auth0.github.io/nextjs-auth0/modules/helpers_with_middleware_auth_required.html) (Edge only) +- [Configuration Options and Environment variables](https://auth0.github.io/nextjs-auth0/types/config.ConfigParameters.html) +- [initAuth0](https://auth0.github.io/nextjs-auth0/types/init.InitAuth0.html) +- [handleAuth](https://auth0.github.io/nextjs-auth0/types/handlers_auth.HandleAuth.html) +- [handleLogin](https://auth0.github.io/nextjs-auth0/types/handlers_login.HandleLogin.html) +- [handleCallback](https://auth0.github.io/nextjs-auth0/types/handlers_callback.HandleCallback.html) +- [handleLogout](https://auth0.github.io/nextjs-auth0/types/handlers_logout.HandleLogout.html) +- [handleProfile](https://auth0.github.io/nextjs-auth0/types/handlers_profile.HandleProfile.html) +- [withApiAuthRequired](https://auth0.github.io/nextjs-auth0/types/helpers_with_api_auth_required.WithApiAuthRequired.html) +- [withPageAuthRequired](https://auth0.github.io/nextjs-auth0/types/helpers_with_page_auth_required.WithPageAuthRequired.html) +- [getSession](https://auth0.github.io/nextjs-auth0/types/session_get_session.GetSession.html) +- [updateSession](https://auth0.github.io/nextjs-auth0/types/session_update_session.UpdateSession.html) +- [getAccessToken](https://auth0.github.io/nextjs-auth0/types/session_get_access_token.GetAccessToken.html) +- [withMiddlewareAuthRequired](https://auth0.github.io/nextjs-auth0/types/helpers_with_middleware_auth_required.WithMiddlewareAuthRequired.html) (Edge only) ### Client (for the Browser) `import * from @auth0/nextjs-auth0/client` -- [UserProvider](https://auth0.github.io/nextjs-auth0/modules/client_use_user.html#userprovider) -- [useUser](https://auth0.github.io/nextjs-auth0/modules/client_use_user.html) -- [withPageAuthRequired](https://auth0.github.io/nextjs-auth0/modules/client_with_page_auth_required.html) +- [UserProvider](https://auth0.github.io/nextjs-auth0/types/client_use_user.UserProvider.html) +- [useUser](https://auth0.github.io/nextjs-auth0/functions/client_use_user.useUser.html) +- [withPageAuthRequired](https://auth0.github.io/nextjs-auth0/types/client_with_page_auth_required.WithPageAuthRequired.html) ### Testing helpers `import * from @auth0/nextjs-auth0/testing` -- [generateSessionCookie](https://auth0.github.io/nextjs-auth0/modules/helpers_testing.html#generatesessioncookie) +- [generateSessionCookie](https://auth0.github.io/nextjs-auth0/types/helpers_testing.GenerateSessionCookieConfig.html) Visit the auto-generated [API Docs](https://auth0.github.io/nextjs-auth0/) for more details diff --git a/docs/types/session_get_access_token.GetAccessToken.html b/docs/types/session_get_access_token.GetAccessToken.html index 0a9a4b526..0bd54900e 100644 --- a/docs/types/session_get_access_token.GetAccessToken.html +++ b/docs/types/session_get_access_token.GetAccessToken.html @@ -24,7 +24,30 @@

Type declaration

+
  • Defined in session/get-access-token.ts:217
    • diff --git a/docs/types/session_get_session.GetSession.html b/docs/types/session_get_session.GetSession.html index 34208edbc..04c078354 100644 --- a/docs/types/session_get_session.GetSession.html +++ b/docs/types/session_get_session.GetSession.html @@ -24,7 +24,32 @@

    Type declaration

    • (...args): Promise<default | null | undefined>
    • -

      Get the user's session from the request.

      +

      Get the user's session from the server.

      +

      In the App Router:

      +

      In a route handler:

      +
      // app/my-api/route.js
      import { getSession } from '@auth0/nextjs-auth0';

      export async function GET() {
        const { user } = await getSession();
        return NextResponse.json({ foo: 'bar' });
      }

      // Or, it's slightly more efficient to use the `req`, `res` args if you're
      // using with another part of the SDK like `withApiAuthRequired` or `getAccessToken`
      import { getSession, withApiAuthRequired } from '@auth0/nextjs-auth0';

      const GET = withApiAuthRequired(async function GET(req) {
        const res = new NextResponse();
        const { user } = await getSession(req, res);
        return NextResponse.json({ foo: 'bar' }, res);
      })

      export { GET }
+
      +

      In a page or React Server Component:

      +
      // app/my-page/page.js
      import { getSession } from '@auth0/nextjs-auth0';

      export default async function MyPage({ params, searchParams }) {
        const { user } = await getSession();
        return <h1>My Page</h1>
      }
+
      +

      Note: You can't write to the cookie in a React Server Component, so updates +to the session like setting the expiry of the rolling session won't be persisted. +For this we recommend touching the session in the middleware using getSession or +withMiddlewareAuthRequired.

      +

      You can also get the session in a page or route in the Edge Runtime:

      +
      // app/my-api/route.js
      import { getSession } from '@auth0/nextjs-auth0/edge';

      export default async function MyPage({ params, searchParams }) {
        const { user } = await getSession();
        return <h1>My Page</h1>
      }

      export const runtime = 'edge'
+
      +

      Note: The Edge runtime features are only supported in the App Router.

      +

      In the Page Router:

      +

      In an api handler:

      +
      // pages/api/my-api.js
      import { getSession } from '@auth0/nextjs-auth0';

      export default async function MyApi(req, res) {
        const { user } = await getSession(req, res);
        res.status(200).json({ name: user.name })
      }
+
      +

      In a page:

      +
      // pages/my-page.js
      import { getSession } from '@auth0/nextjs-auth0';

      export default function About() {
        return <div>About</div>
      }

      export async function getServerSideProps(ctx) {
        const { user } = await getSession(ctx.req, ctx.res);

        return { props: { foo: 'bar' } }
      }
+
      +

      In middleware:

      +
      import { NextResponse } from 'next/server';
      import { getSession } from '@auth0/nextjs-auth0/edge';

      export async function middleware(req) {
        const res = new NextResponse();
        const { user } = await getSession(req, res);
        return NextResponse.redirect(new URL('/bar', request.url), res);
      }

      export const config = {
        matcher: '/foo',
      }

      @category Server
+

      Parameters

      @@ -34,7 +59,7 @@
      Rest Returns Promise<default | null | undefined>
    +
  • Defined in session/get-session.ts:117
    • diff --git a/docs/types/session_touch_session.TouchSession.html b/docs/types/session_touch_session.TouchSession.html index 7e80bd503..2b8e0e2c3 100644 --- a/docs/types/session_touch_session.TouchSession.html +++ b/docs/types/session_touch_session.TouchSession.html @@ -26,7 +26,30 @@

    Type declaration

  • Touch the session object. If rolling sessions are enabled and autoSave is disabled, you will need to call this method to update the session expiry.

    -
    // pages/api/graphql.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export default async function graphql(req, res) {
      await touchSession(req, res);

     // ...
    };
+
    In the App Router:
    
+
    In a route handler:
    
+
    // app/my-api/route.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export async function GET() {
      await touchSession();
      return NextResponse.json({ foo: 'bar' });
    }

    // Or, it's slightly more efficient to use the `req`, `res` args if you're
    // using with another part of the SDK like `withApiAuthRequired` or `getSession`
    import { touchSession, withApiAuthRequired } from '@auth0/nextjs-auth0';

    const GET = withApiAuthRequired(async function GET(req) {
      const res = new NextResponse();
      await touchSession(req, res);
      return NextResponse.json({ foo: 'bar' }, res);
    })

    export { GET }
+
    
+
    In a page or React Server Component:
    
+
    // app/my-page/page.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export default async function MyPage({ params, searchParams }) {
      await touchSession();
      return <h1>My Page</h1>
    }
+
    
+
    Note: You can't write to the cookie in a React Server Component, so updates
+to the session like setting the expiry of the rolling session won't be persisted.
+For this we recommend touching the session in the middleware using touchSession or
+withMiddlewareAuthRequired.
    
+
    You can also touch the session in a page or route in the Edge Runtime:
    
+
    // app/my-api/route.js
    import { getSession } from '@auth0/nextjs-auth0/edge';

    export default async function MyPage({ params, searchParams }) {
      await touchSession();
      return <h1>My Page</h1>
    }

    export const runtime = 'edge'
+
    
+
    Note: The Edge runtime features are only supported in the App Router.
    
+
    In the Page Router:
    
+
    In an api handler:
    
+
    // pages/api/my-api.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export default async function MyApi(req, res) {
      await touchSession(req, res);
      res.status(200).json({ name: user.name })
    }
+
    
+
    In a page:
    
+
    // pages/my-page.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export default function About() {
      return <div>About</div>
    }

    export async function getServerSideProps(ctx) {
      await touchSession(ctx.req, ctx.res);

      return { props: { foo: 'bar' } }
    }
+
    
+
    In middleware:
    
+
    import { NextResponse } from 'next/server';
    import { touchSession } from '@auth0/nextjs-auth0/edge';

    export async function middleware(req) {
      const res = new NextResponse();
      await touchSession(req, res);
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    export const config = {
      matcher: '/foo',
    }

    @category Server
    @@ -37,7 +60,7 @@
    Rest Returns Promise<void>
    • +
  • Defined in session/touch-session.ts:118
    • diff --git a/docs/types/session_update_session.UpdateSession.html b/docs/types/session_update_session.UpdateSession.html index a5f5206b0..e3510ca9e 100644 --- a/docs/types/session_update_session.UpdateSession.html +++ b/docs/types/session_update_session.UpdateSession.html @@ -27,7 +27,29 @@

    Type declaration

    Update the session object. The provided session object will replace the existing session.

    Note you can't use this method to login or logout - you should use the login and logout handlers for this. If no session is provided, it doesn't contain a user or the user is not authenticated; this is a no-op.

    -
    // pages/api/update-user.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default async function updateSession(req, res) {
      if (req.method === 'PUT') {
        const session = await getSession(req, res);
        updateSession(req, res, { ...session, user: { ...session.user, foo: req.query.foo } });
        res.json({ success: true });
      }
    };
+
    In the App Router:
    
+
    In a route handler:
    
+
    // app/my-api/route.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export async function GET() {
      const { user } = await getSession();
      await updateSession({ ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.json({ foo: 'bar' });
    }

    // Or, it's slightly more efficient to use the `req`, `res` args if you're
    // using with another part of the SDK like `withApiAuthRequired` or `getSession`
    import { getSession, updateSession, withApiAuthRequired } from '@auth0/nextjs-auth0';

    const GET = withApiAuthRequired(async function GET(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.json({ foo: 'bar' }, res);
    })

    export { GET }
+
    
+
    In a Server Action in a page or React Server Component:
    
+
    // app/my-page/page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default async function Page() {
      async function updateUser(updates) {
        'use server'
        const { user } = await getSession();
        await updateSession(req, res, { ...session, user: { ...session.user, ...updates }});
      }
      return (
        <form action={updateUser}>
          <button type="submit">Update User</button>
        </form>
      )
    }
+
    
+
    Note: You can't write to the cookie in a React Server Component, so updates
+to the session would need to happen in a Server Action.
+More info on Server Actions https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions
    
+
    You can also update the session in a page or route in the Edge Runtime:
    
+
    // app/my-page/page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0/edge';

    export default async function Page() {
      async function updateUser(updates) {
        'use server'
        const { user } = await getSession();
        await updateSession(req, res, { ...session, user: { ...session.user, ...updates }});
      }
      return (
        <form action={updateUser}>
          <button type="submit">Update User</button>
        </form>
      )
    }
    export const runtime = 'edge'
+
    
+
    Note: The Edge runtime features are only supported in the App Router.
    
+
    In the Page Router:
    
+
    In an api handler:
    
+
    // pages/api/my-api.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default async function MyApi(req, res) {
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      res.status(200).json({ name: user.name });
    }
+
    
+
    In a page:
    
+
    // pages/my-page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default function About() {
      return <div>About</div>
    }

    export async function getServerSideProps(ctx) {
      const { user } = await getSession(ctx.req, ctx.res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});

      return { props: { foo: 'bar' } }
    }
+
    
+
    In middleware:
    
+
    import { NextResponse } from 'next/server';
    import { getSession, updateSession } from '@auth0/nextjs-auth0/edge';

    export async function middleware(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    // See "Matching Paths" below to learn more
    export const config = {
      matcher: '/foo',
    }

    @category Server
    @@ -38,7 +60,7 @@
    Rest Returns Promise<void>
    +
  • Defined in session/update-session.ts:140
    • diff --git a/src/session/get-access-token.ts b/src/session/get-access-token.ts index a25c85d96..7a72a6758 100644 --- a/src/session/get-access-token.ts +++ b/src/session/get-access-token.ts @@ -100,7 +100,115 @@ export interface GetAccessTokenResult { } /** - * Get an access token to access an external API. + * Get an access token to access an external API from the server. + * + * **In the App Router:** + * + * In a route handler: + * + * ```js + * // app/my-api/route.js + * import { NextResponse } from 'next/server'; + * import { getAccessToken } from '@auth0/nextjs-auth0'; + * + * export async function GET() { + * const { accessToken } = await getAccessToken(); + * return NextResponse.json({ foo: 'bar' }); + * } + * + * // Or, it's slightly more efficient to use the `req`, `res` args if you're + * // using with another part of the SDK like `withApiAuthRequired` or `getSession` + * import { NextResponse } from 'next/server'; + * import { getAccessToken, withApiAuthRequired } from '@auth0/nextjs-auth0'; + * + * const GET = withApiAuthRequired(async function GET(req) { + * const res = new NextResponse(); + * const { accessToken } = await getAccessToken(req, res); + * return NextResponse.json({ foo: 'bar' }, res); + * }) + * + * export { GET } + * ``` + * + * In a page or React Server Component: + * + * ```js + * // app/my-page/page.js + * import { getAccessToken } from '@auth0/nextjs-auth0'; + * + * export default async function MyPage({ params, searchParams }) { + * const { accessToken } = await getAccessToken(); + * return

    My Page

    + * } + * ``` + * + * **Note:** You can't write to the cookie in a React Server Component, so if + * the Access Token is refreshed, it won't be persisted in the session. + * + * You can also get the access token in a page or route in the Edge Runtime: + * + * ```js + * // app/my-api/route.js + * import { NextResponse } from 'next/server'; + * import { getAccessToken } from '@auth0/nextjs-auth0/edge'; + * + * export async function GET() { + * const { accessToken } = await getAccessToken(); + * return NextResponse.json({ foo: 'bar' }); + * } + * + * export const runtime = 'edge' + * ``` + * + * **Note:** The Edge runtime features are only supported in the App Router. + * + * **In the Page Router:** + * + * In an api handler: + * + * ```js + * // pages/api/my-api.js + * import { getAccessToken } from '@auth0/nextjs-auth0'; + * + * export default async function MyApi(req, res) { + * const { accessToken } = await getAccessToken(req, res); + * res.status(200).json({ name: 'John Doe' }) + * } + * ``` + * + * In a page: + * + * ```js + * // pages/my-page.js + * import { getAccessToken } from '@auth0/nextjs-auth0'; + * + * export default function About() { + * return
    About
    + * } + * + * export async function getServerSideProps(ctx) { + * const { accessToken } = await getAccessToken(ctx.req, ctx.res); + * + * return { props: { foo: 'bar' } } + * } + * ``` + * + * **In middleware:** + * + * ```js + * import { NextResponse } from 'next/server'; + * import { getAccessToken } from '@auth0/nextjs-auth0/edge'; + * + * export async function middleware(req) { + * const res = new NextResponse(); + * const { accessToken } = await getAccessToken(req, res); + * return NextResponse.redirect(new URL('/bar', request.url), res); + * } + * + * export const config = { + * matcher: '/foo', + * } + * ``` * * @throws {@link AccessTokenError} * diff --git a/src/session/get-session.ts b/src/session/get-session.ts index 05e98d7ea..3b80a409c 100644 --- a/src/session/get-session.ts +++ b/src/session/get-session.ts @@ -4,7 +4,113 @@ import { NextRequest, NextResponse } from 'next/server'; import { SessionCache, Session, get } from '../session'; /** - * Get the user's session from the request. + * Get the user's session from the server. + * + * **In the App Router:** + * + * In a route handler: + * + * ```js + * // app/my-api/route.js + * import { getSession } from '@auth0/nextjs-auth0'; + * + * export async function GET() { + * const { user } = await getSession(); + * return NextResponse.json({ foo: 'bar' }); + * } + * + * // Or, it's slightly more efficient to use the `req`, `res` args if you're + * // using with another part of the SDK like `withApiAuthRequired` or `getAccessToken` + * import { getSession, withApiAuthRequired } from '@auth0/nextjs-auth0'; + * + * const GET = withApiAuthRequired(async function GET(req) { + * const res = new NextResponse(); + * const { user } = await getSession(req, res); + * return NextResponse.json({ foo: 'bar' }, res); + * }) + * + * export { GET } + * ``` + * + * In a page or React Server Component: + * + * ```js + * // app/my-page/page.js + * import { getSession } from '@auth0/nextjs-auth0'; + * + * export default async function MyPage({ params, searchParams }) { + * const { user } = await getSession(); + * return

    My Page

    + * } + * ``` + * + * **Note:** You can't write to the cookie in a React Server Component, so updates + * to the session like setting the expiry of the rolling session won't be persisted. + * For this we recommend touching the session in the middleware using `getSession` or + * `withMiddlewareAuthRequired`. + * + * You can also get the session in a page or route in the Edge Runtime: + * + * ```js + * // app/my-api/route.js + * import { getSession } from '@auth0/nextjs-auth0/edge'; + * + * export default async function MyPage({ params, searchParams }) { + * const { user } = await getSession(); + * return

    My Page

    + * } + * + * export const runtime = 'edge' + * ``` + * + * **Note:** The Edge runtime features are only supported in the App Router. + * + * **In the Page Router:** + * + * In an api handler: + * + * ```js + * // pages/api/my-api.js + * import { getSession } from '@auth0/nextjs-auth0'; + * + * export default async function MyApi(req, res) { + * const { user } = await getSession(req, res); + * res.status(200).json({ name: user.name }) + * } + * ``` + * + * In a page: + * + * ```js + * // pages/my-page.js + * import { getSession } from '@auth0/nextjs-auth0'; + * + * export default function About() { + * return
    About
    + * } + * + * export async function getServerSideProps(ctx) { + * const { user } = await getSession(ctx.req, ctx.res); + * + * return { props: { foo: 'bar' } } + * } + * ``` + * + * **In middleware:** + * + * ```js + * import { NextResponse } from 'next/server'; + * import { getSession } from '@auth0/nextjs-auth0/edge'; + * + * export async function middleware(req) { + * const res = new NextResponse(); + * const { user } = await getSession(req, res); + * return NextResponse.redirect(new URL('/bar', request.url), res); + * } + * + * export const config = { + * matcher: '/foo', + * } * * @category Server */ diff --git a/src/session/touch-session.ts b/src/session/touch-session.ts index 06192b05c..53029b191 100644 --- a/src/session/touch-session.ts +++ b/src/session/touch-session.ts @@ -7,17 +7,112 @@ import { get, set, SessionCache } from '../session'; * Touch the session object. If rolling sessions are enabled and autoSave is disabled, you will need * to call this method to update the session expiry. * + * **In the App Router:** + * + * In a route handler: + * + * ```js + * // app/my-api/route.js + * import { touchSession } from '@auth0/nextjs-auth0'; + * + * export async function GET() { + * await touchSession(); + * return NextResponse.json({ foo: 'bar' }); + * } + * + * // Or, it's slightly more efficient to use the `req`, `res` args if you're + * // using with another part of the SDK like `withApiAuthRequired` or `getSession` + * import { touchSession, withApiAuthRequired } from '@auth0/nextjs-auth0'; + * + * const GET = withApiAuthRequired(async function GET(req) { + * const res = new NextResponse(); + * await touchSession(req, res); + * return NextResponse.json({ foo: 'bar' }, res); + * }) + * + * export { GET } + * ``` + * + * In a page or React Server Component: + * + * ```js + * // app/my-page/page.js + * import { touchSession } from '@auth0/nextjs-auth0'; + * + * export default async function MyPage({ params, searchParams }) { + * await touchSession(); + * return

    My Page

    + * } + * ``` + * + * **Note:** You can't write to the cookie in a React Server Component, so updates + * to the session like setting the expiry of the rolling session won't be persisted. + * For this we recommend touching the session in the middleware using `touchSession` or + * `withMiddlewareAuthRequired`. + * + * You can also touch the session in a page or route in the Edge Runtime: + * + * ```js + * // app/my-api/route.js + * import { getSession } from '@auth0/nextjs-auth0/edge'; + * + * export default async function MyPage({ params, searchParams }) { + * await touchSession(); + * return

    My Page

    + * } + * + * export const runtime = 'edge' + * ``` + * + * **Note:** The Edge runtime features are only supported in the App Router. + * + * **In the Page Router:** + * + * In an api handler: + * * ```js - * // pages/api/graphql.js + * // pages/api/my-api.js * import { touchSession } from '@auth0/nextjs-auth0'; * - * export default async function graphql(req, res) { + * export default async function MyApi(req, res) { * await touchSession(req, res); + * res.status(200).json({ name: user.name }) + * } + * ``` + * + * In a page: + * + * ```js + * // pages/my-page.js + * import { touchSession } from '@auth0/nextjs-auth0'; + * + * export default function About() { + * return
    About
    + * } * - * // ... - * }; + * export async function getServerSideProps(ctx) { + * await touchSession(ctx.req, ctx.res); + * + * return { props: { foo: 'bar' } } + * } * ``` * + * **In middleware:** + * + * ```js + * import { NextResponse } from 'next/server'; + * import { touchSession } from '@auth0/nextjs-auth0/edge'; + * + * export async function middleware(req) { + * const res = new NextResponse(); + * await touchSession(req, res); + * return NextResponse.redirect(new URL('/bar', request.url), res); + * } + * + * export const config = { + * matcher: '/foo', + * } + * * @category Server */ export type TouchSession = ( diff --git a/src/session/update-session.ts b/src/session/update-session.ts index 99d19b0ad..ed94b33d4 100644 --- a/src/session/update-session.ts +++ b/src/session/update-session.ts @@ -9,19 +9,132 @@ import { get, set, Session, SessionCache } from '../session'; * **Note** you can't use this method to login or logout - you should use the login and logout handlers for this. * If no session is provided, it doesn't contain a user or the user is not authenticated; this is a no-op. * + * **In the App Router:** + * + * In a route handler: + * + * ```js + * // app/my-api/route.js + * import { getSession, updateSession } from '@auth0/nextjs-auth0'; + * + * export async function GET() { + * const { user } = await getSession(); + * await updateSession({ ...session, user: { ...session.user, foo: 'bar' }}); + * return NextResponse.json({ foo: 'bar' }); + * } + * + * // Or, it's slightly more efficient to use the `req`, `res` args if you're + * // using with another part of the SDK like `withApiAuthRequired` or `getSession` + * import { getSession, updateSession, withApiAuthRequired } from '@auth0/nextjs-auth0'; + * + * const GET = withApiAuthRequired(async function GET(req) { + * const res = new NextResponse(); + * const { user } = await getSession(req, res); + * await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }}); + * return NextResponse.json({ foo: 'bar' }, res); + * }) + * + * export { GET } + * ``` + * + * In a Server Action in a page or React Server Component: + * * ```js - * // pages/api/update-user.js + * // app/my-page/page.js * import { getSession, updateSession } from '@auth0/nextjs-auth0'; * - * export default async function updateSession(req, res) { - * if (req.method === 'PUT') { - * const session = await getSession(req, res); - * updateSession(req, res, { ...session, user: { ...session.user, foo: req.query.foo } }); - * res.json({ success: true }); + * export default async function Page() { + * async function updateUser(updates) { + * 'use server' + * const { user } = await getSession(); + * await updateSession(req, res, { ...session, user: { ...session.user, ...updates }}); + * } + * return ( + *
    + * + *
    + * ) + * } + * ``` + * + * **Note:** You can't write to the cookie in a React Server Component, so updates + * to the session would need to happen in a Server Action. + * More info on Server Actions https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions + * + * You can also update the session in a page or route in the Edge Runtime: + * + * ```js + * // app/my-page/page.js + * import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; + * + * export default async function Page() { + * async function updateUser(updates) { + * 'use server' + * const { user } = await getSession(); + * await updateSession(req, res, { ...session, user: { ...session.user, ...updates }}); * } - * }; + * return ( + *
    + * + *
    + * ) + * } + * export const runtime = 'edge' * ``` * + * **Note:** The Edge runtime features are only supported in the App Router. + * + * **In the Page Router:** + * + * In an api handler: + * + * ```js + * // pages/api/my-api.js + * import { getSession, updateSession } from '@auth0/nextjs-auth0'; + * + * export default async function MyApi(req, res) { + * const { user } = await getSession(req, res); + * await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }}); + * res.status(200).json({ name: user.name }); + * } + * ``` + * + * In a page: + * + * ```js + * // pages/my-page.js + * import { getSession, updateSession } from '@auth0/nextjs-auth0'; + * + * export default function About() { + * return
    About
    + * } + * + * export async function getServerSideProps(ctx) { + * const { user } = await getSession(ctx.req, ctx.res); + * await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }}); + * + * return { props: { foo: 'bar' } } + * } + * ``` + * + * **In middleware:** + * + * ```js + * import { NextResponse } from 'next/server'; + * import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; + * + * export async function middleware(req) { + * const res = new NextResponse(); + * const { user } = await getSession(req, res); + * await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }}); + * return NextResponse.redirect(new URL('/bar', request.url), res); + * } + * + * // See "Matching Paths" below to learn more + * export const config = { + * matcher: '/foo', + * } + * * @category Server */ export type UpdateSession = ( From d6b6e9a7c13cc023ffb9963f6d64c0e618073179 Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Fri, 18 Aug 2023 14:54:59 +0100 Subject: [PATCH 2/7] Apply suggestions from code review Co-authored-by: Rita Zerrizuela --- src/session/get-access-token.ts | 28 ++++++++++++++-------------- src/session/get-session.ts | 29 ++++++++++++++--------------- src/session/touch-session.ts | 29 ++++++++++++++--------------- src/session/update-session.ts | 12 ++++++------ 4 files changed, 48 insertions(+), 50 deletions(-) diff --git a/src/session/get-access-token.ts b/src/session/get-access-token.ts index 7a72a6758..5cc65f9c3 100644 --- a/src/session/get-access-token.ts +++ b/src/session/get-access-token.ts @@ -117,7 +117,7 @@ export interface GetAccessTokenResult { * } * * // Or, it's slightly more efficient to use the `req`, `res` args if you're - * // using with another part of the SDK like `withApiAuthRequired` or `getSession` + * // using another part of the SDK like `withApiAuthRequired` or `getSession`. * import { NextResponse } from 'next/server'; * import { getAccessToken, withApiAuthRequired } from '@auth0/nextjs-auth0'; * @@ -125,9 +125,9 @@ export interface GetAccessTokenResult { * const res = new NextResponse(); * const { accessToken } = await getAccessToken(req, res); * return NextResponse.json({ foo: 'bar' }, res); - * }) + * }); * - * export { GET } + * export { GET }; * ``` * * In a page or React Server Component: @@ -138,33 +138,33 @@ export interface GetAccessTokenResult { * * export default async function MyPage({ params, searchParams }) { * const { accessToken } = await getAccessToken(); - * return

    My Page

    + * return

    My Page

    ; * } * ``` * * **Note:** You can't write to the cookie in a React Server Component, so if - * the Access Token is refreshed, it won't be persisted in the session. + * the access token is refreshed, it won't be persisted in the session. * * You can also get the access token in a page or route in the Edge Runtime: * * ```js * // app/my-api/route.js * import { NextResponse } from 'next/server'; - * import { getAccessToken } from '@auth0/nextjs-auth0/edge'; + * import { getAccessToken } from '@auth0/nextjs-auth0/edge'; // Note the /edge import * * export async function GET() { * const { accessToken } = await getAccessToken(); * return NextResponse.json({ foo: 'bar' }); * } * - * export const runtime = 'edge' + * export const runtime = 'edge'; * ``` * * **Note:** The Edge runtime features are only supported in the App Router. * * **In the Page Router:** * - * In an api handler: + * In an API handler: * * ```js * // pages/api/my-api.js @@ -172,7 +172,7 @@ export interface GetAccessTokenResult { * * export default async function MyApi(req, res) { * const { accessToken } = await getAccessToken(req, res); - * res.status(200).json({ name: 'John Doe' }) + * res.status(200).json({ name: 'John Doe' }); * } * ``` * @@ -183,13 +183,12 @@ export interface GetAccessTokenResult { * import { getAccessToken } from '@auth0/nextjs-auth0'; * * export default function About() { - * return
    About
    + * return
    About
    ; * } * * export async function getServerSideProps(ctx) { * const { accessToken } = await getAccessToken(ctx.req, ctx.res); - * - * return { props: { foo: 'bar' } } + * return { props: { foo: 'bar' } }; * } * ``` * @@ -197,7 +196,8 @@ export interface GetAccessTokenResult { * * ```js * import { NextResponse } from 'next/server'; - * import { getAccessToken } from '@auth0/nextjs-auth0/edge'; + * import { getAccessToken } from '@auth0/nextjs-auth0/edge'; // Note the /edge import + * * export async function middleware(req) { * const res = new NextResponse(); @@ -207,7 +207,7 @@ export interface GetAccessTokenResult { * * export const config = { * matcher: '/foo', - * } + * }; * ``` * * @throws {@link AccessTokenError} diff --git a/src/session/get-session.ts b/src/session/get-session.ts index 3b80a409c..3049e51b8 100644 --- a/src/session/get-session.ts +++ b/src/session/get-session.ts @@ -20,16 +20,16 @@ import { SessionCache, Session, get } from '../session'; * } * * // Or, it's slightly more efficient to use the `req`, `res` args if you're - * // using with another part of the SDK like `withApiAuthRequired` or `getAccessToken` + * // using another part of the SDK like `withApiAuthRequired` or `getAccessToken`. * import { getSession, withApiAuthRequired } from '@auth0/nextjs-auth0'; * * const GET = withApiAuthRequired(async function GET(req) { * const res = new NextResponse(); * const { user } = await getSession(req, res); * return NextResponse.json({ foo: 'bar' }, res); - * }) + * }); * - * export { GET } + * export { GET }; * ``` * * In a page or React Server Component: @@ -40,34 +40,34 @@ import { SessionCache, Session, get } from '../session'; * * export default async function MyPage({ params, searchParams }) { * const { user } = await getSession(); - * return

    My Page

    + * return

    My Page

    ; * } * ``` * * **Note:** You can't write to the cookie in a React Server Component, so updates * to the session like setting the expiry of the rolling session won't be persisted. - * For this we recommend touching the session in the middleware using `getSession` or + * For this, we recommend touching the session in the middleware using `getSession` or * `withMiddlewareAuthRequired`. * * You can also get the session in a page or route in the Edge Runtime: * * ```js * // app/my-api/route.js - * import { getSession } from '@auth0/nextjs-auth0/edge'; + * import { getSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import * * export default async function MyPage({ params, searchParams }) { * const { user } = await getSession(); - * return

    My Page

    + * return

    My Page

    ; * } * - * export const runtime = 'edge' + * export const runtime = 'edge'; * ``` * * **Note:** The Edge runtime features are only supported in the App Router. * * **In the Page Router:** * - * In an api handler: + * In an API handler: * * ```js * // pages/api/my-api.js @@ -75,7 +75,7 @@ import { SessionCache, Session, get } from '../session'; * * export default async function MyApi(req, res) { * const { user } = await getSession(req, res); - * res.status(200).json({ name: user.name }) + * res.status(200).json({ name: user.name }); * } * ``` * @@ -86,13 +86,12 @@ import { SessionCache, Session, get } from '../session'; * import { getSession } from '@auth0/nextjs-auth0'; * * export default function About() { - * return
    About
    + * return
    About
    ; * } * * export async function getServerSideProps(ctx) { * const { user } = await getSession(ctx.req, ctx.res); - * - * return { props: { foo: 'bar' } } + * return { props: { foo: 'bar' } }; * } * ``` * @@ -100,7 +99,7 @@ import { SessionCache, Session, get } from '../session'; * * ```js * import { NextResponse } from 'next/server'; - * import { getSession } from '@auth0/nextjs-auth0/edge'; + * import { getSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import * * export async function middleware(req) { * const res = new NextResponse(); @@ -110,7 +109,7 @@ import { SessionCache, Session, get } from '../session'; * * export const config = { * matcher: '/foo', - * } + * }; * * @category Server */ diff --git a/src/session/touch-session.ts b/src/session/touch-session.ts index 53029b191..5ab8ac705 100644 --- a/src/session/touch-session.ts +++ b/src/session/touch-session.ts @@ -21,16 +21,16 @@ import { get, set, SessionCache } from '../session'; * } * * // Or, it's slightly more efficient to use the `req`, `res` args if you're - * // using with another part of the SDK like `withApiAuthRequired` or `getSession` + * // using another part of the SDK like `withApiAuthRequired` or `getSession`. * import { touchSession, withApiAuthRequired } from '@auth0/nextjs-auth0'; * * const GET = withApiAuthRequired(async function GET(req) { * const res = new NextResponse(); * await touchSession(req, res); * return NextResponse.json({ foo: 'bar' }, res); - * }) + * }); * - * export { GET } + * export { GET }; * ``` * * In a page or React Server Component: @@ -41,34 +41,34 @@ import { get, set, SessionCache } from '../session'; * * export default async function MyPage({ params, searchParams }) { * await touchSession(); - * return

    My Page

    + * return

    My Page

    ; * } * ``` * * **Note:** You can't write to the cookie in a React Server Component, so updates * to the session like setting the expiry of the rolling session won't be persisted. - * For this we recommend touching the session in the middleware using `touchSession` or + * For this, we recommend touching the session in the middleware using `touchSession` or * `withMiddlewareAuthRequired`. * * You can also touch the session in a page or route in the Edge Runtime: * * ```js * // app/my-api/route.js - * import { getSession } from '@auth0/nextjs-auth0/edge'; + * import { getSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import * * export default async function MyPage({ params, searchParams }) { * await touchSession(); - * return

    My Page

    + * return

    My Page

    ; * } * - * export const runtime = 'edge' + * export const runtime = 'edge'; * ``` * * **Note:** The Edge runtime features are only supported in the App Router. * * **In the Page Router:** * - * In an api handler: + * In an API handler: * * ```js * // pages/api/my-api.js @@ -76,7 +76,7 @@ import { get, set, SessionCache } from '../session'; * * export default async function MyApi(req, res) { * await touchSession(req, res); - * res.status(200).json({ name: user.name }) + * res.status(200).json({ name: user.name }); * } * ``` * @@ -87,13 +87,12 @@ import { get, set, SessionCache } from '../session'; * import { touchSession } from '@auth0/nextjs-auth0'; * * export default function About() { - * return
    About
    + * return
    About
    ; * } * * export async function getServerSideProps(ctx) { * await touchSession(ctx.req, ctx.res); - * - * return { props: { foo: 'bar' } } + * return { props: { foo: 'bar' } }; * } * ``` * @@ -101,7 +100,7 @@ import { get, set, SessionCache } from '../session'; * * ```js * import { NextResponse } from 'next/server'; - * import { touchSession } from '@auth0/nextjs-auth0/edge'; + * import { touchSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import * * export async function middleware(req) { * const res = new NextResponse(); @@ -111,7 +110,7 @@ import { get, set, SessionCache } from '../session'; * * export const config = { * matcher: '/foo', - * } + * }; * * @category Server */ diff --git a/src/session/update-session.ts b/src/session/update-session.ts index ed94b33d4..177776599 100644 --- a/src/session/update-session.ts +++ b/src/session/update-session.ts @@ -24,7 +24,7 @@ import { get, set, Session, SessionCache } from '../session'; * } * * // Or, it's slightly more efficient to use the `req`, `res` args if you're - * // using with another part of the SDK like `withApiAuthRequired` or `getSession` + * // using another part of the SDK like `withApiAuthRequired` or `getSession`. * import { getSession, updateSession, withApiAuthRequired } from '@auth0/nextjs-auth0'; * * const GET = withApiAuthRequired(async function GET(req) { @@ -32,9 +32,9 @@ import { get, set, Session, SessionCache } from '../session'; * const { user } = await getSession(req, res); * await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }}); * return NextResponse.json({ foo: 'bar' }, res); - * }) + * }); * - * export { GET } + * export { GET }; * ``` * * In a Server Action in a page or React Server Component: @@ -65,7 +65,7 @@ import { get, set, Session, SessionCache } from '../session'; * * ```js * // app/my-page/page.js - * import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; + * import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import * * export default async function Page() { * async function updateUser(updates) { @@ -86,7 +86,7 @@ import { get, set, Session, SessionCache } from '../session'; * * **In the Page Router:** * - * In an api handler: + * In an API handler: * * ```js * // pages/api/my-api.js @@ -121,7 +121,7 @@ import { get, set, Session, SessionCache } from '../session'; * * ```js * import { NextResponse } from 'next/server'; - * import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; + * import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import * * export async function middleware(req) { * const res = new NextResponse(); From dfda6263835a2b8ba31b3f03c7ab64a36acffe92 Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Fri, 18 Aug 2023 14:56:13 +0100 Subject: [PATCH 3/7] Generate the docs again --- ...ession_get_access_token.GetAccessToken.html | 18 +++++++++--------- docs/types/session_get_session.GetSession.html | 18 +++++++++--------- .../session_touch_session.TouchSession.html | 18 +++++++++--------- .../session_update_session.UpdateSession.html | 10 +++++----- 4 files changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/types/session_get_access_token.GetAccessToken.html b/docs/types/session_get_access_token.GetAccessToken.html index 0bd54900e..b0db83203 100644 --- a/docs/types/session_get_access_token.GetAccessToken.html +++ b/docs/types/session_get_access_token.GetAccessToken.html @@ -27,26 +27,26 @@

    Type declaration

    Get an access token to access an external API from the server.

    In the App Router:

    In a route handler:

    -
    // app/my-api/route.js
    import { NextResponse } from 'next/server';
    import { getAccessToken } from '@auth0/nextjs-auth0';

    export async function GET() {
      const { accessToken } = await getAccessToken();
      return NextResponse.json({ foo: 'bar' });
    }

    // Or, it's slightly more efficient to use the `req`, `res` args if you're
    // using with another part of the SDK like `withApiAuthRequired` or `getSession`
    import { NextResponse } from 'next/server';
    import { getAccessToken, withApiAuthRequired } from '@auth0/nextjs-auth0';

    const GET = withApiAuthRequired(async function GET(req) {
      const res = new NextResponse();
      const { accessToken } = await getAccessToken(req, res);
      return NextResponse.json({ foo: 'bar' }, res);
    })

    export { GET }
+
    // app/my-api/route.js
    import { NextResponse } from 'next/server';
    import { getAccessToken } from '@auth0/nextjs-auth0';

    export async function GET() {
      const { accessToken } = await getAccessToken();
      return NextResponse.json({ foo: 'bar' });
    }

    // Or, it's slightly more efficient to use the `req`, `res` args if you're
    // using another part of the SDK like `withApiAuthRequired` or `getSession`.
    import { NextResponse } from 'next/server';
    import { getAccessToken, withApiAuthRequired } from '@auth0/nextjs-auth0';

    const GET = withApiAuthRequired(async function GET(req) {
      const res = new NextResponse();
      const { accessToken } = await getAccessToken(req, res);
      return NextResponse.json({ foo: 'bar' }, res);
    });

    export { GET };
 
    
 
    In a page or React Server Component:
    
-
    // app/my-page/page.js
    import { getAccessToken } from '@auth0/nextjs-auth0';

    export default async function MyPage({ params, searchParams }) {
      const { accessToken } = await getAccessToken();
      return <h1>My Page</h1>
    }
+
    // app/my-page/page.js
    import { getAccessToken } from '@auth0/nextjs-auth0';

    export default async function MyPage({ params, searchParams }) {
      const { accessToken } = await getAccessToken();
      return <h1>My Page</h1>;
    }
 
    
 
    Note: You can't write to the cookie in a React Server Component, so if
-the Access Token is refreshed, it won't be persisted in the session.
    
+the access token is refreshed, it won't be persisted in the session.
    
 
    You can also get the access token in a page or route in the Edge Runtime:
    
-
    // app/my-api/route.js
    import { NextResponse } from 'next/server';
    import { getAccessToken } from '@auth0/nextjs-auth0/edge';

    export async function GET() {
      const { accessToken } = await getAccessToken();
      return NextResponse.json({ foo: 'bar' });
    }

    export const runtime = 'edge'
+
    // app/my-api/route.js
    import { NextResponse } from 'next/server';
    import { getAccessToken } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export async function GET() {
      const { accessToken } = await getAccessToken();
      return NextResponse.json({ foo: 'bar' });
    }

    export const runtime = 'edge';
 
    
 
    Note: The Edge runtime features are only supported in the App Router.
    
 
    In the Page Router:
    
-
    In an api handler:
    
-
    // pages/api/my-api.js
    import { getAccessToken } from '@auth0/nextjs-auth0';

    export default async function MyApi(req, res) {
      const { accessToken } = await getAccessToken(req, res);
      res.status(200).json({ name: 'John Doe' })
    }
+
    In an API handler:
    
+
    // pages/api/my-api.js
    import { getAccessToken } from '@auth0/nextjs-auth0';

    export default async function MyApi(req, res) {
      const { accessToken } = await getAccessToken(req, res);
      res.status(200).json({ name: 'John Doe' });
    }
 
    
 
    In a page:
    
-
    // pages/my-page.js
    import { getAccessToken } from '@auth0/nextjs-auth0';

    export default function About() {
      return <div>About</div>
    }

    export async function getServerSideProps(ctx) {
      const { accessToken } = await getAccessToken(ctx.req, ctx.res);

      return { props: { foo: 'bar' } }
    }
+
    // pages/my-page.js
    import { getAccessToken } from '@auth0/nextjs-auth0';

    export default function About() {
      return <div>About</div>;
    }

    export async function getServerSideProps(ctx) {
      const { accessToken } = await getAccessToken(ctx.req, ctx.res);
      return { props: { foo: 'bar' } };
    }
 
    
 
    In middleware:
    
-
    import { NextResponse } from 'next/server';
    import { getAccessToken } from '@auth0/nextjs-auth0/edge';

    export async function middleware(req) {
      const res = new NextResponse();
      const { accessToken } = await getAccessToken(req, res);
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    export const config = {
      matcher: '/foo',
    }
+
    import { NextResponse } from 'next/server';
    import { getAccessToken } from '@auth0/nextjs-auth0/edge'; // Note the /edge import


    export async function middleware(req) {
      const res = new NextResponse();
      const { accessToken } = await getAccessToken(req, res);
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    export const config = {
      matcher: '/foo',
    };
    @@ -59,7 +59,7 @@

    Returns Promise<

    Throws

    AccessTokenError

    +
  • Defined in session/get-access-token.ts:217
    • diff --git a/docs/types/session_get_session.GetSession.html b/docs/types/session_get_session.GetSession.html index 04c078354..07c0d64c5 100644 --- a/docs/types/session_get_session.GetSession.html +++ b/docs/types/session_get_session.GetSession.html @@ -27,28 +27,28 @@

    Type declaration

    Get the user's session from the server.

    In the App Router:

    In a route handler:

    -
    // app/my-api/route.js
    import { getSession } from '@auth0/nextjs-auth0';

    export async function GET() {
      const { user } = await getSession();
      return NextResponse.json({ foo: 'bar' });
    }

    // Or, it's slightly more efficient to use the `req`, `res` args if you're
    // using with another part of the SDK like `withApiAuthRequired` or `getAccessToken`
    import { getSession, withApiAuthRequired } from '@auth0/nextjs-auth0';

    const GET = withApiAuthRequired(async function GET(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      return NextResponse.json({ foo: 'bar' }, res);
    })

    export { GET }
+
    // app/my-api/route.js
    import { getSession } from '@auth0/nextjs-auth0';

    export async function GET() {
      const { user } = await getSession();
      return NextResponse.json({ foo: 'bar' });
    }

    // Or, it's slightly more efficient to use the `req`, `res` args if you're
    // using another part of the SDK like `withApiAuthRequired` or `getAccessToken`.
    import { getSession, withApiAuthRequired } from '@auth0/nextjs-auth0';

    const GET = withApiAuthRequired(async function GET(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      return NextResponse.json({ foo: 'bar' }, res);
    });

    export { GET };
 
    
 
    In a page or React Server Component:
    
-
    // app/my-page/page.js
    import { getSession } from '@auth0/nextjs-auth0';

    export default async function MyPage({ params, searchParams }) {
      const { user } = await getSession();
      return <h1>My Page</h1>
    }
+
    // app/my-page/page.js
    import { getSession } from '@auth0/nextjs-auth0';

    export default async function MyPage({ params, searchParams }) {
      const { user } = await getSession();
      return <h1>My Page</h1>;
    }
 
    
 
    Note: You can't write to the cookie in a React Server Component, so updates
 to the session like setting the expiry of the rolling session won't be persisted.
-For this we recommend touching the session in the middleware using getSession or
+For this, we recommend touching the session in the middleware using getSession or
 withMiddlewareAuthRequired.
    
 
    You can also get the session in a page or route in the Edge Runtime:
    
-
    // app/my-api/route.js
    import { getSession } from '@auth0/nextjs-auth0/edge';

    export default async function MyPage({ params, searchParams }) {
      const { user } = await getSession();
      return <h1>My Page</h1>
    }

    export const runtime = 'edge'
+
    // app/my-api/route.js
    import { getSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export default async function MyPage({ params, searchParams }) {
      const { user } = await getSession();
      return <h1>My Page</h1>;
    }

    export const runtime = 'edge';
 
    
 
    Note: The Edge runtime features are only supported in the App Router.
    
 
    In the Page Router:
    
-
    In an api handler:
    
-
    // pages/api/my-api.js
    import { getSession } from '@auth0/nextjs-auth0';

    export default async function MyApi(req, res) {
      const { user } = await getSession(req, res);
      res.status(200).json({ name: user.name })
    }
+
    In an API handler:
    
+
    // pages/api/my-api.js
    import { getSession } from '@auth0/nextjs-auth0';

    export default async function MyApi(req, res) {
      const { user } = await getSession(req, res);
      res.status(200).json({ name: user.name });
    }
 
    
 
    In a page:
    
-
    // pages/my-page.js
    import { getSession } from '@auth0/nextjs-auth0';

    export default function About() {
      return <div>About</div>
    }

    export async function getServerSideProps(ctx) {
      const { user } = await getSession(ctx.req, ctx.res);

      return { props: { foo: 'bar' } }
    }
+
    // pages/my-page.js
    import { getSession } from '@auth0/nextjs-auth0';

    export default function About() {
      return <div>About</div>;
    }

    export async function getServerSideProps(ctx) {
      const { user } = await getSession(ctx.req, ctx.res);
      return { props: { foo: 'bar' } };
    }
 
    
 
    In middleware:
    
-
    import { NextResponse } from 'next/server';
    import { getSession } from '@auth0/nextjs-auth0/edge';

    export async function middleware(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    export const config = {
      matcher: '/foo',
    }

    @category Server
+
    import { NextResponse } from 'next/server';
    import { getSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export async function middleware(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    export const config = {
      matcher: '/foo',
    };

    @category Server
    @@ -59,7 +59,7 @@
    Rest Returns Promise<default | null | undefined>
    +
  • Defined in session/get-session.ts:116
    • diff --git a/docs/types/session_touch_session.TouchSession.html b/docs/types/session_touch_session.TouchSession.html index 2b8e0e2c3..d336d76a6 100644 --- a/docs/types/session_touch_session.TouchSession.html +++ b/docs/types/session_touch_session.TouchSession.html @@ -28,28 +28,28 @@

    Type declaration

    to call this method to update the session expiry.

    In the App Router:

    In a route handler:

    -
    // app/my-api/route.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export async function GET() {
      await touchSession();
      return NextResponse.json({ foo: 'bar' });
    }

    // Or, it's slightly more efficient to use the `req`, `res` args if you're
    // using with another part of the SDK like `withApiAuthRequired` or `getSession`
    import { touchSession, withApiAuthRequired } from '@auth0/nextjs-auth0';

    const GET = withApiAuthRequired(async function GET(req) {
      const res = new NextResponse();
      await touchSession(req, res);
      return NextResponse.json({ foo: 'bar' }, res);
    })

    export { GET }
+
    // app/my-api/route.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export async function GET() {
      await touchSession();
      return NextResponse.json({ foo: 'bar' });
    }

    // Or, it's slightly more efficient to use the `req`, `res` args if you're
    // using another part of the SDK like `withApiAuthRequired` or `getSession`.
    import { touchSession, withApiAuthRequired } from '@auth0/nextjs-auth0';

    const GET = withApiAuthRequired(async function GET(req) {
      const res = new NextResponse();
      await touchSession(req, res);
      return NextResponse.json({ foo: 'bar' }, res);
    });

    export { GET };
 
    
 
    In a page or React Server Component:
    
-
    // app/my-page/page.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export default async function MyPage({ params, searchParams }) {
      await touchSession();
      return <h1>My Page</h1>
    }
+
    // app/my-page/page.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export default async function MyPage({ params, searchParams }) {
      await touchSession();
      return <h1>My Page</h1>;
    }
 
    
 
    Note: You can't write to the cookie in a React Server Component, so updates
 to the session like setting the expiry of the rolling session won't be persisted.
-For this we recommend touching the session in the middleware using touchSession or
+For this, we recommend touching the session in the middleware using touchSession or
 withMiddlewareAuthRequired.
    
 
    You can also touch the session in a page or route in the Edge Runtime:
    
-
    // app/my-api/route.js
    import { getSession } from '@auth0/nextjs-auth0/edge';

    export default async function MyPage({ params, searchParams }) {
      await touchSession();
      return <h1>My Page</h1>
    }

    export const runtime = 'edge'
+
    // app/my-api/route.js
    import { getSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export default async function MyPage({ params, searchParams }) {
      await touchSession();
      return <h1>My Page</h1>;
    }

    export const runtime = 'edge';
 
    
 
    Note: The Edge runtime features are only supported in the App Router.
    
 
    In the Page Router:
    
-
    In an api handler:
    
-
    // pages/api/my-api.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export default async function MyApi(req, res) {
      await touchSession(req, res);
      res.status(200).json({ name: user.name })
    }
+
    In an API handler:
    
+
    // pages/api/my-api.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export default async function MyApi(req, res) {
      await touchSession(req, res);
      res.status(200).json({ name: user.name });
    }
 
    
 
    In a page:
    
-
    // pages/my-page.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export default function About() {
      return <div>About</div>
    }

    export async function getServerSideProps(ctx) {
      await touchSession(ctx.req, ctx.res);

      return { props: { foo: 'bar' } }
    }
+
    // pages/my-page.js
    import { touchSession } from '@auth0/nextjs-auth0';

    export default function About() {
      return <div>About</div>;
    }

    export async function getServerSideProps(ctx) {
      await touchSession(ctx.req, ctx.res);
      return { props: { foo: 'bar' } };
    }
 
    
 
    In middleware:
    
-
    import { NextResponse } from 'next/server';
    import { touchSession } from '@auth0/nextjs-auth0/edge';

    export async function middleware(req) {
      const res = new NextResponse();
      await touchSession(req, res);
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    export const config = {
      matcher: '/foo',
    }

    @category Server
+
    import { NextResponse } from 'next/server';
    import { touchSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export async function middleware(req) {
      const res = new NextResponse();
      await touchSession(req, res);
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    export const config = {
      matcher: '/foo',
    };

    @category Server
    @@ -60,7 +60,7 @@
    Rest Returns Promise<void>
    +
  • Defined in session/touch-session.ts:117
    • diff --git a/docs/types/session_update_session.UpdateSession.html b/docs/types/session_update_session.UpdateSession.html index e3510ca9e..5be5e9b84 100644 --- a/docs/types/session_update_session.UpdateSession.html +++ b/docs/types/session_update_session.UpdateSession.html @@ -29,7 +29,7 @@

    Type declaration

    If no session is provided, it doesn't contain a user or the user is not authenticated; this is a no-op.

    In the App Router:

    In a route handler:

    -
    // app/my-api/route.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export async function GET() {
      const { user } = await getSession();
      await updateSession({ ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.json({ foo: 'bar' });
    }

    // Or, it's slightly more efficient to use the `req`, `res` args if you're
    // using with another part of the SDK like `withApiAuthRequired` or `getSession`
    import { getSession, updateSession, withApiAuthRequired } from '@auth0/nextjs-auth0';

    const GET = withApiAuthRequired(async function GET(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.json({ foo: 'bar' }, res);
    })

    export { GET }
+
    // app/my-api/route.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export async function GET() {
      const { user } = await getSession();
      await updateSession({ ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.json({ foo: 'bar' });
    }

    // Or, it's slightly more efficient to use the `req`, `res` args if you're
    // using another part of the SDK like `withApiAuthRequired` or `getSession`.
    import { getSession, updateSession, withApiAuthRequired } from '@auth0/nextjs-auth0';

    const GET = withApiAuthRequired(async function GET(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.json({ foo: 'bar' }, res);
    });

    export { GET };
 
    
 
    In a Server Action in a page or React Server Component:
    
 
    // app/my-page/page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default async function Page() {
      async function updateUser(updates) {
        'use server'
        const { user } = await getSession();
        await updateSession(req, res, { ...session, user: { ...session.user, ...updates }});
      }
      return (
        <form action={updateUser}>
          <button type="submit">Update User</button>
        </form>
      )
    }
@@ -38,18 +38,18 @@ 
    Type declaration
    
 to the session would need to happen in a Server Action.
 More info on Server Actions https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions
    
 
    You can also update the session in a page or route in the Edge Runtime:
    
-
    // app/my-page/page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0/edge';

    export default async function Page() {
      async function updateUser(updates) {
        'use server'
        const { user } = await getSession();
        await updateSession(req, res, { ...session, user: { ...session.user, ...updates }});
      }
      return (
        <form action={updateUser}>
          <button type="submit">Update User</button>
        </form>
      )
    }
    export const runtime = 'edge'
+
    // app/my-page/page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export default async function Page() {
      async function updateUser(updates) {
        'use server'
        const { user } = await getSession();
        await updateSession(req, res, { ...session, user: { ...session.user, ...updates }});
      }
      return (
        <form action={updateUser}>
          <button type="submit">Update User</button>
        </form>
      )
    }
    export const runtime = 'edge'
 
    
 
    Note: The Edge runtime features are only supported in the App Router.
    
 
    In the Page Router:
    
-
    In an api handler:
    
+
    In an API handler:
    
 
    // pages/api/my-api.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default async function MyApi(req, res) {
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      res.status(200).json({ name: user.name });
    }
 
    
 
    In a page:
    
 
    // pages/my-page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default function About() {
      return <div>About</div>
    }

    export async function getServerSideProps(ctx) {
      const { user } = await getSession(ctx.req, ctx.res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});

      return { props: { foo: 'bar' } }
    }
 
    
 
    In middleware:
    
-
    import { NextResponse } from 'next/server';
    import { getSession, updateSession } from '@auth0/nextjs-auth0/edge';

    export async function middleware(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    // See "Matching Paths" below to learn more
    export const config = {
      matcher: '/foo',
    }

    @category Server
+
    import { NextResponse } from 'next/server';
    import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export async function middleware(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    // See "Matching Paths" below to learn more
    export const config = {
      matcher: '/foo',
    }

    @category Server
    @@ -60,7 +60,7 @@
    Rest Returns Promise<void>
    +
  • Defined in session/update-session.ts:140
    • From 9081ca7a6c8a442b1a8fd854378ebafbf043ba6e Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Fri, 18 Aug 2023 15:17:50 +0100 Subject: [PATCH 4/7] Don't try and list methods that bump the session expiry --- src/session/get-session.ts | 3 +-- src/session/touch-session.ts | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/src/session/get-session.ts b/src/session/get-session.ts index 3049e51b8..c08e991f2 100644 --- a/src/session/get-session.ts +++ b/src/session/get-session.ts @@ -46,8 +46,7 @@ import { SessionCache, Session, get } from '../session'; * * **Note:** You can't write to the cookie in a React Server Component, so updates * to the session like setting the expiry of the rolling session won't be persisted. - * For this, we recommend touching the session in the middleware using `getSession` or - * `withMiddlewareAuthRequired`. + * For this, we recommend interacting with the session in the middleware. * * You can also get the session in a page or route in the Edge Runtime: * diff --git a/src/session/touch-session.ts b/src/session/touch-session.ts index 5ab8ac705..6be4f7c45 100644 --- a/src/session/touch-session.ts +++ b/src/session/touch-session.ts @@ -47,8 +47,7 @@ import { get, set, SessionCache } from '../session'; * * **Note:** You can't write to the cookie in a React Server Component, so updates * to the session like setting the expiry of the rolling session won't be persisted. - * For this, we recommend touching the session in the middleware using `touchSession` or - * `withMiddlewareAuthRequired`. + * For this, we recommend interacting with the session in the middleware. * * You can also touch the session in a page or route in the Edge Runtime: * From 5d993ac897b4a8597fbf25b26f03a2bc8e6708d1 Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Fri, 18 Aug 2023 16:30:09 +0100 Subject: [PATCH 5/7] Apply suggestions from code review Co-authored-by: Rita Zerrizuela --- src/session/update-session.ts | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/src/session/update-session.ts b/src/session/update-session.ts index 177776599..2edb8ff10 100644 --- a/src/session/update-session.ts +++ b/src/session/update-session.ts @@ -45,7 +45,7 @@ import { get, set, Session, SessionCache } from '../session'; * * export default async function Page() { * async function updateUser(updates) { - * 'use server' + * 'use server'; * const { user } = await getSession(); * await updateSession(req, res, { ...session, user: { ...session.user, ...updates }}); * } @@ -53,7 +53,7 @@ import { get, set, Session, SessionCache } from '../session'; *
    * *
    - * ) + * ); * } * ``` * @@ -69,7 +69,7 @@ import { get, set, Session, SessionCache } from '../session'; * * export default async function Page() { * async function updateUser(updates) { - * 'use server' + * 'use server'; * const { user } = await getSession(); * await updateSession(req, res, { ...session, user: { ...session.user, ...updates }}); * } @@ -77,9 +77,9 @@ import { get, set, Session, SessionCache } from '../session'; *
    * *
    - * ) + * ); * } - * export const runtime = 'edge' + * export const runtime = 'edge'; * ``` * * **Note:** The Edge runtime features are only supported in the App Router. @@ -106,14 +106,13 @@ import { get, set, Session, SessionCache } from '../session'; * import { getSession, updateSession } from '@auth0/nextjs-auth0'; * * export default function About() { - * return
    About
    + * return
    About
    ; * } * * export async function getServerSideProps(ctx) { * const { user } = await getSession(ctx.req, ctx.res); * await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }}); - * - * return { props: { foo: 'bar' } } + * return { props: { foo: 'bar' } }; * } * ``` * @@ -133,7 +132,7 @@ import { get, set, Session, SessionCache } from '../session'; * // See "Matching Paths" below to learn more * export const config = { * matcher: '/foo', - * } + * }; * * @category Server */ From 46afe1daeb130d6bf3f48e2c006624001a01df7f Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Fri, 18 Aug 2023 16:31:38 +0100 Subject: [PATCH 6/7] Build docs --- .../types/session_get_access_token.GetAccessToken.html | 2 +- docs/types/session_update_session.UpdateSession.html | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/types/session_get_access_token.GetAccessToken.html b/docs/types/session_get_access_token.GetAccessToken.html index b0db83203..4464b0132 100644 --- a/docs/types/session_get_access_token.GetAccessToken.html +++ b/docs/types/session_get_access_token.GetAccessToken.html @@ -59,7 +59,7 @@

    Returns Promise<

    Throws

    AccessTokenError

    +
  • Defined in session/get-access-token.ts:217
    • diff --git a/docs/types/session_update_session.UpdateSession.html b/docs/types/session_update_session.UpdateSession.html index 5be5e9b84..666b33b07 100644 --- a/docs/types/session_update_session.UpdateSession.html +++ b/docs/types/session_update_session.UpdateSession.html @@ -32,13 +32,13 @@

    Type declaration

    // app/my-api/route.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export async function GET() {
      const { user } = await getSession();
      await updateSession({ ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.json({ foo: 'bar' });
    }

    // Or, it's slightly more efficient to use the `req`, `res` args if you're
    // using another part of the SDK like `withApiAuthRequired` or `getSession`.
    import { getSession, updateSession, withApiAuthRequired } from '@auth0/nextjs-auth0';

    const GET = withApiAuthRequired(async function GET(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.json({ foo: 'bar' }, res);
    });

    export { GET };

    In a Server Action in a page or React Server Component:

    -
    // app/my-page/page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default async function Page() {
      async function updateUser(updates) {
        'use server'
        const { user } = await getSession();
        await updateSession(req, res, { ...session, user: { ...session.user, ...updates }});
      }
      return (
        <form action={updateUser}>
          <button type="submit">Update User</button>
        </form>
      )
    }
+
    // app/my-page/page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default async function Page() {
      async function updateUser(updates) {
        'use server';
        const { user } = await getSession();
        await updateSession(req, res, { ...session, user: { ...session.user, ...updates }});
      }
      return (
        <form action={updateUser}>
          <button type="submit">Update User</button>
        </form>
      );
    }
 
    
 
    Note: You can't write to the cookie in a React Server Component, so updates
 to the session would need to happen in a Server Action.
 More info on Server Actions https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions
    
 
    You can also update the session in a page or route in the Edge Runtime:
    
-
    // app/my-page/page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export default async function Page() {
      async function updateUser(updates) {
        'use server'
        const { user } = await getSession();
        await updateSession(req, res, { ...session, user: { ...session.user, ...updates }});
      }
      return (
        <form action={updateUser}>
          <button type="submit">Update User</button>
        </form>
      )
    }
    export const runtime = 'edge'
+
    // app/my-page/page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export default async function Page() {
      async function updateUser(updates) {
        'use server';
        const { user } = await getSession();
        await updateSession(req, res, { ...session, user: { ...session.user, ...updates }});
      }
      return (
        <form action={updateUser}>
          <button type="submit">Update User</button>
        </form>
      );
    }
    export const runtime = 'edge';
 
    
 
    Note: The Edge runtime features are only supported in the App Router.
    
 
    In the Page Router:
    
@@ -46,10 +46,10 @@ 
    Type declaration
    
 
    // pages/api/my-api.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default async function MyApi(req, res) {
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      res.status(200).json({ name: user.name });
    }
 
    
 
    In a page:
    
-
    // pages/my-page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default function About() {
      return <div>About</div>
    }

    export async function getServerSideProps(ctx) {
      const { user } = await getSession(ctx.req, ctx.res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});

      return { props: { foo: 'bar' } }
    }
+
    // pages/my-page.js
    import { getSession, updateSession } from '@auth0/nextjs-auth0';

    export default function About() {
      return <div>About</div>;
    }

    export async function getServerSideProps(ctx) {
      const { user } = await getSession(ctx.req, ctx.res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      return { props: { foo: 'bar' } };
    }
 
    
 
    In middleware:
    
-
    import { NextResponse } from 'next/server';
    import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export async function middleware(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    // See "Matching Paths" below to learn more
    export const config = {
      matcher: '/foo',
    }

    @category Server
+
    import { NextResponse } from 'next/server';
    import { getSession, updateSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export async function middleware(req) {
      const res = new NextResponse();
      const { user } = await getSession(req, res);
      await updateSession(req, res, { ...session, user: { ...session.user, foo: 'bar' }});
      return NextResponse.redirect(new URL('/bar', request.url), res);
    }

    // See "Matching Paths" below to learn more
    export const config = {
      matcher: '/foo',
    };

    @category Server
    @@ -60,7 +60,7 @@
    Rest Returns Promise<void>
    +
  • Defined in session/update-session.ts:139
    • From 634d95a8fb3261fd8b0beba460ec5ee07af104f6 Mon Sep 17 00:00:00 2001 From: Adam Mcgrath Date: Fri, 18 Aug 2023 16:32:13 +0100 Subject: [PATCH 7/7] Build docs II --- docs/types/session_get_session.GetSession.html | 5 ++--- docs/types/session_touch_session.TouchSession.html | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/types/session_get_session.GetSession.html b/docs/types/session_get_session.GetSession.html index 07c0d64c5..756b8b237 100644 --- a/docs/types/session_get_session.GetSession.html +++ b/docs/types/session_get_session.GetSession.html @@ -34,8 +34,7 @@

    Type declaration

    Note: You can't write to the cookie in a React Server Component, so updates to the session like setting the expiry of the rolling session won't be persisted. -For this, we recommend touching the session in the middleware using getSession or -withMiddlewareAuthRequired.

    +For this, we recommend interacting with the session in the middleware.

    You can also get the session in a page or route in the Edge Runtime:

    // app/my-api/route.js
    import { getSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export default async function MyPage({ params, searchParams }) {
      const { user } = await getSession();
      return <h1>My Page</h1>;
    }

    export const runtime = 'edge';
    @@ -59,7 +58,7 @@
    Rest Returns Promise<default | null | undefined>
    +
  • Defined in session/get-session.ts:115
    • diff --git a/docs/types/session_touch_session.TouchSession.html b/docs/types/session_touch_session.TouchSession.html index d336d76a6..d0bc6c4b7 100644 --- a/docs/types/session_touch_session.TouchSession.html +++ b/docs/types/session_touch_session.TouchSession.html @@ -35,8 +35,7 @@

    Type declaration

    Note: You can't write to the cookie in a React Server Component, so updates to the session like setting the expiry of the rolling session won't be persisted. -For this, we recommend touching the session in the middleware using touchSession or -withMiddlewareAuthRequired.

    +For this, we recommend interacting with the session in the middleware.

    You can also touch the session in a page or route in the Edge Runtime:

    // app/my-api/route.js
    import { getSession } from '@auth0/nextjs-auth0/edge'; // Note the /edge import

    export default async function MyPage({ params, searchParams }) {
      await touchSession();
      return <h1>My Page</h1>;
    }

    export const runtime = 'edge';
    @@ -60,7 +59,7 @@
    Rest Returns Promise<void>
    +
  • Defined in session/touch-session.ts:116