chore(clerk-js,shared,ui): Add EnterpriseConnection resource

.changeset/humble-trams-laugh.md

@@ -0,0 +1,9 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/shared': minor
+'@clerk/ui': minor
+---
+
+Add `EnterpriseConnection` resource
+
+`User.getEnterpriseConnections()` was wrongly typed as returning `EnterpriseAccountConnectionResource[]`, it now returns `EnterpriseConnectionResource[]`

packages/clerk-js/bundlewatch.config.json

@@ -1,10 +1,10 @@
 {
  "files": [
- { "path": "./dist/clerk.js", "maxSize": "540KB" },
+ { "path": "./dist/clerk.js", "maxSize": "543KB" },
  { "path": "./dist/clerk.browser.js", "maxSize": "67KB" },
- { "path": "./dist/clerk.legacy.browser.js", "maxSize": "108KB" },
- { "path": "./dist/clerk.no-rhc.js", "maxSize": "307KB" },
- { "path": "./dist/clerk.native.js", "maxSize": "66KB" },
+ { "path": "./dist/clerk.legacy.browser.js", "maxSize": "110KB" },
+ { "path": "./dist/clerk.no-rhc.js", "maxSize": "309KB" },
+ { "path": "./dist/clerk.native.js", "maxSize": "68KB" },
  { "path": "./dist/vendors*.js", "maxSize": "7KB" },
  { "path": "./dist/coinbase*.js", "maxSize": "36KB" },
  { "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },

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

@@ -0,0 +1,141 @@
+import type {
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionJSONSnapshot,
+ EnterpriseConnectionResource,
+ EnterpriseOAuthConfigJSON,
+ EnterpriseOAuthConfigResource,
+ EnterpriseSamlConnectionNestedJSON,
+ EnterpriseSamlConnectionNestedResource,
+} from '@clerk/shared/types';
+
+import { unixEpochToDate } from '../../utils/date';
+import { BaseResource } from './Base';
+
+function samlNestedFromJSON(data: EnterpriseSamlConnectionNestedJSON): EnterpriseSamlConnectionNestedResource {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idpEntityId: data.idp_entity_id,
+ idpSsoUrl: data.idp_sso_url,
+ idpCertificate: data.idp_certificate,
+ idpMetadataUrl: data.idp_metadata_url,
+ idpMetadata: data.idp_metadata,
+ acsUrl: data.acs_url,
+ spEntityId: data.sp_entity_id,
+ spMetadataUrl: data.sp_metadata_url,
+ allowSubdomains: data.allow_subdomains,
+ allowIdpInitiated: data.allow_idp_initiated,
+ forceAuthn: data.force_authn,
+ };
+}
+
+function samlNestedToJSON(data: EnterpriseSamlConnectionNestedResource): EnterpriseSamlConnectionNestedJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idp_entity_id: data.idpEntityId,
+ idp_sso_url: data.idpSsoUrl,
+ idp_certificate: data.idpCertificate,
+ idp_metadata_url: data.idpMetadataUrl,
+ idp_metadata: data.idpMetadata,
+ acs_url: data.acsUrl,
+ sp_entity_id: data.spEntityId,
+ sp_metadata_url: data.spMetadataUrl,
+ allow_subdomains: data.allowSubdomains,
+ allow_idp_initiated: data.allowIdpInitiated,
+ force_authn: data.forceAuthn,
+ };
+}
+
+function oauthConfigFromJSON(data: EnterpriseOAuthConfigJSON): EnterpriseOAuthConfigResource {
+ return {
+ id: data.id,
+ name: data.name,
+ clientId: data.client_id,
+ providerKey: data.provider_key,
+ discoveryUrl: data.discovery_url,
+ logoPublicUrl: data.logo_public_url,
+ requiresPkce: data.requires_pkce,
+ createdAt: unixEpochToDate(data.created_at),
+ updatedAt: unixEpochToDate(data.updated_at),
+ };
+}
+
+function oauthConfigToJSON(data: EnterpriseOAuthConfigResource): EnterpriseOAuthConfigJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ client_id: data.clientId,
+ provider_key: data.providerKey,
+ discovery_url: data.discoveryUrl,
+ logo_public_url: data.logoPublicUrl,
+ requires_pkce: data.requiresPkce,
+ created_at: data.createdAt?.getTime() ?? 0,
+ updated_at: data.updatedAt?.getTime() ?? 0,
+ };
+}
+
+export class EnterpriseConnection extends BaseResource implements EnterpriseConnectionResource {
+ id!: string;
+ name!: string;
+ active!: boolean;
+ domains: string[] = [];
+ organizationId: string | null = null;
+ syncUserAttributes!: boolean;
+ disableAdditionalIdentifications!: boolean;
+ allowOrganizationAccountLinking!: boolean;
+ customAttributes: unknown[] = [];
+ oauthConfig: EnterpriseOAuthConfigResource | null = null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null = null;
+ createdAt: Date | null = null;
+ updatedAt: Date | null = null;
+
+ constructor(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null) {
+ super();
+ this.fromJSON(data);
+ }
+
+ protected fromJSON(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null): this {
+ if (!data) {
+ return this;
+ }
+
+ this.id = data.id;
+ this.name = data.name;
+ this.active = data.active;
+ this.domains = data.domains ?? [];
+ this.organizationId = data.organization_id ?? null;
+ this.syncUserAttributes = data.sync_user_attributes;
+ this.disableAdditionalIdentifications = data.disable_additional_identifications;
+ this.allowOrganizationAccountLinking = data.allow_organization_account_linking ?? false;
+ this.customAttributes = data.custom_attributes ?? [];
+ this.createdAt = unixEpochToDate(data.created_at);
+ this.updatedAt = unixEpochToDate(data.updated_at);
+
+ this.samlConnection = data.saml_connection ? samlNestedFromJSON(data.saml_connection) : null;
+ this.oauthConfig = data.oauth_config ? oauthConfigFromJSON(data.oauth_config) : null;
+
+ return this;
+ }
+
+ public __internal_toSnapshot(): EnterpriseConnectionJSONSnapshot {
+ return {
+ object: 'enterprise_connection',
+ id: this.id,
+ name: this.name,
+ active: this.active,
+ domains: this.domains,
+ organization_id: this.organizationId,
+ sync_user_attributes: this.syncUserAttributes,
+ disable_additional_identifications: this.disableAdditionalIdentifications,
+ allow_organization_account_linking: this.allowOrganizationAccountLinking,
+ custom_attributes: this.customAttributes,
+ saml_connection: this.samlConnection ? samlNestedToJSON(this.samlConnection) : undefined,
+ oauth_config: this.oauthConfig ? oauthConfigToJSON(this.oauthConfig) : undefined,
+ created_at: this.createdAt?.getTime() ?? 0,
+ updated_at: this.updatedAt?.getTime() ?? 0,
+ };
+ }
+}

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

@@ -9,9 +9,9 @@ import type {
  DeletedObjectJSON,
  DeletedObjectResource,
  EmailAddressResource,
- EnterpriseAccountConnectionJSON,
- EnterpriseAccountConnectionResource,
  EnterpriseAccountResource,
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionResource,
  ExternalAccountJSON,
  ExternalAccountResource,
  GetEnterpriseConnectionsParams,
@@ -45,7 +45,7 @@ import {
  DeletedObject,
  EmailAddress,
  EnterpriseAccount,
-EnterpriseAccountConnection,
+EnterpriseConnection,
  ExternalAccount,
  Image,
  OrganizationMembership,
@@ -296,7 +296,7 @@ export class User extends BaseResource implements UserResource {
 
  getEnterpriseConnections = async (
  params?: GetEnterpriseConnectionsParams,
- ): Promise<EnterpriseAccountConnectionResource[]> => {
+ ): Promise<EnterpriseConnectionResource[]> => {
  const { withOrganizationAccountLinking } = params || {};
 
  const json = (
@@ -311,9 +311,9 @@ export class User extends BaseResource implements UserResource {
  }
  : {}),
  })
- )?.response as unknown as EnterpriseAccountConnectionJSON[];
+ )?.response as unknown as EnterpriseConnectionJSON[];
 
- return (json || []).map(connection => new EnterpriseAccountConnection(connection));
+ return (json || []).map(connection => new EnterpriseConnection(connection));
  };
 
  initializePaymentMethod: typeof initializePaymentMethod = params => {

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

@@ -16,6 +16,7 @@ export * from './DeletedObject';
 export * from './DisplayConfig';
 export * from './EmailAddress';
 export * from './EnterpriseAccount';
+export * from './EnterpriseConnection';
 export * from './Environment';
 export * from './ExternalAccount';
 export * from './Feature';

packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx

@@ -1,4 +1,4 @@
-import type { EnterpriseAccountConnectionResource } from '../../types/enterpriseAccount';
+import type { EnterpriseConnectionResource } from '../../types/enterpriseConnection';
 import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
 import { useClerkQuery } from '../clerk-rq/useQuery';
 import { useClerkInstanceContext } from '../contexts';
@@ -13,7 +13,7 @@ export type UseUserEnterpriseConnectionsParams = {
 };
 
 export type UseUserEnterpriseConnectionsReturn = {
- data: EnterpriseAccountConnectionResource[] | undefined;
+ data: EnterpriseConnectionResource[] | undefined;
  error: Error | null;
  isLoading: boolean;
  isFetching: boolean;

packages/shared/src/types/enterpriseConnection.ts

@@ -0,0 +1,95 @@
+import type { ClerkResourceJSON } from './json';
+import type { ClerkResource } from './resource';
+
+export interface EnterpriseConnectionJSON extends ClerkResourceJSON {
+ object: 'enterprise_connection';
+ name: string;
+ active: boolean;
+ domains?: string[];
+ organization_id?: string | null;
+ sync_user_attributes: boolean;
+ disable_additional_identifications: boolean;
+ allow_organization_account_linking?: boolean;
+ custom_attributes?: unknown[];
+ oauth_config?: EnterpriseOAuthConfigJSON | null;
+ saml_connection?: EnterpriseSamlConnectionNestedJSON | null;
+ created_at: number;
+ updated_at: number;
+}
+
+export type EnterpriseConnectionJSONSnapshot = EnterpriseConnectionJSON;
+
+export interface EnterpriseConnectionResource extends ClerkResource {
+ id: string;
+ name: string;
+ active: boolean;
+ domains: string[];
+ organizationId: string | null;
+ syncUserAttributes: boolean;
+ disableAdditionalIdentifications: boolean;
+ allowOrganizationAccountLinking: boolean;
+ customAttributes: unknown[];
+ oauthConfig: EnterpriseOAuthConfigResource | null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+ __internal_toSnapshot: () => EnterpriseConnectionJSONSnapshot;
+}
+
+export interface EnterpriseSamlConnectionNestedJSON {
+ id: string;
+ name: string;
+ active: boolean;
+ idp_entity_id: string;
+ idp_sso_url: string;
+ idp_certificate: string;
+ idp_metadata_url: string;
+ idp_metadata: string;
+ acs_url: string;
+ sp_entity_id: string;
+ sp_metadata_url: string;
+ allow_subdomains: boolean;
+ allow_idp_initiated: boolean;
+ force_authn: boolean;
+}
+
+export interface EnterpriseSamlConnectionNestedResource {
+ id: string;
+ name: string;
+ active: boolean;
+ idpEntityId: string;
+ idpSsoUrl: string;
+ idpCertificate: string;
+ idpMetadataUrl: string;
+ idpMetadata: string;
+ acsUrl: string;
+ spEntityId: string;
+ spMetadataUrl: string;
+ allowSubdomains: boolean;
+ allowIdpInitiated: boolean;
+ forceAuthn: boolean;
+}
+
+export interface EnterpriseOAuthConfigJSON {
+ id: string;
+ name: string;
+ provider_key?: string;
+ client_id: string;
+ discovery_url?: string;
+ logo_public_url?: string | null;
+ requires_pkce?: boolean;
+ created_at: number;
+ updated_at: number;
+}
+
+export interface EnterpriseOAuthConfigResource {
+ id: string;
+ name: string;
+ clientId: string;
+ providerKey?: string;
+ discoveryUrl?: string;
+ logoPublicUrl?: string | null;
+ requiresPkce?: boolean;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+}

packages/shared/src/types/index.ts

@@ -16,6 +16,7 @@ export type * from './displayConfig';
 export type * from './elementIds';
 export type * from './emailAddress';
 export type * from './enterpriseAccount';
+export type * from './enterpriseConnection';
 export type * from './environment';
 export type * from './errors';
 export type * from './externalAccount';

packages/shared/src/types/user.ts

@@ -2,7 +2,8 @@ import type { BackupCodeResource } from './backupCode';
 import type { BillingPayerMethods } from './billing';
 import type { DeletedObjectResource } from './deletedObject';
 import type { EmailAddressResource } from './emailAddress';
-import type { EnterpriseAccountConnectionResource, EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseConnectionResource } from './enterpriseConnection';
 import type { ExternalAccountResource } from './externalAccount';
 import type { ImageResource } from './image';
 import type { UserJSON } from './json';
@@ -118,7 +119,7 @@ export interface UserResource extends ClerkResource, BillingPayerMethods {
  ) => Promise<ClerkPaginatedResponse<OrganizationSuggestionResource>>;
  getOrganizationCreationDefaults: () => Promise<OrganizationCreationDefaultsResource>;
  leaveOrganization: (organizationId: string) => Promise<DeletedObjectResource>;
- getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseAccountConnectionResource[]>;
+ getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseConnectionResource[]>;
  createTOTP: () => Promise<TOTPResource>;
  verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
  disableTOTP: () => Promise<DeletedObjectResource>;

.changeset/humble-trams-laugh.md

@@ -0,0 +1,9 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/shared': minor
+'@clerk/ui': minor
+---
+
+Add `EnterpriseConnection` resource
+
+`User.getEnterpriseConnections()` was wrongly typed as returning `EnterpriseAccountConnectionResource[]`, it now returns `EnterpriseConnectionResource[]`

packages/clerk-js/bundlewatch.config.json

@@ -1,10 +1,10 @@
 {
  "files": [
- { "path": "./dist/clerk.js", "maxSize": "540KB" },
+ { "path": "./dist/clerk.js", "maxSize": "543KB" },
  { "path": "./dist/clerk.browser.js", "maxSize": "67KB" },
- { "path": "./dist/clerk.legacy.browser.js", "maxSize": "108KB" },
- { "path": "./dist/clerk.no-rhc.js", "maxSize": "307KB" },
- { "path": "./dist/clerk.native.js", "maxSize": "66KB" },
+ { "path": "./dist/clerk.legacy.browser.js", "maxSize": "110KB" },
+ { "path": "./dist/clerk.no-rhc.js", "maxSize": "309KB" },
+ { "path": "./dist/clerk.native.js", "maxSize": "68KB" },
  { "path": "./dist/vendors*.js", "maxSize": "7KB" },
  { "path": "./dist/coinbase*.js", "maxSize": "36KB" },
  { "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },

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

@@ -0,0 +1,141 @@
+import type {
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionJSONSnapshot,
+ EnterpriseConnectionResource,
+ EnterpriseOAuthConfigJSON,
+ EnterpriseOAuthConfigResource,
+ EnterpriseSamlConnectionNestedJSON,
+ EnterpriseSamlConnectionNestedResource,
+} from '@clerk/shared/types';
+
+import { unixEpochToDate } from '../../utils/date';
+import { BaseResource } from './Base';
+
+function samlNestedFromJSON(data: EnterpriseSamlConnectionNestedJSON): EnterpriseSamlConnectionNestedResource {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idpEntityId: data.idp_entity_id,
+ idpSsoUrl: data.idp_sso_url,
+ idpCertificate: data.idp_certificate,
+ idpMetadataUrl: data.idp_metadata_url,
+ idpMetadata: data.idp_metadata,
+ acsUrl: data.acs_url,
+ spEntityId: data.sp_entity_id,
+ spMetadataUrl: data.sp_metadata_url,
+ allowSubdomains: data.allow_subdomains,
+ allowIdpInitiated: data.allow_idp_initiated,
+ forceAuthn: data.force_authn,
+ };
+}
+
+function samlNestedToJSON(data: EnterpriseSamlConnectionNestedResource): EnterpriseSamlConnectionNestedJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idp_entity_id: data.idpEntityId,
+ idp_sso_url: data.idpSsoUrl,
+ idp_certificate: data.idpCertificate,
+ idp_metadata_url: data.idpMetadataUrl,
+ idp_metadata: data.idpMetadata,
+ acs_url: data.acsUrl,
+ sp_entity_id: data.spEntityId,
+ sp_metadata_url: data.spMetadataUrl,
+ allow_subdomains: data.allowSubdomains,
+ allow_idp_initiated: data.allowIdpInitiated,
+ force_authn: data.forceAuthn,
+ };
+}
+
+function oauthConfigFromJSON(data: EnterpriseOAuthConfigJSON): EnterpriseOAuthConfigResource {
+ return {
+ id: data.id,
+ name: data.name,
+ clientId: data.client_id,
+ providerKey: data.provider_key,
+ discoveryUrl: data.discovery_url,
+ logoPublicUrl: data.logo_public_url,
+ requiresPkce: data.requires_pkce,
+ createdAt: unixEpochToDate(data.created_at),
+ updatedAt: unixEpochToDate(data.updated_at),
+ };
+}
+
+function oauthConfigToJSON(data: EnterpriseOAuthConfigResource): EnterpriseOAuthConfigJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ client_id: data.clientId,
+ provider_key: data.providerKey,
+ discovery_url: data.discoveryUrl,
+ logo_public_url: data.logoPublicUrl,
+ requires_pkce: data.requiresPkce,
+ created_at: data.createdAt?.getTime() ?? 0,
+ updated_at: data.updatedAt?.getTime() ?? 0,
+ };
+}
+
+export class EnterpriseConnection extends BaseResource implements EnterpriseConnectionResource {
+ id!: string;
+ name!: string;
+ active!: boolean;
+ domains: string[] = [];
+ organizationId: string | null = null;
+ syncUserAttributes!: boolean;
+ disableAdditionalIdentifications!: boolean;
+ allowOrganizationAccountLinking!: boolean;
+ customAttributes: unknown[] = [];
+ oauthConfig: EnterpriseOAuthConfigResource | null = null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null = null;
+ createdAt: Date | null = null;
+ updatedAt: Date | null = null;
+
+ constructor(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null) {
+ super();
+ this.fromJSON(data);
+ }
+
+ protected fromJSON(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null): this {
+ if (!data) {
+ return this;
+ }
+
+ this.id = data.id;
+ this.name = data.name;
+ this.active = data.active;
+ this.domains = data.domains ?? [];
+ this.organizationId = data.organization_id ?? null;
+ this.syncUserAttributes = data.sync_user_attributes;
+ this.disableAdditionalIdentifications = data.disable_additional_identifications;
+ this.allowOrganizationAccountLinking = data.allow_organization_account_linking ?? false;
+ this.customAttributes = data.custom_attributes ?? [];
+ this.createdAt = unixEpochToDate(data.created_at);
+ this.updatedAt = unixEpochToDate(data.updated_at);
+
+ this.samlConnection = data.saml_connection ? samlNestedFromJSON(data.saml_connection) : null;
+ this.oauthConfig = data.oauth_config ? oauthConfigFromJSON(data.oauth_config) : null;
+
+ return this;
+ }
+
+ public __internal_toSnapshot(): EnterpriseConnectionJSONSnapshot {
+ return {
+ object: 'enterprise_connection',
+ id: this.id,
+ name: this.name,
+ active: this.active,
+ domains: this.domains,
+ organization_id: this.organizationId,
+ sync_user_attributes: this.syncUserAttributes,
+ disable_additional_identifications: this.disableAdditionalIdentifications,
+ allow_organization_account_linking: this.allowOrganizationAccountLinking,
+ custom_attributes: this.customAttributes,
+ saml_connection: this.samlConnection ? samlNestedToJSON(this.samlConnection) : undefined,
+ oauth_config: this.oauthConfig ? oauthConfigToJSON(this.oauthConfig) : undefined,
+ created_at: this.createdAt?.getTime() ?? 0,
+ updated_at: this.updatedAt?.getTime() ?? 0,
+ };
+ }
+}

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

@@ -9,9 +9,9 @@ import type {
  DeletedObjectJSON,
  DeletedObjectResource,
  EmailAddressResource,
- EnterpriseAccountConnectionJSON,
- EnterpriseAccountConnectionResource,
  EnterpriseAccountResource,
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionResource,
  ExternalAccountJSON,
  ExternalAccountResource,
  GetEnterpriseConnectionsParams,
@@ -45,7 +45,7 @@ import {
  DeletedObject,
  EmailAddress,
  EnterpriseAccount,
-EnterpriseAccountConnection,
+EnterpriseConnection,
  ExternalAccount,
  Image,
  OrganizationMembership,
@@ -296,7 +296,7 @@ export class User extends BaseResource implements UserResource {
 
  getEnterpriseConnections = async (
  params?: GetEnterpriseConnectionsParams,
- ): Promise<EnterpriseAccountConnectionResource[]> => {
+ ): Promise<EnterpriseConnectionResource[]> => {
  const { withOrganizationAccountLinking } = params || {};
 
  const json = (
@@ -311,9 +311,9 @@ export class User extends BaseResource implements UserResource {
  }
  : {}),
  })
- )?.response as unknown as EnterpriseAccountConnectionJSON[];
+ )?.response as unknown as EnterpriseConnectionJSON[];
 
- return (json || []).map(connection => new EnterpriseAccountConnection(connection));
+ return (json || []).map(connection => new EnterpriseConnection(connection));
  };
 
  initializePaymentMethod: typeof initializePaymentMethod = params => {

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

@@ -16,6 +16,7 @@ export * from './DeletedObject';
 export * from './DisplayConfig';
 export * from './EmailAddress';
 export * from './EnterpriseAccount';
+export * from './EnterpriseConnection';
 export * from './Environment';
 export * from './ExternalAccount';
 export * from './Feature';

packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx

@@ -1,4 +1,4 @@
-import type { EnterpriseAccountConnectionResource } from '../../types/enterpriseAccount';
+import type { EnterpriseConnectionResource } from '../../types/enterpriseConnection';
 import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
 import { useClerkQuery } from '../clerk-rq/useQuery';
 import { useClerkInstanceContext } from '../contexts';
@@ -13,7 +13,7 @@ export type UseUserEnterpriseConnectionsParams = {
 };
 
 export type UseUserEnterpriseConnectionsReturn = {
- data: EnterpriseAccountConnectionResource[] | undefined;
+ data: EnterpriseConnectionResource[] | undefined;
  error: Error | null;
  isLoading: boolean;
  isFetching: boolean;

packages/shared/src/types/enterpriseConnection.ts

@@ -0,0 +1,95 @@
+import type { ClerkResourceJSON } from './json';
+import type { ClerkResource } from './resource';
+
+export interface EnterpriseConnectionJSON extends ClerkResourceJSON {
+ object: 'enterprise_connection';
+ name: string;
+ active: boolean;
+ domains?: string[];
+ organization_id?: string | null;
+ sync_user_attributes: boolean;
+ disable_additional_identifications: boolean;
+ allow_organization_account_linking?: boolean;
+ custom_attributes?: unknown[];
+ oauth_config?: EnterpriseOAuthConfigJSON | null;
+ saml_connection?: EnterpriseSamlConnectionNestedJSON | null;
+ created_at: number;
+ updated_at: number;
+}
+
+export type EnterpriseConnectionJSONSnapshot = EnterpriseConnectionJSON;
+
+export interface EnterpriseConnectionResource extends ClerkResource {
+ id: string;
+ name: string;
+ active: boolean;
+ domains: string[];
+ organizationId: string | null;
+ syncUserAttributes: boolean;
+ disableAdditionalIdentifications: boolean;
+ allowOrganizationAccountLinking: boolean;
+ customAttributes: unknown[];
+ oauthConfig: EnterpriseOAuthConfigResource | null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+ __internal_toSnapshot: () => EnterpriseConnectionJSONSnapshot;
+}
+
+export interface EnterpriseSamlConnectionNestedJSON {
+ id: string;
+ name: string;
+ active: boolean;
+ idp_entity_id: string;
+ idp_sso_url: string;
+ idp_certificate: string;
+ idp_metadata_url: string;
+ idp_metadata: string;
+ acs_url: string;
+ sp_entity_id: string;
+ sp_metadata_url: string;
+ allow_subdomains: boolean;
+ allow_idp_initiated: boolean;
+ force_authn: boolean;
+}
+
+export interface EnterpriseSamlConnectionNestedResource {
+ id: string;
+ name: string;
+ active: boolean;
+ idpEntityId: string;
+ idpSsoUrl: string;
+ idpCertificate: string;
+ idpMetadataUrl: string;
+ idpMetadata: string;
+ acsUrl: string;
+ spEntityId: string;
+ spMetadataUrl: string;
+ allowSubdomains: boolean;
+ allowIdpInitiated: boolean;
+ forceAuthn: boolean;
+}
+
+export interface EnterpriseOAuthConfigJSON {
+ id: string;
+ name: string;
+ provider_key?: string;
+ client_id: string;
+ discovery_url?: string;
+ logo_public_url?: string | null;
+ requires_pkce?: boolean;
+ created_at: number;
+ updated_at: number;
+}
+
+export interface EnterpriseOAuthConfigResource {
+ id: string;
+ name: string;
+ clientId: string;
+ providerKey?: string;
+ discoveryUrl?: string;
+ logoPublicUrl?: string | null;
+ requiresPkce?: boolean;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+}

packages/shared/src/types/index.ts

@@ -16,6 +16,7 @@ export type * from './displayConfig';
 export type * from './elementIds';
 export type * from './emailAddress';
 export type * from './enterpriseAccount';
+export type * from './enterpriseConnection';
 export type * from './environment';
 export type * from './errors';
 export type * from './externalAccount';

packages/shared/src/types/user.ts

@@ -2,7 +2,8 @@ import type { BackupCodeResource } from './backupCode';
 import type { BillingPayerMethods } from './billing';
 import type { DeletedObjectResource } from './deletedObject';
 import type { EmailAddressResource } from './emailAddress';
-import type { EnterpriseAccountConnectionResource, EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseConnectionResource } from './enterpriseConnection';
 import type { ExternalAccountResource } from './externalAccount';
 import type { ImageResource } from './image';
 import type { UserJSON } from './json';
@@ -118,7 +119,7 @@ export interface UserResource extends ClerkResource, BillingPayerMethods {
  ) => Promise<ClerkPaginatedResponse<OrganizationSuggestionResource>>;
  getOrganizationCreationDefaults: () => Promise<OrganizationCreationDefaultsResource>;
  leaveOrganization: (organizationId: string) => Promise<DeletedObjectResource>;
- getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseAccountConnectionResource[]>;
+ getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseConnectionResource[]>;
  createTOTP: () => Promise<TOTPResource>;
  verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
  disableTOTP: () => Promise<DeletedObjectResource>;

.changeset/humble-trams-laugh.md

@@ -0,0 +1,9 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/shared': minor
+'@clerk/ui': minor
+---
+
+Add `EnterpriseConnection` resource
+
+`User.getEnterpriseConnections()` was wrongly typed as returning `EnterpriseAccountConnectionResource[]`, it now returns `EnterpriseConnectionResource[]`

packages/clerk-js/bundlewatch.config.json

@@ -1,10 +1,10 @@
 {
  "files": [
- { "path": "./dist/clerk.js", "maxSize": "540KB" },
+ { "path": "./dist/clerk.js", "maxSize": "543KB" },
  { "path": "./dist/clerk.browser.js", "maxSize": "67KB" },
- { "path": "./dist/clerk.legacy.browser.js", "maxSize": "108KB" },
- { "path": "./dist/clerk.no-rhc.js", "maxSize": "307KB" },
- { "path": "./dist/clerk.native.js", "maxSize": "66KB" },
+ { "path": "./dist/clerk.legacy.browser.js", "maxSize": "110KB" },
+ { "path": "./dist/clerk.no-rhc.js", "maxSize": "309KB" },
+ { "path": "./dist/clerk.native.js", "maxSize": "68KB" },
  { "path": "./dist/vendors*.js", "maxSize": "7KB" },
  { "path": "./dist/coinbase*.js", "maxSize": "36KB" },
  { "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },

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

@@ -0,0 +1,141 @@
+import type {
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionJSONSnapshot,
+ EnterpriseConnectionResource,
+ EnterpriseOAuthConfigJSON,
+ EnterpriseOAuthConfigResource,
+ EnterpriseSamlConnectionNestedJSON,
+ EnterpriseSamlConnectionNestedResource,
+} from '@clerk/shared/types';
+
+import { unixEpochToDate } from '../../utils/date';
+import { BaseResource } from './Base';
+
+function samlNestedFromJSON(data: EnterpriseSamlConnectionNestedJSON): EnterpriseSamlConnectionNestedResource {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idpEntityId: data.idp_entity_id,
+ idpSsoUrl: data.idp_sso_url,
+ idpCertificate: data.idp_certificate,
+ idpMetadataUrl: data.idp_metadata_url,
+ idpMetadata: data.idp_metadata,
+ acsUrl: data.acs_url,
+ spEntityId: data.sp_entity_id,
+ spMetadataUrl: data.sp_metadata_url,
+ allowSubdomains: data.allow_subdomains,
+ allowIdpInitiated: data.allow_idp_initiated,
+ forceAuthn: data.force_authn,
+ };
+}
+
+function samlNestedToJSON(data: EnterpriseSamlConnectionNestedResource): EnterpriseSamlConnectionNestedJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idp_entity_id: data.idpEntityId,
+ idp_sso_url: data.idpSsoUrl,
+ idp_certificate: data.idpCertificate,
+ idp_metadata_url: data.idpMetadataUrl,
+ idp_metadata: data.idpMetadata,
+ acs_url: data.acsUrl,
+ sp_entity_id: data.spEntityId,
+ sp_metadata_url: data.spMetadataUrl,
+ allow_subdomains: data.allowSubdomains,
+ allow_idp_initiated: data.allowIdpInitiated,
+ force_authn: data.forceAuthn,
+ };
+}
+
+function oauthConfigFromJSON(data: EnterpriseOAuthConfigJSON): EnterpriseOAuthConfigResource {
+ return {
+ id: data.id,
+ name: data.name,
+ clientId: data.client_id,
+ providerKey: data.provider_key,
+ discoveryUrl: data.discovery_url,
+ logoPublicUrl: data.logo_public_url,
+ requiresPkce: data.requires_pkce,
+ createdAt: unixEpochToDate(data.created_at),
+ updatedAt: unixEpochToDate(data.updated_at),
+ };
+}
+
+function oauthConfigToJSON(data: EnterpriseOAuthConfigResource): EnterpriseOAuthConfigJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ client_id: data.clientId,
+ provider_key: data.providerKey,
+ discovery_url: data.discoveryUrl,
+ logo_public_url: data.logoPublicUrl,
+ requires_pkce: data.requiresPkce,
+ created_at: data.createdAt?.getTime() ?? 0,
+ updated_at: data.updatedAt?.getTime() ?? 0,
+ };
+}
+
+export class EnterpriseConnection extends BaseResource implements EnterpriseConnectionResource {
+ id!: string;
+ name!: string;
+ active!: boolean;
+ domains: string[] = [];
+ organizationId: string | null = null;
+ syncUserAttributes!: boolean;
+ disableAdditionalIdentifications!: boolean;
+ allowOrganizationAccountLinking!: boolean;
+ customAttributes: unknown[] = [];
+ oauthConfig: EnterpriseOAuthConfigResource | null = null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null = null;
+ createdAt: Date | null = null;
+ updatedAt: Date | null = null;
+
+ constructor(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null) {
+ super();
+ this.fromJSON(data);
+ }
+
+ protected fromJSON(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null): this {
+ if (!data) {
+ return this;
+ }
+
+ this.id = data.id;
+ this.name = data.name;
+ this.active = data.active;
+ this.domains = data.domains ?? [];
+ this.organizationId = data.organization_id ?? null;
+ this.syncUserAttributes = data.sync_user_attributes;
+ this.disableAdditionalIdentifications = data.disable_additional_identifications;
+ this.allowOrganizationAccountLinking = data.allow_organization_account_linking ?? false;
+ this.customAttributes = data.custom_attributes ?? [];
+ this.createdAt = unixEpochToDate(data.created_at);
+ this.updatedAt = unixEpochToDate(data.updated_at);
+
+ this.samlConnection = data.saml_connection ? samlNestedFromJSON(data.saml_connection) : null;
+ this.oauthConfig = data.oauth_config ? oauthConfigFromJSON(data.oauth_config) : null;
+
+ return this;
+ }
+
+ public __internal_toSnapshot(): EnterpriseConnectionJSONSnapshot {
+ return {
+ object: 'enterprise_connection',
+ id: this.id,
+ name: this.name,
+ active: this.active,
+ domains: this.domains,
+ organization_id: this.organizationId,
+ sync_user_attributes: this.syncUserAttributes,
+ disable_additional_identifications: this.disableAdditionalIdentifications,
+ allow_organization_account_linking: this.allowOrganizationAccountLinking,
+ custom_attributes: this.customAttributes,
+ saml_connection: this.samlConnection ? samlNestedToJSON(this.samlConnection) : undefined,
+ oauth_config: this.oauthConfig ? oauthConfigToJSON(this.oauthConfig) : undefined,
+ created_at: this.createdAt?.getTime() ?? 0,
+ updated_at: this.updatedAt?.getTime() ?? 0,
+ };
+ }
+}

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

@@ -9,9 +9,9 @@ import type {
  DeletedObjectJSON,
  DeletedObjectResource,
  EmailAddressResource,
- EnterpriseAccountConnectionJSON,
- EnterpriseAccountConnectionResource,
  EnterpriseAccountResource,
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionResource,
  ExternalAccountJSON,
  ExternalAccountResource,
  GetEnterpriseConnectionsParams,
@@ -45,7 +45,7 @@ import {
  DeletedObject,
  EmailAddress,
  EnterpriseAccount,
-EnterpriseAccountConnection,
+EnterpriseConnection,
  ExternalAccount,
  Image,
  OrganizationMembership,
@@ -296,7 +296,7 @@ export class User extends BaseResource implements UserResource {
 
  getEnterpriseConnections = async (
  params?: GetEnterpriseConnectionsParams,
- ): Promise<EnterpriseAccountConnectionResource[]> => {
+ ): Promise<EnterpriseConnectionResource[]> => {
  const { withOrganizationAccountLinking } = params || {};
 
  const json = (
@@ -311,9 +311,9 @@ export class User extends BaseResource implements UserResource {
  }
  : {}),
  })
- )?.response as unknown as EnterpriseAccountConnectionJSON[];
+ )?.response as unknown as EnterpriseConnectionJSON[];
 
- return (json || []).map(connection => new EnterpriseAccountConnection(connection));
+ return (json || []).map(connection => new EnterpriseConnection(connection));
  };
 
  initializePaymentMethod: typeof initializePaymentMethod = params => {

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

@@ -16,6 +16,7 @@ export * from './DeletedObject';
 export * from './DisplayConfig';
 export * from './EmailAddress';
 export * from './EnterpriseAccount';
+export * from './EnterpriseConnection';
 export * from './Environment';
 export * from './ExternalAccount';
 export * from './Feature';

packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx

@@ -1,4 +1,4 @@
-import type { EnterpriseAccountConnectionResource } from '../../types/enterpriseAccount';
+import type { EnterpriseConnectionResource } from '../../types/enterpriseConnection';
 import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
 import { useClerkQuery } from '../clerk-rq/useQuery';
 import { useClerkInstanceContext } from '../contexts';
@@ -13,7 +13,7 @@ export type UseUserEnterpriseConnectionsParams = {
 };
 
 export type UseUserEnterpriseConnectionsReturn = {
- data: EnterpriseAccountConnectionResource[] | undefined;
+ data: EnterpriseConnectionResource[] | undefined;
  error: Error | null;
  isLoading: boolean;
  isFetching: boolean;

packages/shared/src/types/enterpriseConnection.ts

@@ -0,0 +1,95 @@
+import type { ClerkResourceJSON } from './json';
+import type { ClerkResource } from './resource';
+
+export interface EnterpriseConnectionJSON extends ClerkResourceJSON {
+ object: 'enterprise_connection';
+ name: string;
+ active: boolean;
+ domains?: string[];
+ organization_id?: string | null;
+ sync_user_attributes: boolean;
+ disable_additional_identifications: boolean;
+ allow_organization_account_linking?: boolean;
+ custom_attributes?: unknown[];
+ oauth_config?: EnterpriseOAuthConfigJSON | null;
+ saml_connection?: EnterpriseSamlConnectionNestedJSON | null;
+ created_at: number;
+ updated_at: number;
+}
+
+export type EnterpriseConnectionJSONSnapshot = EnterpriseConnectionJSON;
+
+export interface EnterpriseConnectionResource extends ClerkResource {
+ id: string;
+ name: string;
+ active: boolean;
+ domains: string[];
+ organizationId: string | null;
+ syncUserAttributes: boolean;
+ disableAdditionalIdentifications: boolean;
+ allowOrganizationAccountLinking: boolean;
+ customAttributes: unknown[];
+ oauthConfig: EnterpriseOAuthConfigResource | null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+ __internal_toSnapshot: () => EnterpriseConnectionJSONSnapshot;
+}
+
+export interface EnterpriseSamlConnectionNestedJSON {
+ id: string;
+ name: string;
+ active: boolean;
+ idp_entity_id: string;
+ idp_sso_url: string;
+ idp_certificate: string;
+ idp_metadata_url: string;
+ idp_metadata: string;
+ acs_url: string;
+ sp_entity_id: string;
+ sp_metadata_url: string;
+ allow_subdomains: boolean;
+ allow_idp_initiated: boolean;
+ force_authn: boolean;
+}
+
+export interface EnterpriseSamlConnectionNestedResource {
+ id: string;
+ name: string;
+ active: boolean;
+ idpEntityId: string;
+ idpSsoUrl: string;
+ idpCertificate: string;
+ idpMetadataUrl: string;
+ idpMetadata: string;
+ acsUrl: string;
+ spEntityId: string;
+ spMetadataUrl: string;
+ allowSubdomains: boolean;
+ allowIdpInitiated: boolean;
+ forceAuthn: boolean;
+}
+
+export interface EnterpriseOAuthConfigJSON {
+ id: string;
+ name: string;
+ provider_key?: string;
+ client_id: string;
+ discovery_url?: string;
+ logo_public_url?: string | null;
+ requires_pkce?: boolean;
+ created_at: number;
+ updated_at: number;
+}
+
+export interface EnterpriseOAuthConfigResource {
+ id: string;
+ name: string;
+ clientId: string;
+ providerKey?: string;
+ discoveryUrl?: string;
+ logoPublicUrl?: string | null;
+ requiresPkce?: boolean;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+}

packages/shared/src/types/index.ts

@@ -16,6 +16,7 @@ export type * from './displayConfig';
 export type * from './elementIds';
 export type * from './emailAddress';
 export type * from './enterpriseAccount';
+export type * from './enterpriseConnection';
 export type * from './environment';
 export type * from './errors';
 export type * from './externalAccount';

packages/shared/src/types/user.ts

@@ -2,7 +2,8 @@ import type { BackupCodeResource } from './backupCode';
 import type { BillingPayerMethods } from './billing';
 import type { DeletedObjectResource } from './deletedObject';
 import type { EmailAddressResource } from './emailAddress';
-import type { EnterpriseAccountConnectionResource, EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseConnectionResource } from './enterpriseConnection';
 import type { ExternalAccountResource } from './externalAccount';
 import type { ImageResource } from './image';
 import type { UserJSON } from './json';
@@ -118,7 +119,7 @@ export interface UserResource extends ClerkResource, BillingPayerMethods {
  ) => Promise<ClerkPaginatedResponse<OrganizationSuggestionResource>>;
  getOrganizationCreationDefaults: () => Promise<OrganizationCreationDefaultsResource>;
  leaveOrganization: (organizationId: string) => Promise<DeletedObjectResource>;
- getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseAccountConnectionResource[]>;
+ getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseConnectionResource[]>;
  createTOTP: () => Promise<TOTPResource>;
  verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
  disableTOTP: () => Promise<DeletedObjectResource>;

.changeset/humble-trams-laugh.md

@@ -0,0 +1,9 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/shared': minor
+'@clerk/ui': minor
+---
+
+Add `EnterpriseConnection` resource
+
+`User.getEnterpriseConnections()` was wrongly typed as returning `EnterpriseAccountConnectionResource[]`, it now returns `EnterpriseConnectionResource[]`

packages/clerk-js/bundlewatch.config.json

@@ -1,10 +1,10 @@
 {
  "files": [
- { "path": "./dist/clerk.js", "maxSize": "540KB" },
+ { "path": "./dist/clerk.js", "maxSize": "543KB" },
  { "path": "./dist/clerk.browser.js", "maxSize": "67KB" },
- { "path": "./dist/clerk.legacy.browser.js", "maxSize": "108KB" },
- { "path": "./dist/clerk.no-rhc.js", "maxSize": "307KB" },
- { "path": "./dist/clerk.native.js", "maxSize": "66KB" },
+ { "path": "./dist/clerk.legacy.browser.js", "maxSize": "110KB" },
+ { "path": "./dist/clerk.no-rhc.js", "maxSize": "309KB" },
+ { "path": "./dist/clerk.native.js", "maxSize": "68KB" },
  { "path": "./dist/vendors*.js", "maxSize": "7KB" },
  { "path": "./dist/coinbase*.js", "maxSize": "36KB" },
  { "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },

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

@@ -0,0 +1,141 @@
+import type {
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionJSONSnapshot,
+ EnterpriseConnectionResource,
+ EnterpriseOAuthConfigJSON,
+ EnterpriseOAuthConfigResource,
+ EnterpriseSamlConnectionNestedJSON,
+ EnterpriseSamlConnectionNestedResource,
+} from '@clerk/shared/types';
+
+import { unixEpochToDate } from '../../utils/date';
+import { BaseResource } from './Base';
+
+function samlNestedFromJSON(data: EnterpriseSamlConnectionNestedJSON): EnterpriseSamlConnectionNestedResource {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idpEntityId: data.idp_entity_id,
+ idpSsoUrl: data.idp_sso_url,
+ idpCertificate: data.idp_certificate,
+ idpMetadataUrl: data.idp_metadata_url,
+ idpMetadata: data.idp_metadata,
+ acsUrl: data.acs_url,
+ spEntityId: data.sp_entity_id,
+ spMetadataUrl: data.sp_metadata_url,
+ allowSubdomains: data.allow_subdomains,
+ allowIdpInitiated: data.allow_idp_initiated,
+ forceAuthn: data.force_authn,
+ };
+}
+
+function samlNestedToJSON(data: EnterpriseSamlConnectionNestedResource): EnterpriseSamlConnectionNestedJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idp_entity_id: data.idpEntityId,
+ idp_sso_url: data.idpSsoUrl,
+ idp_certificate: data.idpCertificate,
+ idp_metadata_url: data.idpMetadataUrl,
+ idp_metadata: data.idpMetadata,
+ acs_url: data.acsUrl,
+ sp_entity_id: data.spEntityId,
+ sp_metadata_url: data.spMetadataUrl,
+ allow_subdomains: data.allowSubdomains,
+ allow_idp_initiated: data.allowIdpInitiated,
+ force_authn: data.forceAuthn,
+ };
+}
+
+function oauthConfigFromJSON(data: EnterpriseOAuthConfigJSON): EnterpriseOAuthConfigResource {
+ return {
+ id: data.id,
+ name: data.name,
+ clientId: data.client_id,
+ providerKey: data.provider_key,
+ discoveryUrl: data.discovery_url,
+ logoPublicUrl: data.logo_public_url,
+ requiresPkce: data.requires_pkce,
+ createdAt: unixEpochToDate(data.created_at),
+ updatedAt: unixEpochToDate(data.updated_at),
+ };
+}
+
+function oauthConfigToJSON(data: EnterpriseOAuthConfigResource): EnterpriseOAuthConfigJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ client_id: data.clientId,
+ provider_key: data.providerKey,
+ discovery_url: data.discoveryUrl,
+ logo_public_url: data.logoPublicUrl,
+ requires_pkce: data.requiresPkce,
+ created_at: data.createdAt?.getTime() ?? 0,
+ updated_at: data.updatedAt?.getTime() ?? 0,
+ };
+}
+
+export class EnterpriseConnection extends BaseResource implements EnterpriseConnectionResource {
+ id!: string;
+ name!: string;
+ active!: boolean;
+ domains: string[] = [];
+ organizationId: string | null = null;
+ syncUserAttributes!: boolean;
+ disableAdditionalIdentifications!: boolean;
+ allowOrganizationAccountLinking!: boolean;
+ customAttributes: unknown[] = [];
+ oauthConfig: EnterpriseOAuthConfigResource | null = null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null = null;
+ createdAt: Date | null = null;
+ updatedAt: Date | null = null;
+
+ constructor(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null) {
+ super();
+ this.fromJSON(data);
+ }
+
+ protected fromJSON(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null): this {
+ if (!data) {
+ return this;
+ }
+
+ this.id = data.id;
+ this.name = data.name;
+ this.active = data.active;
+ this.domains = data.domains ?? [];
+ this.organizationId = data.organization_id ?? null;
+ this.syncUserAttributes = data.sync_user_attributes;
+ this.disableAdditionalIdentifications = data.disable_additional_identifications;
+ this.allowOrganizationAccountLinking = data.allow_organization_account_linking ?? false;
+ this.customAttributes = data.custom_attributes ?? [];
+ this.createdAt = unixEpochToDate(data.created_at);
+ this.updatedAt = unixEpochToDate(data.updated_at);
+
+ this.samlConnection = data.saml_connection ? samlNestedFromJSON(data.saml_connection) : null;
+ this.oauthConfig = data.oauth_config ? oauthConfigFromJSON(data.oauth_config) : null;
+
+ return this;
+ }
+
+ public __internal_toSnapshot(): EnterpriseConnectionJSONSnapshot {
+ return {
+ object: 'enterprise_connection',
+ id: this.id,
+ name: this.name,
+ active: this.active,
+ domains: this.domains,
+ organization_id: this.organizationId,
+ sync_user_attributes: this.syncUserAttributes,
+ disable_additional_identifications: this.disableAdditionalIdentifications,
+ allow_organization_account_linking: this.allowOrganizationAccountLinking,
+ custom_attributes: this.customAttributes,
+ saml_connection: this.samlConnection ? samlNestedToJSON(this.samlConnection) : undefined,
+ oauth_config: this.oauthConfig ? oauthConfigToJSON(this.oauthConfig) : undefined,
+ created_at: this.createdAt?.getTime() ?? 0,
+ updated_at: this.updatedAt?.getTime() ?? 0,
+ };
+ }
+}

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

@@ -9,9 +9,9 @@ import type {
  DeletedObjectJSON,
  DeletedObjectResource,
  EmailAddressResource,
- EnterpriseAccountConnectionJSON,
- EnterpriseAccountConnectionResource,
  EnterpriseAccountResource,
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionResource,
  ExternalAccountJSON,
  ExternalAccountResource,
  GetEnterpriseConnectionsParams,
@@ -45,7 +45,7 @@ import {
  DeletedObject,
  EmailAddress,
  EnterpriseAccount,
-EnterpriseAccountConnection,
+EnterpriseConnection,
  ExternalAccount,
  Image,
  OrganizationMembership,
@@ -296,7 +296,7 @@ export class User extends BaseResource implements UserResource {
 
  getEnterpriseConnections = async (
  params?: GetEnterpriseConnectionsParams,
- ): Promise<EnterpriseAccountConnectionResource[]> => {
+ ): Promise<EnterpriseConnectionResource[]> => {
  const { withOrganizationAccountLinking } = params || {};
 
  const json = (
@@ -311,9 +311,9 @@ export class User extends BaseResource implements UserResource {
  }
  : {}),
  })
- )?.response as unknown as EnterpriseAccountConnectionJSON[];
+ )?.response as unknown as EnterpriseConnectionJSON[];
 
- return (json || []).map(connection => new EnterpriseAccountConnection(connection));
+ return (json || []).map(connection => new EnterpriseConnection(connection));
  };
 
  initializePaymentMethod: typeof initializePaymentMethod = params => {

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

@@ -16,6 +16,7 @@ export * from './DeletedObject';
 export * from './DisplayConfig';
 export * from './EmailAddress';
 export * from './EnterpriseAccount';
+export * from './EnterpriseConnection';
 export * from './Environment';
 export * from './ExternalAccount';
 export * from './Feature';

packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx

@@ -1,4 +1,4 @@
-import type { EnterpriseAccountConnectionResource } from '../../types/enterpriseAccount';
+import type { EnterpriseConnectionResource } from '../../types/enterpriseConnection';
 import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
 import { useClerkQuery } from '../clerk-rq/useQuery';
 import { useClerkInstanceContext } from '../contexts';
@@ -13,7 +13,7 @@ export type UseUserEnterpriseConnectionsParams = {
 };
 
 export type UseUserEnterpriseConnectionsReturn = {
- data: EnterpriseAccountConnectionResource[] | undefined;
+ data: EnterpriseConnectionResource[] | undefined;
  error: Error | null;
  isLoading: boolean;
  isFetching: boolean;

packages/shared/src/types/enterpriseConnection.ts

@@ -0,0 +1,95 @@
+import type { ClerkResourceJSON } from './json';
+import type { ClerkResource } from './resource';
+
+export interface EnterpriseConnectionJSON extends ClerkResourceJSON {
+ object: 'enterprise_connection';
+ name: string;
+ active: boolean;
+ domains?: string[];
+ organization_id?: string | null;
+ sync_user_attributes: boolean;
+ disable_additional_identifications: boolean;
+ allow_organization_account_linking?: boolean;
+ custom_attributes?: unknown[];
+ oauth_config?: EnterpriseOAuthConfigJSON | null;
+ saml_connection?: EnterpriseSamlConnectionNestedJSON | null;
+ created_at: number;
+ updated_at: number;
+}
+
+export type EnterpriseConnectionJSONSnapshot = EnterpriseConnectionJSON;
+
+export interface EnterpriseConnectionResource extends ClerkResource {
+ id: string;
+ name: string;
+ active: boolean;
+ domains: string[];
+ organizationId: string | null;
+ syncUserAttributes: boolean;
+ disableAdditionalIdentifications: boolean;
+ allowOrganizationAccountLinking: boolean;
+ customAttributes: unknown[];
+ oauthConfig: EnterpriseOAuthConfigResource | null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+ __internal_toSnapshot: () => EnterpriseConnectionJSONSnapshot;
+}
+
+export interface EnterpriseSamlConnectionNestedJSON {
+ id: string;
+ name: string;
+ active: boolean;
+ idp_entity_id: string;
+ idp_sso_url: string;
+ idp_certificate: string;
+ idp_metadata_url: string;
+ idp_metadata: string;
+ acs_url: string;
+ sp_entity_id: string;
+ sp_metadata_url: string;
+ allow_subdomains: boolean;
+ allow_idp_initiated: boolean;
+ force_authn: boolean;
+}
+
+export interface EnterpriseSamlConnectionNestedResource {
+ id: string;
+ name: string;
+ active: boolean;
+ idpEntityId: string;
+ idpSsoUrl: string;
+ idpCertificate: string;
+ idpMetadataUrl: string;
+ idpMetadata: string;
+ acsUrl: string;
+ spEntityId: string;
+ spMetadataUrl: string;
+ allowSubdomains: boolean;
+ allowIdpInitiated: boolean;
+ forceAuthn: boolean;
+}
+
+export interface EnterpriseOAuthConfigJSON {
+ id: string;
+ name: string;
+ provider_key?: string;
+ client_id: string;
+ discovery_url?: string;
+ logo_public_url?: string | null;
+ requires_pkce?: boolean;
+ created_at: number;
+ updated_at: number;
+}
+
+export interface EnterpriseOAuthConfigResource {
+ id: string;
+ name: string;
+ clientId: string;
+ providerKey?: string;
+ discoveryUrl?: string;
+ logoPublicUrl?: string | null;
+ requiresPkce?: boolean;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+}

packages/shared/src/types/index.ts

@@ -16,6 +16,7 @@ export type * from './displayConfig';
 export type * from './elementIds';
 export type * from './emailAddress';
 export type * from './enterpriseAccount';
+export type * from './enterpriseConnection';
 export type * from './environment';
 export type * from './errors';
 export type * from './externalAccount';

packages/shared/src/types/user.ts

@@ -2,7 +2,8 @@ import type { BackupCodeResource } from './backupCode';
 import type { BillingPayerMethods } from './billing';
 import type { DeletedObjectResource } from './deletedObject';
 import type { EmailAddressResource } from './emailAddress';
-import type { EnterpriseAccountConnectionResource, EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseConnectionResource } from './enterpriseConnection';
 import type { ExternalAccountResource } from './externalAccount';
 import type { ImageResource } from './image';
 import type { UserJSON } from './json';
@@ -118,7 +119,7 @@ export interface UserResource extends ClerkResource, BillingPayerMethods {
  ) => Promise<ClerkPaginatedResponse<OrganizationSuggestionResource>>;
  getOrganizationCreationDefaults: () => Promise<OrganizationCreationDefaultsResource>;
  leaveOrganization: (organizationId: string) => Promise<DeletedObjectResource>;
- getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseAccountConnectionResource[]>;
+ getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseConnectionResource[]>;
  createTOTP: () => Promise<TOTPResource>;
  verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
  disableTOTP: () => Promise<DeletedObjectResource>;

.changeset/humble-trams-laugh.md

@@ -0,0 +1,9 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/shared': minor
+'@clerk/ui': minor
+---
+
+Add `EnterpriseConnection` resource
+
+`User.getEnterpriseConnections()` was wrongly typed as returning `EnterpriseAccountConnectionResource[]`, it now returns `EnterpriseConnectionResource[]`

packages/clerk-js/bundlewatch.config.json

@@ -1,10 +1,10 @@
 {
  "files": [
- { "path": "./dist/clerk.js", "maxSize": "540KB" },
+ { "path": "./dist/clerk.js", "maxSize": "543KB" },
  { "path": "./dist/clerk.browser.js", "maxSize": "67KB" },
- { "path": "./dist/clerk.legacy.browser.js", "maxSize": "108KB" },
- { "path": "./dist/clerk.no-rhc.js", "maxSize": "307KB" },
- { "path": "./dist/clerk.native.js", "maxSize": "66KB" },
+ { "path": "./dist/clerk.legacy.browser.js", "maxSize": "110KB" },
+ { "path": "./dist/clerk.no-rhc.js", "maxSize": "309KB" },
+ { "path": "./dist/clerk.native.js", "maxSize": "68KB" },
  { "path": "./dist/vendors*.js", "maxSize": "7KB" },
  { "path": "./dist/coinbase*.js", "maxSize": "36KB" },
  { "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },

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

@@ -0,0 +1,141 @@
+import type {
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionJSONSnapshot,
+ EnterpriseConnectionResource,
+ EnterpriseOAuthConfigJSON,
+ EnterpriseOAuthConfigResource,
+ EnterpriseSamlConnectionNestedJSON,
+ EnterpriseSamlConnectionNestedResource,
+} from '@clerk/shared/types';
+
+import { unixEpochToDate } from '../../utils/date';
+import { BaseResource } from './Base';
+
+function samlNestedFromJSON(data: EnterpriseSamlConnectionNestedJSON): EnterpriseSamlConnectionNestedResource {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idpEntityId: data.idp_entity_id,
+ idpSsoUrl: data.idp_sso_url,
+ idpCertificate: data.idp_certificate,
+ idpMetadataUrl: data.idp_metadata_url,
+ idpMetadata: data.idp_metadata,
+ acsUrl: data.acs_url,
+ spEntityId: data.sp_entity_id,
+ spMetadataUrl: data.sp_metadata_url,
+ allowSubdomains: data.allow_subdomains,
+ allowIdpInitiated: data.allow_idp_initiated,
+ forceAuthn: data.force_authn,
+ };
+}
+
+function samlNestedToJSON(data: EnterpriseSamlConnectionNestedResource): EnterpriseSamlConnectionNestedJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idp_entity_id: data.idpEntityId,
+ idp_sso_url: data.idpSsoUrl,
+ idp_certificate: data.idpCertificate,
+ idp_metadata_url: data.idpMetadataUrl,
+ idp_metadata: data.idpMetadata,
+ acs_url: data.acsUrl,
+ sp_entity_id: data.spEntityId,
+ sp_metadata_url: data.spMetadataUrl,
+ allow_subdomains: data.allowSubdomains,
+ allow_idp_initiated: data.allowIdpInitiated,
+ force_authn: data.forceAuthn,
+ };
+}
+
+function oauthConfigFromJSON(data: EnterpriseOAuthConfigJSON): EnterpriseOAuthConfigResource {
+ return {
+ id: data.id,
+ name: data.name,
+ clientId: data.client_id,
+ providerKey: data.provider_key,
+ discoveryUrl: data.discovery_url,
+ logoPublicUrl: data.logo_public_url,
+ requiresPkce: data.requires_pkce,
+ createdAt: unixEpochToDate(data.created_at),
+ updatedAt: unixEpochToDate(data.updated_at),
+ };
+}
+
+function oauthConfigToJSON(data: EnterpriseOAuthConfigResource): EnterpriseOAuthConfigJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ client_id: data.clientId,
+ provider_key: data.providerKey,
+ discovery_url: data.discoveryUrl,
+ logo_public_url: data.logoPublicUrl,
+ requires_pkce: data.requiresPkce,
+ created_at: data.createdAt?.getTime() ?? 0,
+ updated_at: data.updatedAt?.getTime() ?? 0,
+ };
+}
+
+export class EnterpriseConnection extends BaseResource implements EnterpriseConnectionResource {
+ id!: string;
+ name!: string;
+ active!: boolean;
+ domains: string[] = [];
+ organizationId: string | null = null;
+ syncUserAttributes!: boolean;
+ disableAdditionalIdentifications!: boolean;
+ allowOrganizationAccountLinking!: boolean;
+ customAttributes: unknown[] = [];
+ oauthConfig: EnterpriseOAuthConfigResource | null = null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null = null;
+ createdAt: Date | null = null;
+ updatedAt: Date | null = null;
+
+ constructor(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null) {
+ super();
+ this.fromJSON(data);
+ }
+
+ protected fromJSON(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null): this {
+ if (!data) {
+ return this;
+ }
+
+ this.id = data.id;
+ this.name = data.name;
+ this.active = data.active;
+ this.domains = data.domains ?? [];
+ this.organizationId = data.organization_id ?? null;
+ this.syncUserAttributes = data.sync_user_attributes;
+ this.disableAdditionalIdentifications = data.disable_additional_identifications;
+ this.allowOrganizationAccountLinking = data.allow_organization_account_linking ?? false;
+ this.customAttributes = data.custom_attributes ?? [];
+ this.createdAt = unixEpochToDate(data.created_at);
+ this.updatedAt = unixEpochToDate(data.updated_at);
+
+ this.samlConnection = data.saml_connection ? samlNestedFromJSON(data.saml_connection) : null;
+ this.oauthConfig = data.oauth_config ? oauthConfigFromJSON(data.oauth_config) : null;
+
+ return this;
+ }
+
+ public __internal_toSnapshot(): EnterpriseConnectionJSONSnapshot {
+ return {
+ object: 'enterprise_connection',
+ id: this.id,
+ name: this.name,
+ active: this.active,
+ domains: this.domains,
+ organization_id: this.organizationId,
+ sync_user_attributes: this.syncUserAttributes,
+ disable_additional_identifications: this.disableAdditionalIdentifications,
+ allow_organization_account_linking: this.allowOrganizationAccountLinking,
+ custom_attributes: this.customAttributes,
+ saml_connection: this.samlConnection ? samlNestedToJSON(this.samlConnection) : undefined,
+ oauth_config: this.oauthConfig ? oauthConfigToJSON(this.oauthConfig) : undefined,
+ created_at: this.createdAt?.getTime() ?? 0,
+ updated_at: this.updatedAt?.getTime() ?? 0,
+ };
+ }
+}

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

@@ -9,9 +9,9 @@ import type {
  DeletedObjectJSON,
  DeletedObjectResource,
  EmailAddressResource,
- EnterpriseAccountConnectionJSON,
- EnterpriseAccountConnectionResource,
  EnterpriseAccountResource,
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionResource,
  ExternalAccountJSON,
  ExternalAccountResource,
  GetEnterpriseConnectionsParams,
@@ -45,7 +45,7 @@ import {
  DeletedObject,
  EmailAddress,
  EnterpriseAccount,
-EnterpriseAccountConnection,
+EnterpriseConnection,
  ExternalAccount,
  Image,
  OrganizationMembership,
@@ -296,7 +296,7 @@ export class User extends BaseResource implements UserResource {
 
  getEnterpriseConnections = async (
  params?: GetEnterpriseConnectionsParams,
- ): Promise<EnterpriseAccountConnectionResource[]> => {
+ ): Promise<EnterpriseConnectionResource[]> => {
  const { withOrganizationAccountLinking } = params || {};
 
  const json = (
@@ -311,9 +311,9 @@ export class User extends BaseResource implements UserResource {
  }
  : {}),
  })
- )?.response as unknown as EnterpriseAccountConnectionJSON[];
+ )?.response as unknown as EnterpriseConnectionJSON[];
 
- return (json || []).map(connection => new EnterpriseAccountConnection(connection));
+ return (json || []).map(connection => new EnterpriseConnection(connection));
  };
 
  initializePaymentMethod: typeof initializePaymentMethod = params => {

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

@@ -16,6 +16,7 @@ export * from './DeletedObject';
 export * from './DisplayConfig';
 export * from './EmailAddress';
 export * from './EnterpriseAccount';
+export * from './EnterpriseConnection';
 export * from './Environment';
 export * from './ExternalAccount';
 export * from './Feature';

packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx

@@ -1,4 +1,4 @@
-import type { EnterpriseAccountConnectionResource } from '../../types/enterpriseAccount';
+import type { EnterpriseConnectionResource } from '../../types/enterpriseConnection';
 import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
 import { useClerkQuery } from '../clerk-rq/useQuery';
 import { useClerkInstanceContext } from '../contexts';
@@ -13,7 +13,7 @@ export type UseUserEnterpriseConnectionsParams = {
 };
 
 export type UseUserEnterpriseConnectionsReturn = {
- data: EnterpriseAccountConnectionResource[] | undefined;
+ data: EnterpriseConnectionResource[] | undefined;
  error: Error | null;
  isLoading: boolean;
  isFetching: boolean;

packages/shared/src/types/enterpriseConnection.ts

@@ -0,0 +1,95 @@
+import type { ClerkResourceJSON } from './json';
+import type { ClerkResource } from './resource';
+
+export interface EnterpriseConnectionJSON extends ClerkResourceJSON {
+ object: 'enterprise_connection';
+ name: string;
+ active: boolean;
+ domains?: string[];
+ organization_id?: string | null;
+ sync_user_attributes: boolean;
+ disable_additional_identifications: boolean;
+ allow_organization_account_linking?: boolean;
+ custom_attributes?: unknown[];
+ oauth_config?: EnterpriseOAuthConfigJSON | null;
+ saml_connection?: EnterpriseSamlConnectionNestedJSON | null;
+ created_at: number;
+ updated_at: number;
+}
+
+export type EnterpriseConnectionJSONSnapshot = EnterpriseConnectionJSON;
+
+export interface EnterpriseConnectionResource extends ClerkResource {
+ id: string;
+ name: string;
+ active: boolean;
+ domains: string[];
+ organizationId: string | null;
+ syncUserAttributes: boolean;
+ disableAdditionalIdentifications: boolean;
+ allowOrganizationAccountLinking: boolean;
+ customAttributes: unknown[];
+ oauthConfig: EnterpriseOAuthConfigResource | null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+ __internal_toSnapshot: () => EnterpriseConnectionJSONSnapshot;
+}
+
+export interface EnterpriseSamlConnectionNestedJSON {
+ id: string;
+ name: string;
+ active: boolean;
+ idp_entity_id: string;
+ idp_sso_url: string;
+ idp_certificate: string;
+ idp_metadata_url: string;
+ idp_metadata: string;
+ acs_url: string;
+ sp_entity_id: string;
+ sp_metadata_url: string;
+ allow_subdomains: boolean;
+ allow_idp_initiated: boolean;
+ force_authn: boolean;
+}
+
+export interface EnterpriseSamlConnectionNestedResource {
+ id: string;
+ name: string;
+ active: boolean;
+ idpEntityId: string;
+ idpSsoUrl: string;
+ idpCertificate: string;
+ idpMetadataUrl: string;
+ idpMetadata: string;
+ acsUrl: string;
+ spEntityId: string;
+ spMetadataUrl: string;
+ allowSubdomains: boolean;
+ allowIdpInitiated: boolean;
+ forceAuthn: boolean;
+}
+
+export interface EnterpriseOAuthConfigJSON {
+ id: string;
+ name: string;
+ provider_key?: string;
+ client_id: string;
+ discovery_url?: string;
+ logo_public_url?: string | null;
+ requires_pkce?: boolean;
+ created_at: number;
+ updated_at: number;
+}
+
+export interface EnterpriseOAuthConfigResource {
+ id: string;
+ name: string;
+ clientId: string;
+ providerKey?: string;
+ discoveryUrl?: string;
+ logoPublicUrl?: string | null;
+ requiresPkce?: boolean;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+}

packages/shared/src/types/index.ts

@@ -16,6 +16,7 @@ export type * from './displayConfig';
 export type * from './elementIds';
 export type * from './emailAddress';
 export type * from './enterpriseAccount';
+export type * from './enterpriseConnection';
 export type * from './environment';
 export type * from './errors';
 export type * from './externalAccount';

packages/shared/src/types/user.ts

@@ -2,7 +2,8 @@ import type { BackupCodeResource } from './backupCode';
 import type { BillingPayerMethods } from './billing';
 import type { DeletedObjectResource } from './deletedObject';
 import type { EmailAddressResource } from './emailAddress';
-import type { EnterpriseAccountConnectionResource, EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseConnectionResource } from './enterpriseConnection';
 import type { ExternalAccountResource } from './externalAccount';
 import type { ImageResource } from './image';
 import type { UserJSON } from './json';
@@ -118,7 +119,7 @@ export interface UserResource extends ClerkResource, BillingPayerMethods {
  ) => Promise<ClerkPaginatedResponse<OrganizationSuggestionResource>>;
  getOrganizationCreationDefaults: () => Promise<OrganizationCreationDefaultsResource>;
  leaveOrganization: (organizationId: string) => Promise<DeletedObjectResource>;
- getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseAccountConnectionResource[]>;
+ getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseConnectionResource[]>;
  createTOTP: () => Promise<TOTPResource>;
  verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
  disableTOTP: () => Promise<DeletedObjectResource>;

.changeset/humble-trams-laugh.md

@@ -0,0 +1,9 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/shared': minor
+'@clerk/ui': minor
+---
+
+Add `EnterpriseConnection` resource
+
+`User.getEnterpriseConnections()` was wrongly typed as returning `EnterpriseAccountConnectionResource[]`, it now returns `EnterpriseConnectionResource[]`

packages/clerk-js/bundlewatch.config.json

@@ -1,10 +1,10 @@
 {
  "files": [
- { "path": "./dist/clerk.js", "maxSize": "540KB" },
+ { "path": "./dist/clerk.js", "maxSize": "543KB" },
  { "path": "./dist/clerk.browser.js", "maxSize": "67KB" },
- { "path": "./dist/clerk.legacy.browser.js", "maxSize": "108KB" },
- { "path": "./dist/clerk.no-rhc.js", "maxSize": "307KB" },
- { "path": "./dist/clerk.native.js", "maxSize": "66KB" },
+ { "path": "./dist/clerk.legacy.browser.js", "maxSize": "110KB" },
+ { "path": "./dist/clerk.no-rhc.js", "maxSize": "309KB" },
+ { "path": "./dist/clerk.native.js", "maxSize": "68KB" },
  { "path": "./dist/vendors*.js", "maxSize": "7KB" },
  { "path": "./dist/coinbase*.js", "maxSize": "36KB" },
  { "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },

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

@@ -0,0 +1,141 @@
+import type {
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionJSONSnapshot,
+ EnterpriseConnectionResource,
+ EnterpriseOAuthConfigJSON,
+ EnterpriseOAuthConfigResource,
+ EnterpriseSamlConnectionNestedJSON,
+ EnterpriseSamlConnectionNestedResource,
+} from '@clerk/shared/types';
+
+import { unixEpochToDate } from '../../utils/date';
+import { BaseResource } from './Base';
+
+function samlNestedFromJSON(data: EnterpriseSamlConnectionNestedJSON): EnterpriseSamlConnectionNestedResource {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idpEntityId: data.idp_entity_id,
+ idpSsoUrl: data.idp_sso_url,
+ idpCertificate: data.idp_certificate,
+ idpMetadataUrl: data.idp_metadata_url,
+ idpMetadata: data.idp_metadata,
+ acsUrl: data.acs_url,
+ spEntityId: data.sp_entity_id,
+ spMetadataUrl: data.sp_metadata_url,
+ allowSubdomains: data.allow_subdomains,
+ allowIdpInitiated: data.allow_idp_initiated,
+ forceAuthn: data.force_authn,
+ };
+}
+
+function samlNestedToJSON(data: EnterpriseSamlConnectionNestedResource): EnterpriseSamlConnectionNestedJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idp_entity_id: data.idpEntityId,
+ idp_sso_url: data.idpSsoUrl,
+ idp_certificate: data.idpCertificate,
+ idp_metadata_url: data.idpMetadataUrl,
+ idp_metadata: data.idpMetadata,
+ acs_url: data.acsUrl,
+ sp_entity_id: data.spEntityId,
+ sp_metadata_url: data.spMetadataUrl,
+ allow_subdomains: data.allowSubdomains,
+ allow_idp_initiated: data.allowIdpInitiated,
+ force_authn: data.forceAuthn,
+ };
+}
+
+function oauthConfigFromJSON(data: EnterpriseOAuthConfigJSON): EnterpriseOAuthConfigResource {
+ return {
+ id: data.id,
+ name: data.name,
+ clientId: data.client_id,
+ providerKey: data.provider_key,
+ discoveryUrl: data.discovery_url,
+ logoPublicUrl: data.logo_public_url,
+ requiresPkce: data.requires_pkce,
+ createdAt: unixEpochToDate(data.created_at),
+ updatedAt: unixEpochToDate(data.updated_at),
+ };
+}
+
+function oauthConfigToJSON(data: EnterpriseOAuthConfigResource): EnterpriseOAuthConfigJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ client_id: data.clientId,
+ provider_key: data.providerKey,
+ discovery_url: data.discoveryUrl,
+ logo_public_url: data.logoPublicUrl,
+ requires_pkce: data.requiresPkce,
+ created_at: data.createdAt?.getTime() ?? 0,
+ updated_at: data.updatedAt?.getTime() ?? 0,
+ };
+}
+
+export class EnterpriseConnection extends BaseResource implements EnterpriseConnectionResource {
+ id!: string;
+ name!: string;
+ active!: boolean;
+ domains: string[] = [];
+ organizationId: string | null = null;
+ syncUserAttributes!: boolean;
+ disableAdditionalIdentifications!: boolean;
+ allowOrganizationAccountLinking!: boolean;
+ customAttributes: unknown[] = [];
+ oauthConfig: EnterpriseOAuthConfigResource | null = null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null = null;
+ createdAt: Date | null = null;
+ updatedAt: Date | null = null;
+
+ constructor(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null) {
+ super();
+ this.fromJSON(data);
+ }
+
+ protected fromJSON(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null): this {
+ if (!data) {
+ return this;
+ }
+
+ this.id = data.id;
+ this.name = data.name;
+ this.active = data.active;
+ this.domains = data.domains ?? [];
+ this.organizationId = data.organization_id ?? null;
+ this.syncUserAttributes = data.sync_user_attributes;
+ this.disableAdditionalIdentifications = data.disable_additional_identifications;
+ this.allowOrganizationAccountLinking = data.allow_organization_account_linking ?? false;
+ this.customAttributes = data.custom_attributes ?? [];
+ this.createdAt = unixEpochToDate(data.created_at);
+ this.updatedAt = unixEpochToDate(data.updated_at);
+
+ this.samlConnection = data.saml_connection ? samlNestedFromJSON(data.saml_connection) : null;
+ this.oauthConfig = data.oauth_config ? oauthConfigFromJSON(data.oauth_config) : null;
+
+ return this;
+ }
+
+ public __internal_toSnapshot(): EnterpriseConnectionJSONSnapshot {
+ return {
+ object: 'enterprise_connection',
+ id: this.id,
+ name: this.name,
+ active: this.active,
+ domains: this.domains,
+ organization_id: this.organizationId,
+ sync_user_attributes: this.syncUserAttributes,
+ disable_additional_identifications: this.disableAdditionalIdentifications,
+ allow_organization_account_linking: this.allowOrganizationAccountLinking,
+ custom_attributes: this.customAttributes,
+ saml_connection: this.samlConnection ? samlNestedToJSON(this.samlConnection) : undefined,
+ oauth_config: this.oauthConfig ? oauthConfigToJSON(this.oauthConfig) : undefined,
+ created_at: this.createdAt?.getTime() ?? 0,
+ updated_at: this.updatedAt?.getTime() ?? 0,
+ };
+ }
+}

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

@@ -9,9 +9,9 @@ import type {
  DeletedObjectJSON,
  DeletedObjectResource,
  EmailAddressResource,
- EnterpriseAccountConnectionJSON,
- EnterpriseAccountConnectionResource,
  EnterpriseAccountResource,
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionResource,
  ExternalAccountJSON,
  ExternalAccountResource,
  GetEnterpriseConnectionsParams,
@@ -45,7 +45,7 @@ import {
  DeletedObject,
  EmailAddress,
  EnterpriseAccount,
-EnterpriseAccountConnection,
+EnterpriseConnection,
  ExternalAccount,
  Image,
  OrganizationMembership,
@@ -296,7 +296,7 @@ export class User extends BaseResource implements UserResource {
 
  getEnterpriseConnections = async (
  params?: GetEnterpriseConnectionsParams,
- ): Promise<EnterpriseAccountConnectionResource[]> => {
+ ): Promise<EnterpriseConnectionResource[]> => {
  const { withOrganizationAccountLinking } = params || {};
 
  const json = (
@@ -311,9 +311,9 @@ export class User extends BaseResource implements UserResource {
  }
  : {}),
  })
- )?.response as unknown as EnterpriseAccountConnectionJSON[];
+ )?.response as unknown as EnterpriseConnectionJSON[];
 
- return (json || []).map(connection => new EnterpriseAccountConnection(connection));
+ return (json || []).map(connection => new EnterpriseConnection(connection));
  };
 
  initializePaymentMethod: typeof initializePaymentMethod = params => {

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

@@ -16,6 +16,7 @@ export * from './DeletedObject';
 export * from './DisplayConfig';
 export * from './EmailAddress';
 export * from './EnterpriseAccount';
+export * from './EnterpriseConnection';
 export * from './Environment';
 export * from './ExternalAccount';
 export * from './Feature';

packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx

@@ -1,4 +1,4 @@
-import type { EnterpriseAccountConnectionResource } from '../../types/enterpriseAccount';
+import type { EnterpriseConnectionResource } from '../../types/enterpriseConnection';
 import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
 import { useClerkQuery } from '../clerk-rq/useQuery';
 import { useClerkInstanceContext } from '../contexts';
@@ -13,7 +13,7 @@ export type UseUserEnterpriseConnectionsParams = {
 };
 
 export type UseUserEnterpriseConnectionsReturn = {
- data: EnterpriseAccountConnectionResource[] | undefined;
+ data: EnterpriseConnectionResource[] | undefined;
  error: Error | null;
  isLoading: boolean;
  isFetching: boolean;

packages/shared/src/types/enterpriseConnection.ts

@@ -0,0 +1,95 @@
+import type { ClerkResourceJSON } from './json';
+import type { ClerkResource } from './resource';
+
+export interface EnterpriseConnectionJSON extends ClerkResourceJSON {
+ object: 'enterprise_connection';
+ name: string;
+ active: boolean;
+ domains?: string[];
+ organization_id?: string | null;
+ sync_user_attributes: boolean;
+ disable_additional_identifications: boolean;
+ allow_organization_account_linking?: boolean;
+ custom_attributes?: unknown[];
+ oauth_config?: EnterpriseOAuthConfigJSON | null;
+ saml_connection?: EnterpriseSamlConnectionNestedJSON | null;
+ created_at: number;
+ updated_at: number;
+}
+
+export type EnterpriseConnectionJSONSnapshot = EnterpriseConnectionJSON;
+
+export interface EnterpriseConnectionResource extends ClerkResource {
+ id: string;
+ name: string;
+ active: boolean;
+ domains: string[];
+ organizationId: string | null;
+ syncUserAttributes: boolean;
+ disableAdditionalIdentifications: boolean;
+ allowOrganizationAccountLinking: boolean;
+ customAttributes: unknown[];
+ oauthConfig: EnterpriseOAuthConfigResource | null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+ __internal_toSnapshot: () => EnterpriseConnectionJSONSnapshot;
+}
+
+export interface EnterpriseSamlConnectionNestedJSON {
+ id: string;
+ name: string;
+ active: boolean;
+ idp_entity_id: string;
+ idp_sso_url: string;
+ idp_certificate: string;
+ idp_metadata_url: string;
+ idp_metadata: string;
+ acs_url: string;
+ sp_entity_id: string;
+ sp_metadata_url: string;
+ allow_subdomains: boolean;
+ allow_idp_initiated: boolean;
+ force_authn: boolean;
+}
+
+export interface EnterpriseSamlConnectionNestedResource {
+ id: string;
+ name: string;
+ active: boolean;
+ idpEntityId: string;
+ idpSsoUrl: string;
+ idpCertificate: string;
+ idpMetadataUrl: string;
+ idpMetadata: string;
+ acsUrl: string;
+ spEntityId: string;
+ spMetadataUrl: string;
+ allowSubdomains: boolean;
+ allowIdpInitiated: boolean;
+ forceAuthn: boolean;
+}
+
+export interface EnterpriseOAuthConfigJSON {
+ id: string;
+ name: string;
+ provider_key?: string;
+ client_id: string;
+ discovery_url?: string;
+ logo_public_url?: string | null;
+ requires_pkce?: boolean;
+ created_at: number;
+ updated_at: number;
+}
+
+export interface EnterpriseOAuthConfigResource {
+ id: string;
+ name: string;
+ clientId: string;
+ providerKey?: string;
+ discoveryUrl?: string;
+ logoPublicUrl?: string | null;
+ requiresPkce?: boolean;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+}

packages/shared/src/types/index.ts

@@ -16,6 +16,7 @@ export type * from './displayConfig';
 export type * from './elementIds';
 export type * from './emailAddress';
 export type * from './enterpriseAccount';
+export type * from './enterpriseConnection';
 export type * from './environment';
 export type * from './errors';
 export type * from './externalAccount';

packages/shared/src/types/user.ts

@@ -2,7 +2,8 @@ import type { BackupCodeResource } from './backupCode';
 import type { BillingPayerMethods } from './billing';
 import type { DeletedObjectResource } from './deletedObject';
 import type { EmailAddressResource } from './emailAddress';
-import type { EnterpriseAccountConnectionResource, EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseConnectionResource } from './enterpriseConnection';
 import type { ExternalAccountResource } from './externalAccount';
 import type { ImageResource } from './image';
 import type { UserJSON } from './json';
@@ -118,7 +119,7 @@ export interface UserResource extends ClerkResource, BillingPayerMethods {
  ) => Promise<ClerkPaginatedResponse<OrganizationSuggestionResource>>;
  getOrganizationCreationDefaults: () => Promise<OrganizationCreationDefaultsResource>;
  leaveOrganization: (organizationId: string) => Promise<DeletedObjectResource>;
- getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseAccountConnectionResource[]>;
+ getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseConnectionResource[]>;
  createTOTP: () => Promise<TOTPResource>;
  verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
  disableTOTP: () => Promise<DeletedObjectResource>;

.changeset/humble-trams-laugh.md

@@ -0,0 +1,9 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/shared': minor
+'@clerk/ui': minor
+---
+
+Add `EnterpriseConnection` resource
+
+`User.getEnterpriseConnections()` was wrongly typed as returning `EnterpriseAccountConnectionResource[]`, it now returns `EnterpriseConnectionResource[]`

packages/clerk-js/bundlewatch.config.json

@@ -1,10 +1,10 @@
 {
  "files": [
- { "path": "./dist/clerk.js", "maxSize": "540KB" },
+ { "path": "./dist/clerk.js", "maxSize": "543KB" },
  { "path": "./dist/clerk.browser.js", "maxSize": "67KB" },
- { "path": "./dist/clerk.legacy.browser.js", "maxSize": "108KB" },
- { "path": "./dist/clerk.no-rhc.js", "maxSize": "307KB" },
- { "path": "./dist/clerk.native.js", "maxSize": "66KB" },
+ { "path": "./dist/clerk.legacy.browser.js", "maxSize": "110KB" },
+ { "path": "./dist/clerk.no-rhc.js", "maxSize": "309KB" },
+ { "path": "./dist/clerk.native.js", "maxSize": "68KB" },
  { "path": "./dist/vendors*.js", "maxSize": "7KB" },
  { "path": "./dist/coinbase*.js", "maxSize": "36KB" },
  { "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },

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

@@ -0,0 +1,141 @@
+import type {
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionJSONSnapshot,
+ EnterpriseConnectionResource,
+ EnterpriseOAuthConfigJSON,
+ EnterpriseOAuthConfigResource,
+ EnterpriseSamlConnectionNestedJSON,
+ EnterpriseSamlConnectionNestedResource,
+} from '@clerk/shared/types';
+
+import { unixEpochToDate } from '../../utils/date';
+import { BaseResource } from './Base';
+
+function samlNestedFromJSON(data: EnterpriseSamlConnectionNestedJSON): EnterpriseSamlConnectionNestedResource {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idpEntityId: data.idp_entity_id,
+ idpSsoUrl: data.idp_sso_url,
+ idpCertificate: data.idp_certificate,
+ idpMetadataUrl: data.idp_metadata_url,
+ idpMetadata: data.idp_metadata,
+ acsUrl: data.acs_url,
+ spEntityId: data.sp_entity_id,
+ spMetadataUrl: data.sp_metadata_url,
+ allowSubdomains: data.allow_subdomains,
+ allowIdpInitiated: data.allow_idp_initiated,
+ forceAuthn: data.force_authn,
+ };
+}
+
+function samlNestedToJSON(data: EnterpriseSamlConnectionNestedResource): EnterpriseSamlConnectionNestedJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idp_entity_id: data.idpEntityId,
+ idp_sso_url: data.idpSsoUrl,
+ idp_certificate: data.idpCertificate,
+ idp_metadata_url: data.idpMetadataUrl,
+ idp_metadata: data.idpMetadata,
+ acs_url: data.acsUrl,
+ sp_entity_id: data.spEntityId,
+ sp_metadata_url: data.spMetadataUrl,
+ allow_subdomains: data.allowSubdomains,
+ allow_idp_initiated: data.allowIdpInitiated,
+ force_authn: data.forceAuthn,
+ };
+}
+
+function oauthConfigFromJSON(data: EnterpriseOAuthConfigJSON): EnterpriseOAuthConfigResource {
+ return {
+ id: data.id,
+ name: data.name,
+ clientId: data.client_id,
+ providerKey: data.provider_key,
+ discoveryUrl: data.discovery_url,
+ logoPublicUrl: data.logo_public_url,
+ requiresPkce: data.requires_pkce,
+ createdAt: unixEpochToDate(data.created_at),
+ updatedAt: unixEpochToDate(data.updated_at),
+ };
+}
+
+function oauthConfigToJSON(data: EnterpriseOAuthConfigResource): EnterpriseOAuthConfigJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ client_id: data.clientId,
+ provider_key: data.providerKey,
+ discovery_url: data.discoveryUrl,
+ logo_public_url: data.logoPublicUrl,
+ requires_pkce: data.requiresPkce,
+ created_at: data.createdAt?.getTime() ?? 0,
+ updated_at: data.updatedAt?.getTime() ?? 0,
+ };
+}
+
+export class EnterpriseConnection extends BaseResource implements EnterpriseConnectionResource {
+ id!: string;
+ name!: string;
+ active!: boolean;
+ domains: string[] = [];
+ organizationId: string | null = null;
+ syncUserAttributes!: boolean;
+ disableAdditionalIdentifications!: boolean;
+ allowOrganizationAccountLinking!: boolean;
+ customAttributes: unknown[] = [];
+ oauthConfig: EnterpriseOAuthConfigResource | null = null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null = null;
+ createdAt: Date | null = null;
+ updatedAt: Date | null = null;
+
+ constructor(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null) {
+ super();
+ this.fromJSON(data);
+ }
+
+ protected fromJSON(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null): this {
+ if (!data) {
+ return this;
+ }
+
+ this.id = data.id;
+ this.name = data.name;
+ this.active = data.active;
+ this.domains = data.domains ?? [];
+ this.organizationId = data.organization_id ?? null;
+ this.syncUserAttributes = data.sync_user_attributes;
+ this.disableAdditionalIdentifications = data.disable_additional_identifications;
+ this.allowOrganizationAccountLinking = data.allow_organization_account_linking ?? false;
+ this.customAttributes = data.custom_attributes ?? [];
+ this.createdAt = unixEpochToDate(data.created_at);
+ this.updatedAt = unixEpochToDate(data.updated_at);
+
+ this.samlConnection = data.saml_connection ? samlNestedFromJSON(data.saml_connection) : null;
+ this.oauthConfig = data.oauth_config ? oauthConfigFromJSON(data.oauth_config) : null;
+
+ return this;
+ }
+
+ public __internal_toSnapshot(): EnterpriseConnectionJSONSnapshot {
+ return {
+ object: 'enterprise_connection',
+ id: this.id,
+ name: this.name,
+ active: this.active,
+ domains: this.domains,
+ organization_id: this.organizationId,
+ sync_user_attributes: this.syncUserAttributes,
+ disable_additional_identifications: this.disableAdditionalIdentifications,
+ allow_organization_account_linking: this.allowOrganizationAccountLinking,
+ custom_attributes: this.customAttributes,
+ saml_connection: this.samlConnection ? samlNestedToJSON(this.samlConnection) : undefined,
+ oauth_config: this.oauthConfig ? oauthConfigToJSON(this.oauthConfig) : undefined,
+ created_at: this.createdAt?.getTime() ?? 0,
+ updated_at: this.updatedAt?.getTime() ?? 0,
+ };
+ }
+}

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

@@ -9,9 +9,9 @@ import type {
  DeletedObjectJSON,
  DeletedObjectResource,
  EmailAddressResource,
- EnterpriseAccountConnectionJSON,
- EnterpriseAccountConnectionResource,
  EnterpriseAccountResource,
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionResource,
  ExternalAccountJSON,
  ExternalAccountResource,
  GetEnterpriseConnectionsParams,
@@ -45,7 +45,7 @@ import {
  DeletedObject,
  EmailAddress,
  EnterpriseAccount,
-EnterpriseAccountConnection,
+EnterpriseConnection,
  ExternalAccount,
  Image,
  OrganizationMembership,
@@ -296,7 +296,7 @@ export class User extends BaseResource implements UserResource {
 
  getEnterpriseConnections = async (
  params?: GetEnterpriseConnectionsParams,
- ): Promise<EnterpriseAccountConnectionResource[]> => {
+ ): Promise<EnterpriseConnectionResource[]> => {
  const { withOrganizationAccountLinking } = params || {};
 
  const json = (
@@ -311,9 +311,9 @@ export class User extends BaseResource implements UserResource {
  }
  : {}),
  })
- )?.response as unknown as EnterpriseAccountConnectionJSON[];
+ )?.response as unknown as EnterpriseConnectionJSON[];
 
- return (json || []).map(connection => new EnterpriseAccountConnection(connection));
+ return (json || []).map(connection => new EnterpriseConnection(connection));
  };
 
  initializePaymentMethod: typeof initializePaymentMethod = params => {

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

@@ -16,6 +16,7 @@ export * from './DeletedObject';
 export * from './DisplayConfig';
 export * from './EmailAddress';
 export * from './EnterpriseAccount';
+export * from './EnterpriseConnection';
 export * from './Environment';
 export * from './ExternalAccount';
 export * from './Feature';

packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx

@@ -1,4 +1,4 @@
-import type { EnterpriseAccountConnectionResource } from '../../types/enterpriseAccount';
+import type { EnterpriseConnectionResource } from '../../types/enterpriseConnection';
 import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
 import { useClerkQuery } from '../clerk-rq/useQuery';
 import { useClerkInstanceContext } from '../contexts';
@@ -13,7 +13,7 @@ export type UseUserEnterpriseConnectionsParams = {
 };
 
 export type UseUserEnterpriseConnectionsReturn = {
- data: EnterpriseAccountConnectionResource[] | undefined;
+ data: EnterpriseConnectionResource[] | undefined;
  error: Error | null;
  isLoading: boolean;
  isFetching: boolean;

packages/shared/src/types/enterpriseConnection.ts

@@ -0,0 +1,95 @@
+import type { ClerkResourceJSON } from './json';
+import type { ClerkResource } from './resource';
+
+export interface EnterpriseConnectionJSON extends ClerkResourceJSON {
+ object: 'enterprise_connection';
+ name: string;
+ active: boolean;
+ domains?: string[];
+ organization_id?: string | null;
+ sync_user_attributes: boolean;
+ disable_additional_identifications: boolean;
+ allow_organization_account_linking?: boolean;
+ custom_attributes?: unknown[];
+ oauth_config?: EnterpriseOAuthConfigJSON | null;
+ saml_connection?: EnterpriseSamlConnectionNestedJSON | null;
+ created_at: number;
+ updated_at: number;
+}
+
+export type EnterpriseConnectionJSONSnapshot = EnterpriseConnectionJSON;
+
+export interface EnterpriseConnectionResource extends ClerkResource {
+ id: string;
+ name: string;
+ active: boolean;
+ domains: string[];
+ organizationId: string | null;
+ syncUserAttributes: boolean;
+ disableAdditionalIdentifications: boolean;
+ allowOrganizationAccountLinking: boolean;
+ customAttributes: unknown[];
+ oauthConfig: EnterpriseOAuthConfigResource | null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+ __internal_toSnapshot: () => EnterpriseConnectionJSONSnapshot;
+}
+
+export interface EnterpriseSamlConnectionNestedJSON {
+ id: string;
+ name: string;
+ active: boolean;
+ idp_entity_id: string;
+ idp_sso_url: string;
+ idp_certificate: string;
+ idp_metadata_url: string;
+ idp_metadata: string;
+ acs_url: string;
+ sp_entity_id: string;
+ sp_metadata_url: string;
+ allow_subdomains: boolean;
+ allow_idp_initiated: boolean;
+ force_authn: boolean;
+}
+
+export interface EnterpriseSamlConnectionNestedResource {
+ id: string;
+ name: string;
+ active: boolean;
+ idpEntityId: string;
+ idpSsoUrl: string;
+ idpCertificate: string;
+ idpMetadataUrl: string;
+ idpMetadata: string;
+ acsUrl: string;
+ spEntityId: string;
+ spMetadataUrl: string;
+ allowSubdomains: boolean;
+ allowIdpInitiated: boolean;
+ forceAuthn: boolean;
+}
+
+export interface EnterpriseOAuthConfigJSON {
+ id: string;
+ name: string;
+ provider_key?: string;
+ client_id: string;
+ discovery_url?: string;
+ logo_public_url?: string | null;
+ requires_pkce?: boolean;
+ created_at: number;
+ updated_at: number;
+}
+
+export interface EnterpriseOAuthConfigResource {
+ id: string;
+ name: string;
+ clientId: string;
+ providerKey?: string;
+ discoveryUrl?: string;
+ logoPublicUrl?: string | null;
+ requiresPkce?: boolean;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+}

packages/shared/src/types/index.ts

@@ -16,6 +16,7 @@ export type * from './displayConfig';
 export type * from './elementIds';
 export type * from './emailAddress';
 export type * from './enterpriseAccount';
+export type * from './enterpriseConnection';
 export type * from './environment';
 export type * from './errors';
 export type * from './externalAccount';

packages/shared/src/types/user.ts

@@ -2,7 +2,8 @@ import type { BackupCodeResource } from './backupCode';
 import type { BillingPayerMethods } from './billing';
 import type { DeletedObjectResource } from './deletedObject';
 import type { EmailAddressResource } from './emailAddress';
-import type { EnterpriseAccountConnectionResource, EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseConnectionResource } from './enterpriseConnection';
 import type { ExternalAccountResource } from './externalAccount';
 import type { ImageResource } from './image';
 import type { UserJSON } from './json';
@@ -118,7 +119,7 @@ export interface UserResource extends ClerkResource, BillingPayerMethods {
  ) => Promise<ClerkPaginatedResponse<OrganizationSuggestionResource>>;
  getOrganizationCreationDefaults: () => Promise<OrganizationCreationDefaultsResource>;
  leaveOrganization: (organizationId: string) => Promise<DeletedObjectResource>;
- getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseAccountConnectionResource[]>;
+ getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseConnectionResource[]>;
  createTOTP: () => Promise<TOTPResource>;
  verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
  disableTOTP: () => Promise<DeletedObjectResource>;

.changeset/humble-trams-laugh.md

@@ -0,0 +1,9 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/shared': minor
+'@clerk/ui': minor
+---
+
+Add `EnterpriseConnection` resource
+
+`User.getEnterpriseConnections()` was wrongly typed as returning `EnterpriseAccountConnectionResource[]`, it now returns `EnterpriseConnectionResource[]`

packages/clerk-js/bundlewatch.config.json

@@ -1,10 +1,10 @@
 {
  "files": [
- { "path": "./dist/clerk.js", "maxSize": "540KB" },
+ { "path": "./dist/clerk.js", "maxSize": "543KB" },
  { "path": "./dist/clerk.browser.js", "maxSize": "67KB" },
- { "path": "./dist/clerk.legacy.browser.js", "maxSize": "108KB" },
- { "path": "./dist/clerk.no-rhc.js", "maxSize": "307KB" },
- { "path": "./dist/clerk.native.js", "maxSize": "66KB" },
+ { "path": "./dist/clerk.legacy.browser.js", "maxSize": "110KB" },
+ { "path": "./dist/clerk.no-rhc.js", "maxSize": "309KB" },
+ { "path": "./dist/clerk.native.js", "maxSize": "68KB" },
  { "path": "./dist/vendors*.js", "maxSize": "7KB" },
  { "path": "./dist/coinbase*.js", "maxSize": "36KB" },
  { "path": "./dist/base-account-sdk*.js", "maxSize": "203KB" },

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

@@ -0,0 +1,141 @@
+import type {
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionJSONSnapshot,
+ EnterpriseConnectionResource,
+ EnterpriseOAuthConfigJSON,
+ EnterpriseOAuthConfigResource,
+ EnterpriseSamlConnectionNestedJSON,
+ EnterpriseSamlConnectionNestedResource,
+} from '@clerk/shared/types';
+
+import { unixEpochToDate } from '../../utils/date';
+import { BaseResource } from './Base';
+
+function samlNestedFromJSON(data: EnterpriseSamlConnectionNestedJSON): EnterpriseSamlConnectionNestedResource {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idpEntityId: data.idp_entity_id,
+ idpSsoUrl: data.idp_sso_url,
+ idpCertificate: data.idp_certificate,
+ idpMetadataUrl: data.idp_metadata_url,
+ idpMetadata: data.idp_metadata,
+ acsUrl: data.acs_url,
+ spEntityId: data.sp_entity_id,
+ spMetadataUrl: data.sp_metadata_url,
+ allowSubdomains: data.allow_subdomains,
+ allowIdpInitiated: data.allow_idp_initiated,
+ forceAuthn: data.force_authn,
+ };
+}
+
+function samlNestedToJSON(data: EnterpriseSamlConnectionNestedResource): EnterpriseSamlConnectionNestedJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ active: data.active,
+ idp_entity_id: data.idpEntityId,
+ idp_sso_url: data.idpSsoUrl,
+ idp_certificate: data.idpCertificate,
+ idp_metadata_url: data.idpMetadataUrl,
+ idp_metadata: data.idpMetadata,
+ acs_url: data.acsUrl,
+ sp_entity_id: data.spEntityId,
+ sp_metadata_url: data.spMetadataUrl,
+ allow_subdomains: data.allowSubdomains,
+ allow_idp_initiated: data.allowIdpInitiated,
+ force_authn: data.forceAuthn,
+ };
+}
+
+function oauthConfigFromJSON(data: EnterpriseOAuthConfigJSON): EnterpriseOAuthConfigResource {
+ return {
+ id: data.id,
+ name: data.name,
+ clientId: data.client_id,
+ providerKey: data.provider_key,
+ discoveryUrl: data.discovery_url,
+ logoPublicUrl: data.logo_public_url,
+ requiresPkce: data.requires_pkce,
+ createdAt: unixEpochToDate(data.created_at),
+ updatedAt: unixEpochToDate(data.updated_at),
+ };
+}
+
+function oauthConfigToJSON(data: EnterpriseOAuthConfigResource): EnterpriseOAuthConfigJSON {
+ return {
+ id: data.id,
+ name: data.name,
+ client_id: data.clientId,
+ provider_key: data.providerKey,
+ discovery_url: data.discoveryUrl,
+ logo_public_url: data.logoPublicUrl,
+ requires_pkce: data.requiresPkce,
+ created_at: data.createdAt?.getTime() ?? 0,
+ updated_at: data.updatedAt?.getTime() ?? 0,
+ };
+}
+
+export class EnterpriseConnection extends BaseResource implements EnterpriseConnectionResource {
+ id!: string;
+ name!: string;
+ active!: boolean;
+ domains: string[] = [];
+ organizationId: string | null = null;
+ syncUserAttributes!: boolean;
+ disableAdditionalIdentifications!: boolean;
+ allowOrganizationAccountLinking!: boolean;
+ customAttributes: unknown[] = [];
+ oauthConfig: EnterpriseOAuthConfigResource | null = null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null = null;
+ createdAt: Date | null = null;
+ updatedAt: Date | null = null;
+
+ constructor(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null) {
+ super();
+ this.fromJSON(data);
+ }
+
+ protected fromJSON(data: EnterpriseConnectionJSON | EnterpriseConnectionJSONSnapshot | null): this {
+ if (!data) {
+ return this;
+ }
+
+ this.id = data.id;
+ this.name = data.name;
+ this.active = data.active;
+ this.domains = data.domains ?? [];
+ this.organizationId = data.organization_id ?? null;
+ this.syncUserAttributes = data.sync_user_attributes;
+ this.disableAdditionalIdentifications = data.disable_additional_identifications;
+ this.allowOrganizationAccountLinking = data.allow_organization_account_linking ?? false;
+ this.customAttributes = data.custom_attributes ?? [];
+ this.createdAt = unixEpochToDate(data.created_at);
+ this.updatedAt = unixEpochToDate(data.updated_at);
+
+ this.samlConnection = data.saml_connection ? samlNestedFromJSON(data.saml_connection) : null;
+ this.oauthConfig = data.oauth_config ? oauthConfigFromJSON(data.oauth_config) : null;
+
+ return this;
+ }
+
+ public __internal_toSnapshot(): EnterpriseConnectionJSONSnapshot {
+ return {
+ object: 'enterprise_connection',
+ id: this.id,
+ name: this.name,
+ active: this.active,
+ domains: this.domains,
+ organization_id: this.organizationId,
+ sync_user_attributes: this.syncUserAttributes,
+ disable_additional_identifications: this.disableAdditionalIdentifications,
+ allow_organization_account_linking: this.allowOrganizationAccountLinking,
+ custom_attributes: this.customAttributes,
+ saml_connection: this.samlConnection ? samlNestedToJSON(this.samlConnection) : undefined,
+ oauth_config: this.oauthConfig ? oauthConfigToJSON(this.oauthConfig) : undefined,
+ created_at: this.createdAt?.getTime() ?? 0,
+ updated_at: this.updatedAt?.getTime() ?? 0,
+ };
+ }
+}

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

@@ -9,9 +9,9 @@ import type {
  DeletedObjectJSON,
  DeletedObjectResource,
  EmailAddressResource,
- EnterpriseAccountConnectionJSON,
- EnterpriseAccountConnectionResource,
  EnterpriseAccountResource,
+ EnterpriseConnectionJSON,
+ EnterpriseConnectionResource,
  ExternalAccountJSON,
  ExternalAccountResource,
  GetEnterpriseConnectionsParams,
@@ -45,7 +45,7 @@ import {
  DeletedObject,
  EmailAddress,
  EnterpriseAccount,
-EnterpriseAccountConnection,
+EnterpriseConnection,
  ExternalAccount,
  Image,
  OrganizationMembership,
@@ -296,7 +296,7 @@ export class User extends BaseResource implements UserResource {
 
  getEnterpriseConnections = async (
  params?: GetEnterpriseConnectionsParams,
- ): Promise<EnterpriseAccountConnectionResource[]> => {
+ ): Promise<EnterpriseConnectionResource[]> => {
  const { withOrganizationAccountLinking } = params || {};
 
  const json = (
@@ -311,9 +311,9 @@ export class User extends BaseResource implements UserResource {
  }
  : {}),
  })
- )?.response as unknown as EnterpriseAccountConnectionJSON[];
+ )?.response as unknown as EnterpriseConnectionJSON[];
 
- return (json || []).map(connection => new EnterpriseAccountConnection(connection));
+ return (json || []).map(connection => new EnterpriseConnection(connection));
  };
 
  initializePaymentMethod: typeof initializePaymentMethod = params => {

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

@@ -16,6 +16,7 @@ export * from './DeletedObject';
 export * from './DisplayConfig';
 export * from './EmailAddress';
 export * from './EnterpriseAccount';
+export * from './EnterpriseConnection';
 export * from './Environment';
 export * from './ExternalAccount';
 export * from './Feature';

packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx

@@ -1,4 +1,4 @@
-import type { EnterpriseAccountConnectionResource } from '../../types/enterpriseAccount';
+import type { EnterpriseConnectionResource } from '../../types/enterpriseConnection';
 import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
 import { useClerkQuery } from '../clerk-rq/useQuery';
 import { useClerkInstanceContext } from '../contexts';
@@ -13,7 +13,7 @@ export type UseUserEnterpriseConnectionsParams = {
 };
 
 export type UseUserEnterpriseConnectionsReturn = {
- data: EnterpriseAccountConnectionResource[] | undefined;
+ data: EnterpriseConnectionResource[] | undefined;
  error: Error | null;
  isLoading: boolean;
  isFetching: boolean;

packages/shared/src/types/enterpriseConnection.ts

@@ -0,0 +1,95 @@
+import type { ClerkResourceJSON } from './json';
+import type { ClerkResource } from './resource';
+
+export interface EnterpriseConnectionJSON extends ClerkResourceJSON {
+ object: 'enterprise_connection';
+ name: string;
+ active: boolean;
+ domains?: string[];
+ organization_id?: string | null;
+ sync_user_attributes: boolean;
+ disable_additional_identifications: boolean;
+ allow_organization_account_linking?: boolean;
+ custom_attributes?: unknown[];
+ oauth_config?: EnterpriseOAuthConfigJSON | null;
+ saml_connection?: EnterpriseSamlConnectionNestedJSON | null;
+ created_at: number;
+ updated_at: number;
+}
+
+export type EnterpriseConnectionJSONSnapshot = EnterpriseConnectionJSON;
+
+export interface EnterpriseConnectionResource extends ClerkResource {
+ id: string;
+ name: string;
+ active: boolean;
+ domains: string[];
+ organizationId: string | null;
+ syncUserAttributes: boolean;
+ disableAdditionalIdentifications: boolean;
+ allowOrganizationAccountLinking: boolean;
+ customAttributes: unknown[];
+ oauthConfig: EnterpriseOAuthConfigResource | null;
+ samlConnection: EnterpriseSamlConnectionNestedResource | null;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+ __internal_toSnapshot: () => EnterpriseConnectionJSONSnapshot;
+}
+
+export interface EnterpriseSamlConnectionNestedJSON {
+ id: string;
+ name: string;
+ active: boolean;
+ idp_entity_id: string;
+ idp_sso_url: string;
+ idp_certificate: string;
+ idp_metadata_url: string;
+ idp_metadata: string;
+ acs_url: string;
+ sp_entity_id: string;
+ sp_metadata_url: string;
+ allow_subdomains: boolean;
+ allow_idp_initiated: boolean;
+ force_authn: boolean;
+}
+
+export interface EnterpriseSamlConnectionNestedResource {
+ id: string;
+ name: string;
+ active: boolean;
+ idpEntityId: string;
+ idpSsoUrl: string;
+ idpCertificate: string;
+ idpMetadataUrl: string;
+ idpMetadata: string;
+ acsUrl: string;
+ spEntityId: string;
+ spMetadataUrl: string;
+ allowSubdomains: boolean;
+ allowIdpInitiated: boolean;
+ forceAuthn: boolean;
+}
+
+export interface EnterpriseOAuthConfigJSON {
+ id: string;
+ name: string;
+ provider_key?: string;
+ client_id: string;
+ discovery_url?: string;
+ logo_public_url?: string | null;
+ requires_pkce?: boolean;
+ created_at: number;
+ updated_at: number;
+}
+
+export interface EnterpriseOAuthConfigResource {
+ id: string;
+ name: string;
+ clientId: string;
+ providerKey?: string;
+ discoveryUrl?: string;
+ logoPublicUrl?: string | null;
+ requiresPkce?: boolean;
+ createdAt: Date | null;
+ updatedAt: Date | null;
+}

packages/shared/src/types/index.ts

@@ -16,6 +16,7 @@ export type * from './displayConfig';
 export type * from './elementIds';
 export type * from './emailAddress';
 export type * from './enterpriseAccount';
+export type * from './enterpriseConnection';
 export type * from './environment';
 export type * from './errors';
 export type * from './externalAccount';

packages/shared/src/types/user.ts

@@ -2,7 +2,8 @@ import type { BackupCodeResource } from './backupCode';
 import type { BillingPayerMethods } from './billing';
 import type { DeletedObjectResource } from './deletedObject';
 import type { EmailAddressResource } from './emailAddress';
-import type { EnterpriseAccountConnectionResource, EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseAccountResource } from './enterpriseAccount';
+import type { EnterpriseConnectionResource } from './enterpriseConnection';
 import type { ExternalAccountResource } from './externalAccount';
 import type { ImageResource } from './image';
 import type { UserJSON } from './json';
@@ -118,7 +119,7 @@ export interface UserResource extends ClerkResource, BillingPayerMethods {
  ) => Promise<ClerkPaginatedResponse<OrganizationSuggestionResource>>;
  getOrganizationCreationDefaults: () => Promise<OrganizationCreationDefaultsResource>;
  leaveOrganization: (organizationId: string) => Promise<DeletedObjectResource>;
- getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseAccountConnectionResource[]>;
+ getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseConnectionResource[]>;
  createTOTP: () => Promise<TOTPResource>;
  verifyTOTP: (params: VerifyTOTPParams) => Promise<TOTPResource>;
  disableTOTP: () => Promise<DeletedObjectResource>;