feat: new fetch endpoint

BruceWouaigne · BruceWouaigne · commit ad42bbd579fa · 2025-09-16T23:24:03.000+02:00
diff --git a/README.md b/README.md
@@ -73,9 +73,11 @@ askLinkup()
 
 ### ⬇️ Fetch Endpoint
 
-You can use the fetch endpoint to retrieve the content of a given URL either in `html` or `markdown` format.
+You can use the fetch endpoint to retrieve the content of a given URL in clean `markdown` format.
 
-You can also use the `renderJS` flag to execute the JavaScript code of the page before returning the content.
+You can also use the `renderJs` flag to execute the JavaScript code of the page before returning the content.
+
+You can also ask to `includeRawHtml` if you feel like it.
 
 #### 📝 Example
 
@@ -87,9 +89,8 @@ const client = new LinkupClient({
 });
 
 const fetchLinkup = async () => client.fetch({
-  url: 'https://www.linkup.so',
-  outputFormat: 'html',
-  renderJS: true,
+  url: 'https://docs.linkup.so',
+  renderJs: true,
 });
 
 fetchLinkup()
diff --git a/src/__tests__/linkup-client.test.ts b/src/__tests__/linkup-client.test.ts
@@ -192,51 +192,49 @@ describe('LinkupClient', () => {
   });
 
   describe('fetch method', () => {
-    it('should make a successful fetch API call with HTML output', async () => {
-      const mockResponse = { data: '<html><body>Content</body></html>' };
+    it('should make a successful fetch API call', async () => {
+      const mockResponse = { data: { content: 'Content' } };
       mockAxiosInstance.post.mockResolvedValueOnce(mockResponse as AxiosResponse);
 
       const result = await underTest.fetch({
-        outputFormat: 'html',
         url: 'https://example.com',
       });
 
       expect(mockAxiosInstance.post).toHaveBeenCalledWith('/fetch', {
-        outputFormat: 'html',
         url: 'https://example.com',
       });
-      expect(result).toEqual('<html><body>Content</body></html>');
+      expect(result).toEqual({ content: 'Content' });
     });
 
-    it('should make a successful fetch API call with Markdown output', async () => {
-      const mockResponse = { data: '# Title\n\nContent' };
+    it('should make a successful fetch API call including raw HTML', async () => {
+      const mockResponse = {
+        data: { content: 'Content', rawHtml: '<h1>Title</h1><p>Content</p>' },
+      };
       mockAxiosInstance.post.mockResolvedValueOnce(mockResponse as AxiosResponse);
 
       const result = await underTest.fetch({
-        outputFormat: 'markdown',
+        includeRawHtml: true,
         url: 'https://example.com',
       });
 
       expect(mockAxiosInstance.post).toHaveBeenCalledWith('/fetch', {
-        outputFormat: 'markdown',
+        includeRawHtml: true,
         url: 'https://example.com',
       });
-      expect(result).toEqual('# Title\n\nContent');
+      expect(result).toEqual({ content: 'Content', rawHtml: '<h1>Title</h1><p>Content</p>' });
     });
 
     it('should handle fetch with renderJS parameter', async () => {
-      const mockResponse = { data: 'Fetched content' };
+      const mockResponse = { data: { content: 'Fetched content' } };
       mockAxiosInstance.post.mockResolvedValueOnce(mockResponse as AxiosResponse);
 
       await underTest.fetch({
-        outputFormat: 'html',
-        renderJS: true,
+        renderJs: true,
         url: 'https://example.com',
       });
 
       expect(mockAxiosInstance.post).toHaveBeenCalledWith('/fetch', {
-        outputFormat: 'html',
-        renderJS: true,
+        renderJs: true,
         url: 'https://example.com',
       });
     });
@@ -254,7 +252,6 @@ describe('LinkupClient', () => {
 
       try {
         await underTest.fetch({
-          outputFormat: 'html',
           url: 'https://invalid-url.com',
         });
         fail('Expected fetch to throw an error');
diff --git a/src/linkup-client.ts b/src/linkup-client.ts
@@ -4,6 +4,7 @@ import zodToJsonSchema from 'zod-to-json-schema';
 import {
   ApiConfig,
   FetchParams,
+  LinkupFetchResponse,
   LinkupSearchResponse,
   SearchOutputType,
   SearchParams,
@@ -56,8 +57,8 @@ export class LinkupClient {
       .then(response => this.formatResponse<T>(response.data, params.outputType));
   }
 
-  async fetch(params: FetchParams): Promise<unknown> {
-    return this.client.post('/fetch', params).then(response => response.data);
+  async fetch(params: FetchParams): Promise<LinkupFetchResponse> {
+    return this.client.post<LinkupFetchResponse>('/fetch', params).then(response => response.data);
   }
 
   private sanitizeParams<T extends SearchOutputType>({
diff --git a/src/types.ts b/src/types.ts
@@ -73,6 +73,11 @@ export type LinkupApiError = {
 
 export interface FetchParams {
   url: string;
-  outputFormat: 'html' | 'markdown';
-  renderJS?: boolean;
+  renderJs?: boolean;
+  includeRawHtml?: boolean;
+}
+
+export interface LinkupFetchResponse {
+  content: string;
+  rawHtml?: string;
 }
