Skip to content

Commit

Permalink
Revert "chore(types,clerk-js,clerk-react): Deprecate `Clerk.isReady()…
Browse files Browse the repository at this point in the history
…` in favor of `Clerk.loaded` (#2293)" (#2441)

This reverts commit a624798.
  • Loading branch information
dimkl committed Dec 22, 2023
1 parent 0bf0bdd commit 6c64c9b
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 14 deletions.
6 changes: 6 additions & 0 deletions .changeset/tough-cherries-smoke.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': patch
'@clerk/clerk-react': patch
---

Fix support of Clerk@v3 instance from `<ClerkProvider />`
2 changes: 1 addition & 1 deletion integration/testUtils/appPageObject.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export const createAppPageObject = (testArgs: { page: Page }, app: Application)
waitForClerkJsLoaded: async () => {
return page.waitForFunction(() => {
// @ts-ignore
return window.Clerk?.loaded;
return window.Clerk?.isReady();
});
},
waitForClerkComponentMounted: async () => {
Expand Down
19 changes: 8 additions & 11 deletions packages/clerk-js/src/core/clerk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ export default class Clerk implements ClerkInterface {
#environment?: EnvironmentResource | null;
#fapiClient: FapiClient;
#instanceType: InstanceType;
#loaded = false;
#isReady = false;

/**
* @deprecated Although this being a private field, this is a reminder to drop it with the next major release
Expand All @@ -200,7 +200,7 @@ export default class Clerk implements ClerkInterface {
}

get loaded(): boolean {
return this.#loaded;
return this.#isReady;
}

get isSatellite(): boolean {
Expand Down Expand Up @@ -319,13 +319,10 @@ export default class Clerk implements ClerkInterface {

public getFapiClient = (): FapiClient => this.#fapiClient;

public isReady = (): boolean => {
deprecated('Clerk.isReady()', 'Use `Clerk.loaded` instead.');
return this.#loaded;
};
public isReady = (): boolean => this.#isReady;

public load = async (options?: ClerkOptions): Promise<void> => {
if (this.#loaded) {
if (this.#isReady) {
return;
}

Expand All @@ -335,9 +332,9 @@ export default class Clerk implements ClerkInterface {
};

if (this.#options.standardBrowser) {
this.#loaded = await this.#loadInStandardBrowser();
this.#isReady = await this.#loadInStandardBrowser();
} else {
this.#loaded = await this.#loadInNonStandardBrowser();
this.#isReady = await this.#loadInNonStandardBrowser();
}
};

Expand Down Expand Up @@ -952,7 +949,7 @@ export default class Clerk implements ClerkInterface {
params: HandleOAuthCallbackParams = {},
customNavigate?: (to: string) => Promise<unknown>,
): Promise<unknown> => {
if (!this.loaded || !this.#environment || !this.client) {
if (!this.#isReady || !this.#environment || !this.client) {
return;
}
const { signIn, signUp } = this.client;
Expand Down Expand Up @@ -1622,7 +1619,7 @@ export default class Clerk implements ClerkInterface {
};

#buildUrl = (key: 'signInUrl' | 'signUpUrl', options?: SignInRedirectOptions | SignUpRedirectOptions): string => {
if (!this.loaded || !this.#environment || !this.#environment.displayConfig) {
if (!this.#isReady || !this.#environment || !this.#environment.displayConfig) {
return '';
}

Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/isomorphicClerk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ export default class IsomorphicClerk implements IsomorphicLoadedClerk {
// Otherwise use the instantiated Clerk object
c = this.Clerk;

if (!c.loaded) {
if (!c.isReady()) {
await c.load(this.options);
}
}
Expand All @@ -390,7 +390,7 @@ export default class IsomorphicClerk implements IsomorphicLoadedClerk {

global.Clerk.sdkMetadata = this.options.sdkMetadata ?? { name: PACKAGE_NAME, version: PACKAGE_VERSION };

if (global.Clerk?.loaded) {
if (global.Clerk?.loaded || global.Clerk?.isReady()) {
return this.hydrateClerkJS(global.Clerk);
}
return;
Expand Down

0 comments on commit 6c64c9b

Please sign in to comment.