Rename select-organization to choose-organization

Author: LauraBeatris

.changeset/shaky-papers-push.md

@@ -0,0 +1,6 @@
+---
+'@clerk/clerk-js': patch
+'@clerk/types': patch
+---
+
+Rename task key from `select-organization` to `choose-organization`

integration/tests/session-tasks-eject-flow.test.ts

@@ -20,7 +20,7 @@ import { ClerkProvider } from "@clerk/nextjs";
 
 export function Provider({ children }: { children: any }) {
 return (
-  <ClerkProvider taskUrls={{ 'select-organization': '/onboarding/select-organization' }}>
+  <ClerkProvider taskUrls={{ 'choose-organization': '/onboarding/choose-organization' }}>
     {children}
   </ClerkProvider>
 )

packages/clerk-js/src/core/__tests__/clerk.test.ts

@@ -483,17 +483,17 @@ describe('Clerk singleton', () => {
         touch: jest.fn(() => Promise.resolve()),
         getToken: jest.fn(),
         lastActiveToken: { getRawString: () => 'mocked-token' },
-        tasks: [{ key: 'select-organization' }],
-        currentTask: { key: 'select-organization', __internal_getUrl: () => 'https://sut/tasks/select-organization' },
+        tasks: [{ key: 'choose-organization' }],
+        currentTask: { key: 'choose-organization', __internal_getUrl: () => 'https://sut/tasks/choose-organization' },
         reload: jest.fn(() =>
           Promise.resolve({
             id: '1',
             status: 'pending',
             user: {},
-            tasks: [{ key: 'select-organization' }],
+            tasks: [{ key: 'choose-organization' }],
             currentTask: {
-              key: 'select-organization',
-              __internal_getUrl: () => 'https://sut/tasks/select-organization',
+              key: 'choose-organization',
+              __internal_getUrl: () => 'https://sut/tasks/choose-organization',
             },
           }),
         ),
@@ -929,8 +929,8 @@ describe('Clerk singleton', () => {
           id: '1',
           status: 'pending',
           user: {},
-          tasks: [{ key: 'select-organization' }],
-          currentTask: { key: 'select-organization', __internal_getUrl: () => 'https://sut/tasks/select-organization' },
+          tasks: [{ key: 'choose-organization' }],
+          currentTask: { key: 'choose-organization', __internal_getUrl: () => 'https://sut/tasks/choose-organization' },
           lastActiveToken: { getRawString: () => 'mocked-token' },
         };
 
@@ -970,7 +970,7 @@ describe('Clerk singleton', () => {
         await sut.handleRedirectCallback();
 
         await waitFor(() => {
-          expect(mockNavigate.mock.calls[0][0]).toBe('/sign-in#/tasks/select-organization');
+          expect(mockNavigate.mock.calls[0][0]).toBe('/sign-in#/tasks/choose-organization');
         });
       });
 
@@ -2438,8 +2438,8 @@ describe('Clerk singleton', () => {
         id: '1',
         status: 'pending',
         user: {},
-        tasks: [{ key: 'select-organization' }],
-        currentTask: { key: 'select-organization', __internal_getUrl: () => 'https://sut/tasks/select-organization' },
+        tasks: [{ key: 'choose-organization' }],
+        currentTask: { key: 'choose-organization', __internal_getUrl: () => 'https://sut/tasks/choose-organization' },
         lastActiveToken: { getRawString: () => 'mocked-token' },
       };
 
@@ -2473,22 +2473,22 @@ describe('Clerk singleton', () => {
         await sut.setActive({ session: mockResource as any as PendingSessionResource });
         await sut.__internal_navigateToTaskIfAvailable();
 
-        expect(mockNavigate.mock.calls[0][0]).toBe('/sign-in#/tasks/select-organization');
+        expect(mockNavigate.mock.calls[0][0]).toBe('/sign-in#/tasks/choose-organization');
       });
 
       it('navigates to next task with custom routing from clerk options', async () => {
         const sut = new Clerk(productionPublishableKey);
         await sut.load({
           ...mockedLoadOptions,
           taskUrls: {
-            'select-organization': '/onboarding/select-organization',
+            'choose-organization': '/onboarding/choose-organization',
           },
         });
 
         await sut.setActive({ session: mockResource as any as PendingSessionResource });
         await sut.__internal_navigateToTaskIfAvailable();
 
-        expect(mockNavigate.mock.calls[0][0]).toBe('/onboarding/select-organization');
+        expect(mockNavigate.mock.calls[0][0]).toBe('/onboarding/choose-organization');
       });
     });
 

packages/clerk-js/src/core/sessionTasks.ts

@@ -8,7 +8,7 @@ import type {
 import { buildURL } from '../utils';
 
 export const INTERNAL_SESSION_TASK_ROUTE_BY_KEY: Record<SessionTask['key'], string> = {
-  'select-organization': 'select-organization',
+  'choose-organization': 'choose-organization',
 } as const;
 
 interface NavigateToTaskOptions {

packages/clerk-js/src/ui/components/SessionTasks/index.tsx

@@ -44,7 +44,7 @@ function SessionTaskRoutes(): JSX.Element {
 
   return (
     <Switch>
-      <Route path={INTERNAL_SESSION_TASK_ROUTE_BY_KEY['select-organization']}>
+      <Route path={INTERNAL_SESSION_TASK_ROUTE_BY_KEY['choose-organization']}>
         <TaskChooseOrganizationContext.Provider
           value={{ componentName: 'TaskChooseOrganization', redirectUrlComplete: ctx.redirectUrlComplete }}
         >

packages/clerk-js/src/ui/components/SessionTasks/tasks/TaskChooseOrganization/__tests__/TaskChooseOrganization.test.tsx

@@ -35,7 +35,7 @@ describe('TaskChooseOrganization', () => {
       f.withUser({
         email_addresses: ['[email protected]'],
         create_organization_enabled: true,
-        tasks: [{ key: 'select-organization' }],
+        tasks: [{ key: 'choose-organization' }],
       });
     });
 
@@ -55,7 +55,7 @@ describe('TaskChooseOrganization', () => {
       f.withUser({
         email_addresses: ['[email protected]'],
         create_organization_enabled: true,
-        tasks: [{ key: 'select-organization' }],
+        tasks: [{ key: 'choose-organization' }],
       });
     });
 
@@ -74,7 +74,7 @@ describe('TaskChooseOrganization', () => {
       f.withUser({
         email_addresses: ['[email protected]'],
         create_organization_enabled: true,
-        tasks: [{ key: 'select-organization' }],
+        tasks: [{ key: 'choose-organization' }],
       });
     });
 
@@ -114,7 +114,7 @@ describe('TaskChooseOrganization', () => {
       f.withUser({
         email_addresses: ['[email protected]'],
         create_organization_enabled: true,
-        tasks: [{ key: 'select-organization' }],
+        tasks: [{ key: 'choose-organization' }],
       });
     });
 
@@ -173,7 +173,7 @@ describe('TaskChooseOrganization', () => {
       f.withUser({
         email_addresses: ['[email protected]'],
         create_organization_enabled: true,
-        tasks: [{ key: 'select-organization' }],
+        tasks: [{ key: 'choose-organization' }],
       });
     });
 
@@ -192,7 +192,7 @@ describe('TaskChooseOrganization', () => {
       f.withUser({
         email_addresses: ['[email protected]'],
         create_organization_enabled: true,
-        tasks: [{ key: 'select-organization' }],
+        tasks: [{ key: 'choose-organization' }],
       });
     });
 
@@ -211,7 +211,7 @@ describe('TaskChooseOrganization', () => {
       f.withUser({
         username: 'testuser',
         create_organization_enabled: true,
-        tasks: [{ key: 'select-organization' }],
+        tasks: [{ key: 'choose-organization' }],
       });
     });
 

packages/types/src/session.ts

@@ -333,7 +333,7 @@ export interface SessionTask {
   /**
    * A unique identifier for the task
    */
-  key: 'select-organization';
+  key: 'choose-organization';
 }
 
 export type GetTokenOptions = {