fix: better dx for search endpoint

Author: Shedna

src/__tests__/linkup-client.test.ts

@@ -13,8 +13,8 @@ import { LinkupClient } from '../linkup-client';
 import type {
   ImageSearchResult,
   LinkupApiError,
+  SearchParams,
   Source,
-  SourcedAnswerParams,
   TextSearchResult,
 } from '../types';
 import { refineError } from '../utils/refine-error.utils';
@@ -375,7 +375,7 @@ describe('LinkupClient', () => {
     mockAxiosInstance.post.mockRejectedValueOnce(refineError(invalidError));
 
     try {
-      await underTest.search({} as SourcedAnswerParams);
+      await underTest.search({} as SearchParams);
     } catch (e) {
       expect(e).toBeInstanceOf(LinkupInvalidRequestError);
       expect((e as LinkupInvalidRequestError).message).toEqual(
@@ -395,7 +395,7 @@ describe('LinkupClient', () => {
     mockAxiosInstance.post.mockRejectedValueOnce(refineError(invalidError));
 
     try {
-      await underTest.search({} as SourcedAnswerParams);
+      await underTest.search({} as SearchParams);
     } catch (e) {
       expect(e).toBeInstanceOf(LinkupNoResultError);
       expect((e as LinkupNoResultError).message).toEqual('The query did not yield any result');
@@ -413,7 +413,7 @@ describe('LinkupClient', () => {
     mockAxiosInstance.post.mockRejectedValueOnce(refineError(invalidError));
 
     try {
-      await underTest.search({} as SourcedAnswerParams);
+      await underTest.search({} as SearchParams);
     } catch (e) {
       expect(e).toBeInstanceOf(LinkupAuthenticationError);
       expect((e as LinkupAuthenticationError).message).toEqual('Unauthorized action');
@@ -431,7 +431,7 @@ describe('LinkupClient', () => {
     mockAxiosInstance.post.mockRejectedValueOnce(refineError(invalidError));
 
     try {
-      await underTest.search({} as SourcedAnswerParams);
+      await underTest.search({} as SearchParams);
     } catch (e) {
       expect(e).toBeInstanceOf(LinkupAuthenticationError);
       expect((e as LinkupAuthenticationError).message).toEqual('Forbidden action');
@@ -449,7 +449,7 @@ describe('LinkupClient', () => {
     mockAxiosInstance.post.mockRejectedValueOnce(refineError(invalidError));
 
     try {
-      await underTest.search({} as SourcedAnswerParams);
+      await underTest.search({} as SearchParams);
     } catch (e) {
       expect(e).toBeInstanceOf(LinkupInsufficientCreditError);
       expect((e as LinkupInsufficientCreditError).message).toEqual(
@@ -469,7 +469,7 @@ describe('LinkupClient', () => {
     mockAxiosInstance.post.mockRejectedValueOnce(refineError(invalidError));
 
     try {
-      await underTest.search({} as SourcedAnswerParams);
+      await underTest.search({} as SearchParams);
     } catch (e) {
       expect(e).toBeInstanceOf(LinkupTooManyRequestsError);
       expect((e as LinkupTooManyRequestsError).message).toEqual('Too many requests');
@@ -487,7 +487,7 @@ describe('LinkupClient', () => {
     mockAxiosInstance.post.mockRejectedValueOnce(refineError(invalidError));
 
     try {
-      await underTest.search({} as SourcedAnswerParams);
+      await underTest.search({} as SearchParams);
     } catch (e) {
       expect(e).toBeInstanceOf(LinkupUnknownError);
       expect((e as LinkupUnknownError).message).toEqual(
@@ -507,7 +507,7 @@ describe('LinkupClient', () => {
     mockAxiosInstance.post.mockRejectedValueOnce(refineError(invalidError));
 
     try {
-      await underTest.search({} as SourcedAnswerParams);
+      await underTest.search({} as SearchParams);
     } catch (e) {
       expect(e).toBeInstanceOf(LinkupUnknownError);
       expect((e as LinkupUnknownError).message).toEqual(

src/linkup-client.ts

@@ -5,14 +5,8 @@ import {
   ApiConfig,
   FetchParams,
   LinkupFetchResponse,
+  LinkupSearchResponse,
   SearchParams,
-  SearchResults,
-  SearchResultsParams,
-  SourcedAnswer,
-  SourcedAnswerParams,
-  Structured,
-  StructuredParams,
-  StructuredWithSources,
 } from './types';
 import { refineError } from './utils/refine-error.utils';
 import { isZodObject } from './utils/schema.utils';
@@ -43,24 +37,17 @@ export class LinkupClient {
     );
   }
 
-  async search(params: SourcedAnswerParams): Promise<SourcedAnswer>;
-  async search(params: SearchResultsParams): Promise<SearchResults>;
-  async search(params: StructuredParams & { includeSources: true }): Promise<StructuredWithSources>;
-  async search(
-    params: StructuredParams & { includeSources?: false | undefined },
-  ): Promise<Structured>;
-
-  async search(
-    params: SearchParams,
-  ): Promise<SourcedAnswer | SearchResults | Structured | StructuredWithSources> {
+  async search<T extends SearchParams>(params: T): Promise<LinkupSearchResponse<T>> {
     return this.client.post('/search', this.sanitizeParams(params)).then(response => response.data);
   }
 
   async fetch<T extends FetchParams>(params: T): Promise<LinkupFetchResponse<T>> {
     return this.client.post('/fetch', params).then(response => response.data);
   }
 
-  private sanitizeParams(params: SearchParams): Record<string, string | boolean | string[]> {
+  private sanitizeParams<T extends SearchParams>(
+    params: T,
+  ): Record<string, string | boolean | string[]> {
     const {
       query,
       depth,

src/types.ts

@@ -47,15 +47,13 @@ export type SearchParams = {
     }
 );
 
-export type SourcedAnswerParams = Extract<SearchParams, { outputType: 'sourcedAnswer' }>;
-export type SearchResultsParams = Extract<SearchParams, { outputType: 'searchResults' }>;
-export type StructuredParams = Extract<SearchParams, { outputType: 'structured' }>;
-
-export type LinkupSearchResponse =
-  | SourcedAnswer
-  | SearchResults
-  | Structured
-  | StructuredWithSources;
+export type LinkupSearchResponse<T> = T extends { outputType: 'structured'; includeSources: true }
+  ? StructuredWithSources
+  : T extends { outputType: 'structured' }
+    ? Structured
+    : T extends { outputType: 'sourcedAnswer' }
+      ? SourcedAnswer
+      : SearchResults;
 
 export type SearchResults = {
   results: (TextSearchResult | ImageSearchResult)[];