Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(types): Add oidcPrompt and oidcLoginHint #4789

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
12 changes: 12 additions & 0 deletions .changeset/old-dryers-approve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
'@clerk/types': minor
---

Adds `oidcLoginHint` & `oidcPrompt` parameters to following types:

- `ReauthorizeExternalAccountParams`
- `OAuthConfig`
- `SignInCreateParams`
- `PrepareVerificationParams`
- `SignUpCreateParams`
- `CreateExternalAccountParams`
2 changes: 2 additions & 0 deletions packages/types/src/externalAccount.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import type { VerificationResource } from './verification';
export type ReauthorizeExternalAccountParams = {
additionalScopes?: OAuthScope[];
redirectUrl?: string;
oidcPrompt?: string;
oidcLoginHint?: string;
};

export interface ExternalAccountResource extends ClerkResource {
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/factors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ export type PassKeyConfig = PasskeyFactor;
export type OAuthConfig = OauthFactor & {
redirectUrl: string;
actionCompleteRedirectUrl: string;
oidcPrompt?: string;
oidcLoginHint?: string;
};

export type SamlConfig = SamlFactor & {
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/signIn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,8 @@ export type SignInCreateParams = (
redirectUrl: string;
actionCompleteRedirectUrl?: string;
identifier?: string;
oidcPrompt?: string;
oidcLoginHint?: string;
}
| {
strategy: TicketStrategy;
Expand Down
4 changes: 4 additions & 0 deletions packages/types/src/signUp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,8 @@ export type PrepareVerificationParams =
strategy: OAuthStrategy;
redirectUrl?: string;
actionCompleteRedirectUrl?: string;
oidcPrompt?: string;
oidcLoginHint?: string;
}
| {
strategy: SamlStrategy;
Expand Down Expand Up @@ -171,6 +173,8 @@ export type SignUpCreateParams = Partial<
ticket: string;
token: string;
legalAccepted: boolean;
oidcPrompt: string;
oidcLoginHint: string;
} & Omit<SnakeToCamel<Record<SignUpAttributeField | SignUpVerifiableField, string>>, 'legalAccepted'>
>;

Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/user.ts
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ export type CreateExternalAccountParams = {
strategy: OAuthStrategy;
redirectUrl?: string;
additionalScopes?: OAuthScope[];
oidcPrompt?: string;
oidcLoginHint?: string;
};
export type VerifyTOTPParams = { code: string };

Expand Down
Loading