@workos-inc/node 7.36.3 → 7.37.0

package/lib/user-management/session.d.ts

@@ -31,7 +31,9 @@ export declare class Session {
      *
      * @returns The URL to redirect the user to for logging out.
      */
-    getLogoutUrl(): Promise<string>;
+    getLogoutUrl({ returnTo, }?: {
+        returnTo?: string;
+    }): Promise<string>;
     private isValidJwt;
 }
 export {};

package/lib/user-management/session.js

@@ -143,7 +143,7 @@ class Session {
      *
      * @returns The URL to redirect the user to for logging out.
      */
-    getLogoutUrl() {
+    getLogoutUrl({ returnTo, } = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const authenticationResponse = yield this.authenticate();
             if (!authenticationResponse.authenticated) {
@@ -152,6 +152,7 @@ class Session {
             }
             return this.userManagement.getLogoutUrl({
                 sessionId: authenticationResponse.sessionId,
+                returnTo,
             });
         });
     }

package/lib/user-management/session.spec.js

@@ -278,5 +278,30 @@ describe('Session', () => {
             });
             yield expect(session.getLogoutUrl()).rejects.toThrow('Failed to extract session ID for logout URL: no_session_cookie_provided');
         }));
+        describe('when a returnTo URL is provided', () => {
+            it('returns a logout URL for the user', () => __awaiter(void 0, void 0, void 0, function* () {
+                jest
+                    .spyOn(jose, 'jwtVerify')
+                    .mockResolvedValue({});
+                const cookiePassword = 'alongcookiesecretmadefortestingsessions';
+                const sessionData = yield (0, iron_session_1.sealData)({
+                    accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ewogICJzdWIiOiAiMTIzNDU2Nzg5MCIsCiAgIm5hbWUiOiAiSm9obiBEb2UiLAogICJpYXQiOiAxNTE2MjM5MDIyLAogICJzaWQiOiAic2Vzc2lvbl8xMjMiLAogICJvcmdfaWQiOiAib3JnXzEyMyIsCiAgInJvbGUiOiAibWVtYmVyIiwKICAicGVybWlzc2lvbnMiOiBbInBvc3RzOmNyZWF0ZSIsICJwb3N0czpkZWxldGUiXQp9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c',
+                    refreshToken: 'def456',
+                    user: {
+                        object: 'user',
+                        id: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                        email: 'test01@example.com',
+                    },
+                }, { password: cookiePassword });
+                const session = workos.userManagement.loadSealedSession({
+                    sessionData,
+                    cookiePassword,
+                });
+                const url = yield session.getLogoutUrl({
+                    returnTo: 'https://example.com/signed-out',
+                });
+                expect(url).toBe('https://api.workos.com/user_management/sessions/logout?session_id=session_123&return_to=https%3A%2F%2Fexample.com%2Fsigned-out');
+            }));
+        });
     });
 });

package/lib/user-management/user-management.d.ts

@@ -104,8 +104,9 @@ export declare class UserManagement {
     revokeInvitation(invitationId: string): Promise<Invitation>;
     revokeSession(payload: RevokeSessionOptions): Promise<void>;
     getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, context, clientId, domainHint, loginHint, organizationId, provider, redirectUri, state, screenHint, }: AuthorizationURLOptions): string;
-    getLogoutUrl({ sessionId }: {
+    getLogoutUrl({ sessionId, returnTo, }: {
         sessionId: string;
+        returnTo?: string;
     }): string;
     /**
      * @deprecated This method is deprecated and will be removed in a future major version.

package/lib/user-management/user-management.js

@@ -532,11 +532,16 @@ class UserManagement {
         });
         return `${this.workos.baseURL}/user_management/authorize?${query}`;
     }
-    getLogoutUrl({ sessionId }) {
+    getLogoutUrl({ sessionId, returnTo, }) {
         if (!sessionId) {
             throw new TypeError(`Incomplete arguments. Need to specify 'sessionId'.`);
         }
-        return `${this.workos.baseURL}/user_management/sessions/logout?session_id=${sessionId}`;
+        const url = new URL('/user_management/sessions/logout', this.workos.baseURL);
+        url.searchParams.set('session_id', sessionId);
+        if (returnTo) {
+            url.searchParams.set('return_to', returnTo);
+        }
+        return url.toString();
     }
     /**
      * @deprecated This method is deprecated and will be removed in a future major version.

package/lib/user-management/user-management.spec.js

@@ -1604,6 +1604,16 @@ describe('UserManagement', () => {
             });
             expect(url).toBe('https://api.workos.com/user_management/sessions/logout?session_id=123456');
         });
+        describe('when a `returnTo` is given', () => {
+            it('includes a `return_to` in the URL', () => {
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                const url = workos.userManagement.getLogoutUrl({
+                    sessionId: '123456',
+                    returnTo: 'https://your-app.com/signed-out',
+                });
+                expect(url).toBe('https://api.workos.com/user_management/sessions/logout?session_id=123456&return_to=https%3A%2F%2Fyour-app.com%2Fsigned-out');
+            });
+        });
     });
     describe('getLogoutUrlFromSessionCookie', () => {
         beforeEach(() => {

package/lib/workos.js

@@ -29,7 +29,7 @@ const subtle_crypto_provider_1 = require("./common/crypto/subtle-crypto-provider
 const fetch_client_1 = require("./common/net/fetch-client");
 const widgets_1 = require("./widgets/widgets");
 const actions_1 = require("./actions/actions");
-const VERSION = '7.36.3';
+const VERSION = '7.37.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 const HEADER_AUTHORIZATION = 'Authorization';
 const HEADER_IDEMPOTENCY_KEY = 'Idempotency-Key';

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.36.3",
+  "version": "7.37.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -73,4 +73,3 @@
     }
   }
 }
-