@logto/next 3.6.1 → 3.7.1

package/lib/edge/index.cjs

@@ -16,17 +16,15 @@ 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) => {
-            const { nodeClient, headers } = await this.createNodeClientFromEdgeRequest(request);
-            await nodeClient.signIn(redirectUri, interactionMode);
-            const response = new Response(null, {
-                headers,
-                status: 307,
-            });
-            if (this.navigateUrl) {
-                response.headers.append('Location', this.navigateUrl);
+        this.handleSignIn = (options, interactionMode) => {
+            // The array function can not have multiple signatures, have to warn the deprecated usage
+            if (typeof options === 'string') {
+                console.warn('Deprecated: Use the object parameter for handleSignIn instead.');
+                return this.handleSignInImplementation({ redirectUri: options, interactionMode });
             }
-            return response;
+            return this.handleSignInImplementation(options ?? {
+                redirectUri: `${this.config.baseUrl}/api/logto/sign-in-callback`,
+            });
         };
         this.handleSignOut = (redirectUri = this.config.baseUrl) => async (request) => {
             const { nodeClient, headers } = await this.createNodeClientFromEdgeRequest(request);
@@ -71,6 +69,18 @@ class LogtoClient extends client.default {
             const context = await nodeClient.getContext(config);
             return context;
         };
+        this.handleSignInImplementation = (options) => async (request) => {
+            const { nodeClient, headers } = await this.createNodeClientFromEdgeRequest(request);
+            await nodeClient.signIn(options);
+            const response = new Response(null, {
+                headers,
+                status: 307,
+            });
+            if (this.navigateUrl) {
+                response.headers.append('Location', this.navigateUrl);
+            }
+            return response;
+        };
     }
     async createNodeClientFromEdgeRequest(request) {
         const cookies$1 = new cookies.RequestCookies(request.headers);

package/lib/edge/index.d.ts

@@ -1,11 +1,11 @@
-import { type GetContextParameters, type InteractionMode } from '@logto/node';
+import { type SignInOptions, type GetContextParameters, type InteractionMode } from '@logto/node';
 import { type NextRequest } from 'next/server';
 import BaseClient from '../src/client';
 import type { LogtoNextConfig } from '../src/types.js';
 export type { AccessTokenClaims, IdTokenClaims, LogtoContext, InteractionMode, LogtoErrorCode, UserInfoResponse, } from '@logto/node';
 export default class LogtoClient extends BaseClient {
     constructor(config: LogtoNextConfig);
-    handleSignIn: (redirectUri?: string, interactionMode?: InteractionMode) => (request: Request) => Promise<Response>;
+    handleSignIn: (options?: SignInOptions | string, interactionMode?: InteractionMode) => (request: Request) => Promise<Response>;
     handleSignOut: (redirectUri?: string) => (request: NextRequest) => Promise<Response>;
     handleSignInCallback: (redirectTo?: string) => (request: NextRequest) => Promise<Response>;
     handleUser: (configs?: GetContextParameters) => (request: NextRequest) => Promise<Response>;
@@ -14,4 +14,5 @@ export default class LogtoClient extends BaseClient {
         nodeClient: import("@logto/node").default;
         headers: Headers;
     }>;
+    private readonly handleSignInImplementation;
 }

package/lib/edge/index.js

@@ -8,17 +8,15 @@ class LogtoClient extends LogtoNextBaseClient {
         super(config, {
             NodeClient,
         });
-        this.handleSignIn = (redirectUri = `${this.config.baseUrl}/api/logto/sign-in-callback`, interactionMode) => async (request) => {
-            const { nodeClient, headers } = await this.createNodeClientFromEdgeRequest(request);
-            await nodeClient.signIn(redirectUri, interactionMode);
-            const response = new Response(null, {
-                headers,
-                status: 307,
-            });
-            if (this.navigateUrl) {
-                response.headers.append('Location', this.navigateUrl);
+        this.handleSignIn = (options, interactionMode) => {
+            // The array function can not have multiple signatures, have to warn the deprecated usage
+            if (typeof options === 'string') {
+                console.warn('Deprecated: Use the object parameter for handleSignIn instead.');
+                return this.handleSignInImplementation({ redirectUri: options, interactionMode });
             }
-            return response;
+            return this.handleSignInImplementation(options ?? {
+                redirectUri: `${this.config.baseUrl}/api/logto/sign-in-callback`,
+            });
         };
         this.handleSignOut = (redirectUri = this.config.baseUrl) => async (request) => {
             const { nodeClient, headers } = await this.createNodeClientFromEdgeRequest(request);
@@ -63,6 +61,18 @@ class LogtoClient extends LogtoNextBaseClient {
             const context = await nodeClient.getContext(config);
             return context;
         };
+        this.handleSignInImplementation = (options) => async (request) => {
+            const { nodeClient, headers } = await this.createNodeClientFromEdgeRequest(request);
+            await nodeClient.signIn(options);
+            const response = new Response(null, {
+                headers,
+                status: 307,
+            });
+            if (this.navigateUrl) {
+                response.headers.append('Location', this.navigateUrl);
+            }
+            return response;
+        };
     }
     async createNodeClientFromEdgeRequest(request) {
         const cookies = new RequestCookies(request.headers);

package/lib/server-actions/client.cjs

@@ -16,16 +16,12 @@ class LogtoClient extends client.default {
             NodeClient: NodeClient__default.default,
         });
     }
-    /**
-     * Init sign-in and return the url to redirect to Logto.
-     *
-     * @param redirectUri the uri (callbackUri) to redirect to after sign in
-     * @param interactionMode OIDC interaction mode
-     * @returns the url to redirect
-     */
-    async handleSignIn(redirectUri, interactionMode) {
+    async handleSignIn(options, interactionMode) {
         const nodeClient = await this.createNodeClient();
-        await nodeClient.signIn(redirectUri, interactionMode);
+        const finalOptions = typeof options === 'string' || options instanceof URL
+            ? { redirectUri: options, interactionMode }
+            : options;
+        await nodeClient.signIn(finalOptions);
         if (!this.navigateUrl) {
             // Not expected to happen
             throw new Error('navigateUrl is not set');

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

@@ -1,12 +1,22 @@
-import { type GetContextParameters, type InteractionMode } from '@logto/node';
+import { type SignInOptions, type GetContextParameters, type InteractionMode } from '@logto/node';
 import BaseClient from '../src/client';
 import type { LogtoNextConfig } from '../src/types.js';
 export type { LogtoContext, InteractionMode } from '@logto/node';
 export default class LogtoClient extends BaseClient {
     constructor(config: LogtoNextConfig);
+    /**
+     * Start the sign-in flow with the specified options.
+     *
+     * @param options The options for the sign-in flow.
+     */
+    handleSignIn(options: SignInOptions): Promise<{
+        url: string;
+        newCookie?: string;
+    }>;
     /**
      * Init sign-in and return the url to redirect to Logto.
      *
+     * @deprecated Use the object parameter instead.
      * @param redirectUri the uri (callbackUri) to redirect to after sign in
      * @param interactionMode OIDC interaction mode
      * @returns the url to redirect

package/lib/server-actions/client.js

@@ -8,16 +8,12 @@ class LogtoClient extends LogtoNextBaseClient {
             NodeClient,
         });
     }
-    /**
-     * Init sign-in and return the url to redirect to Logto.
-     *
-     * @param redirectUri the uri (callbackUri) to redirect to after sign in
-     * @param interactionMode OIDC interaction mode
-     * @returns the url to redirect
-     */
-    async handleSignIn(redirectUri, interactionMode) {
+    async handleSignIn(options, interactionMode) {
         const nodeClient = await this.createNodeClient();
-        await nodeClient.signIn(redirectUri, interactionMode);
+        const finalOptions = typeof options === 'string' || options instanceof URL
+            ? { redirectUri: options, interactionMode }
+            : options;
+        await nodeClient.signIn(finalOptions);
         if (!this.navigateUrl) {
             // Not expected to happen
             throw new Error('navigateUrl is not set');

package/lib/server-actions/index.cjs

@@ -5,14 +5,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var navigation = require('next/navigation');
 var client = require('./client.cjs');
 
-/**
- * Init sign in process and redirect to the Logto sign-in page
- */
-const signIn = async (config, redirectUri, interactionMode) => {
+async function signIn(config, options, interactionMode) {
     const client$1 = new client.default(config);
-    const { url } = await client$1.handleSignIn(redirectUri ?? `${config.baseUrl}/callback`, interactionMode);
+    const finalOptions = typeof options === 'string' || options === undefined
+        ? { redirectUri: options ?? `${config.baseUrl}/callback`, interactionMode }
+        : options;
+    const { url } = await client$1.handleSignIn(finalOptions);
     navigation.redirect(url);
-};
+}
 /**
  * Handle sign in callback from search params or full redirect URL, save tokens to session
  */

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

@@ -1,10 +1,16 @@
-import { type LogtoContext, type GetContextParameters, type InteractionMode } from '@logto/node';
+import { type LogtoContext, type GetContextParameters, type InteractionMode, type SignInOptions } from '@logto/node';
 import type { LogtoNextConfig } from '../src/types.js';
 export type { LogtoContext, InteractionMode } from '@logto/node';
 /**
  * Init sign in process and redirect to the Logto sign-in page
  */
-export declare const signIn: (config: LogtoNextConfig, redirectUri?: string, interactionMode?: InteractionMode) => Promise<void>;
+export declare function signIn(config: LogtoNextConfig, options?: SignInOptions): Promise<void>;
+/**
+ * Init sign in process and redirect to the Logto sign-in page
+ *
+ * @deprecated Use the object parameter instead.
+ */
+export declare function signIn(config: LogtoNextConfig, redirectUri?: string, interactionMode?: InteractionMode): Promise<void>;
 export declare function handleSignIn(config: LogtoNextConfig, searchParams: URLSearchParams): Promise<void>;
 export declare function handleSignIn(config: LogtoNextConfig, url: URL): Promise<void>;
 /**

package/lib/server-actions/index.js

@@ -1,14 +1,14 @@
 import { redirect } from 'next/navigation';
 import LogtoClient from './client.js';
 
-/**
- * Init sign in process and redirect to the Logto sign-in page
- */
-const signIn = async (config, redirectUri, interactionMode) => {
+async function signIn(config, options, interactionMode) {
     const client = new LogtoClient(config);
-    const { url } = await client.handleSignIn(redirectUri ?? `${config.baseUrl}/callback`, interactionMode);
+    const finalOptions = typeof options === 'string' || options === undefined
+        ? { redirectUri: options ?? `${config.baseUrl}/callback`, interactionMode }
+        : options;
+    const { url } = await client.handleSignIn(finalOptions);
     redirect(url);
-};
+}
 /**
  * Handle sign in callback from search params or full redirect URL, save tokens to session
  */

package/lib/src/index.cjs

@@ -16,13 +16,17 @@ class LogtoClient extends client.default {
         super(config, {
             NodeClient: NodeClient__default.default,
         });
-        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);
-            if (this.navigateUrl) {
-                response.redirect(this.navigateUrl);
+        this.handleSignIn = (options, interactionMode, onError) => {
+            // The array function can not have multiple signatures, have to warn the deprecated usage
+            if (typeof options === 'string') {
+                console.warn('Deprecated: Use the object parameter for handleSignIn instead.');
+                return this.handleSignInImplementation({ redirectUri: options, interactionMode, onError });
             }
-        }, onError);
+            return this.handleSignInImplementation(options ?? {
+                redirectUri: `${this.config.baseUrl}/api/logto/sign-in-callback`,
+                interactionMode,
+            });
+        };
         this.handleSignInCallback = (redirectTo = this.config.baseUrl, onError) => utils.buildHandler(async (request, response) => {
             const nodeClient = await this.createNodeClientFromNextApi(request, response);
             if (request.url) {
@@ -80,6 +84,13 @@ class LogtoClient extends client.default {
                 return handler(context);
             }, configs, onError);
         };
+        this.handleSignInImplementation = (options) => utils.buildHandler(async (request, response) => {
+            const nodeClient = await this.createNodeClientFromNextApi(request, response);
+            await nodeClient.signIn(options);
+            if (this.navigateUrl) {
+                response.redirect(this.navigateUrl);
+            }
+        }, options.onError);
     }
     async createNodeClientFromNextApi(request, response) {
         this.storage = new NodeClient.CookieStorage({

package/lib/src/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { type IncomingMessage, type ServerResponse } from 'node:http';
-import NodeClient, { type GetContextParameters, type InteractionMode } from '@logto/node';
+import NodeClient, { type SignInOptions, type GetContextParameters, type InteractionMode } from '@logto/node';
 import { type GetServerSidePropsResult, type GetServerSidePropsContext, type NextApiHandler, type NextApiRequest, type NextApiResponse } from 'next';
 import { type NextApiRequestCookies } from 'next/dist/server/api-utils/index.js';
 import LogtoNextBaseClient from './client.js';
@@ -10,7 +10,9 @@ export { LogtoError, LogtoRequestError, LogtoClientError, OidcError, Prompt, Res
 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, onError?: ErrorHandler) => NextApiHandler;
+    handleSignIn: (options?: (SignInOptions & {
+        onError?: ErrorHandler;
+    }) | string, interactionMode?: InteractionMode, onError?: ErrorHandler) => NextApiHandler;
     handleSignInCallback: (redirectTo?: string, onError?: ErrorHandler) => NextApiHandler;
     handleSignOut: (redirectUri?: string, onError?: ErrorHandler) => NextApiHandler;
     handleUser: (configs?: GetContextParameters, onError?: ErrorHandler) => NextApiHandler;
@@ -22,4 +24,5 @@ export default class LogtoClient extends LogtoNextBaseClient {
     createNodeClientFromNextApi(request: IncomingMessage & {
         cookies: NextApiRequestCookies;
     }, response: ServerResponse): Promise<NodeClient>;
+    private readonly handleSignInImplementation;
 }

package/lib/src/index.js

@@ -9,13 +9,17 @@ class LogtoClient extends LogtoNextBaseClient {
         super(config, {
             NodeClient,
         });
-        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);
-            if (this.navigateUrl) {
-                response.redirect(this.navigateUrl);
+        this.handleSignIn = (options, interactionMode, onError) => {
+            // The array function can not have multiple signatures, have to warn the deprecated usage
+            if (typeof options === 'string') {
+                console.warn('Deprecated: Use the object parameter for handleSignIn instead.');
+                return this.handleSignInImplementation({ redirectUri: options, interactionMode, onError });
             }
-        }, onError);
+            return this.handleSignInImplementation(options ?? {
+                redirectUri: `${this.config.baseUrl}/api/logto/sign-in-callback`,
+                interactionMode,
+            });
+        };
         this.handleSignInCallback = (redirectTo = this.config.baseUrl, onError) => buildHandler(async (request, response) => {
             const nodeClient = await this.createNodeClientFromNextApi(request, response);
             if (request.url) {
@@ -73,6 +77,13 @@ class LogtoClient extends LogtoNextBaseClient {
                 return handler(context);
             }, configs, onError);
         };
+        this.handleSignInImplementation = (options) => buildHandler(async (request, response) => {
+            const nodeClient = await this.createNodeClientFromNextApi(request, response);
+            await nodeClient.signIn(options);
+            if (this.navigateUrl) {
+                response.redirect(this.navigateUrl);
+            }
+        }, options.onError);
     }
     async createNodeClientFromNextApi(request, response) {
         this.storage = new CookieStorage({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/next",
-  "version": "3.6.1",
+  "version": "3.7.1",
   "type": "module",
   "main": "./lib/src/index.cjs",
   "module": "./lib/src/index.js",
@@ -47,7 +47,7 @@
   "dependencies": {
     "@edge-runtime/cookies": "^4.0.0",
     "cookie": "^0.6.0",
-    "@logto/node": "^2.5.7"
+    "@logto/node": "^2.5.8"
   },
   "devDependencies": {
     "@silverhand/eslint-config": "^6.0.1",