chore: Refactor the supaglue client to also use the new createOpenapiClient

Author: tonyxiao

apps/api/routes/engagement/v2/sequence.integration.test.ts

@@ -5,6 +5,7 @@
  * @jest-environment ./integration-test-environment
  */
 
+import { HTTPError } from '@supaglue/schemas';
 import type {
   CreateContactRequest,
   CreateContactResponse,
@@ -92,17 +93,18 @@ describe('sequence', () => {
   test(`Error body`, async () => {
     testSequence.steps[0].interval_seconds = 123;
 
-    const res = await supaglueClient.engagement.POST('/sequences', {
-      body: { record: testSequence },
-      // TODO: Make it so that x-customer-id can be omitted if it was passed into the client at creation time.
-      params: { header: { 'x-provider-name': 'salesloft', 'x-customer-id': process.env.CUSTOMER_ID! } },
-    });
+    const res = (await supaglueClient.engagement
+      .POST('/sequences', {
+        body: { record: testSequence },
+        // TODO: Make it so that x-customer-id can be omitted if it was passed into the client at creation time.
+        params: { header: { 'x-provider-name': 'salesloft', 'x-customer-id': process.env.CUSTOMER_ID! } },
+      })
+      .catch((e) => e as HTTPError<unknown>)) as HTTPError<unknown>;
 
+    expect(res).toBeInstanceOf(HTTPError);
     expect(res.response.status).toEqual(400);
     // Our API spec is wrong and should specify 400 return code with ability to have errors
-    expect((res.error as typeof res.data)?.errors?.[0].title).toMatch(
-      'Salesloft only supports intervals in whole days'
-    );
+    expect((res.error as any)?.errors?.[0].title).toMatch('Salesloft only supports intervals in whole days');
   });
 
   describe.each(['outreach', 'apollo', 'salesloft'])('%s', (providerName) => {

packages/core/package.json

@@ -48,7 +48,6 @@
     "@types/uuid": "^9.0.1",
     "concurrently": "^8.2.2",
     "openapi-typescript": "^6.7.1",
-    "openapi-typescript-helpers": "0.0.4",
     "prettier": "^3.1.0",
     "ts-toolbelt": "9.6.0",
     "typescript": "^4.9.5"

packages/core/remotes/impl/apollo/apollo.client.ts

@@ -1,4 +1,4 @@
-import { createOpenapiClient } from '../../utils/createOpenapiClient';
+import { createOpenapiClient } from '@supaglue/schemas';
 
 import type { paths } from './apollo.openapi.gen';
 import oas from './apollo.openapi.json';

packages/core/remotes/impl/apollo/apollo.openapi.json

@@ -211,6 +211,10 @@ export function outputOpenApi() {
     openapi: '3.1.0',
     info: { title: 'Apollo API', version: '0.0.0' },
     servers: [{ url: 'https://app.apollo.io/api' }],
+    security: [{ api_key: [] }],
+    components: {
+      securitySchemes: { api_key: { type: 'apiKey', name: 'api_key', in: 'query' } },
+    },
     paths: {
       '/v1/emailer_campaigns/{id}': {
         get: jsonOperation('getEmailerCampaign', {

packages/core/remotes/impl/apollo/apollo.openapi.ts

@@ -1,6 +1,6 @@
+import type { OAuthClientOptions } from '@supaglue/schemas';
+import { createOpenapiOauthClient, HTTPError } from '@supaglue/schemas';
 import { SGConnectionNoLongerAuthenticatedError } from '../../../errors';
-import type { OAuthClientOptions } from '../../utils/createOpenapiClient';
-import { createOpenapiOauthClient, HTTPError } from '../../utils/createOpenapiClient';
 
 import type { paths } from './outreach.openapi.gen';
 import oas from './outreach.openapi.json';

packages/core/remotes/impl/outreach/outreach.client.ts

@@ -1,6 +1,6 @@
+import type { OAuthClientOptions } from '@supaglue/schemas';
+import { createOpenapiOauthClient } from '@supaglue/schemas';
 import type { ConnectorAuthConfig } from '../../base';
-import type { OAuthClientOptions } from '../../utils/createOpenapiClient';
-import { createOpenapiOauthClient } from '../../utils/createOpenapiClient';
 
 import type { paths } from './salesloft.openapi.gen';
 import oas from './salesloft.openapi.json';

packages/core/remotes/impl/salesloft/salesloft.client.ts

@@ -1,7 +1,6 @@
 import type { FetchOptions, FetchResponse } from 'openapi-fetch';
 import createClient from 'openapi-fetch';
-// @ts-expect-error Not sure we get The current file is a CommonJS module whose imports will
-// produce 'require' calls error, but it's ireelevant and thus we will suppress it
+// @ts-expect-error Not sure why this is needed 
 import type { PathsWithMethod } from 'openapi-typescript-helpers';
 
 type HTTPMethod = 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH' | 'TRACE';

…ore/remotes/utils/createOpenapiClient.ts packages/schemas/createOpenapiClient.tspackages/core/remotes/utils/createOpenapiClient.ts renamed to packages/schemas/createOpenapiClient.ts packages/core/remotes/utils/createOpenapiClient.ts renamed to packages/schemas/createOpenapiClient.ts

@@ -1 +1,2 @@
 export * from './supaglue-client';
+export * from './createOpenapiClient'

packages/schemas/index.ts

@@ -9,6 +9,7 @@
   },
   "devDependencies": {
     "openapi-typescript": "^6.7.0",
+    "openapi-typescript-helpers": "^0.0.4",
     "tsx": "^3.12.3"
   }
 }