@stack0/sdk 0.2.8 → 0.3.0

package/dist/screenshots/index.d.mts

@@ -0,0 +1,377 @@
+import { a as HttpClientConfig } from '../http-client-DjrRWvXA.mjs';
+import { E as Environment, B as BatchJobStatus, S as ScheduleFrequency, C as CreateBatchResponse, G as GetBatchJobRequest, L as ListBatchJobsRequest, c as CreateScheduleResponse, a as GetScheduleRequest, b as ListSchedulesRequest } from '../shared-types-B0PyC7cF.mjs';
+
+/**
+ * Type definitions for Stack0 Screenshot API
+ */
+
+type ScreenshotStatus = "pending" | "processing" | "completed" | "failed";
+type ScreenshotFormat = "png" | "jpeg" | "webp" | "pdf";
+type DeviceType = "desktop" | "tablet" | "mobile";
+type ResourceType = "image" | "stylesheet" | "script" | "font" | "media" | "xhr" | "fetch" | "websocket";
+interface Screenshot {
+    id: string;
+    organizationId: string;
+    projectId: string | null;
+    environment: Environment;
+    url: string;
+    format: ScreenshotFormat;
+    quality: number | null;
+    fullPage: boolean;
+    deviceType: DeviceType;
+    viewportWidth: number | null;
+    viewportHeight: number | null;
+    status: ScreenshotStatus;
+    imageUrl: string | null;
+    imageSize: number | null;
+    imageWidth: number | null;
+    imageHeight: number | null;
+    error: string | null;
+    processingTimeMs: number | null;
+    metadata: Record<string, unknown> | null;
+    createdAt: Date;
+    completedAt: Date | null;
+}
+interface Clip {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface CreateScreenshotRequest {
+    url: string;
+    environment?: Environment;
+    projectId?: string;
+    format?: ScreenshotFormat;
+    quality?: number;
+    fullPage?: boolean;
+    deviceType?: DeviceType;
+    viewportWidth?: number;
+    viewportHeight?: number;
+    deviceScaleFactor?: number;
+    waitForSelector?: string;
+    waitForTimeout?: number;
+    blockAds?: boolean;
+    blockCookieBanners?: boolean;
+    blockChatWidgets?: boolean;
+    blockTrackers?: boolean;
+    blockUrls?: string[];
+    blockResources?: ResourceType[];
+    darkMode?: boolean;
+    customCss?: string;
+    customJs?: string;
+    headers?: Record<string, string>;
+    cookies?: Array<{
+        name: string;
+        value: string;
+        domain?: string;
+    }>;
+    selector?: string;
+    hideSelectors?: string[];
+    clickSelector?: string;
+    omitBackground?: boolean;
+    userAgent?: string;
+    clip?: Clip;
+    thumbnailWidth?: number;
+    thumbnailHeight?: number;
+    cacheKey?: string;
+    cacheTtl?: number;
+    webhookUrl?: string;
+    webhookSecret?: string;
+    metadata?: Record<string, unknown>;
+}
+interface CreateScreenshotResponse {
+    id: string;
+    status: ScreenshotStatus;
+}
+interface GetScreenshotRequest {
+    id: string;
+    environment?: Environment;
+    projectId?: string;
+}
+interface ListScreenshotsRequest {
+    environment?: Environment;
+    projectId?: string;
+    status?: ScreenshotStatus;
+    url?: string;
+    limit?: number;
+    cursor?: string;
+}
+interface ListScreenshotsResponse {
+    items: Screenshot[];
+    nextCursor?: string;
+}
+interface BatchScreenshotJob {
+    id: string;
+    organizationId: string;
+    projectId: string | null;
+    environment: Environment;
+    type: "screenshot";
+    name: string | null;
+    status: BatchJobStatus;
+    urls: string[];
+    config: Record<string, unknown>;
+    totalUrls: number;
+    processedUrls: number;
+    successfulUrls: number;
+    failedUrls: number;
+    webhookUrl: string | null;
+    metadata: Record<string, unknown> | null;
+    createdAt: Date;
+    startedAt: Date | null;
+    completedAt: Date | null;
+}
+interface CreateBatchScreenshotsRequest {
+    urls: string[];
+    environment?: Environment;
+    projectId?: string;
+    name?: string;
+    config?: {
+        format?: ScreenshotFormat;
+        quality?: number;
+        fullPage?: boolean;
+        deviceType?: DeviceType;
+        viewportWidth?: number;
+        viewportHeight?: number;
+        blockAds?: boolean;
+        blockCookieBanners?: boolean;
+        waitForSelector?: string;
+        waitForTimeout?: number;
+    };
+    webhookUrl?: string;
+    webhookSecret?: string;
+    metadata?: Record<string, unknown>;
+}
+interface ScreenshotBatchJobsResponse {
+    items: BatchScreenshotJob[];
+    nextCursor?: string;
+}
+interface ScreenshotSchedule {
+    id: string;
+    organizationId: string;
+    projectId: string | null;
+    environment: Environment;
+    name: string;
+    url: string;
+    type: "screenshot";
+    frequency: ScheduleFrequency;
+    config: Record<string, unknown>;
+    isActive: boolean;
+    detectChanges: boolean;
+    changeThreshold: number | null;
+    webhookUrl: string | null;
+    totalRuns: number;
+    successfulRuns: number;
+    failedRuns: number;
+    lastRunAt: Date | null;
+    nextRunAt: Date | null;
+    metadata: Record<string, unknown> | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface CreateScreenshotScheduleRequest {
+    name: string;
+    url: string;
+    environment?: Environment;
+    projectId?: string;
+    frequency?: ScheduleFrequency;
+    config: {
+        format?: ScreenshotFormat;
+        quality?: number;
+        fullPage?: boolean;
+        deviceType?: DeviceType;
+        viewportWidth?: number;
+        viewportHeight?: number;
+        blockAds?: boolean;
+        blockCookieBanners?: boolean;
+        waitForSelector?: string;
+        waitForTimeout?: number;
+    };
+    detectChanges?: boolean;
+    changeThreshold?: number;
+    webhookUrl?: string;
+    webhookSecret?: string;
+    metadata?: Record<string, unknown>;
+}
+interface UpdateScreenshotScheduleRequest {
+    id: string;
+    environment?: Environment;
+    projectId?: string;
+    name?: string;
+    frequency?: ScheduleFrequency;
+    config?: Record<string, unknown>;
+    isActive?: boolean;
+    detectChanges?: boolean;
+    changeThreshold?: number;
+    webhookUrl?: string | null;
+    webhookSecret?: string | null;
+    metadata?: Record<string, unknown>;
+}
+interface ScreenshotSchedulesResponse {
+    items: ScreenshotSchedule[];
+    nextCursor?: string;
+}
+
+/**
+ * Stack0 Screenshots Client
+ * Capture high-quality screenshots of any webpage
+ */
+
+declare class Screenshots {
+    private http;
+    constructor(config: HttpClientConfig);
+    /**
+     * Capture a screenshot of a URL
+     *
+     * @example
+     * ```typescript
+     * const { id, status } = await screenshots.capture({
+     *   url: 'https://example.com',
+     *   format: 'png',
+     *   fullPage: true,
+     *   deviceType: 'desktop',
+     * });
+     *
+     * // Poll for completion
+     * const screenshot = await screenshots.get({ id });
+     * console.log(screenshot.imageUrl);
+     * ```
+     */
+    capture(request: CreateScreenshotRequest): Promise<CreateScreenshotResponse>;
+    /**
+     * Get a screenshot by ID
+     *
+     * @example
+     * ```typescript
+     * const screenshot = await screenshots.get({ id: 'screenshot-id' });
+     * if (screenshot.status === 'completed') {
+     *   console.log(screenshot.imageUrl);
+     * }
+     * ```
+     */
+    get(request: GetScreenshotRequest): Promise<Screenshot>;
+    /**
+     * List screenshots with pagination and filters
+     *
+     * @example
+     * ```typescript
+     * const { items, nextCursor } = await screenshots.list({
+     *   status: 'completed',
+     *   limit: 20,
+     * });
+     * ```
+     */
+    list(request?: ListScreenshotsRequest): Promise<ListScreenshotsResponse>;
+    /**
+     * Delete a screenshot
+     *
+     * @example
+     * ```typescript
+     * await screenshots.delete({ id: 'screenshot-id' });
+     * ```
+     */
+    delete(request: GetScreenshotRequest): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Capture a screenshot and wait for completion
+     *
+     * @example
+     * ```typescript
+     * const screenshot = await screenshots.captureAndWait({
+     *   url: 'https://example.com',
+     *   format: 'png',
+     * });
+     * console.log(screenshot.imageUrl);
+     * ```
+     */
+    captureAndWait(request: CreateScreenshotRequest, options?: {
+        pollInterval?: number;
+        timeout?: number;
+    }): Promise<Screenshot>;
+    /**
+     * Create a batch screenshot job for multiple URLs
+     *
+     * @example
+     * ```typescript
+     * const { id, totalUrls } = await screenshots.batch({
+     *   urls: [
+     *     'https://example.com',
+     *     'https://example.org',
+     *   ],
+     *   config: { format: 'png', fullPage: true },
+     * });
+     *
+     * // Poll for completion
+     * const job = await screenshots.getBatchJob({ id });
+     * console.log(`Progress: ${job.processedUrls}/${job.totalUrls}`);
+     * ```
+     */
+    batch(request: CreateBatchScreenshotsRequest): Promise<CreateBatchResponse>;
+    /**
+     * Get a batch job by ID
+     */
+    getBatchJob(request: GetBatchJobRequest): Promise<BatchScreenshotJob>;
+    /**
+     * List batch jobs with pagination and filters
+     */
+    listBatchJobs(request?: ListBatchJobsRequest): Promise<ScreenshotBatchJobsResponse>;
+    /**
+     * Cancel a batch job
+     */
+    cancelBatchJob(request: GetBatchJobRequest): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Create a batch screenshot job and wait for completion
+     */
+    batchAndWait(request: CreateBatchScreenshotsRequest, options?: {
+        pollInterval?: number;
+        timeout?: number;
+    }): Promise<BatchScreenshotJob>;
+    /**
+     * Create a scheduled screenshot job
+     *
+     * @example
+     * ```typescript
+     * const { id } = await screenshots.createSchedule({
+     *   name: 'Daily homepage screenshot',
+     *   url: 'https://example.com',
+     *   frequency: 'daily',
+     *   config: { format: 'png', fullPage: true },
+     * });
+     * ```
+     */
+    createSchedule(request: CreateScreenshotScheduleRequest): Promise<CreateScheduleResponse>;
+    /**
+     * Update a schedule
+     */
+    updateSchedule(request: UpdateScreenshotScheduleRequest): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Get a schedule by ID
+     */
+    getSchedule(request: GetScheduleRequest): Promise<ScreenshotSchedule>;
+    /**
+     * List schedules with pagination and filters
+     */
+    listSchedules(request?: ListSchedulesRequest): Promise<ScreenshotSchedulesResponse>;
+    /**
+     * Delete a schedule
+     */
+    deleteSchedule(request: GetScheduleRequest): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Toggle a schedule on or off
+     */
+    toggleSchedule(request: GetScheduleRequest): Promise<{
+        isActive: boolean;
+    }>;
+    private convertDates;
+    private convertBatchJobDates;
+    private convertScheduleDates;
+}
+
+export { type BatchScreenshotJob, type Clip, type CreateBatchScreenshotsRequest, type CreateScreenshotRequest, type CreateScreenshotResponse, type CreateScreenshotScheduleRequest, type DeviceType, type GetScreenshotRequest, type ListScreenshotsRequest, type ListScreenshotsResponse, type ResourceType, type Screenshot, type ScreenshotBatchJobsResponse, type ScreenshotFormat, type ScreenshotSchedule, type ScreenshotSchedulesResponse, type ScreenshotStatus, Screenshots, type UpdateScreenshotScheduleRequest };