feat: add extract images parameter

Author: Shedna

README.md

@@ -75,9 +75,11 @@ askLinkup()
 
 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.
+Use `renderJs` to execute the JavaScript code of the page before returning the content.
 
-You can also ask to `includeRawHtml` if you feel like it.
+Use `includeRawHtml` to get the raw HTML of the page.
+
+Use `extractImages` to get an extracted list of images from the page.
 
 #### 📝 Example
 

src/__tests__/linkup-client.test.ts

@@ -259,6 +259,40 @@ describe('LinkupClient', () => {
       });
     });
 
+    it('should handle fetch with extractImages parameter', async () => {
+      const mockResponse = {
+        data: {
+          images: [
+            {
+              alt: 'Image 1',
+              url: 'https://example.com/image.jpg',
+            },
+          ],
+          markdown: 'Fetched content',
+        },
+      };
+      mockAxiosInstance.post.mockResolvedValueOnce(mockResponse as AxiosResponse);
+
+      const result = await underTest.fetch({
+        extractImages: true,
+        url: 'https://example.com',
+      });
+
+      expect(mockAxiosInstance.post).toHaveBeenCalledWith('/fetch', {
+        extractImages: true,
+        url: 'https://example.com',
+      });
+      expect(result).toEqual({
+        images: [
+          {
+            alt: 'Image 1',
+            url: 'https://example.com/image.jpg',
+          },
+        ],
+        markdown: 'Fetched content',
+      });
+    });
+
     it('should handle fetch errors', async () => {
       const fetchError: LinkupApiError = {
         error: {

src/types.ts

@@ -1,3 +1,4 @@
+/** biome-ignore-all lint/complexity/noBannedTypes: needed for conditional props */
 import { ZodObject, ZodRawShape } from 'zod';
 
 export type SearchDepth = 'standard' | 'deep';
@@ -78,8 +79,12 @@ export interface FetchParams {
   url: string;
   renderJs?: boolean;
   includeRawHtml?: boolean;
+  extractImages?: boolean;
 }
 
+type ConditionalProp<Condition, PropType> = Condition extends true ? PropType : {};
+
 export type LinkupFetchResponse<T extends FetchParams = FetchParams> = {
   markdown: string;
-} & (T['includeRawHtml'] extends true ? { rawHtml: string } : Record<string, never>);
+} & ConditionalProp<T['includeRawHtml'], { rawHtml: string }> &
+  ConditionalProp<T['extractImages'], { images: string[] }>;