Skip to content

Commit 74cf3b2

Browse files
authored
chore(clerk-js): Rename __experimental_nextTask to __experimental_navigateToTask (#5715)
1 parent 62692cb commit 74cf3b2

File tree

6 files changed

+17
-10
lines changed

6 files changed

+17
-10
lines changed

.changeset/happy-radios-juggle.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
'@clerk/clerk-js': patch
3+
'@clerk/clerk-react': patch
4+
'@clerk/types': patch
5+
---
6+
7+
Rename ` __experimental_nextTask` to `__experimental_navigateToTask`

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2284,7 +2284,7 @@ describe('Clerk singleton', () => {
22842284
await sut.load(mockedLoadOptions);
22852285

22862286
await sut.setActive({ session: mockResource as any as PendingSessionResource });
2287-
await sut.__experimental_nextTask();
2287+
await sut.__experimental_navigateToTask();
22882288

22892289
expect(mockNavigate.mock.calls[0][0]).toBe('/sign-in#/tasks/add-organization');
22902290
});
@@ -2328,7 +2328,7 @@ describe('Clerk singleton', () => {
23282328
await sut.setActive({ session: mockSession as any as ActiveSessionResource });
23292329

23302330
const redirectUrlComplete = '/welcome-to-app';
2331-
await sut.__experimental_nextTask({ redirectUrlComplete });
2331+
await sut.__experimental_navigateToTask({ redirectUrlComplete });
23322332

23332333
console.log(mockNavigate.mock.calls);
23342334

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1198,7 +1198,7 @@ export class Clerk implements ClerkInterface {
11981198
this.#emit();
11991199
};
12001200

1201-
public __experimental_nextTask = async ({ redirectUrlComplete }: NextTaskParams = {}): Promise<void> => {
1201+
public __experimental_navigateToTask = async ({ redirectUrlComplete }: NextTaskParams = {}): Promise<void> => {
12021202
const session = await this.session?.reload();
12031203
if (!session || !this.environment) {
12041204
return;
@@ -1215,7 +1215,7 @@ export class Clerk implements ClerkInterface {
12151215
}
12161216

12171217
const tracker = createBeforeUnloadTracker(this.#options.standardBrowser);
1218-
const defaultRedirectUrlComplete = this.client?.signUp ? this.buildAfterSignUpUrl() : this.buildAfterSignUpUrl();
1218+
const defaultRedirectUrlComplete = this.client?.signUp ? this.buildAfterSignUpUrl() : this.buildAfterSignInUrl();
12191219

12201220
this.#setTransitiveState();
12211221

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ const SessionTasksStart = withCardStateProvider(() => {
2121
useEffect(() => {
2222
// Simulates additional latency to avoid a abrupt UI transition when navigating to the next task
2323
const timeoutId = setTimeout(() => {
24-
void clerk.__experimental_nextTask({ redirectUrlComplete });
24+
void clerk.__experimental_navigateToTask({ redirectUrlComplete });
2525
}, 500);
2626
return () => clearTimeout(timeoutId);
2727
}, [navigate, clerk, redirectUrlComplete]);
@@ -80,7 +80,7 @@ export function SessionTask(): JSX.Element {
8080
}, [clerk, navigate, redirectUrlComplete]);
8181

8282
const nextTask = useCallback(
83-
() => clerk.__experimental_nextTask({ redirectUrlComplete }),
83+
() => clerk.__experimental_navigateToTask({ redirectUrlComplete }),
8484
[clerk, redirectUrlComplete],
8585
);
8686

packages/react/src/isomorphicClerk.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -693,9 +693,9 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
693693
}
694694
};
695695

696-
__experimental_nextTask = async (params?: NextTaskParams): Promise<void> => {
696+
__experimental_navigateToTask = async (params?: NextTaskParams): Promise<void> => {
697697
if (this.clerkjs) {
698-
return this.clerkjs.__experimental_nextTask(params);
698+
return this.clerkjs.__experimental_navigateToTask(params);
699699
} else {
700700
return Promise.reject();
701701
}

packages/types/src/clerk.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -706,10 +706,10 @@ export interface Clerk {
706706
/**
707707
* Navigates to the next task or redirects to completion URL.
708708
* If the current session has pending tasks, it navigates to the next task.
709-
* If all tasks are complete, it navigates to the provided completion URL.
709+
* If all tasks are complete, it navigates to the provided completion URL or defaults to the origin redirect URL (either from sign-in or sign-up).
710710
* @experimental
711711
*/
712-
__experimental_nextTask: (params?: NextTaskParams) => Promise<void>;
712+
__experimental_navigateToTask: (params?: NextTaskParams) => Promise<void>;
713713

714714
/**
715715
* This is an optional function.

0 commit comments

Comments
 (0)