fix: type inference

LinkupPlatform · Jan 2, 2025 · 7ebafc5 · 7ebafc5
1 parent b8aaa96
commit 7ebafc5
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 21 deletions.
diff --git a/src/__tests__/linkup-client.test.ts b/src/__tests__/linkup-client.test.ts
@@ -29,7 +29,7 @@ describe('LinkupClient', () => {
       query: 'foo',
       depth: 'deep',
       outputType: 'sourcedAnswer',
-    } as SearchParams);
+    });
 
     expect(maxios.post).toHaveBeenCalledWith(
       '/search',
@@ -146,7 +146,7 @@ describe('LinkupClient', () => {
     // Non Axios error
     maxios.post.mockRejectedValueOnce(new Error('unknown'));
     await underTest
-      .search({} as SearchParams)
+      .search({} as SearchParams<'sourcedAnswer'>)
       .catch((e) => expect(e).toBeInstanceOf(LinkupUnknownError));
 
     // 400 invalid
@@ -155,7 +155,7 @@ describe('LinkupClient', () => {
       response: { status: 400, data: { message: '' } },
     });
     await underTest
-      .search({} as SearchParams)
+      .search({} as SearchParams<'sourcedAnswer'>)
       .catch((e) => expect(e).toBeInstanceOf(LinkupInvalidRequestError));
 
     // 400 empty result
@@ -167,7 +167,7 @@ describe('LinkupClient', () => {
       },
     });
     await underTest
-      .search({} as SearchParams)
+      .search({} as SearchParams<'sourcedAnswer'>)
       .catch((e) => expect(e).toBeInstanceOf(LinkupNoResultError));
 
     // 403
@@ -179,7 +179,7 @@ describe('LinkupClient', () => {
       },
     });
     await underTest
-      .search({} as SearchParams)
+      .search({} as SearchParams<'sourcedAnswer'>)
       .catch((e) => expect(e).toBeInstanceOf(LinkupAuthenticationError));
 
     // 429
@@ -191,7 +191,7 @@ describe('LinkupClient', () => {
       },
     });
     await underTest
-      .search({} as SearchParams)
+      .search({} as SearchParams<'sourcedAnswer'>)
       .catch((e) => expect(e).toBeInstanceOf(LinkupInsufficientCreditError));
 
     // 500
@@ -203,7 +203,7 @@ describe('LinkupClient', () => {
       },
     });
     await underTest
-      .search({} as SearchParams)
+      .search({} as SearchParams<'sourcedAnswer'>)
       .catch((e) => expect(e).toBeInstanceOf(LinkupUnknownError));
   });
 
@@ -217,7 +217,7 @@ describe('LinkupClient', () => {
     });
 
     await underTest
-      .search({} as SearchParams)
+      .search({} as SearchParams<'sourcedAnswer'>)
       .catch((e) => expect(e).toBeInstanceOf(LinkupInvalidRequestError));
   });
 });
diff --git a/src/linkup-client.ts b/src/linkup-client.ts
@@ -9,11 +9,12 @@ import {
 } from './errors';
 import {
   ApiConfig,
-  LinkupSearchResponse,
   SearchOutputType,
   SearchParams,
   SearchResults,
   SourcedAnswer,
+  StructuredOutputSchema,
+  LinkupSearchResponse,
 } from './types';
 import { getVersionFromPackage } from './utils/version.utils';
 import zodToJsonSchema from 'zod-to-json-schema';
@@ -30,9 +31,17 @@ export class LinkupClient {
     this.baseUrl = config.baseUrl || 'https://api.linkup.so/v1';
   }
 
-  async search<T extends SearchOutputType>(
+  async search<T extends 'sourcedAnswer' | 'searchResults' | 'structured'>(
     params: SearchParams<T>,
-  ): Promise<LinkupSearchResponse<T>> {
+  ): Promise<
+    T extends 'sourcedAnswer'
+      ? SourcedAnswer
+      : T extends 'searchResults'
+        ? SearchResults
+        : T extends 'structured'
+          ? StructuredOutputSchema
+          : never
+  > {
     return axios
       .post('/search', this.sanitizeParams(params), {
         baseURL: this.baseUrl,
@@ -49,13 +58,13 @@ export class LinkupClient {
       });
   }
 
-  private sanitizeParams({
+  private sanitizeParams<T extends SearchOutputType>({
     query,
     depth,
     outputType,
     includeImages = false,
     structuredOutputSchema,
-  }: SearchParams): Record<string, string | boolean> {
+  }: SearchParams<T>): Record<string, string | boolean> {
     const searchParams: Record<string, string | boolean> = {
       q: query,
       depth,
@@ -74,9 +83,9 @@ export class LinkupClient {
     return searchParams;
   }
 
-  private formatResponse<T extends SearchOutputType>(
+  private formatResponse<T>(
     searchResponse: unknown,
-    outputType: T,
+    outputType: SearchOutputType,
   ): LinkupSearchResponse<T> {
     switch (outputType) {
       case 'sourcedAnswer':

diff --git a/src/types.ts b/src/types.ts
@@ -13,19 +13,21 @@ export type StructuredOutputSchema =
   | Record<string, unknown>
   | ZodObject<ZodRawShape>;
 
-export interface SearchParams<T extends SearchOutputType = SearchOutputType> {
+export interface SearchParams<T extends SearchOutputType> {
   query: string;
   depth: SearchDepth;
   outputType: T;
   includeImages?: boolean;
   structuredOutputSchema?: StructuredOutputSchema;
 }
 
-export type LinkupSearchResponse<T extends SearchOutputType> = {
-  sourcedAnswer: SourcedAnswer;
-  searchResults: SearchResults;
-  structured: unknown;
-}[T];
+export type LinkupSearchResponse<T> = T extends 'sourcedAnswer'
+  ? SourcedAnswer
+  : T extends 'searchResults'
+    ? SearchResults
+    : T extends 'structured'
+      ? StructuredOutputSchema
+      : never;
 
 export interface SourcedAnswer {
   answer: string;