Fancy types when initing SDK

openintegrations · Dec 2, 2023 · 3d1dc65 · 3d1dc65
1 parent ea7f4d1
commit 3d1dc65
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 8 deletions.
diff --git a/docs/example.ts b/docs/example.ts
@@ -13,9 +13,15 @@ export const github = initSDK(githubSdkDef, {
   },
 })
 
+export const plaid = initSDK(plaidSdkDef, {
+  headers: {
+    'PLAID-CLIENT-ID': '',
+    'PLAID-SECRET': '',
+  },
+}) // Need clientId & secret
+
 export const discord = initSDK(discordSdkDef)
 export const openai = initSDK(openaiSdkDef)
-export const plaid = initSDK(plaidSdkDef) // Need clientId & secret
 export const slack = initSDK(slackSdkDef)
 export const venice = initSDK(veniceSdkDef) // ApiKey or authToken
 

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -15,8 +15,11 @@ export type OpenAPISpec = oas30.OpenAPIObject | oas31.OpenAPIObject
 
 /** Get this from openapi */
 export interface SdkDefinition<Paths extends {}> {
-  _types: {paths: Paths}
+  _types: {
+    paths: Paths
+  }
   oas: OpenAPISpec
+  headers?: Record<string, string>
 }
 
 // This is necessary because we cannot publish inferred type otherwise
@@ -27,13 +30,14 @@ export type SDK<Paths extends {}> = ReturnType<typeof createClient<Paths>> & {
   oas: OpenAPISpec
 }
 
-export function initSDK<Paths extends {}>(
-  // Can we make this optional to avoid needing to deal with json?
-  sdkDef: SdkDefinition<Paths>,
-  options?: ClientOptions,
-): SDK<Paths> {
+// Can we make this optional to avoid needing to deal with json?
+export function initSDK<TDef extends SdkDefinition<{}>>(
+  ...[sdkDef, options]: 'headers' extends keyof TDef
+    ? [TDef, Omit<ClientOptions, 'headers'> & {headers: TDef['headers']}]
+    : [TDef] | [TDef, ClientOptions?]
+): SDK<TDef['_types']['paths']> {
   const {oas} = sdkDef
-  const client = createClient<Paths>({
+  const client = createClient<TDef['_types']['paths']>({
     baseUrl: oas.servers?.[0]?.url,
     ...options,
   })

diff --git a/packages/sdks/sdk-plaid/index.ts b/packages/sdks/sdk-plaid/index.ts
@@ -22,6 +22,10 @@ export interface plaidTypes {
 export const plaidSdkDef = {
   _types: {} as plaidTypes,
   oas: plaidOas as {} as OpenAPISpec,
+  headers: {} as {
+    'PLAID-CLIENT-ID': string
+    'PLAID-SECRET': string
+  },
 } satisfies SdkDefinition<paths>
 
 export default plaidSdkDef