add string type hints for enum params

Author: mazen-r

src/extractionconfig.ts

@@ -26,7 +26,7 @@ type ExtractionConfigOptions = {
   extraction_prompt?: string;
   extraction_model?: string;
   is_document_compressed?: boolean;
-  document_compression_format?: string | CompressionFormat;
+  document_compression_format?: 'gzip' | 'zstd' | 'deflate' | CompressionFormat;
   webhook?: string;
 };
 
@@ -40,7 +40,7 @@ export class ExtractionConfig {
   extraction_prompt?: string;
   extraction_model?: string;
   is_document_compressed?: boolean;
-  document_compression_format?: string | CompressionFormat;
+  document_compression_format?: 'gzip' | 'zstd' | 'deflate' | CompressionFormat;
   webhook?: string;
 
   constructor(options: ExtractionConfigOptions) {

src/scrapeconfig.ts

@@ -59,8 +59,8 @@ type ScrapeConfigOptions = {
   proxy_pool?: string;
   session?: string;
   tags?: string[];
-  format?: string | Format;
-  format_options?: string[] | FormatOption[];
+  format?: 'json' | 'text' | 'markdown' | 'clean_html' | 'raw' | Format;
+  format_options?: ('no_links' | 'no_images' | 'only_content')[] | FormatOption[];
   correlation_id?: string;
   cookies?: Rec<string>;
   body?: string;
@@ -70,7 +70,7 @@ type ScrapeConfigOptions = {
   rendering_wait?: number;
   wait_for_selector?: string;
   screenshots?: Rec<any>;
-  screenshot_flags?: string[] | ScreenshotFlags[] ;
+  screenshot_flags?: ('load_images' | 'dark_mode' | 'block_banners' | 'print_media_format' | 'high_quality')[] | ScreenshotFlags[];
   session_sticky_proxy?: boolean;
   webhook?: string;
   timeout?: number;
@@ -101,8 +101,8 @@ export class ScrapeConfig {
   proxy_pool?: string;
   session?: string;
   tags: Set<string> = new Set<string>();
-  format?: Format| string; // raw(unchanged)
-  format_options?: string[] | FormatOption[];
+  format?: 'json' | 'text' | 'markdown' | 'clean_html' | 'raw' | Format;
+  format_options?: ('no_links' | 'no_images' | 'only_content')[] | FormatOption[];
   correlation_id?: string;
   cookies?: Rec<string>;
   body?: string;
@@ -113,7 +113,7 @@ export class ScrapeConfig {
   wait_for_selector?: string;
   session_sticky_proxy = false;
   screenshots?: Rec<any>;
-  screenshot_flags?: ScreenshotFlags[] | string[];
+  screenshot_flags?: ('load_images' | 'dark_mode' | 'block_banners' | 'print_media_format' | 'high_quality')[] | ScreenshotFlags[];
   webhook?: string;
   timeout?: number; // in milliseconds
   js_scenario?: Rec<any>;

src/screenshotconfig.ts

@@ -34,14 +34,14 @@ export enum Format {
 
 type ScreenshotConfigOptions = {
   url: string;
-  format?: string | Format;
+  format?: 'jpg'| 'png' | 'webp'| 'gif' | Format;
   capture?: string;
   resolution?: string;
   country?: string;
   timeout?: number;
   rendering_wait?: number;
   wait_for_selector?: string;
-  options?: string[] | Options[];
+  options?: ('load_images' | 'dark_mode' | 'block_banners' | 'print_media_format')[] | Options[];
   auto_scroll?: boolean;
   js?: string;
   cache?: boolean;
@@ -52,14 +52,14 @@ type ScreenshotConfigOptions = {
 
 export class ScreenshotConfig {
   url: string;
-  format?: string | Format;
+  format?: 'jpg'| 'png' | 'webp'| 'gif' | Format;
   capture?: string;
   resolution?: string;
   country?: string = undefined;
   timeout?: number;
   rendering_wait?: number;
   wait_for_selector?: string;
-  options?: string[] | Options[];
+  options?: ('load_images' | 'dark_mode' | 'block_banners' | 'print_media_format')[] | Options[];
   auto_scroll?: boolean;
   js?: string;
   cache?: boolean;