Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/headless-load-issatellite-type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@clerk/shared': patch
'@clerk/astro': patch
'@clerk/vue': patch
---

Align the `HeadlessBrowserClerk.load()` parameter type with the runtime behavior by accepting the full `ClerkOptions`, including `isSatellite`. The clerk-js implementation has always accepted and used `isSatellite` from `load()` options — it's the only way to configure a satellite app when using `@clerk/clerk-js` directly — but the type previously excluded it, producing a contradictory generated API reference and type errors for direct consumers.
2 changes: 1 addition & 1 deletion packages/astro/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export type InternalRuntimeOptions = {

// Copied from `@clerk/react`
export interface HeadlessBrowserClerk extends Clerk {
load: (opts?: Without<ClerkOptions, 'isSatellite'>) => Promise<void>;
load: (opts?: ClerkOptions) => Promise<void>;
updateClient: (client: ClientResource) => void;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/shared/src/types/clerk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2925,7 +2925,7 @@ export interface HeadlessBrowserClerk extends Clerk {
*
* When using the JavaScript SDK, you must call the `load()` method before using the `Clerk` object in your code. Refer to the [quickstart guide](https://clerk.com/docs/js-frontend/getting-started/quickstart) for more information.
*/
load: (opts?: Without<ClerkOptions, 'isSatellite'>) => Promise<void>;
load: (opts?: ClerkOptions) => Promise<void>;
updateClient: (client: ClientResource) => void;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/vue/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export interface VueClerkInjectionKeyType {

// Copied from `@clerk/react`
export interface HeadlessBrowserClerk extends Clerk {
load: (opts?: Without<ClerkOptions, 'isSatellite'>) => Promise<void>;
load: (opts?: ClerkOptions) => Promise<void>;
updateClient: (client: ClientResource) => void;
}

Expand Down
Loading