Skip to content

Commit a11f962

Browse files
authored
chore(clerk-js,types): Convert Saml related types from experimental to stable (#1876)
Saml types: - `User.samlAccounts` - `SamlAccount` - `UserSettingsResource.saml` - `UserSettingsJSON.saml` - `SamlSettings` - `UserResource.samlAccounts` - `SamlAccountResource` - `SamlStrategy` - `UserJSON.saml_accounts` - `SamlAccountJSON` - `SamlConfig` - `SamlFactor` - `HandleSamlCallbackParams`
1 parent 29485eb commit a11f962

File tree

11 files changed

+20
-42
lines changed

11 files changed

+20
-42
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
'@clerk/clerk-js': patch
3+
'@clerk/types': patch
4+
---
5+
6+
Mark the following SAML related types as stable:
7+
8+
- `User.samlAccounts`
9+
- `SamlAccount`
10+
- `UserSettingsResource.saml`
11+
- `UserSettingsJSON.saml`
12+
- `SamlSettings`
13+
- `UserResource.samlAccounts`
14+
- `SamlAccountResource`
15+
- `SamlStrategy`
16+
- `UserJSON.saml_accounts`
17+
- `SamlAccountJSON`
18+
- `SamlConfig`
19+
- `SamlFactor`
20+
- `HandleSamlCallbackParams`

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ import type { SamlAccountJSON, SamlAccountResource, SamlIdpSlug, VerificationRes
33
import { BaseResource } from './Base';
44
import { Verification } from './Verification';
55

6-
/**
7-
* @experimental
8-
*/
96
export class SamlAccount extends BaseResource implements SamlAccountResource {
107
id!: string;
118
provider: SamlIdpSlug = 'saml_custom';

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,6 @@ export class User extends BaseResource implements UserResource {
6262
web3Wallets: Web3WalletResource[] = [];
6363
externalAccounts: ExternalAccountResource[] = [];
6464

65-
/**
66-
* @experimental
67-
*/
6865
samlAccounts: SamlAccountResource[] = [];
6966

7067
organizationMemberships: OrganizationMembershipResource[] = [];

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@ export class UserSettings extends BaseResource implements UserSettingsResource {
2828
id = undefined;
2929
social!: OAuthProviders;
3030

31-
/**
32-
* @experimental
33-
*/
3431
saml!: SamlSettings;
3532

3633
attributes!: Attributes;

packages/types/src/clerk.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -509,9 +509,6 @@ export type HandleOAuthCallbackParams = {
509509
verifyPhoneNumberUrl?: string | null;
510510
};
511511

512-
/**
513-
* @experimental
514-
*/
515512
export type HandleSamlCallbackParams = HandleOAuthCallbackParams;
516513

517514
export type BuildUrlWithAuthParams = {

packages/types/src/factors.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,6 @@ export type OauthFactor = {
4848
strategy: OAuthStrategy;
4949
};
5050

51-
/**
52-
* @experimental
53-
*/
5451
export type SamlFactor = {
5552
strategy: SamlStrategy;
5653
};
@@ -93,9 +90,6 @@ export type OAuthConfig = OauthFactor & {
9390
actionCompleteRedirectUrl: string;
9491
};
9592

96-
/**
97-
* @experimental
98-
*/
9993
export type SamlConfig = SamlFactor & {
10094
redirectUrl: string;
10195
actionCompleteRedirectUrl: string;

packages/types/src/json.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,6 @@ export interface ExternalAccountJSON extends ClerkResourceJSON {
164164
verification?: VerificationJSON;
165165
}
166166

167-
/**
168-
* @experimental
169-
*/
170167
export interface SamlAccountJSON extends ClerkResourceJSON {
171168
object: 'saml_account';
172169
provider: SamlIdpSlug;
@@ -197,9 +194,6 @@ export interface UserJSON extends ClerkResourceJSON {
197194
web3_wallets: Web3WalletJSON[];
198195
external_accounts: ExternalAccountJSON[];
199196

200-
/**
201-
* @experimental
202-
*/
203197
saml_accounts: SamlAccountJSON[];
204198

205199
organization_memberships: OrganizationMembershipJSON[];

packages/types/src/samlAccount.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ import type { ClerkResource } from './resource';
22
import type { SamlIdpSlug } from './saml';
33
import type { VerificationResource } from './verification';
44

5-
/**
6-
* @experimental
7-
*/
85
export interface SamlAccountResource extends ClerkResource {
96
provider: SamlIdpSlug;
107
providerUserId: string | null;

packages/types/src/strategies.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,4 @@ export type ResetPasswordEmailCodeStrategy = 'reset_password_email_code';
1414
export type OAuthStrategy = `oauth_${OAuthProvider}`;
1515
export type Web3Strategy = `web3_${Web3Provider}_signature`;
1616

17-
/**
18-
* @experimental
19-
*/
2017
export type SamlStrategy = 'saml';

packages/types/src/user.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,6 @@ export interface UserResource extends ClerkResource {
7272
web3Wallets: Web3WalletResource[];
7373
externalAccounts: ExternalAccountResource[];
7474

75-
/**
76-
* @experimental
77-
*/
7875
samlAccounts: SamlAccountResource[];
7976

8077
organizationMemberships: OrganizationMembershipResource[];

0 commit comments

Comments
 (0)