@logto/next 3.7.0 → 4.0.3

package/lib/edge/index.js

@@ -80,7 +80,7 @@ class LogtoClient extends LogtoNextBaseClient {
         const responseCookies = new ResponseCookies(headers);
         this.storage = new CookieStorage({
             encryptionKey: this.config.cookieSecret,
-            cookieKey: `logto:${this.config.appId}`,
+            cookieKey: `logto_${this.config.appId}`,
             isSecure: this.config.cookieSecure,
             getCookie: (name) => {
                 return cookies.get(name)?.value ?? '';

package/lib/server-actions/client.js

@@ -62,7 +62,7 @@ class LogtoClient extends LogtoNextBaseClient {
         const { cookies } = await import('next/headers');
         this.storage = new CookieStorage({
             encryptionKey: this.config.cookieSecret,
-            cookieKey: `logto:${this.config.appId}`,
+            cookieKey: `logto_${this.config.appId}`,
             isSecure: this.config.cookieSecure,
             getCookie: (...args) => {
                 return cookies().get(...args)?.value ?? '';

package/lib/src/index.js

@@ -88,7 +88,7 @@ class LogtoClient extends LogtoNextBaseClient {
     async createNodeClientFromNextApi(request, response) {
         this.storage = new CookieStorage({
             encryptionKey: this.config.cookieSecret,
-            cookieKey: `logto:${this.config.appId}`,
+            cookieKey: `logto_${this.config.appId}`,
             isSecure: this.config.cookieSecure,
             getCookie: (name) => {
                 return request.cookies[name] ?? '';

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@logto/next",
-  "version": "3.7.0",
+  "version": "4.0.3",
   "type": "module",
-  "main": "./lib/src/index.cjs",
   "module": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",
   "typesVersions": {
@@ -20,17 +19,14 @@
   },
   "exports": {
     ".": {
-      "require": "./lib/src/index.cjs",
       "import": "./lib/src/index.js",
       "types": "./lib/src/index.d.ts"
     },
     "./edge": {
-      "require": "./lib/edge/index.cjs",
       "import": "./lib/edge/index.js",
       "types": "./lib/edge/index.d.ts"
     },
     "./server-actions": {
-      "require": "./lib/server-actions/index.cjs",
       "import": "./lib/server-actions/index.js",
       "types": "./lib/server-actions/index.d.ts"
     }
@@ -45,9 +41,9 @@
     "directory": "packages/next"
   },
   "dependencies": {
-    "@edge-runtime/cookies": "^4.0.0",
-    "cookie": "^0.6.0",
-    "@logto/node": "^2.5.7"
+    "@edge-runtime/cookies": "^5.0.0",
+    "cookie": "^1.0.0",
+    "@logto/node": "^3.0.3"
   },
   "devDependencies": {
     "@silverhand/eslint-config": "^6.0.1",
@@ -57,7 +53,7 @@
     "@vitest/coverage-v8": "^1.6.0",
     "eslint": "^8.57.0",
     "lint-staged": "^15.0.0",
-    "next": "^14.1.1",
+    "next": "^14.2.10",
     "next-test-api-route-handler": "^4.0.0",
     "prettier": "^3.0.0",
     "react": "^18.2.0",
@@ -82,6 +78,6 @@
     "build": "rm -rf lib/ && tsc -p tsconfig.build.json --noEmit && rollup -c",
     "lint": "eslint --ext .ts src",
     "test": "vitest",
-    "test:coverage": "node test.cjs && vitest --silent --coverage"
+    "test:coverage": "vitest --silent --coverage"
   }
 }

package/lib/edge/index.cjs

@@ -1,111 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var cookies = require('@edge-runtime/cookies');
-var NodeClient$1 = require('@logto/node');
-var NodeClient = require('@logto/node/edge');
-var client = require('../src/client.cjs');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var NodeClient__default = /*#__PURE__*/_interopDefault(NodeClient);
-
-class LogtoClient extends client.default {
-    constructor(config) {
-        super(config, {
-            NodeClient: NodeClient__default.default,
-        });
-        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 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);
-            await nodeClient.signOut(redirectUri);
-            await this.storage?.destroy();
-            const response = new Response(null, {
-                headers,
-                status: 307,
-            });
-            if (this.navigateUrl) {
-                response.headers.append('Location', this.navigateUrl);
-            }
-            return response;
-        };
-        this.handleSignInCallback = (redirectTo = this.config.baseUrl) => async (request) => {
-            const { nodeClient, headers } = await this.createNodeClientFromEdgeRequest(request);
-            if (request.url) {
-                // When app is running behind reverse proxy which is common for edge runtime,
-                // the `request.url`'s domain may not be expected, replace to the configured baseUrl
-                const requestUrl = new URL(request.url);
-                const callbackUrl = new URL(`${requestUrl.pathname}${requestUrl.search}${requestUrl.hash}`, this.config.baseUrl);
-                await nodeClient.handleSignInCallback(callbackUrl.toString());
-            }
-            const response = new Response(null, {
-                status: 307,
-                headers,
-            });
-            response.headers.append('Location', redirectTo);
-            return response;
-        };
-        this.handleUser = (configs) => async (request) => {
-            const context = await this.getLogtoContext(request, configs);
-            return new Response(JSON.stringify(context), {
-                status: 200,
-                headers: {
-                    'content-type': 'application/json',
-                },
-            });
-        };
-        this.getLogtoContext = async (request, config = {}) => {
-            const { nodeClient } = await this.createNodeClientFromEdgeRequest(request);
-            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);
-        const headers = new Headers();
-        const responseCookies = new cookies.ResponseCookies(headers);
-        this.storage = new NodeClient$1.CookieStorage({
-            encryptionKey: this.config.cookieSecret,
-            cookieKey: `logto:${this.config.appId}`,
-            isSecure: this.config.cookieSecure,
-            getCookie: (name) => {
-                return cookies$1.get(name)?.value ?? '';
-            },
-            setCookie: (name, value, options) => {
-                responseCookies.set(name, value, options);
-            },
-        });
-        await this.storage.init();
-        const nodeClient = new this.adapters.NodeClient(this.config, {
-            storage: this.storage,
-            navigate: (url) => {
-                this.navigateUrl = url;
-            },
-        });
-        return { nodeClient, headers };
-    }
-}
-
-exports.default = LogtoClient;

package/lib/server-actions/client.cjs

@@ -1,95 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var NodeClient$1 = require('@logto/node');
-var NodeClient = require('@logto/node/edge');
-var client = require('../src/client.cjs');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var NodeClient__default = /*#__PURE__*/_interopDefault(NodeClient);
-
-class LogtoClient extends client.default {
-    constructor(config) {
-        super(config, {
-            NodeClient: NodeClient__default.default,
-        });
-    }
-    async handleSignIn(options, interactionMode) {
-        const nodeClient = await this.createNodeClient();
-        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');
-        }
-        return {
-            url: this.navigateUrl,
-        };
-    }
-    /**
-     * Init sign-out and return the url to redirect to Logto.
-     *
-     * @param redirectUri the uri (postSignOutUri) to redirect to after sign out
-     * @returns the url to redirect to
-     */
-    async handleSignOut(redirectUri = this.config.baseUrl) {
-        const nodeClient = await this.createNodeClient();
-        await nodeClient.signOut(redirectUri);
-        await this.storage?.destroy();
-        if (!this.navigateUrl) {
-            // Not expected to happen
-            throw new Error('navigateUrl is not set');
-        }
-        return this.navigateUrl;
-    }
-    /**
-     * Handle sign-in callback from Logto.
-     *
-     * @param callbackUrl the uri (callbackUri) to redirect to after sign in, should match the one used in handleSignIn
-     */
-    async handleSignInCallback(callbackUrl) {
-        const nodeClient = await this.createNodeClient();
-        await nodeClient.handleSignInCallback(callbackUrl);
-    }
-    /**
-     * Get Logto context from cookies.
-     *
-     * @param config additional configs of GetContextParameters
-     * @returns LogtoContext
-     */
-    async getLogtoContext(config = {}) {
-        const nodeClient = await this.createNodeClient({ ignoreCookieChange: true });
-        const context = await nodeClient.getContext(config);
-        return context;
-    }
-    async createNodeClient({ ignoreCookieChange } = {}) {
-        const { cookies } = await import('next/headers');
-        this.storage = new NodeClient$1.CookieStorage({
-            encryptionKey: this.config.cookieSecret,
-            cookieKey: `logto:${this.config.appId}`,
-            isSecure: this.config.cookieSecure,
-            getCookie: (...args) => {
-                return cookies().get(...args)?.value ?? '';
-            },
-            setCookie: (...args) => {
-                // In server component (RSC), it is not allowed to modify cookies, see https://nextjs.org/docs/app/api-reference/functions/cookies#cookiessetname-value-options.
-                if (!ignoreCookieChange) {
-                    cookies().set(...args);
-                }
-            },
-        });
-        await this.storage.init();
-        return new this.adapters.NodeClient(this.config, {
-            storage: this.storage,
-            navigate: (url) => {
-                this.navigateUrl = url;
-            },
-        });
-    }
-}
-
-exports.default = LogtoClient;

package/lib/server-actions/index.cjs

@@ -1,105 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var navigation = require('next/navigation');
-var client = require('./client.cjs');
-
-async function signIn(config, options, interactionMode) {
-    const client$1 = new client.default(config);
-    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
- */
-async function handleSignIn(config, searchParamsOrUrl) {
-    const client$1 = new client.default(config);
-    await client$1.handleSignInCallback(searchParamsOrUrl instanceof URL
-        ? searchParamsOrUrl.toString()
-        : `${config.baseUrl}/callback?${searchParamsOrUrl.toString()}`);
-}
-/**
- * Init sign out process, clear session, and redirect to the Logto sign-out page
- */
-const signOut = async (config, redirectUri) => {
-    const client$1 = new client.default(config);
-    const url = await client$1.handleSignOut(redirectUri);
-    navigation.redirect(url);
-};
-/**
- * Get Logto context from session, including auth status and claims
- */
-const getLogtoContext = async (config, getContextParameters) => {
-    const client$1 = new client.default(config);
-    return client$1.getLogtoContext(getContextParameters);
-};
-/**
- * Get organization tokens from session
- *
- * @deprecated Use getOrganizationToken instead
- */
-const getOrganizationTokens = async (config) => {
-    const { isAuthenticated } = await getLogtoContext(config);
-    if (!isAuthenticated) {
-        return [];
-    }
-    const client$1 = new client.default(config);
-    const nodeClient = await client$1.createNodeClient();
-    const { organizations = [] } = await nodeClient.getIdTokenClaims();
-    return Promise.all(organizations.map(async (organizationId) => ({
-        id: organizationId,
-        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 = await client$1.createNodeClient();
-    const accessToken = await nodeClient.getAccessToken(resource, organizationId);
-    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.createNodeClient({ ignoreCookieChange: true });
-    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;
-exports.signOut = signOut;

package/lib/src/client.cjs

@@ -1,12 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-class LogtoNextBaseClient {
-    constructor(config, adapters) {
-        this.config = config;
-        this.adapters = adapters;
-    }
-}
-
-exports.default = LogtoNextBaseClient;

package/lib/src/index.cjs

@@ -1,165 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var NodeClient = require('@logto/node');
-var cookie = require('cookie');
-var client = require('./client.cjs');
-var utils = require('./utils.cjs');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var NodeClient__default = /*#__PURE__*/_interopDefault(NodeClient);
-
-class LogtoClient extends client.default {
-    constructor(config) {
-        super(config, {
-            NodeClient: NodeClient__default.default,
-        });
-        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 });
-            }
-            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) {
-                await nodeClient.handleSignInCallback(`${this.config.baseUrl}${request.url}`);
-                response.redirect(redirectTo);
-            }
-        }, 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();
-            if (this.navigateUrl) {
-                response.redirect(this.navigateUrl);
-            }
-        }, onError);
-        this.handleUser = (configs, onError) => this.withLogtoApiRoute((request, response) => {
-            response.json(request.user);
-        }, configs, onError);
-        this.handleAuthRoutes = (configs, onError) => (request, response) => {
-            const { action } = request.query;
-            if (action === 'sign-in') {
-                return this.handleSignIn(undefined, undefined, onError)(request, response);
-            }
-            if (action === 'sign-up') {
-                return this.handleSignIn(undefined, 'signUp', onError)(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);
-            }
-            if (action === 'user') {
-                return this.handleUser(configs)(request, response);
-            }
-            response.status(404).end();
-        };
-        this.getAccessToken = async (request, response, resource) => {
-            const nodeClient = await this.createNodeClientFromNextApi(request, response);
-            return nodeClient.getAccessToken(resource);
-        };
-        this.getOrganizationToken = async (request, response, organizationId) => {
-            const nodeClient = await this.createNodeClientFromNextApi(request, response);
-            return nodeClient.getOrganizationToken(organizationId);
-        };
-        this.withLogtoApiRoute = (handler, config = {}, onError) => utils.buildHandler(async (request, response) => {
-            const nodeClient = await this.createNodeClientFromNextApi(request, response);
-            const user = await nodeClient.getContext(config);
-            // 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) => {
-            return this.withLogtoApiRoute(async () => {
-                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({
-            encryptionKey: this.config.cookieSecret,
-            cookieKey: `logto:${this.config.appId}`,
-            isSecure: this.config.cookieSecure,
-            getCookie: (name) => {
-                return request.cookies[name] ?? '';
-            },
-            setCookie: (name, value, options) => {
-                response.setHeader('Set-Cookie', cookie.serialize(name, value, options));
-            },
-        });
-        await this.storage.init();
-        return new this.adapters.NodeClient(this.config, {
-            storage: this.storage,
-            navigate: (url) => {
-                this.navigateUrl = url;
-            },
-        });
-    }
-}
-
-Object.defineProperty(exports, "LogtoClientError", {
-    enumerable: true,
-    get: function () { return NodeClient.LogtoClientError; }
-});
-Object.defineProperty(exports, "LogtoError", {
-    enumerable: true,
-    get: function () { return NodeClient.LogtoError; }
-});
-Object.defineProperty(exports, "LogtoRequestError", {
-    enumerable: true,
-    get: function () { return NodeClient.LogtoRequestError; }
-});
-Object.defineProperty(exports, "OidcError", {
-    enumerable: true,
-    get: function () { return NodeClient.OidcError; }
-});
-Object.defineProperty(exports, "PersistKey", {
-    enumerable: true,
-    get: function () { return NodeClient.PersistKey; }
-});
-Object.defineProperty(exports, "Prompt", {
-    enumerable: true,
-    get: function () { return NodeClient.Prompt; }
-});
-Object.defineProperty(exports, "ReservedResource", {
-    enumerable: true,
-    get: function () { return NodeClient.ReservedResource; }
-});
-Object.defineProperty(exports, "ReservedScope", {
-    enumerable: true,
-    get: function () { return NodeClient.ReservedScope; }
-});
-Object.defineProperty(exports, "UserScope", {
-    enumerable: true,
-    get: function () { return NodeClient.UserScope; }
-});
-Object.defineProperty(exports, "buildOrganizationUrn", {
-    enumerable: true,
-    get: function () { return NodeClient.buildOrganizationUrn; }
-});
-Object.defineProperty(exports, "getOrganizationIdFromUrn", {
-    enumerable: true,
-    get: function () { return NodeClient.getOrganizationIdFromUrn; }
-});
-Object.defineProperty(exports, "organizationUrnPrefix", {
-    enumerable: true,
-    get: function () { return NodeClient.organizationUrnPrefix; }
-});
-exports.default = LogtoClient;

package/lib/src/utils.cjs

@@ -1,17 +0,0 @@
-'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;