npm install @allscreenshots/sdk
# or
pnpm add @allscreenshots/sdk
# or
yarn add @allscreenshots/sdk

import { AllscreenshotsClient } from '@allscreenshots/sdk';
import fs from 'fs';

const client = new AllscreenshotsClient();

const imageBuffer = await client.screenshot({
  url: 'https://github.com',
  device: 'Desktop HD',
  fullPage: true
});

fs.writeFileSync('screenshot.png', imageBuffer);

import { AllscreenshotsClient } from '@allscreenshots/sdk';

const client = AllscreenshotsClient.builder()
  .apiKey(process.env.ALLSCREENSHOTS_API_KEY!)
  .baseUrl('https://api.allscreenshots.com')
  .timeout(60000)
  .maxRetries(3)
  .build();

const client = new AllscreenshotsClient({
  apiKey: process.env.ALLSCREENSHOTS_API_KEY!,
  baseUrl: 'https://api.allscreenshots.com',
  timeout: 60000,
  autoRetry: true,
  maxRetries: 3,
});

// Client will read API key from environment
const client = new AllscreenshotsClient();

const screenshot = await client.screenshot({
  url: 'https://example.com',
});

fs.writeFileSync('screenshot.png', screenshot);

const screenshot = await client.screenshot({
  url: 'https://example.com',
  device: 'Desktop HD',
  format: 'png',
  quality: 90,
  fullPage: true,
  darkMode: true,
  blockAds: true,
  blockCookieBanners: true,
  delay: 1000,
});

// Desktop
const desktop = await client.screenshot({
  url: 'https://example.com',
  device: 'Desktop HD',
});

// Mobile
const mobile = await client.screenshot({
  url: 'https://example.com',
  device: 'iPhone 15',
});

// Tablet
const tablet = await client.screenshot({
  url: 'https://example.com',
  device: 'iPad Pro 11',
});

// Create async job
const job = await client.screenshotAsync({
  url: 'https://example.com',
  fullPage: true,
});

console.log(`Job ID: ${job.jobId}`);

// Poll for completion
const result = await client.getJob(job.jobId);

if (result.status === 'completed') {
  const imageData = await client.getJobResult(job.jobId);
  fs.writeFileSync('screenshot.png', imageData);
}

const bulkJob = await client.bulk({
  urls: [
    { url: 'https://example1.com' },
    { url: 'https://example2.com' },
    { url: 'https://example3.com' },
  ],
  defaults: {
    device: 'Desktop HD',
    format: 'png',
  },
});

// Check status
const status = await client.getBulkJob(bulkJob.bulkJobId);

const composed = await client.compose({
  url: 'https://example.com',
  variants: [
    { device: 'Desktop HD', label: 'Desktop' },
    { device: 'iPhone 15', label: 'Mobile' },
  ],
  output: {
    layout: 'horizontal',
    spacing: 20,
  },
});

// Create a schedule
const schedule = await client.schedules.create({
  name: 'Daily Homepage',
  url: 'https://example.com',
  schedule: '0 9 * * *',
  timezone: 'America/New_York',
});

// List schedules
const schedules = await client.schedules.list();

// Get captures
const captures = await client.schedules.getCaptures(schedule.scheduleId);

const usage = await client.usage.get();
console.log(`Screenshots: ${usage.screenshotCount}/${usage.quota}`);

import {
  AllscreenshotsError,
  AuthenticationError,
  ValidationError,
  RateLimitError,
  QuotaExceededError,
  ServerError,
  NetworkError,
  TimeoutError
} from '@allscreenshots/sdk';

try {
  const screenshot = await client.screenshot({
    url: 'https://example.com',
  });
} catch (error) {
  if (error instanceof RateLimitError) {
    console.log(`Rate limited. Retry after ${error.retryAfter}s`);
  } else if (error instanceof QuotaExceededError) {
    console.log('Quota exceeded for this billing period');
  } else if (error instanceof AuthenticationError) {
    console.log('Invalid API key');
  } else if (error instanceof ValidationError) {
    console.log(`Validation error: ${error.message}`);
  } else if (error instanceof AllscreenshotsError) {
    console.log(`API error: ${error.message}`);
  }
}

interface ScreenshotOptions {
  url: string;
  viewport?: {
    width?: number;   // 100-4096, default: 1920
    height?: number;  // 100-4096, default: 1080
    deviceScaleFactor?: number; // 1-3, default: 1
  };
  device?: DevicePreset;
  format?: 'png' | 'jpeg' | 'webp' | 'pdf';
  quality?: number;  // 1-100
  fullPage?: boolean;
  selector?: string;
  delay?: number;    // 0-30000
  waitFor?: string;
  waitUntil?: 'load' | 'domcontentloaded' | 'networkidle';
  timeout?: number;  // 1000-60000
  darkMode?: boolean;
  customCss?: string;
  hideSelectors?: string[];
  blockAds?: boolean;
  blockCookieBanners?: boolean;
  actions?: PageAction[];
}

interface PageAction {
  type: 'click' | 'type' | 'press' | 'hover' | 'select' | 'scroll' | 'wait';
  optional?: boolean;   // skip the step instead of failing the capture (default: false)
  timeout?: number;     // per-action timeout in ms, capped at the request timeout
  selector?: string;    // click, type, hover, select, press (focus), scroll, wait
  text?: string;        // type
  clear?: boolean;      // type — replace (true, default) or append (false)
  key?: string;         // press, e.g. 'Enter'
  value?: string;       // select — option value
  y?: number;           // scroll — by pixels (negative scrolls up)
  toBottom?: boolean;   // scroll — to the bottom of the page
  ms?: number;          // wait — fixed delay, 0–30000
  networkIdle?: boolean;// wait — until the network is idle
}

await client.screenshot({
  url: 'https://example.com',
  actions: [
    { type: 'type', selector: 'input[name=q]', text: 'screenshot api' },
    { type: 'press', key: 'Enter' },
    { type: 'wait', selector: '.results', timeout: 8000 },
  ],
});

type DevicePreset =
  // Desktop
  | 'Desktop HD'
  | 'Desktop Large'
  | 'Laptop'
  // iPhone
  | 'iPhone SE'
  | 'iPhone 12'
  | 'iPhone 14'
  | 'iPhone 15'
  | 'iPhone 15 Pro Max'
  // iPad
  | 'iPad'
  | 'iPad Mini'
  | 'iPad Pro 11'
  | 'iPad Pro 12.9'
  // Android
  | 'Pixel 7'
  | 'Samsung Galaxy S23'
  // Social
  | 'Facebook OG'
  | 'Twitter Card'
  | 'LinkedIn Post';