Remove deprecated test runs methods from the /me path

Author: LauraBeatris

.changeset/quick-pugs-tap.md

@@ -3,6 +3,6 @@
 '@clerk/shared': patch
 ---
 
-Remove deprecated `createEnterpriseConnection`, `updateEnterpriseConnection`, and `deleteEnterpriseConnection` methods from the `User` resource in favor of `Organization` scoped ones
+Remove deprecated `createEnterpriseConnection`, `updateEnterpriseConnection`, `deleteEnterpriseConnection`, `createEnterpriseConnectionTestRun`, and `getEnterpriseConnectionTestRuns` methods from the `User` resource in favor of `Organization` scoped ones. Also removes the unused internal `__internal_useEnterpriseConnectionTestRuns` hook.
 
 `ConfigureSSO` was previously the only consumer but since it hasn't been released GA yet, these changes won't break existing production clients

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

@@ -2,7 +2,6 @@ import { getFullName } from '@clerk/shared/internal/clerk-js/user';
 import type {
   BackupCodeJSON,
   BackupCodeResource,
-  ClerkPaginatedResponse,
   CreateEmailAddressParams,
   CreateExternalAccountParams,
   CreatePhoneNumberParams,
@@ -13,15 +12,9 @@ import type {
   EnterpriseAccountResource,
   EnterpriseConnectionJSON,
   EnterpriseConnectionResource,
-  EnterpriseConnectionTestRunInitJSON,
-  EnterpriseConnectionTestRunInitResource,
-  EnterpriseConnectionTestRunJSON,
-  EnterpriseConnectionTestRunResource,
-  EnterpriseConnectionTestRunsPaginatedJSON,
   ExternalAccountJSON,
   ExternalAccountResource,
   GetEnterpriseConnectionsParams,
-  GetEnterpriseConnectionTestRunsParams,
   GetOrganizationMemberships,
   GetUserOrganizationInvitationsParams,
   GetUserOrganizationSuggestionsParams,
@@ -43,7 +36,6 @@ import type {
   Web3WalletResource,
 } from '@clerk/shared/types';
 
-import { convertPageToOffsetSearchParams } from '../../utils/convertPageToOffsetSearchParams';
 import { unixEpochToDate } from '../../utils/date';
 import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
 import { eventBus, events } from '../events';
@@ -55,7 +47,6 @@ import {
   EmailAddress,
   EnterpriseAccount,
   EnterpriseConnection,
-  EnterpriseConnectionTestRun,
   ExternalAccount,
   Image,
   OrganizationMembership,
@@ -333,45 +324,6 @@ export class User extends BaseResource implements UserResource {
     return (json || []).map(connection => new EnterpriseConnection(connection));
   };
 
-  createEnterpriseConnectionTestRun = async (
-    enterpriseConnectionId: string,
-  ): Promise<EnterpriseConnectionTestRunInitResource> => {
-    const json = (
-      await BaseResource._fetch({
-        path: `${this.path()}/enterprise_connections/${enterpriseConnectionId}/test_runs`,
-        method: 'POST',
-      })
-    )?.response as unknown as EnterpriseConnectionTestRunInitJSON;
-
-    return { url: json.url };
-  };
-
-  getEnterpriseConnectionTestRuns = async (
-    enterpriseConnectionId: string,
-    params?: GetEnterpriseConnectionTestRunsParams,
-  ): Promise<ClerkPaginatedResponse<EnterpriseConnectionTestRunResource>> => {
-    const { status, ...rest } = params || {};
-    const search = convertPageToOffsetSearchParams(rest);
-    if (status?.length) {
-      for (const s of status) {
-        search.append('status', s);
-      }
-    }
-
-    const res = await BaseResource._fetch({
-      path: `${this.path()}/enterprise_connections/${enterpriseConnectionId}/test_runs`,
-      method: 'GET',
-      search,
-    });
-
-    const payload = res?.response as unknown as EnterpriseConnectionTestRunsPaginatedJSON | undefined;
-
-    return {
-      total_count: payload?.total_count ?? 0,
-      data: (payload?.data ?? []).map((row: EnterpriseConnectionTestRunJSON) => new EnterpriseConnectionTestRun(row)),
-    };
-  };
-
   initializePaymentMethod: typeof initializePaymentMethod = params => {
     return initializePaymentMethod(params);
   };

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

@@ -139,72 +139,6 @@ describe('User', () => {
     expect(connections[0].allowOrganizationAccountLinking).toBe(true);
   });
 
-  it('creates an enterprise connection test run', async () => {
-    // @ts-ignore
-    BaseResource._fetch = vi.fn().mockReturnValue(Promise.resolve({ response: { url: 'https://example.com/test' } }));
-
-    const user = new User({
-      email_addresses: [],
-      phone_numbers: [],
-      web3_wallets: [],
-      external_accounts: [],
-    } as unknown as UserJSON);
-
-    const init = await user.createEnterpriseConnectionTestRun('ec_123');
-
-    // @ts-ignore
-    expect(BaseResource._fetch).toHaveBeenCalledWith({
-      method: 'POST',
-      path: '/me/enterprise_connections/ec_123/test_runs',
-    });
-
-    expect(init.url).toBe('https://example.com/test');
-  });
-
-  it('lists enterprise connection test runs', async () => {
-    const paginated = {
-      data: [
-        {
-          object: 'enterprise_connection_test_run' as const,
-          id: 'run_1',
-          status: 'success',
-          connection_type: 'saml' as const,
-          created_at: 1700000000000,
-        },
-      ],
-      total_count: 1,
-    };
-
-    // @ts-ignore
-    BaseResource._fetch = vi.fn().mockReturnValue(Promise.resolve({ response: paginated }));
-
-    const user = new User({
-      email_addresses: [],
-      phone_numbers: [],
-      web3_wallets: [],
-      external_accounts: [],
-    } as unknown as UserJSON);
-
-    const result = await user.getEnterpriseConnectionTestRuns('ec_123', {
-      initialPage: 1,
-      pageSize: 10,
-      status: ['pending', 'success'],
-    });
-
-    // @ts-ignore
-    const call = BaseResource._fetch.mock.calls[0][0];
-    expect(call.method).toBe('GET');
-    expect(call.path).toBe('/me/enterprise_connections/ec_123/test_runs');
-    expect(call.search.get('limit')).toBe('10');
-    expect(call.search.get('offset')).toBe('0');
-    expect(call.search.getAll('status')).toEqual(['pending', 'success']);
-
-    expect(result.total_count).toBe(1);
-    expect(result.data).toHaveLength(1);
-    expect(result.data[0].id).toBe('run_1');
-    expect(result.data[0].connectionType).toBe('saml');
-  });
-
   it('creates a web3 wallet', async () => {
     const targetWeb3Wallet = '0x0000000000000000000000000000000000000000';
     const web3WalletJSON = {

packages/shared/src/react/hooks/index.ts

@@ -38,11 +38,6 @@ export type {
   UseUserEnterpriseConnectionsParams,
   UseUserEnterpriseConnectionsReturn,
 } from './useUserEnterpriseConnections';
-export { __internal_useEnterpriseConnectionTestRuns } from './useEnterpriseConnectionTestRuns';
-export type {
-  UseEnterpriseConnectionTestRunsParams,
-  UseEnterpriseConnectionTestRunsReturn,
-} from './useEnterpriseConnectionTestRuns';
 export { __internal_useOrganizationEnterpriseConnections } from './useOrganizationEnterpriseConnections';
 export type {
   UseOrganizationEnterpriseConnectionsParams,

packages/shared/src/react/hooks/useEnterpriseConnectionTestRuns.shared.ts

@@ -4,11 +4,6 @@ import type { DeletedObjectResource } from './deletedObject';
 import type { EmailAddressResource } from './emailAddress';
 import type { EnterpriseAccountResource } from './enterpriseAccount';
 import type { EnterpriseConnectionResource } from './enterpriseConnection';
-import type {
-  EnterpriseConnectionTestRunInitResource,
-  EnterpriseConnectionTestRunResource,
-  GetEnterpriseConnectionTestRunsParams,
-} from './enterpriseConnectionTestRun';
 import type { ExternalAccountResource } from './externalAccount';
 import type { ImageResource } from './image';
 import type { UserJSON } from './json';
@@ -308,13 +303,6 @@ export interface UserResource extends ClerkResource, BillingPayerMethods {
    * @hidden
    */
   getEnterpriseConnections: (params?: GetEnterpriseConnectionsParams) => Promise<EnterpriseConnectionResource[]>;
-  createEnterpriseConnectionTestRun: (
-    enterpriseConnectionId: string,
-  ) => Promise<EnterpriseConnectionTestRunInitResource>;
-  getEnterpriseConnectionTestRuns: (
-    enterpriseConnectionId: string,
-    params?: GetEnterpriseConnectionTestRunsParams,
-  ) => Promise<ClerkPaginatedResponse<EnterpriseConnectionTestRunResource>>;
   /**
    * Generates a TOTP secret for a user that can be used to register the application on the user's authenticator app of choice. If this method is called again (while still unverified), it replaces the previously generated secret.
    * @returns A [`TOTPResource`](https://clerk.com/docs/reference/types/totp-resource) object.