@crawlkit-sh/sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,1416 @@
+/**
+ * Configuration for resource instances
+ */
+interface ResourceConfig {
+    /** API key for authentication */
+    apiKey: string;
+    /** Base URL for the API */
+    baseUrl: string;
+    /** Default timeout in milliseconds */
+    timeout: number;
+    /** Fetch implementation */
+    fetch: typeof globalThis.fetch;
+}
+/**
+ * Base class for API resources
+ * Provides common HTTP functionality for all resource classes
+ */
+declare abstract class BaseResource {
+    protected readonly config: ResourceConfig;
+    constructor(config: ResourceConfig);
+    /**
+     * Make a POST request to the API
+     * @param endpoint - API endpoint path (e.g., '/v1/crawl/scrape')
+     * @param body - Request body object
+     * @returns Parsed response data
+     * @throws {CrawlKitError} On API errors
+     */
+    protected post<T, B extends object = object>(endpoint: string, body: B): Promise<T>;
+    /**
+     * Make a GET request to the API
+     * @param endpoint - API endpoint path
+     * @param params - Query parameters
+     * @returns Parsed response data
+     * @throws {CrawlKitError} On API errors
+     */
+    protected get<T>(endpoint: string, params?: Record<string, string | number | boolean | undefined>): Promise<T>;
+}
+
+/**
+ * Base API success response wrapper
+ */
+interface ApiSuccessResponse<T> {
+    success: true;
+    data: T;
+}
+/**
+ * API error response
+ */
+interface ApiErrorResponse {
+    success: false;
+    error: {
+        code: string;
+        message: string;
+    };
+    creditsRefunded?: number;
+    creditsRemaining?: number;
+}
+/**
+ * Union type for all API responses
+ */
+type ApiResponse<T> = ApiSuccessResponse<T> | ApiErrorResponse;
+/**
+ * Credit information included in successful responses
+ */
+interface CreditInfo {
+    creditsUsed: number;
+    creditsRemaining: number;
+}
+/**
+ * Timing information
+ */
+interface Timing {
+    total: number;
+}
+/**
+ * API error codes
+ */
+type ErrorCode = 'VALIDATION_ERROR' | 'INSUFFICIENT_CREDITS' | 'TIMEOUT' | 'DNS_FAILED' | 'CONNECTION_REFUSED' | 'SSL_ERROR' | 'TOO_MANY_REDIRECTS' | 'INVALID_URL' | 'PROXY_ERROR' | 'PARSE_ERROR' | 'RATE_LIMITED' | 'NOT_FOUND' | 'BLOCKED' | 'INSTAGRAM_BLOCKED' | 'INSTAGRAM_ERROR' | 'UNKNOWN';
+
+/**
+ * Browser action: wait for specified milliseconds
+ */
+interface WaitAction {
+    type: 'wait';
+    /** Milliseconds to wait (100-30000) */
+    milliseconds: number;
+}
+/**
+ * Browser action: click an element
+ */
+interface ClickAction {
+    type: 'click';
+    /** CSS selector of element to click */
+    selector: string;
+}
+/**
+ * Browser action: type text into an input
+ */
+interface TypeAction {
+    type: 'type';
+    /** CSS selector of input element */
+    selector: string;
+    /** Text to type into the element */
+    text: string;
+}
+/**
+ * Browser action: press a key
+ */
+interface PressAction {
+    type: 'press';
+    /** Key to press (Enter, Tab, Escape, ArrowDown, etc.) */
+    key: string;
+}
+/**
+ * Browser action: scroll the page
+ */
+interface ScrollAction {
+    type: 'scroll';
+    /** Scroll direction */
+    direction: 'up' | 'down';
+}
+/**
+ * Browser action: execute JavaScript
+ */
+interface EvaluateAction {
+    type: 'evaluate';
+    /** JavaScript code to execute in browser context */
+    script: string;
+}
+/**
+ * Union type for all browser actions
+ */
+type BrowserAction = WaitAction | ClickAction | TypeAction | PressAction | ScrollAction | EvaluateAction;
+/**
+ * Options for scraping a URL
+ */
+interface ScrapeOptions {
+    /** Request timeout in milliseconds (1000-300000, default: 30000) */
+    timeout?: number;
+    /** Additional HTTP headers */
+    headers?: Record<string, string>;
+    /** CSS selector or milliseconds to wait before extracting content. Forces browser rendering. */
+    waitFor?: string | number;
+    /** Browser actions to execute in order. Forces browser rendering. Max 50 actions. */
+    actions?: BrowserAction[];
+    /** Extract only main content - removes boilerplate, navigation, etc. (default: true) */
+    onlyMainContent?: boolean;
+    /** Custom CSS selector to extract specific content */
+    contentSelector?: string;
+}
+/**
+ * Parameters for the scrape endpoint
+ */
+interface ScrapeParams {
+    /** URL to scrape */
+    url: string;
+    /** Scrape options */
+    options?: ScrapeOptions;
+}
+/**
+ * Page metadata extracted from the scraped page
+ */
+interface PageMetadata {
+    title: string | null;
+    description: string | null;
+    language: string | null;
+    ogImage: string | null;
+    ogTitle: string | null;
+    ogDescription: string | null;
+    siteName: string | null;
+    favicon: string | null;
+    author: string | null;
+    publishedTime: string | null;
+    modifiedTime: string | null;
+    keywords: string[];
+    canonical: string | null;
+    robots: string | null;
+}
+/**
+ * Links found on the scraped page
+ */
+interface PageLinks {
+    internal: string[];
+    external: string[];
+}
+/**
+ * Processing time statistics
+ */
+interface CrawlStats {
+    fetchTime: number;
+    cleaningTime: number;
+    extractionTime: number;
+    conversionTime: number;
+    llmTime: number | null;
+    totalTime: number;
+}
+/**
+ * Result of a browser action execution
+ */
+interface ActionResult {
+    type: string;
+    success: boolean;
+    duration: number;
+    value?: unknown;
+    error?: string;
+}
+/**
+ * Data returned from the scrape endpoint
+ */
+interface ScrapeData {
+    /** Original requested URL */
+    url: string;
+    /** Final URL after redirects */
+    finalUrl: string;
+    /** Cleaned, readable markdown content */
+    markdown: string;
+    /** Cleaned HTML (main content only) */
+    html: string;
+    /** Original unprocessed HTML */
+    rawHtml: string;
+    /** LLM-extracted data (null for scrape, populated for extract) */
+    json: Record<string, unknown> | null;
+    /** Page metadata */
+    metadata: PageMetadata;
+    /** Internal and external links */
+    links: PageLinks;
+    /** Processing time statistics */
+    stats: CrawlStats;
+    /** Embedded data from Next.js, Nuxt.js, Notion, etc. */
+    embeddedData?: Record<string, unknown> | null;
+    /** Results of browser actions (if any were executed) */
+    actionResults?: ActionResult[];
+    /** Credits charged for this operation */
+    creditsUsed: number;
+    /** Remaining credits after operation */
+    creditsRemaining: number;
+}
+/**
+ * Response from the scrape endpoint
+ */
+type ScrapeResponse = ApiSuccessResponse<ScrapeData>;
+
+/**
+ * Options for extracting structured data from a URL
+ */
+interface ExtractOptions extends ScrapeOptions {
+    /** Custom extraction prompt (max 2000 chars). Helps guide the LLM on what to extract. */
+    prompt?: string;
+}
+/**
+ * Parameters for the extract endpoint
+ */
+interface ExtractParams {
+    /** URL to scrape and extract from */
+    url: string;
+    /** JSON Schema defining the structure for LLM extraction */
+    schema: Record<string, unknown>;
+    /** Extract options */
+    options?: ExtractOptions;
+}
+/**
+ * Data returned from the extract endpoint
+ * @template T - The type of the extracted JSON data based on the provided schema
+ */
+interface ExtractData<T = unknown> {
+    /** Original requested URL */
+    url: string;
+    /** Final URL after redirects */
+    finalUrl: string;
+    /** Cleaned, readable markdown content */
+    markdown: string;
+    /** Cleaned HTML (main content only) */
+    html: string;
+    /** Original unprocessed HTML */
+    rawHtml: string;
+    /** LLM-extracted structured data based on provided schema */
+    json: T;
+    /** Page metadata */
+    metadata: PageMetadata;
+    /** Internal and external links */
+    links: PageLinks;
+    /** Processing time statistics */
+    stats: CrawlStats;
+    /** Embedded data from Next.js, Nuxt.js, Notion, etc. */
+    embeddedData?: Record<string, unknown> | null;
+    /** Results of browser actions (if any were executed) */
+    actionResults?: ActionResult[];
+    /** Credits charged for this operation */
+    creditsUsed: number;
+    /** Remaining credits after operation */
+    creditsRemaining: number;
+}
+/**
+ * Response from the extract endpoint
+ * @template T - The type of the extracted JSON data based on the provided schema
+ */
+type ExtractResponse<T = unknown> = ApiSuccessResponse<ExtractData<T>>;
+
+/**
+ * Time range filter for search results
+ * - 'd': Past day
+ * - 'w': Past week
+ * - 'm': Past month
+ * - 'y': Past year
+ */
+type TimeRange = 'd' | 'w' | 'm' | 'y';
+/**
+ * Options for web search
+ */
+interface SearchOptions {
+    /** Language code (e.g., 'tr-TR', 'en-US') */
+    language?: string;
+    /** Region code (e.g., 'tr-tr', 'us-en', 'de-de') */
+    region?: string;
+    /** Time filter: d (day), w (week), m (month), y (year), null (any time) */
+    timeRange?: TimeRange | null;
+    /** Maximum number of results (1-100, default: 30) */
+    maxResults?: number;
+}
+/**
+ * Parameters for the search endpoint
+ */
+interface SearchParams {
+    /** Search query (1-500 characters) */
+    query: string;
+    /** Search options */
+    options?: SearchOptions;
+}
+/**
+ * A single search result
+ */
+interface SearchResult {
+    /** Result position (1-indexed) */
+    position: number;
+    /** Result title */
+    title: string;
+    /** Result URL */
+    url: string;
+    /** Result snippet/description */
+    snippet: string;
+}
+/**
+ * Data returned from the search endpoint
+ */
+interface SearchData {
+    /** Original search query */
+    query: string;
+    /** Total number of results returned */
+    totalResults: number;
+    /** Search results */
+    results: SearchResult[];
+    /** Timing information */
+    timing: {
+        total: number;
+    };
+    /** Credits charged for this operation */
+    creditsUsed: number;
+    /** Remaining credits after operation */
+    creditsRemaining: number;
+}
+/**
+ * Response from the search endpoint
+ */
+type SearchResponse = ApiSuccessResponse<SearchData>;
+
+/**
+ * Options for taking a screenshot
+ */
+interface ScreenshotOptions {
+    /** Viewport width in pixels (320-3840, default: 1920) */
+    width?: number;
+    /** Viewport height in pixels (240-2160, default: 1080) */
+    height?: number;
+    /** Page load timeout in milliseconds (1000-60000, default: 30000) */
+    timeout?: number;
+    /** CSS selector to wait for before taking screenshot */
+    waitForSelector?: string;
+}
+/**
+ * Parameters for the screenshot endpoint
+ */
+interface ScreenshotParams {
+    /** URL to screenshot */
+    url: string;
+    /** Screenshot options */
+    options?: ScreenshotOptions;
+}
+/**
+ * Data returned from the screenshot endpoint
+ */
+interface ScreenshotData {
+    /** Public URL of the screenshot */
+    url: string;
+    /** Viewport width used */
+    width: number;
+    /** Viewport height used */
+    height: number;
+    /** Timing information */
+    timing: {
+        total: number;
+    };
+    /** Credits charged for this operation */
+    creditsUsed: number;
+    /** Remaining credits after operation */
+    creditsRemaining: number;
+}
+/**
+ * Response from the screenshot endpoint
+ */
+type ScreenshotResponse = ApiSuccessResponse<ScreenshotData>;
+
+/**
+ * Options for scraping a LinkedIn company profile
+ */
+interface LinkedInCompanyOptions {
+    /** Page load timeout in milliseconds (5000-60000, default: 30000) */
+    timeout?: number;
+    /** Whether to fetch job listings (default: true) */
+    includeJobs?: boolean;
+}
+/**
+ * Parameters for the LinkedIn company endpoint
+ */
+interface LinkedInCompanyParams {
+    /** LinkedIn company URL (e.g., https://www.linkedin.com/company/openai/) */
+    url: string;
+    /** Options */
+    options?: LinkedInCompanyOptions;
+}
+/**
+ * LinkedIn employee information
+ */
+interface LinkedInEmployee {
+    name: string;
+    photoUrl: string | null;
+    linkedinUrl: string;
+}
+/**
+ * LinkedIn job listing
+ */
+interface LinkedInJob {
+    title: string;
+    jobUrl: string;
+    jobId: string | null;
+    location: string | null;
+    postedTime: string | null;
+}
+/**
+ * Similar company information
+ */
+interface LinkedInSimilarCompany {
+    name: string;
+    industry: string | null;
+    location: string | null;
+    logoUrl: string | null;
+    linkedinUrl: string;
+}
+/**
+ * LinkedIn company post
+ */
+interface LinkedInPost {
+    content: string | null;
+    postUrl: string;
+    timeAgo: string | null;
+    reactions: number;
+    comments: number;
+    imageUrls: string[];
+}
+/**
+ * LinkedIn company profile data
+ */
+interface LinkedInCompany {
+    name: string;
+    industry: string | null;
+    location: string | null;
+    followers: number | null;
+    slogan: string | null;
+    logoUrl: string | null;
+    coverImageUrl: string | null;
+    description: string | null;
+    website: string | null;
+    companySize: string | null;
+    headquarters: string | null;
+    companyType: string | null;
+    foundedYear: number | null;
+    specialties: string[];
+    employees: LinkedInEmployee[];
+    locations: string[];
+    similarCompanies: LinkedInSimilarCompany[];
+    recentPosts: LinkedInPost[];
+    jobs: LinkedInJob[];
+    linkedinUrl: string;
+    scrapedAt: string;
+}
+/**
+ * Data returned from the LinkedIn company endpoint
+ */
+interface LinkedInCompanyData {
+    company: LinkedInCompany;
+    timing: {
+        total: number;
+    };
+    creditsUsed: number;
+    creditsRemaining: number;
+}
+/**
+ * Response from the LinkedIn company endpoint
+ */
+type LinkedInCompanyResponse = ApiSuccessResponse<LinkedInCompanyData>;
+/**
+ * Parameters for the LinkedIn person endpoint
+ */
+interface LinkedInPersonParams {
+    /** Single LinkedIn profile URL or array of URLs (max 10) */
+    url: string | string[];
+}
+/**
+ * LinkedIn person profile result
+ */
+interface LinkedInPersonResult {
+    url: string;
+    person: Record<string, unknown>;
+}
+/**
+ * Data returned from the LinkedIn person endpoint
+ */
+interface LinkedInPersonData {
+    persons: LinkedInPersonResult[];
+    failed?: string[];
+    totalUrls: number;
+    successCount: number;
+    failedCount: number;
+    timing: {
+        total: number;
+    };
+    creditsUsed: number;
+    creditsRemaining: number;
+}
+/**
+ * Response from the LinkedIn person endpoint
+ */
+type LinkedInPersonResponse = ApiSuccessResponse<LinkedInPersonData>;
+
+/**
+ * Options for scraping an Instagram profile
+ */
+interface InstagramProfileOptions {
+    /** Page load timeout in milliseconds (default: 30000) */
+    timeout?: number;
+}
+/**
+ * Parameters for the Instagram profile endpoint
+ */
+interface InstagramProfileParams {
+    /** Instagram username (without @) or profile URL */
+    username: string;
+    /** Options */
+    options?: InstagramProfileOptions;
+}
+/**
+ * Instagram bio link
+ */
+interface InstagramBioLink {
+    title: string;
+    url: string;
+    link_type: string;
+}
+/**
+ * Instagram post dimensions
+ */
+interface InstagramDimensions {
+    height: number;
+    width: number;
+}
+/**
+ * Instagram post from profile
+ */
+interface InstagramPost {
+    id: string;
+    shortcode: string;
+    display_url: string;
+    thumbnail_src: string;
+    is_video: boolean;
+    video_url: string | null;
+    caption: string | null;
+    like_count: number;
+    comment_count: number;
+    taken_at_timestamp: number;
+    dimensions: InstagramDimensions;
+    video_view_count: number | null;
+}
+/**
+ * Instagram profile data
+ */
+interface InstagramProfile {
+    id: string;
+    username: string;
+    full_name: string;
+    biography: string | null;
+    bio_links: InstagramBioLink[];
+    follower_count: number;
+    following_count: number;
+    media_count: number;
+    profile_pic_url: string;
+    profile_pic_url_hd: string | null;
+    is_verified: boolean;
+    is_private: boolean;
+    is_business_account: boolean;
+    is_professional_account: boolean;
+    business_category_name: string | null;
+    business_email: string | null;
+    business_phone_number: string | null;
+    external_url: string | null;
+    highlight_reel_count: number;
+    posts: InstagramPost[];
+}
+/**
+ * Data returned from the Instagram profile endpoint
+ */
+interface InstagramProfileData {
+    profile: InstagramProfile;
+    timing: {
+        total: number;
+    };
+    creditsUsed: number;
+    creditsRemaining: number;
+}
+/**
+ * Response from the Instagram profile endpoint
+ */
+type InstagramProfileResponse = ApiSuccessResponse<InstagramProfileData>;
+/**
+ * Options for scraping Instagram content
+ */
+interface InstagramContentOptions {
+    /** Page load timeout in milliseconds (default: 30000) */
+    timeout?: number;
+}
+/**
+ * Parameters for the Instagram content endpoint
+ */
+interface InstagramContentParams {
+    /** Post shortcode or full URL */
+    shortcode: string;
+    /** Options */
+    options?: InstagramContentOptions;
+}
+/**
+ * Instagram content owner information
+ */
+interface InstagramContentOwner {
+    id: string;
+    username: string;
+    full_name: string;
+    profile_pic_url: string;
+    is_verified: boolean;
+}
+/**
+ * Instagram audio information (for reels)
+ */
+interface InstagramAudioInfo {
+    title: string | null;
+    artist_username: string | null;
+    is_original: boolean;
+}
+/**
+ * Instagram carousel media item
+ */
+interface InstagramCarouselItem {
+    id: string;
+    media_type: string;
+    display_url: string;
+    video_url: string | null;
+}
+/**
+ * Instagram post/reel/video content data
+ */
+interface InstagramContent {
+    id: string;
+    shortcode: string;
+    taken_at: number;
+    media_type: string;
+    product_type: string;
+    width: number;
+    height: number;
+    like_count: number;
+    comment_count: number;
+    caption: string | null;
+    has_audio: boolean;
+    display_url: string;
+    video_url: string | null;
+    thumbnail_url: string;
+    owner: InstagramContentOwner;
+    audio_info: InstagramAudioInfo | null;
+    carousel_media: InstagramCarouselItem[] | null;
+}
+/**
+ * Data returned from the Instagram content endpoint
+ */
+interface InstagramContentData {
+    post: InstagramContent;
+    timing: {
+        total: number;
+    };
+    creditsUsed: number;
+    creditsRemaining: number;
+}
+/**
+ * Response from the Instagram content endpoint
+ */
+type InstagramContentResponse = ApiSuccessResponse<InstagramContentData>;
+
+/**
+ * Options for fetching Play Store reviews
+ */
+interface PlayStoreReviewsOptions {
+    /** Language code (e.g., 'en', 'tr') */
+    lang?: string;
+    /** Request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+}
+/**
+ * Parameters for the Play Store reviews endpoint
+ */
+interface PlayStoreReviewsParams {
+    /** App ID (e.g., 'com.example.app') */
+    appId: string;
+    /** Pagination cursor from previous response */
+    cursor?: string | null;
+    /** Options */
+    options?: PlayStoreReviewsOptions;
+}
+/**
+ * Developer reply to a review
+ */
+interface DeveloperReply {
+    author: string;
+    text: string;
+    date: number | null;
+}
+/**
+ * Play Store review
+ */
+interface PlayStoreReview {
+    id: string;
+    username: string;
+    userAvatar: string | null;
+    rating: number;
+    text: string;
+    date: number | null;
+    thumbsUp: number;
+    developerReply: DeveloperReply | null;
+    appVersion: string | null;
+}
+/**
+ * Pagination information
+ */
+interface Pagination {
+    nextCursor: string | null;
+    hasMore: boolean;
+}
+/**
+ * Data returned from the Play Store reviews endpoint
+ */
+interface PlayStoreReviewsData {
+    appId: string;
+    reviews: PlayStoreReview[];
+    pagination: Pagination;
+    timing: {
+        total: number;
+    };
+    creditsUsed: number;
+    creditsRemaining: number;
+}
+/**
+ * Response from the Play Store reviews endpoint
+ */
+type PlayStoreReviewsResponse = ApiSuccessResponse<PlayStoreReviewsData>;
+/**
+ * Options for fetching Play Store app details
+ */
+interface PlayStoreDetailOptions {
+    /** Language code (e.g., 'en', 'tr') */
+    lang?: string;
+    /** Request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+}
+/**
+ * Parameters for the Play Store detail endpoint
+ */
+interface PlayStoreDetailParams {
+    /** App ID (e.g., 'com.example.app') */
+    appId: string;
+    /** Options */
+    options?: PlayStoreDetailOptions;
+}
+/**
+ * Screenshot information
+ */
+interface Screenshot {
+    url: string;
+    width: number | null;
+    height: number | null;
+}
+/**
+ * Rating distribution (star counts)
+ */
+interface RatingDistribution {
+    5: number;
+    4: number;
+    3: number;
+    2: number;
+    1: number;
+}
+/**
+ * Developer information
+ */
+interface Developer {
+    name: string;
+    id: string | null;
+    website: string | null;
+    email: string | null;
+    phone: string | null;
+    address: string | null;
+}
+/**
+ * App permission
+ */
+interface Permission {
+    name: string;
+    icon: string | null;
+    details: string[];
+}
+/**
+ * Data safety information
+ */
+interface DataSafety {
+    sharedData: string[] | null;
+    collectedData: string[] | null;
+    encrypted: boolean;
+    deletable: boolean;
+}
+/**
+ * Data returned from the Play Store detail endpoint
+ */
+interface PlayStoreDetailData {
+    appId: string;
+    appName: string;
+    icon: string | null;
+    summary: string | null;
+    description: string | null;
+    screenshots: Screenshot[];
+    category: string | null;
+    categoryId: string | null;
+    rating: number | null;
+    ratingCount: number | null;
+    reviewCount: number | null;
+    ratingDistribution: RatingDistribution | null;
+    installs: string | null;
+    installsExact: number | null;
+    free: boolean;
+    price: string | null;
+    currency: string | null;
+    contentRating: string | null;
+    contentRatingDescription: string | null;
+    developer: Developer;
+    releaseDate: number | null;
+    lastUpdate: number | null;
+    version: string | null;
+    androidVersion: string | null;
+    whatsNew: string | null;
+    permissions: Permission[];
+    dataSafety: DataSafety | null;
+    privacyPolicy: string | null;
+    timing: {
+        total: number;
+    };
+    creditsUsed: number;
+    creditsRemaining: number;
+}
+/**
+ * Response from the Play Store detail endpoint
+ */
+type PlayStoreDetailResponse = ApiSuccessResponse<PlayStoreDetailData>;
+
+/**
+ * Options for fetching App Store reviews
+ */
+interface AppStoreReviewsOptions {
+    /** Language code (e.g., 'en', 'tr') */
+    lang?: string;
+    /** Request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+}
+/**
+ * Parameters for the App Store reviews endpoint
+ */
+interface AppStoreReviewsParams {
+    /** App ID (numeric ID from App Store URL) */
+    appId: string;
+    /** Pagination cursor from previous response */
+    cursor?: string | null;
+    /** Options */
+    options?: AppStoreReviewsOptions;
+}
+/**
+ * App Store review
+ */
+interface AppStoreReview {
+    id: string;
+    username: string;
+    userAvatar: string | null;
+    rating: number;
+    title: string;
+    text: string;
+    date: number | null;
+    isEdited: boolean;
+    thumbsUp: number;
+    developerReply: DeveloperReply | null;
+    appVersion: string | null;
+}
+/**
+ * Data returned from the App Store reviews endpoint
+ */
+interface AppStoreReviewsData {
+    appId: string;
+    reviews: AppStoreReview[];
+    pagination: Pagination;
+    timing: {
+        total: number;
+    };
+    creditsUsed: number;
+    creditsRemaining: number;
+}
+/**
+ * Response from the App Store reviews endpoint
+ */
+type AppStoreReviewsResponse = ApiSuccessResponse<AppStoreReviewsData>;
+
+/**
+ * LinkedIn scraping operations
+ * Provides company and person profile scraping
+ */
+declare class LinkedInResource extends BaseResource {
+    /**
+     * Scrape a LinkedIn company profile
+     *
+     * @param params - Company profile parameters
+     * @returns Company profile data including description, employees, jobs, posts
+     * @throws {CrawlKitError} On API errors
+     *
+     * @example
+     * ```typescript
+     * const result = await crawlkit.linkedin.company({
+     *   url: 'https://www.linkedin.com/company/openai',
+     *   options: { includeJobs: true }
+     * });
+     * console.log(result.company.name);
+     * console.log(result.company.followers);
+     * console.log(result.company.jobs);
+     * ```
+     *
+     * @costs 1 credit
+     */
+    company(params: LinkedInCompanyParams): Promise<LinkedInCompanyData>;
+    /**
+     * Scrape LinkedIn person profile(s)
+     *
+     * @param params - Person profile parameters (single URL or array of URLs, max 10)
+     * @returns Person profile data for each URL
+     * @throws {CrawlKitError} On API errors
+     *
+     * @example
+     * ```typescript
+     * // Single profile
+     * const result = await crawlkit.linkedin.person({
+     *   url: 'https://www.linkedin.com/in/username'
+     * });
+     *
+     * // Multiple profiles (batch)
+     * const batchResult = await crawlkit.linkedin.person({
+     *   url: [
+     *     'https://www.linkedin.com/in/user1',
+     *     'https://www.linkedin.com/in/user2'
+     *   ]
+     * });
+     * console.log(`Success: ${batchResult.successCount}, Failed: ${batchResult.failedCount}`);
+     * ```
+     *
+     * @costs 3 credits per URL
+     */
+    person(params: LinkedInPersonParams): Promise<LinkedInPersonData>;
+}
+
+/**
+ * Instagram scraping operations
+ * Provides profile and content (posts/reels) scraping
+ */
+declare class InstagramResource extends BaseResource {
+    /**
+     * Scrape an Instagram profile
+     *
+     * @param params - Profile parameters (username or URL)
+     * @returns Profile data including bio, follower count, and recent posts
+     * @throws {CrawlKitError} On API errors
+     *
+     * @example
+     * ```typescript
+     * const result = await crawlkit.instagram.profile({
+     *   username: 'instagram'
+     * });
+     * console.log(result.profile.full_name);
+     * console.log(result.profile.follower_count);
+     * console.log(result.profile.posts.length);
+     * ```
+     *
+     * @costs 1 credit
+     */
+    profile(params: InstagramProfileParams): Promise<InstagramProfileData>;
+    /**
+     * Scrape Instagram content (post, reel, or video)
+     *
+     * @param params - Content parameters (shortcode or full URL)
+     * @returns Content data including media URLs, likes, comments, and owner info
+     * @throws {CrawlKitError} On API errors
+     *
+     * @example
+     * ```typescript
+     * // Using shortcode
+     * const result = await crawlkit.instagram.content({
+     *   shortcode: 'CxIIgCCq8mg'
+     * });
+     *
+     * // Using full URL
+     * const result = await crawlkit.instagram.content({
+     *   shortcode: 'https://www.instagram.com/p/CxIIgCCq8mg/'
+     * });
+     *
+     * console.log(result.post.like_count);
+     * console.log(result.post.video_url);
+     * ```
+     *
+     * @costs 1 credit
+     */
+    content(params: InstagramContentParams): Promise<InstagramContentData>;
+}
+
+/**
+ * App store operations
+ * Provides Google Play Store and Apple App Store data scraping
+ */
+declare class AppStoreResource extends BaseResource {
+    /**
+     * Fetch Google Play Store reviews for an app
+     *
+     * @param params - Reviews parameters including app ID and optional pagination cursor
+     * @returns Reviews with pagination information
+     * @throws {CrawlKitError} On API errors
+     *
+     * @example
+     * ```typescript
+     * // First page
+     * const result = await crawlkit.appstore.playstoreReviews({
+     *   appId: 'com.example.app',
+     *   options: { lang: 'en' }
+     * });
+     *
+     * // Next page
+     * if (result.pagination.hasMore) {
+     *   const nextPage = await crawlkit.appstore.playstoreReviews({
+     *     appId: 'com.example.app',
+     *     cursor: result.pagination.nextCursor
+     *   });
+     * }
+     * ```
+     *
+     * @costs 1 credit per page
+     */
+    playstoreReviews(params: PlayStoreReviewsParams): Promise<PlayStoreReviewsData>;
+    /**
+     * Fetch Google Play Store app details
+     *
+     * @param params - App detail parameters
+     * @returns Comprehensive app information including ratings, screenshots, permissions
+     * @throws {CrawlKitError} On API errors
+     *
+     * @example
+     * ```typescript
+     * const result = await crawlkit.appstore.playstoreDetail({
+     *   appId: 'com.example.app',
+     *   options: { lang: 'en' }
+     * });
+     * console.log(result.appName);
+     * console.log(result.rating);
+     * console.log(result.installs);
+     * ```
+     *
+     * @costs 1 credit
+     */
+    playstoreDetail(params: PlayStoreDetailParams): Promise<PlayStoreDetailData>;
+    /**
+     * Fetch Apple App Store reviews for an app
+     *
+     * @param params - Reviews parameters including app ID and optional pagination cursor
+     * @returns Reviews with pagination information
+     * @throws {CrawlKitError} On API errors
+     *
+     * @example
+     * ```typescript
+     * // First page
+     * const result = await crawlkit.appstore.appstoreReviews({
+     *   appId: '123456789',
+     *   options: { lang: 'en' }
+     * });
+     *
+     * // Paginate through all reviews
+     * let cursor = result.pagination.nextCursor;
+     * while (cursor) {
+     *   const nextPage = await crawlkit.appstore.appstoreReviews({
+     *     appId: '123456789',
+     *     cursor
+     *   });
+     *   cursor = nextPage.pagination.nextCursor;
+     * }
+     * ```
+     *
+     * @costs 1 credit per page
+     */
+    appstoreReviews(params: AppStoreReviewsParams): Promise<AppStoreReviewsData>;
+}
+
+/**
+ * Configuration options for the CrawlKit client
+ */
+interface CrawlKitConfig {
+    /**
+     * API key for authentication
+     * Must start with 'ck_' prefix
+     * Get your API key at https://crawlkit.sh
+     */
+    apiKey: string;
+    /**
+     * Base URL for the API
+     * @default 'https://api.crawlkit.sh'
+     */
+    baseUrl?: string;
+    /**
+     * Default timeout in milliseconds for all requests
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Custom fetch implementation
+     * Useful for testing or environments without native fetch
+     */
+    fetch?: typeof globalThis.fetch;
+}
+/**
+ * CrawlKit SDK client for web scraping API
+ *
+ * @example
+ * ```typescript
+ * import { CrawlKit } from '@crawlkit/sdk';
+ *
+ * const crawlkit = new CrawlKit({ apiKey: 'ck_your_api_key' });
+ *
+ * // Scrape a webpage
+ * const page = await crawlkit.scrape({ url: 'https://example.com' });
+ * console.log(page.markdown);
+ *
+ * // Extract structured data with AI
+ * const data = await crawlkit.extract({
+ *   url: 'https://example.com/product',
+ *   schema: {
+ *     type: 'object',
+ *     properties: {
+ *       name: { type: 'string' },
+ *       price: { type: 'number' }
+ *     }
+ *   }
+ * });
+ *
+ * // Scrape social media
+ * const company = await crawlkit.linkedin.company({
+ *   url: 'https://linkedin.com/company/openai'
+ * });
+ * ```
+ */
+declare class CrawlKit {
+    private readonly config;
+    private readonly crawl;
+    /**
+     * LinkedIn scraping operations
+     * Provides company and person profile scraping
+     */
+    readonly linkedin: LinkedInResource;
+    /**
+     * Instagram scraping operations
+     * Provides profile and content scraping
+     */
+    readonly instagram: InstagramResource;
+    /**
+     * App store operations
+     * Provides Google Play Store and Apple App Store data
+     */
+    readonly appstore: AppStoreResource;
+    /**
+     * Create a new CrawlKit client
+     *
+     * @param config - Client configuration
+     * @throws {AuthenticationError} If API key is invalid or missing
+     *
+     * @example
+     * ```typescript
+     * const crawlkit = new CrawlKit({
+     *   apiKey: 'ck_your_api_key',
+     *   timeout: 60000 // 60 seconds
+     * });
+     * ```
+     */
+    constructor(config: CrawlKitConfig);
+    /**
+     * Scrape a URL and return markdown, HTML, metadata, and links
+     *
+     * @param params - Scrape parameters
+     * @returns Scraped page data including markdown, HTML, metadata, and links
+     * @throws {CrawlKitError} On API errors
+     *
+     * @example
+     * ```typescript
+     * // Basic scraping
+     * const result = await crawlkit.scrape({
+     *   url: 'https://example.com'
+     * });
+     * console.log(result.markdown);
+     * console.log(result.metadata.title);
+     *
+     * // With browser automation
+     * const spaResult = await crawlkit.scrape({
+     *   url: 'https://example.com/spa',
+     *   options: {
+     *     waitFor: '#content-loaded',
+     *     actions: [
+     *       { type: 'click', selector: '#load-more' },
+     *       { type: 'wait', milliseconds: 2000 }
+     *     ]
+     *   }
+     * });
+     * ```
+     *
+     * @costs 1 credit
+     */
+    scrape(params: ScrapeParams): Promise<ScrapeData>;
+    /**
+     * Extract structured data from a URL using AI
+     *
+     * Uses LLM to extract data according to the provided JSON schema.
+     *
+     * @param params - Extract parameters including JSON schema
+     * @returns Extracted structured data along with page content
+     * @throws {CrawlKitError} On API errors
+     *
+     * @example
+     * ```typescript
+     * interface Product {
+     *   name: string;
+     *   price: number;
+     *   description: string;
+     *   inStock: boolean;
+     * }
+     *
+     * const result = await crawlkit.extract<Product>({
+     *   url: 'https://example.com/product/123',
+     *   schema: {
+     *     type: 'object',
+     *     properties: {
+     *       name: { type: 'string' },
+     *       price: { type: 'number' },
+     *       description: { type: 'string' },
+     *       inStock: { type: 'boolean' }
+     *     }
+     *   },
+     *   options: {
+     *     prompt: 'Extract product information from this page'
+     *   }
+     * });
+     *
+     * // TypeScript knows result.json is Product
+     * console.log(result.json.name);
+     * console.log(result.json.price);
+     * ```
+     *
+     * @costs 5 credits
+     */
+    extract<T = unknown>(params: ExtractParams): Promise<ExtractData<T>>;
+    /**
+     * Perform a web search using DuckDuckGo
+     *
+     * @param params - Search parameters
+     * @returns Search results with titles, URLs, and snippets
+     * @throws {CrawlKitError} On API errors
+     *
+     * @example
+     * ```typescript
+     * const result = await crawlkit.search({
+     *   query: 'typescript best practices 2024',
+     *   options: {
+     *     maxResults: 20,
+     *     timeRange: 'm', // Past month
+     *     region: 'us-en'
+     *   }
+     * });
+     *
+     * for (const item of result.results) {
+     *   console.log(`${item.position}. ${item.title}`);
+     *   console.log(`   ${item.url}`);
+     *   console.log(`   ${item.snippet}\n`);
+     * }
+     * ```
+     *
+     * @costs 1 credit per page (~10 results)
+     */
+    search(params: SearchParams): Promise<SearchData>;
+    /**
+     * Take a full-page screenshot of a URL
+     *
+     * @param params - Screenshot parameters
+     * @returns Public URL of the screenshot
+     * @throws {CrawlKitError} On API errors
+     *
+     * @example
+     * ```typescript
+     * const result = await crawlkit.screenshot({
+     *   url: 'https://example.com',
+     *   options: {
+     *     width: 1920,
+     *     height: 1080,
+     *     waitForSelector: '#main-content'
+     *   }
+     * });
+     *
+     * console.log('Screenshot URL:', result.url);
+     * console.log(`Dimensions: ${result.width}x${result.height}`);
+     * ```
+     *
+     * @costs 1 credit
+     */
+    screenshot(params: ScreenshotParams): Promise<ScreenshotData>;
+}
+
+/**
+ * Base error class for all CrawlKit errors
+ */
+declare class CrawlKitError extends Error {
+    /** Error code from API */
+    readonly code: ErrorCode;
+    /** HTTP status code */
+    readonly statusCode: number;
+    /** Credits refunded if operation failed */
+    readonly creditsRefunded?: number;
+    /** Remaining credits after operation */
+    readonly creditsRemaining?: number;
+    constructor(code: ErrorCode, message: string, statusCode: number, creditsRefunded?: number, creditsRemaining?: number);
+}
+/**
+ * Authentication error - invalid or missing API key
+ */
+declare class AuthenticationError extends CrawlKitError {
+    constructor(message?: string);
+}
+/**
+ * Insufficient credits to perform the operation
+ */
+declare class InsufficientCreditsError extends CrawlKitError {
+    /** Credits required for the operation */
+    readonly required?: number;
+    /** Credits available */
+    readonly available?: number;
+    constructor(message: string, creditsRefunded?: number, creditsRemaining?: number);
+}
+/**
+ * Validation error - invalid request parameters
+ */
+declare class ValidationError extends CrawlKitError {
+    constructor(message: string);
+}
+/**
+ * Rate limit exceeded
+ */
+declare class RateLimitError extends CrawlKitError {
+    constructor(message?: string);
+}
+/**
+ * Request timeout
+ */
+declare class TimeoutError extends CrawlKitError {
+    constructor(message: string, creditsRefunded?: number, creditsRemaining?: number);
+}
+/**
+ * Resource not found (404)
+ */
+declare class NotFoundError extends CrawlKitError {
+    constructor(message?: string);
+}
+/**
+ * Network or connection error
+ */
+declare class NetworkError extends CrawlKitError {
+    constructor(code: ErrorCode, message: string, creditsRefunded?: number, creditsRemaining?: number);
+}
+/**
+ * Create appropriate error instance from API response
+ */
+declare function createErrorFromResponse(code: string, message: string, statusCode: number, creditsRefunded?: number, creditsRemaining?: number): CrawlKitError;
+
+export { type ActionResult, type ApiErrorResponse, type ApiResponse, type ApiSuccessResponse, type AppStoreReview, type AppStoreReviewsData, type AppStoreReviewsOptions, type AppStoreReviewsParams, type AppStoreReviewsResponse, AuthenticationError, type BrowserAction, type ClickAction, CrawlKit, type CrawlKitConfig, CrawlKitError, type CrawlStats, type CreditInfo, type DataSafety, type Developer, type DeveloperReply, type ErrorCode, type EvaluateAction, type ExtractData, type ExtractOptions, type ExtractParams, type ExtractResponse, type InstagramAudioInfo, type InstagramBioLink, type InstagramCarouselItem, type InstagramContent, type InstagramContentData, type InstagramContentOptions, type InstagramContentOwner, type InstagramContentParams, type InstagramContentResponse, type InstagramDimensions, type InstagramPost, type InstagramProfile, type InstagramProfileData, type InstagramProfileOptions, type InstagramProfileParams, type InstagramProfileResponse, InsufficientCreditsError, type LinkedInCompany, type LinkedInCompanyData, type LinkedInCompanyOptions, type LinkedInCompanyParams, type LinkedInCompanyResponse, type LinkedInEmployee, type LinkedInJob, type LinkedInPersonData, type LinkedInPersonParams, type LinkedInPersonResponse, type LinkedInPersonResult, type LinkedInPost, type LinkedInSimilarCompany, NetworkError, NotFoundError, type PageLinks, type PageMetadata, type Pagination, type Permission, type PlayStoreDetailData, type PlayStoreDetailOptions, type PlayStoreDetailParams, type PlayStoreDetailResponse, type PlayStoreReview, type PlayStoreReviewsData, type PlayStoreReviewsOptions, type PlayStoreReviewsParams, type PlayStoreReviewsResponse, type PressAction, RateLimitError, type RatingDistribution, type ScrapeData, type ScrapeOptions, type ScrapeParams, type ScrapeResponse, type Screenshot, type ScreenshotData, type ScreenshotOptions, type ScreenshotParams, type ScreenshotResponse, type ScrollAction, type SearchData, type SearchOptions, type SearchParams, type SearchResponse, type SearchResult, type TimeRange, TimeoutError, type Timing, type TypeAction, ValidationError, type WaitAction, createErrorFromResponse };