fix: add screenshot get request

Author: antoineross

README.md

@@ -49,6 +49,10 @@ const status = await client.waitForJob(job.job_id)
 // Screenshot job
 const sJob = await client.createScreenshotJob({ url: 'https://example.com', device: 'desktop', full_page: true })
 
+// Wait and fetch a fresh signed URL (recommended)
+const signed = await client.waitForScreenshot(sJob.job_id)
+console.log('screenshot:', signed.screenshot)
+
 // Watch create/pause/resume/check/delete
 const watch = await client.watchCreate({ url: 'https://example.com/pricing', frequency: 'daily', notify_email: '[email protected]' })
 await client.watchPause(watch.watch_id)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supacrawler/js",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Typed TypeScript/JavaScript SDK for Supacrawler API (scrape, jobs, screenshots, watch)",
   "type": "module",
   "main": "dist/index.js",

src/client.ts

@@ -6,6 +6,7 @@ import type {
   JobStatusResponse,
   ScreenshotRequest,
   ScreenshotCreateResponse,
+  ScreenshotGetResponse,
   WatchCreateRequest,
   WatchCreateResponse,
   WatchGetResponse,
@@ -39,7 +40,9 @@ export class SupacrawlerClient {
 
   constructor(options: ClientOptions) {
     this.apiKey = options.apiKey
-    this.baseUrl = (options.baseUrl ?? 'https://api.supacrawler.com/api/v1').replace(/\/$/, '')
+    // Allow passing engine root (e.g., http://localhost:8081/v1) or hosted API root
+    const defaultBase = 'https://api.supacrawler.com/api/v1'
+    this.baseUrl = (options.baseUrl ?? defaultBase).replace(/\/$/, '')
     this.fetchFn = options.fetchFn ?? fetch
     this.timeoutMs = options.timeoutMs ?? 30000
   }
@@ -118,6 +121,19 @@ export class SupacrawlerClient {
     })
   }
 
+  async getScreenshot(jobId: string): Promise<ScreenshotGetResponse> {
+    const qs = new URLSearchParams({ job_id: jobId })
+    return this.request<ScreenshotGetResponse>(`/screenshots?${qs.toString()}`, {
+      headers: { Authorization: `Bearer ${this.apiKey}` },
+    })
+  }
+
+  async waitForScreenshot(jobId: string, opts: { intervalMs?: number; timeoutMs?: number } = {}): Promise<ScreenshotGetResponse> {
+    const status = await this.waitForJob(jobId, opts)
+    if (status.status !== 'completed') throw new SupacrawlerError(`Job ${jobId} did not complete`)
+    return this.getScreenshot(jobId)
+  }
+
   // ------------- Watch -------------
   async watchCreate(req: WatchCreateRequest): Promise<WatchCreateResponse> {
     return this.request<WatchCreateResponse>(`/watch`, {

src/examples/screenshots.ts

@@ -25,6 +25,9 @@ async function main() {
   console.log('Screenshot status:', status.status)
   if (status.status === 'completed' && status.data && 'screenshot' in status.data) {
     console.log('Screenshot URL:', (status.data as any).screenshot)
+    // Example: Renew signed URL
+    const renewed = await client.getScreenshot(job.job_id)
+    console.log('Renewed screenshot URL:', renewed.screenshot)
   }
 }
 

src/types.ts

@@ -143,6 +143,14 @@ export interface ScreenshotCreateResponse {
   metadata?: ScreenshotMetadata
 }
 
+export interface ScreenshotGetResponse {
+  success: boolean
+  job_id: string
+  url: string
+  screenshot: string
+  metadata?: ScreenshotMetadata
+}
+
 export type Frequency = 'hourly' | 'daily' | 'weekly' | 'monthly' | 'custom'
 
 export interface WatchCreateRequest {