diff --git a/.changeset/wicked-meals-travel.md b/.changeset/wicked-meals-travel.md new file mode 100644 index 00000000000..5cf80e98853 --- /dev/null +++ b/.changeset/wicked-meals-travel.md @@ -0,0 +1,6 @@ +--- +'@clerk/clerk-js': patch +'@clerk/types': patch +--- + +Rename `org` session task key to `select-organization` diff --git a/packages/clerk-js/src/core/__tests__/clerk.test.ts b/packages/clerk-js/src/core/__tests__/clerk.test.ts index 035da4a48cb..8e43fcfd3be 100644 --- a/packages/clerk-js/src/core/__tests__/clerk.test.ts +++ b/packages/clerk-js/src/core/__tests__/clerk.test.ts @@ -485,15 +485,18 @@ describe('Clerk singleton', () => { touch: jest.fn(() => Promise.resolve()), getToken: jest.fn(), lastActiveToken: { getRawString: () => 'mocked-token' }, - tasks: [{ key: 'org' }], - currentTask: { key: 'org', __internal_getUrl: () => 'https://sut/tasks/add-organization' }, + tasks: [{ key: 'select-organization' }], + currentTask: { key: 'select-organization', __internal_getUrl: () => 'https://sut/tasks/select-organization' }, reload: jest.fn(() => Promise.resolve({ id: '1', status: 'pending', user: {}, - tasks: [{ key: 'org' }], - currentTask: { key: 'org', __internal_getUrl: () => 'https://sut/tasks/add-organization' }, + tasks: [{ key: 'select-organization' }], + currentTask: { + key: 'select-organization', + __internal_getUrl: () => 'https://sut/tasks/select-organization', + }, }), ), }; @@ -2337,8 +2340,8 @@ describe('Clerk singleton', () => { id: '1', status: 'pending', user: {}, - tasks: [{ key: 'org' }], - currentTask: { key: 'org', __internal_getUrl: () => 'https://sut/tasks/add-organization' }, + tasks: [{ key: 'select-organization' }], + currentTask: { key: 'select-organization', __internal_getUrl: () => 'https://sut/tasks/select-organization' }, lastActiveToken: { getRawString: () => 'mocked-token' }, }; @@ -2367,7 +2370,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/add-organization'); + expect(mockNavigate.mock.calls[0][0]).toBe('/sign-in#/tasks/select-organization'); }); it('navigates to next task with custom routing from clerk options', async () => { @@ -2375,7 +2378,7 @@ describe('Clerk singleton', () => { await sut.load({ ...mockedLoadOptions, taskUrls: { - org: '/onboarding/select-organization', + 'select-organization': '/onboarding/select-organization', }, }); diff --git a/packages/clerk-js/src/core/sessionTasks.ts b/packages/clerk-js/src/core/sessionTasks.ts index da44e2a5756..134e4b44f6c 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 = { - org: 'add-organization', + 'select-organization': 'select-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 20f4229594d..eae394b0c0c 100644 --- a/packages/clerk-js/src/ui/components/SessionTasks/index.tsx +++ b/packages/clerk-js/src/ui/components/SessionTasks/index.tsx @@ -38,7 +38,7 @@ const SessionTasksStart = () => { function SessionTaskRoutes(): JSX.Element { return ( - + diff --git a/packages/types/src/session.ts b/packages/types/src/session.ts index 84ebb5eaf1d..609eeec2bad 100644 --- a/packages/types/src/session.ts +++ b/packages/types/src/session.ts @@ -334,7 +334,7 @@ export interface SessionTask { /** * The unique identifier for the type of task that needs to be completed */ - key: 'org'; + key: 'select-organization'; } export type GetTokenOptions = {