chore(clerk-js,types): Convert Saml related types from experimental t…

…o stable (#1876) Saml types: - `User.samlAccounts` - `SamlAccount` - `UserSettingsResource.saml` - `UserSettingsJSON.saml` - `SamlSettings` - `UserResource.samlAccounts` - `SamlAccountResource` - `SamlStrategy` - `UserJSON.saml_accounts` - `SamlAccountJSON` - `SamlConfig` - `SamlFactor` - `HandleSamlCallbackParams`
clerk · Oct 13, 2023 · a11f962 · a11f962
1 parent 29485eb
commit a11f962
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 42 deletions.
diff --git a/.changeset/happy-turkeys-explode.md b/.changeset/happy-turkeys-explode.md
@@ -0,0 +1,20 @@
+---
+'@clerk/clerk-js': patch
+'@clerk/types': patch
+---
+
+Mark the following SAML related types as stable:
+
+- `User.samlAccounts`
+- `SamlAccount`
+- `UserSettingsResource.saml`
+- `UserSettingsJSON.saml`
+- `SamlSettings`
+- `UserResource.samlAccounts`
+- `SamlAccountResource`
+- `SamlStrategy`
+- `UserJSON.saml_accounts`
+- `SamlAccountJSON`
+- `SamlConfig`
+- `SamlFactor`
+- `HandleSamlCallbackParams`
diff --git a/packages/clerk-js/src/core/resources/SamlAccount.ts b/packages/clerk-js/src/core/resources/SamlAccount.ts
@@ -3,9 +3,6 @@ import type { SamlAccountJSON, SamlAccountResource, SamlIdpSlug, VerificationRes
 import { BaseResource } from './Base';
 import { Verification } from './Verification';
 
-/**
- * @experimental
- */
 export class SamlAccount extends BaseResource implements SamlAccountResource {
   id!: string;
   provider: SamlIdpSlug = 'saml_custom';

diff --git a/packages/clerk-js/src/core/resources/User.ts b/packages/clerk-js/src/core/resources/User.ts
@@ -62,9 +62,6 @@ export class User extends BaseResource implements UserResource {
   web3Wallets: Web3WalletResource[] = [];
   externalAccounts: ExternalAccountResource[] = [];
 
-  /**
-   * @experimental
-   */
   samlAccounts: SamlAccountResource[] = [];
 
   organizationMemberships: OrganizationMembershipResource[] = [];

diff --git a/packages/clerk-js/src/core/resources/UserSettings.ts b/packages/clerk-js/src/core/resources/UserSettings.ts
@@ -28,9 +28,6 @@ export class UserSettings extends BaseResource implements UserSettingsResource {
   id = undefined;
   social!: OAuthProviders;
 
-  /**
-   * @experimental
-   */
   saml!: SamlSettings;
 
   attributes!: Attributes;

diff --git a/packages/types/src/clerk.ts b/packages/types/src/clerk.ts
@@ -509,9 +509,6 @@ export type HandleOAuthCallbackParams = {
   verifyPhoneNumberUrl?: string | null;
 };
 
-/**
- * @experimental
- */
 export type HandleSamlCallbackParams = HandleOAuthCallbackParams;
 
 export type BuildUrlWithAuthParams = {

diff --git a/packages/types/src/factors.ts b/packages/types/src/factors.ts
@@ -48,9 +48,6 @@ export type OauthFactor = {
   strategy: OAuthStrategy;
 };
 
-/**
- * @experimental
- */
 export type SamlFactor = {
   strategy: SamlStrategy;
 };
@@ -93,9 +90,6 @@ export type OAuthConfig = OauthFactor & {
   actionCompleteRedirectUrl: string;
 };
 
-/**
- * @experimental
- */
 export type SamlConfig = SamlFactor & {
   redirectUrl: string;
   actionCompleteRedirectUrl: string;

diff --git a/packages/types/src/json.ts b/packages/types/src/json.ts
@@ -164,9 +164,6 @@ export interface ExternalAccountJSON extends ClerkResourceJSON {
   verification?: VerificationJSON;
 }
 
-/**
- * @experimental
- */
 export interface SamlAccountJSON extends ClerkResourceJSON {
   object: 'saml_account';
   provider: SamlIdpSlug;
@@ -197,9 +194,6 @@ export interface UserJSON extends ClerkResourceJSON {
   web3_wallets: Web3WalletJSON[];
   external_accounts: ExternalAccountJSON[];
 
-  /**
-   * @experimental
-   */
   saml_accounts: SamlAccountJSON[];
 
   organization_memberships: OrganizationMembershipJSON[];

diff --git a/packages/types/src/samlAccount.ts b/packages/types/src/samlAccount.ts
@@ -2,9 +2,6 @@ import type { ClerkResource } from './resource';
 import type { SamlIdpSlug } from './saml';
 import type { VerificationResource } from './verification';
 
-/**
- * @experimental
- */
 export interface SamlAccountResource extends ClerkResource {
   provider: SamlIdpSlug;
   providerUserId: string | null;

diff --git a/packages/types/src/strategies.ts b/packages/types/src/strategies.ts
@@ -14,7 +14,4 @@ export type ResetPasswordEmailCodeStrategy = 'reset_password_email_code';
 export type OAuthStrategy = `oauth_${OAuthProvider}`;
 export type Web3Strategy = `web3_${Web3Provider}_signature`;
 
-/**
- * @experimental
- */
 export type SamlStrategy = 'saml';
diff --git a/packages/types/src/user.ts b/packages/types/src/user.ts
@@ -72,9 +72,6 @@ export interface UserResource extends ClerkResource {
   web3Wallets: Web3WalletResource[];
   externalAccounts: ExternalAccountResource[];
 
-  /**
-   * @experimental
-   */
   samlAccounts: SamlAccountResource[];
 
   organizationMemberships: OrganizationMembershipResource[];

diff --git a/packages/types/src/userSettings.ts b/packages/types/src/userSettings.ts
@@ -67,9 +67,6 @@ export type OAuthProviders = {
   [provider in OAuthStrategy]: OAuthProviderSettings;
 };
 
-/**
- * @experimental
- */
 export type SamlSettings = {
   enabled: boolean;
 };
@@ -94,9 +91,6 @@ export interface UserSettingsJSON extends ClerkResourceJSON {
   actions: Actions;
   social: OAuthProviders;
 
-  /**
-   * @experimental
-   */
   saml: SamlSettings;
 
   sign_in: SignInData;
@@ -108,9 +102,6 @@ export interface UserSettingsResource extends ClerkResource {
   id?: undefined;
   social: OAuthProviders;
 
-  /**
-   * @experimental
-   */
   saml: SamlSettings;
 
   attributes: Attributes;