diff --git a/.changeset/shaky-papers-push.md b/.changeset/shaky-papers-push.md new file mode 100644 index 00000000000..53ce7c03c0b --- /dev/null +++ b/.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` diff --git a/integration/tests/session-tasks-eject-flow.test.ts b/integration/tests/session-tasks-eject-flow.test.ts index d8a44744dcf..528c81f872b 100644 --- a/integration/tests/session-tasks-eject-flow.test.ts +++ b/integration/tests/session-tasks-eject-flow.test.ts @@ -20,7 +20,7 @@ import { ClerkProvider } from "@clerk/nextjs"; export function Provider({ children }: { children: any }) { return ( - + {children} ) @@ -50,7 +50,7 @@ return ( }`, ) .addFile( - 'src/app/onboarding/select-organization/page.tsx', + 'src/app/onboarding/choose-organization/page.tsx', () => ` import { TaskChooseOrganization } from '@clerk/nextjs'; @@ -96,7 +96,7 @@ return ( await u.po.expect.toBeSignedIn(); // Complete the organization selection task - await u.page.waitForAppUrl('/onboarding/select-organization'); + await u.page.waitForAppUrl('/onboarding/choose-organization'); const fakeOrganization = Object.assign(u.services.organizations.createFakeOrganization(), { slug: u.services.organizations.createFakeOrganization().slug + '-eject-flow', }); diff --git a/packages/clerk-js/src/core/__tests__/clerk.test.ts b/packages/clerk-js/src/core/__tests__/clerk.test.ts index f0c01a013e9..f26a547947d 100644 --- a/packages/clerk-js/src/core/__tests__/clerk.test.ts +++ b/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,7 +2473,7 @@ 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 () => { @@ -2481,14 +2481,14 @@ describe('Clerk singleton', () => { 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'); }); }); diff --git a/packages/clerk-js/src/core/sessionTasks.ts b/packages/clerk-js/src/core/sessionTasks.ts index 7dd3c1e31ed..e785617063a 100644 --- a/packages/clerk-js/src/core/sessionTasks.ts +++ b/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 = { - 'select-organization': 'select-organization', + 'choose-organization': 'choose-organization', } as const; interface NavigateToTaskOptions { diff --git a/packages/clerk-js/src/ui/components/SessionTasks/index.tsx b/packages/clerk-js/src/ui/components/SessionTasks/index.tsx index c4f0205cd85..25a19c16bfc 100644 --- a/packages/clerk-js/src/ui/components/SessionTasks/index.tsx +++ b/packages/clerk-js/src/ui/components/SessionTasks/index.tsx @@ -44,7 +44,7 @@ function SessionTaskRoutes(): JSX.Element { return ( - + diff --git a/packages/clerk-js/src/ui/components/SessionTasks/tasks/TaskChooseOrganization/__tests__/TaskChooseOrganization.test.tsx b/packages/clerk-js/src/ui/components/SessionTasks/tasks/TaskChooseOrganization/__tests__/TaskChooseOrganization.test.tsx index a34b2f81d60..9d5a6abb474 100644 --- a/packages/clerk-js/src/ui/components/SessionTasks/tasks/TaskChooseOrganization/__tests__/TaskChooseOrganization.test.tsx +++ b/packages/clerk-js/src/ui/components/SessionTasks/tasks/TaskChooseOrganization/__tests__/TaskChooseOrganization.test.tsx @@ -35,7 +35,7 @@ describe('TaskChooseOrganization', () => { f.withUser({ email_addresses: ['test@clerk.com'], create_organization_enabled: true, - tasks: [{ key: 'select-organization' }], + tasks: [{ key: 'choose-organization' }], }); }); @@ -55,7 +55,7 @@ describe('TaskChooseOrganization', () => { f.withUser({ email_addresses: ['test@clerk.com'], create_organization_enabled: true, - tasks: [{ key: 'select-organization' }], + tasks: [{ key: 'choose-organization' }], }); }); @@ -74,7 +74,7 @@ describe('TaskChooseOrganization', () => { f.withUser({ email_addresses: ['test@clerk.com'], create_organization_enabled: true, - tasks: [{ key: 'select-organization' }], + tasks: [{ key: 'choose-organization' }], }); }); @@ -114,7 +114,7 @@ describe('TaskChooseOrganization', () => { f.withUser({ email_addresses: ['test@clerk.com'], create_organization_enabled: true, - tasks: [{ key: 'select-organization' }], + tasks: [{ key: 'choose-organization' }], }); }); @@ -173,7 +173,7 @@ describe('TaskChooseOrganization', () => { f.withUser({ email_addresses: ['user@test.com'], create_organization_enabled: true, - tasks: [{ key: 'select-organization' }], + tasks: [{ key: 'choose-organization' }], }); }); @@ -192,7 +192,7 @@ describe('TaskChooseOrganization', () => { f.withUser({ email_addresses: ['test@clerk.com'], 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' }], }); }); diff --git a/packages/types/src/session.ts b/packages/types/src/session.ts index 0113d71a18a..fb18c618d04 100644 --- a/packages/types/src/session.ts +++ b/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 = {