From a11f962bcbcf225fb927122267de1e8f5faccf53 Mon Sep 17 00:00:00 2001 From: Dimitris Klouvas Date: Fri, 13 Oct 2023 16:01:17 +0300 Subject: [PATCH] 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` --- .changeset/happy-turkeys-explode.md | 20 +++++++++++++++++++ .../src/core/resources/SamlAccount.ts | 3 --- packages/clerk-js/src/core/resources/User.ts | 3 --- .../src/core/resources/UserSettings.ts | 3 --- packages/types/src/clerk.ts | 3 --- packages/types/src/factors.ts | 6 ------ packages/types/src/json.ts | 6 ------ packages/types/src/samlAccount.ts | 3 --- packages/types/src/strategies.ts | 3 --- packages/types/src/user.ts | 3 --- packages/types/src/userSettings.ts | 9 --------- 11 files changed, 20 insertions(+), 42 deletions(-) create mode 100644 .changeset/happy-turkeys-explode.md diff --git a/.changeset/happy-turkeys-explode.md b/.changeset/happy-turkeys-explode.md new file mode 100644 index 0000000000..473954ce27 --- /dev/null +++ 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` \ No newline at end of file diff --git a/packages/clerk-js/src/core/resources/SamlAccount.ts b/packages/clerk-js/src/core/resources/SamlAccount.ts index 41e8be0f02..2b7988c20e 100644 --- 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 index 31898f8b75..99ac453716 100644 --- 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 index 82ec8eb6bc..34106038f5 100644 --- 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 index 28c1653b64..43c48e59fc 100644 --- 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 index 36d61dec34..268f25f848 100644 --- 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 index 2a896ea8f1..607ffa43ba 100644 --- 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 index 7927db8faa..5a1fff291c 100644 --- 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 index 1a3490d483..f6005d60fc 100644 --- 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 index a63db05e74..3680265511 100644 --- 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 index 053992a097..efd7cb35bd 100644 --- 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;