@logto/next 3.3.4 → 3.5.0

package/lib/server-actions/index.cjs

@@ -47,6 +47,8 @@ const getLogtoContext = async (config, getContextParameters) => {
 };
 /**
  * Get organization tokens from session
+ *
+ * @deprecated Use getOrganizationToken instead
  */
 const getOrganizationTokens = async (config) => {
     const { isAuthenticated } = await getLogtoContext(config);
@@ -61,9 +63,55 @@ const getOrganizationTokens = async (config) => {
         token: await nodeClient.getOrganizationToken(organizationId),
     })));
 };
+/**
+ * Get access token for the specified resource or organization,
+ * this function can be used in server actions or API routes
+ */
+const getAccessToken = async (config, resource, organizationId) => {
+    const client$1 = new client.default(config);
+    const { nodeClient, session } = await client$1.createNodeClientFromHeaders(await cookie.getCookies(config));
+    const accessToken = await nodeClient.getAccessToken(resource, organizationId);
+    // Update access token cache
+    const newCookie = await session.getValues?.();
+    if (newCookie) {
+        await cookie.setCookies(newCookie, config);
+    }
+    return accessToken;
+};
+/**
+ * Get organization token from session,
+ * this function can be used in server actions or API routes
+ */
+const getOrganizationToken = async (config, organizationId) => {
+    return getAccessToken(config, undefined, organizationId);
+};
+/**
+ * Get access token for the specified resource or organization,
+ * this function can be used in React Server Components (RSC)
+ * 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.
+ * When using server actions or API routes, we highly recommand to use the getAccessToken method
+ */
+const getAccessTokenRSC = async (config, resource, organizationId) => {
+    const client$1 = new client.default(config);
+    const { nodeClient } = await client$1.createNodeClientFromHeaders(await cookie.getCookies(config));
+    return nodeClient.getAccessToken(resource, organizationId);
+};
+/**
+ * Get organization token from session,
+ * this function can be used in React Server Components (RSC)
+ * 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.
+ * When using server actions or API routes, we highly recommand to use the getOrganizationToken method
+ */
+const getOrganizationTokenRSC = async (config, organizationId) => {
+    return getAccessTokenRSC(config, undefined, organizationId);
+};
 
 exports.default = client.default;
+exports.getAccessToken = getAccessToken;
+exports.getAccessTokenRSC = getAccessTokenRSC;
 exports.getLogtoContext = getLogtoContext;
+exports.getOrganizationToken = getOrganizationToken;
+exports.getOrganizationTokenRSC = getOrganizationTokenRSC;
 exports.getOrganizationTokens = getOrganizationTokens;
 exports.handleSignIn = handleSignIn;
 exports.signIn = signIn;

package/lib/server-actions/index.d.ts

@@ -14,12 +14,47 @@ export declare const signOut: (config: LogtoNextConfig, redirectUri?: string) =>
 /**
  * Get Logto context from session, including auth status and claims
  */
-export declare const getLogtoContext: (config: LogtoNextConfig, getContextParameters?: GetContextParameters) => Promise<LogtoContext>;
+export declare const getLogtoContext: (config: LogtoNextConfig, getContextParameters?: Omit<GetContextParameters, 'getAccessToken' | 'resource' | 'organizationId' | 'getOrganizationToken'> & {
+    /** @deprecated use getAccessTokenRSC() */
+    getAccessToken?: GetContextParameters['getAccessToken'];
+    /** @deprecated use getOrganizationTokenRSC() */
+    getOrganizationToken?: GetContextParameters['getOrganizationToken'];
+    /** @deprecated use getAccessTokenRSC() */
+    resource?: GetContextParameters['resource'];
+    /** @deprecated use getOrganizationTokenRSC() */
+    organizationId?: GetContextParameters['organizationId'];
+}) => Promise<LogtoContext>;
 /**
  * Get organization tokens from session
+ *
+ * @deprecated Use getOrganizationToken instead
  */
 export declare const getOrganizationTokens: (config: LogtoNextConfig) => Promise<{
     id: string;
     token: string;
 }[]>;
+/**
+ * Get access token for the specified resource or organization,
+ * this function can be used in server actions or API routes
+ */
+export declare const getAccessToken: (config: LogtoNextConfig, resource?: string, organizationId?: string) => Promise<string>;
+/**
+ * Get organization token from session,
+ * this function can be used in server actions or API routes
+ */
+export declare const getOrganizationToken: (config: LogtoNextConfig, organizationId?: string) => Promise<string>;
+/**
+ * Get access token for the specified resource or organization,
+ * this function can be used in React Server Components (RSC)
+ * 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.
+ * When using server actions or API routes, we highly recommand to use the getAccessToken method
+ */
+export declare const getAccessTokenRSC: (config: LogtoNextConfig, resource?: string, organizationId?: string) => Promise<string>;
+/**
+ * Get organization token from session,
+ * this function can be used in React Server Components (RSC)
+ * 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.
+ * When using server actions or API routes, we highly recommand to use the getOrganizationToken method
+ */
+export declare const getOrganizationTokenRSC: (config: LogtoNextConfig, organizationId?: string) => Promise<string>;
 export { default } from './client';

package/lib/server-actions/index.js

@@ -43,6 +43,8 @@ const getLogtoContext = async (config, getContextParameters) => {
 };
 /**
  * Get organization tokens from session
+ *
+ * @deprecated Use getOrganizationToken instead
  */
 const getOrganizationTokens = async (config) => {
     const { isAuthenticated } = await getLogtoContext(config);
@@ -57,5 +59,47 @@ const getOrganizationTokens = async (config) => {
         token: await nodeClient.getOrganizationToken(organizationId),
     })));
 };
+/**
+ * Get access token for the specified resource or organization,
+ * this function can be used in server actions or API routes
+ */
+const getAccessToken = async (config, resource, organizationId) => {
+    const client = new LogtoClient(config);
+    const { nodeClient, session } = await client.createNodeClientFromHeaders(await getCookies(config));
+    const accessToken = await nodeClient.getAccessToken(resource, organizationId);
+    // Update access token cache
+    const newCookie = await session.getValues?.();
+    if (newCookie) {
+        await setCookies(newCookie, config);
+    }
+    return accessToken;
+};
+/**
+ * Get organization token from session,
+ * this function can be used in server actions or API routes
+ */
+const getOrganizationToken = async (config, organizationId) => {
+    return getAccessToken(config, undefined, organizationId);
+};
+/**
+ * Get access token for the specified resource or organization,
+ * this function can be used in React Server Components (RSC)
+ * 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.
+ * When using server actions or API routes, we highly recommand to use the getAccessToken method
+ */
+const getAccessTokenRSC = async (config, resource, organizationId) => {
+    const client = new LogtoClient(config);
+    const { nodeClient } = await client.createNodeClientFromHeaders(await getCookies(config));
+    return nodeClient.getAccessToken(resource, organizationId);
+};
+/**
+ * Get organization token from session,
+ * this function can be used in React Server Components (RSC)
+ * 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.
+ * When using server actions or API routes, we highly recommand to use the getOrganizationToken method
+ */
+const getOrganizationTokenRSC = async (config, organizationId) => {
+    return getAccessTokenRSC(config, undefined, organizationId);
+};
 
-export { LogtoClient as default, getLogtoContext, getOrganizationTokens, handleSignIn, signIn, signOut };
+export { LogtoClient as default, getAccessToken, getAccessTokenRSC, getLogtoContext, getOrganizationToken, getOrganizationTokenRSC, getOrganizationTokens, handleSignIn, signIn, signOut };

package/lib/src/index.cjs

@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var NodeClient = require('@logto/node');
 var client = require('./client.cjs');
+var utils = require('./utils.cjs');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
@@ -14,23 +15,23 @@ class LogtoClient extends client.default {
         super(config, {
             NodeClient: NodeClient__default.default,
         });
-        this.handleSignIn = (redirectUri = `${this.config.baseUrl}/api/logto/sign-in-callback`, interactionMode) => async (request, response) => {
+        this.handleSignIn = (redirectUri = `${this.config.baseUrl}/api/logto/sign-in-callback`, interactionMode, onError) => utils.buildHandler(async (request, response) => {
             const nodeClient = await this.createNodeClientFromNextApi(request, response);
             await nodeClient.signIn(redirectUri, interactionMode);
             await this.storage?.save();
             if (this.navigateUrl) {
                 response.redirect(this.navigateUrl);
             }
-        };
-        this.handleSignInCallback = (redirectTo = this.config.baseUrl) => async (request, response) => {
+        }, onError);
+        this.handleSignInCallback = (redirectTo = this.config.baseUrl, onError) => utils.buildHandler(async (request, response) => {
             const nodeClient = await this.createNodeClientFromNextApi(request, response);
             if (request.url) {
                 await nodeClient.handleSignInCallback(`${this.config.baseUrl}${request.url}`);
                 await this.storage?.save();
                 response.redirect(redirectTo);
             }
-        };
-        this.handleSignOut = (redirectUri = this.config.baseUrl) => async (request, response) => {
+        }, onError);
+        this.handleSignOut = (redirectUri = this.config.baseUrl, onError) => utils.buildHandler(async (request, response) => {
             const nodeClient = await this.createNodeClientFromNextApi(request, response);
             await nodeClient.signOut(redirectUri);
             await this.storage?.destroy();
@@ -38,68 +39,41 @@ class LogtoClient extends client.default {
             if (this.navigateUrl) {
                 response.redirect(this.navigateUrl);
             }
-        };
-        this.handleUser = (configs) => this.withLogtoApiRoute((request, response) => {
+        }, onError);
+        this.handleUser = (configs, onError) => this.withLogtoApiRoute((request, response) => {
             response.json(request.user);
-        }, configs);
+        }, configs, onError);
         this.handleAuthRoutes = (configs, onError) => (request, response) => {
-            try {
-                const { action } = request.query;
-                if (action === 'sign-in') {
-                    return this.handleSignIn()(request, response);
-                }
-                if (action === 'sign-up') {
-                    return this.handleSignIn(undefined, 'signUp')(request, response);
-                }
-                if (action === 'sign-in-callback') {
-                    return this.handleSignInCallback()(request, response);
-                }
-                if (action === 'sign-out') {
-                    return this.handleSignOut()(request, response);
-                }
-                if (action === 'user') {
-                    return this.handleUser(configs)(request, response);
-                }
-                response.status(404).end();
+            const { action } = request.query;
+            if (action === 'sign-in') {
+                return this.handleSignIn(undefined, undefined, onError)(request, response);
             }
-            catch (error) {
-                if (onError) {
-                    return onError(request, response, error);
-                }
-                throw error;
+            if (action === 'sign-up') {
+                return this.handleSignIn(undefined, 'signUp', onError)(request, response);
             }
-        };
-        this.withLogtoApiRoute = (handler, config = {}, onError) => async (request, response) => {
-            try {
-                const nodeClient = await this.createNodeClientFromNextApi(request, response);
-                const user = await nodeClient.getContext(config);
-                await this.storage?.save();
-                // eslint-disable-next-line @silverhand/fp/no-mutating-methods
-                Object.defineProperty(request, 'user', { enumerable: true, get: () => user });
-                return handler(request, response);
+            if (action === 'sign-in-callback') {
+                return this.handleSignInCallback(undefined, onError)(request, response);
+            }
+            if (action === 'sign-out') {
+                return this.handleSignOut(undefined, onError)(request, response);
             }
-            catch (error) {
-                if (onError) {
-                    return onError(request, response, error);
-                }
-                throw error;
+            if (action === 'user') {
+                return this.handleUser(configs)(request, response);
             }
+            response.status(404).end();
         };
+        this.withLogtoApiRoute = (handler, config = {}, onError) => utils.buildHandler(async (request, response) => {
+            const nodeClient = await this.createNodeClientFromNextApi(request, response);
+            const user = await nodeClient.getContext(config);
+            await this.storage?.save();
+            // eslint-disable-next-line @silverhand/fp/no-mutating-methods
+            Object.defineProperty(request, 'user', { enumerable: true, get: () => user });
+            return handler(request, response);
+        }, onError);
         this.withLogtoSsr = (handler, configs = {}, onError) => async (context) => {
-            try {
-                const nodeClient = await this.createNodeClientFromNextApi(context.req, context.res);
-                const user = await nodeClient.getContext(configs);
-                await this.storage?.save();
-                // eslint-disable-next-line @silverhand/fp/no-mutating-methods
-                Object.defineProperty(context.req, 'user', { enumerable: true, get: () => user });
-                return await handler(context);
-            }
-            catch (error) {
-                if (onError) {
-                    return onError(error);
-                }
-                throw error;
-            }
+            return this.withLogtoApiRoute(async () => {
+                return handler(context);
+            }, configs, onError);
         };
     }
     async createNodeClientFromNextApi(request, response) {

package/lib/src/index.d.ts

@@ -1,22 +1,22 @@
 /// <reference types="node" />
 import { type IncomingMessage, type ServerResponse } from 'node:http';
 import NodeClient, { type GetContextParameters, type InteractionMode } from '@logto/node';
-import { type GetServerSidePropsResult, type GetServerSidePropsContext, type NextApiHandler, type NextApiRequest, type NextApiResponse } from 'next';
+import { type GetServerSidePropsResult, type GetServerSidePropsContext, type NextApiHandler } from 'next';
 import { type NextApiRequestCookies } from 'next/dist/server/api-utils/index.js';
 import LogtoNextBaseClient from './client.js';
-import type { LogtoNextConfig } from './types.js';
+import type { ErrorHandler, LogtoNextConfig } from './types.js';
 export type { LogtoNextConfig } from './types.js';
 export { LogtoError, LogtoRequestError, LogtoClientError, OidcError, Prompt, ReservedScope, ReservedResource, UserScope, organizationUrnPrefix, buildOrganizationUrn, getOrganizationIdFromUrn, PersistKey, } from '@logto/node';
 export type { AccessTokenClaims, IdTokenClaims, LogtoContext, InteractionMode, LogtoErrorCode, UserInfoResponse, } from '@logto/node';
 export default class LogtoClient extends LogtoNextBaseClient {
     constructor(config: LogtoNextConfig);
-    handleSignIn: (redirectUri?: string, interactionMode?: InteractionMode) => NextApiHandler;
-    handleSignInCallback: (redirectTo?: string) => NextApiHandler;
-    handleSignOut: (redirectUri?: string) => NextApiHandler;
-    handleUser: (configs?: GetContextParameters) => NextApiHandler;
-    handleAuthRoutes: (configs?: GetContextParameters, onError?: ((request: NextApiRequest, response: NextApiResponse, error: unknown) => unknown) | undefined) => NextApiHandler;
-    withLogtoApiRoute: (handler: NextApiHandler, config?: GetContextParameters, onError?: ((request: NextApiRequest, response: NextApiResponse, error: unknown) => unknown) | undefined) => NextApiHandler;
-    withLogtoSsr: <P extends Record<string, unknown> = Record<string, unknown>>(handler: (context: GetServerSidePropsContext) => GetServerSidePropsResult<P> | Promise<GetServerSidePropsResult<P>>, configs?: GetContextParameters, onError?: ((error: unknown) => unknown) | undefined) => (context: GetServerSidePropsContext) => Promise<unknown>;
+    handleSignIn: (redirectUri?: string, interactionMode?: InteractionMode, onError?: ErrorHandler) => NextApiHandler;
+    handleSignInCallback: (redirectTo?: string, onError?: ErrorHandler) => NextApiHandler;
+    handleSignOut: (redirectUri?: string, onError?: ErrorHandler) => NextApiHandler;
+    handleUser: (configs?: GetContextParameters, onError?: ErrorHandler) => NextApiHandler;
+    handleAuthRoutes: (configs?: GetContextParameters, onError?: ErrorHandler) => NextApiHandler;
+    withLogtoApiRoute: (handler: NextApiHandler, config?: GetContextParameters, onError?: ErrorHandler) => NextApiHandler;
+    withLogtoSsr: <P extends Record<string, unknown> = Record<string, unknown>>(handler: (context: GetServerSidePropsContext) => GetServerSidePropsResult<P> | Promise<GetServerSidePropsResult<P>>, configs?: GetContextParameters, onError?: ((error: unknown) => unknown) | undefined) => (context: GetServerSidePropsContext) => Promise<NextApiHandler>;
     createNodeClientFromNextApi(request: IncomingMessage & {
         cookies: NextApiRequestCookies;
     }, response: ServerResponse): Promise<NodeClient>;

package/lib/src/index.js

@@ -1,29 +1,30 @@
 import NodeClient, { createSession } from '@logto/node';
 export { LogtoClientError, LogtoError, LogtoRequestError, OidcError, PersistKey, Prompt, ReservedResource, ReservedScope, UserScope, buildOrganizationUrn, getOrganizationIdFromUrn, organizationUrnPrefix } from '@logto/node';
 import LogtoNextBaseClient from './client.js';
+import { buildHandler } from './utils.js';
 
 class LogtoClient extends LogtoNextBaseClient {
     constructor(config) {
         super(config, {
             NodeClient,
         });
-        this.handleSignIn = (redirectUri = `${this.config.baseUrl}/api/logto/sign-in-callback`, interactionMode) => async (request, response) => {
+        this.handleSignIn = (redirectUri = `${this.config.baseUrl}/api/logto/sign-in-callback`, interactionMode, onError) => buildHandler(async (request, response) => {
             const nodeClient = await this.createNodeClientFromNextApi(request, response);
             await nodeClient.signIn(redirectUri, interactionMode);
             await this.storage?.save();
             if (this.navigateUrl) {
                 response.redirect(this.navigateUrl);
             }
-        };
-        this.handleSignInCallback = (redirectTo = this.config.baseUrl) => async (request, response) => {
+        }, onError);
+        this.handleSignInCallback = (redirectTo = this.config.baseUrl, onError) => buildHandler(async (request, response) => {
             const nodeClient = await this.createNodeClientFromNextApi(request, response);
             if (request.url) {
                 await nodeClient.handleSignInCallback(`${this.config.baseUrl}${request.url}`);
                 await this.storage?.save();
                 response.redirect(redirectTo);
             }
-        };
-        this.handleSignOut = (redirectUri = this.config.baseUrl) => async (request, response) => {
+        }, onError);
+        this.handleSignOut = (redirectUri = this.config.baseUrl, onError) => buildHandler(async (request, response) => {
             const nodeClient = await this.createNodeClientFromNextApi(request, response);
             await nodeClient.signOut(redirectUri);
             await this.storage?.destroy();
@@ -31,68 +32,41 @@ class LogtoClient extends LogtoNextBaseClient {
             if (this.navigateUrl) {
                 response.redirect(this.navigateUrl);
             }
-        };
-        this.handleUser = (configs) => this.withLogtoApiRoute((request, response) => {
+        }, onError);
+        this.handleUser = (configs, onError) => this.withLogtoApiRoute((request, response) => {
             response.json(request.user);
-        }, configs);
+        }, configs, onError);
         this.handleAuthRoutes = (configs, onError) => (request, response) => {
-            try {
-                const { action } = request.query;
-                if (action === 'sign-in') {
-                    return this.handleSignIn()(request, response);
-                }
-                if (action === 'sign-up') {
-                    return this.handleSignIn(undefined, 'signUp')(request, response);
-                }
-                if (action === 'sign-in-callback') {
-                    return this.handleSignInCallback()(request, response);
-                }
-                if (action === 'sign-out') {
-                    return this.handleSignOut()(request, response);
-                }
-                if (action === 'user') {
-                    return this.handleUser(configs)(request, response);
-                }
-                response.status(404).end();
+            const { action } = request.query;
+            if (action === 'sign-in') {
+                return this.handleSignIn(undefined, undefined, onError)(request, response);
             }
-            catch (error) {
-                if (onError) {
-                    return onError(request, response, error);
-                }
-                throw error;
+            if (action === 'sign-up') {
+                return this.handleSignIn(undefined, 'signUp', onError)(request, response);
             }
-        };
-        this.withLogtoApiRoute = (handler, config = {}, onError) => async (request, response) => {
-            try {
-                const nodeClient = await this.createNodeClientFromNextApi(request, response);
-                const user = await nodeClient.getContext(config);
-                await this.storage?.save();
-                // eslint-disable-next-line @silverhand/fp/no-mutating-methods
-                Object.defineProperty(request, 'user', { enumerable: true, get: () => user });
-                return handler(request, response);
+            if (action === 'sign-in-callback') {
+                return this.handleSignInCallback(undefined, onError)(request, response);
+            }
+            if (action === 'sign-out') {
+                return this.handleSignOut(undefined, onError)(request, response);
             }
-            catch (error) {
-                if (onError) {
-                    return onError(request, response, error);
-                }
-                throw error;
+            if (action === 'user') {
+                return this.handleUser(configs)(request, response);
             }
+            response.status(404).end();
         };
+        this.withLogtoApiRoute = (handler, config = {}, onError) => buildHandler(async (request, response) => {
+            const nodeClient = await this.createNodeClientFromNextApi(request, response);
+            const user = await nodeClient.getContext(config);
+            await this.storage?.save();
+            // eslint-disable-next-line @silverhand/fp/no-mutating-methods
+            Object.defineProperty(request, 'user', { enumerable: true, get: () => user });
+            return handler(request, response);
+        }, onError);
         this.withLogtoSsr = (handler, configs = {}, onError) => async (context) => {
-            try {
-                const nodeClient = await this.createNodeClientFromNextApi(context.req, context.res);
-                const user = await nodeClient.getContext(configs);
-                await this.storage?.save();
-                // eslint-disable-next-line @silverhand/fp/no-mutating-methods
-                Object.defineProperty(context.req, 'user', { enumerable: true, get: () => user });
-                return await handler(context);
-            }
-            catch (error) {
-                if (onError) {
-                    return onError(error);
-                }
-                throw error;
-            }
+            return this.withLogtoApiRoute(async () => {
+                return handler(context);
+            }, configs, onError);
         };
     }
     async createNodeClientFromNextApi(request, response) {

package/lib/src/types.d.ts

@@ -1,5 +1,6 @@
 import type { LogtoConfig } from '@logto/node';
 import type NodeClient from '@logto/node';
+import { type NextApiRequest, type NextApiResponse } from 'next';
 export type LogtoNextConfig = LogtoConfig & {
     cookieSecret: string;
     cookieSecure: boolean;
@@ -8,3 +9,4 @@ export type LogtoNextConfig = LogtoConfig & {
 export type Adapters = {
     NodeClient: typeof NodeClient;
 };
+export type ErrorHandler = (request: NextApiRequest, response: NextApiResponse, error: unknown) => unknown;

package/lib/src/utils.cjs

@@ -0,0 +1,17 @@
+'use strict';
+
+const buildHandler = (handler, onError) => {
+    return async (request, response) => {
+        try {
+            await handler(request, response);
+        }
+        catch (error) {
+            if (onError) {
+                return onError(request, response, error);
+            }
+            throw error;
+        }
+    };
+};
+
+exports.buildHandler = buildHandler;

package/lib/src/utils.d.ts

@@ -0,0 +1,3 @@
+import { type NextApiHandler } from 'next';
+import { type ErrorHandler } from './types';
+export declare const buildHandler: (handler: NextApiHandler, onError?: ErrorHandler) => NextApiHandler;

package/lib/src/utils.js

@@ -0,0 +1,15 @@
+const buildHandler = (handler, onError) => {
+    return async (request, response) => {
+        try {
+            await handler(request, response);
+        }
+        catch (error) {
+            if (onError) {
+                return onError(request, response, error);
+            }
+            throw error;
+        }
+    };
+};
+
+export { buildHandler };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/next",
-  "version": "3.3.4",
+  "version": "3.5.0",
   "type": "module",
   "main": "./lib/src/index.cjs",
   "module": "./lib/src/index.js",