@skrillex1224/playwright-toolkit 2.0.44 → 2.0.46

package/index.d.ts

@@ -0,0 +1,174 @@
+import type { Page, BrowserContext, Browser, ElementHandle } from 'playwright';
+
+// =============================================================================
+// Constants
+// =============================================================================
+export interface CodeType {
+    Success: 0;
+    UnknownError: -1;
+    NotLogin: 30000001;
+    Chaptcha: 30000002;
+}
+
+export interface StatusType {
+    Success: 'SUCCESS';
+    Failed: 'FAILED';
+}
+
+export interface ConstantsModule {
+    Code: CodeType;
+    Status: StatusType;
+    FAILED_KEY_SEPARATOR: string;
+    PresetOfLiveViewKey: string;
+}
+
+// =============================================================================
+// Errors
+// =============================================================================
+export interface CrawlerErrorInfo {
+    message: string;
+    code?: number;
+    context?: Record<string, any>;
+}
+
+export declare class CrawlerError extends Error {
+    name: 'CrawlerError';
+    code: number;
+    context: Record<string, any>;
+    timestamp: string;
+
+    constructor(info: string | CrawlerErrorInfo);
+    toJSON(): Record<string, any>;
+    static isCrawlerError(error: any): error is CrawlerError;
+    static from(error: Error, options?: { code?: number; context?: Record<string, any> }): CrawlerError;
+}
+
+export interface ErrorsModule {
+    CrawlerError: typeof CrawlerError;
+}
+
+// =============================================================================
+// ApifyKit
+// =============================================================================
+export interface RunStepOptions {
+    failActor?: boolean;
+}
+
+export interface ApifyKitInstance {
+    runStep<T>(step: string, page: Page | null, actionFn: () => Promise<T>, options?: RunStepOptions): Promise<T>;
+    runStepLoose<T>(step: string, page: Page | null, fn: () => Promise<T>): Promise<T>;
+    pushSuccess(data: Record<string, any>): Promise<void>;
+    pushFailed(error: Error | CrawlerError, meta?: Record<string, any>): Promise<void>;
+}
+
+export interface ApifyKitModule {
+    useApifyKit(): Promise<ApifyKitInstance>;
+}
+
+// =============================================================================
+// Humanize
+// =============================================================================
+export interface HumanTypeOptions {
+    baseDelay?: number;
+    jitterPercent?: number;
+}
+
+export interface HumanClickOptions {
+    reactionDelay?: number;
+    jitterPercent?: number;
+}
+
+export interface HumanizeModule {
+    initializeCursor(page: Page): Promise<void>;
+    jitterMs(base: number, jitterPercent?: number): number;
+    humanType(page: Page, selector: string, text: string, options?: HumanTypeOptions): Promise<void>;
+    humanClick(page: Page, target: string | ElementHandle, options?: HumanClickOptions): Promise<void>;
+    warmUpBrowsing(page: Page, baseDuration?: number): Promise<void>;
+    naturalScroll(page: Page, direction?: 'up' | 'down', distance?: number, steps?: number): Promise<void>;
+    simulateGaze(page: Page, baseDurationMs?: number): Promise<void>;
+    randomSleep(baseMs: number, jitterPercent?: number): Promise<void>;
+}
+
+// =============================================================================
+// Stealth
+// =============================================================================
+export interface StealthModule {
+    syncViewportWithScreen(page: Page): Promise<void>;
+    hideWebdriver(page: Page): Promise<void>;
+    setupBlockingResources(page: Page, types?: string[]): Promise<void>;
+    setChinaTimezone(context: BrowserContext): Promise<void>;
+}
+
+// =============================================================================
+// Launch
+// =============================================================================
+export interface LaunchOptions {
+    headless?: boolean;
+    args?: string[];
+    ignoreDefaultArgs?: string[];
+    [key: string]: any;
+}
+
+export interface LaunchModule {
+    createStealthChromium(chromium: any, stealthPlugin: any): any;
+    getAdvancedLaunchOptions(): LaunchOptions;
+    getLaunchOptions(): LaunchOptions;
+    getFingerprintGeneratorOptions(): Record<string, any>;
+}
+
+// =============================================================================
+// LiveView
+// =============================================================================
+export interface LiveViewInstance {
+    startLiveViewServer(): Promise<void>;
+    takeLiveScreenshot(page: Page, label?: string): Promise<void>;
+}
+
+export interface LiveViewModule {
+    useLiveView(): LiveViewInstance;
+}
+
+// =============================================================================
+// Captcha
+// =============================================================================
+export interface CaptchaMonitorOptions {
+    domSelector?: string;
+    urlPattern?: string;
+    onDetected?: () => Promise<void>;
+}
+
+export interface CaptchaModule {
+    useCaptchaMonitor(page: Page, options: CaptchaMonitorOptions): void;
+}
+
+// =============================================================================
+// Utils
+// =============================================================================
+export interface ParsedCookie {
+    name: string;
+    value: string;
+    domain: string;
+    path?: string;
+}
+
+export interface UtilsModule {
+    parseSseStream(sseText: string): any[];
+    parseCookies(cookieString: string, domain: string): ParsedCookie[];
+}
+
+// =============================================================================
+// Toolkit Entry Point
+// =============================================================================
+export interface PlaywrightToolKit {
+    ApifyKit: ApifyKitModule;
+    Stealth: StealthModule;
+    Humanize: HumanizeModule;
+    Launch: LaunchModule;
+    LiveView: LiveViewModule;
+    Constants: ConstantsModule;
+    Utils: UtilsModule;
+    Captcha: CaptchaModule;
+    Errors: ErrorsModule;
+}
+
+export declare function usePlaywrightToolKit(): PlaywrightToolKit;

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@skrillex1224/playwright-toolkit",
-  "version": "2.0.44",
+  "version": "2.0.46",
   "description": "一个在 Apify/Crawlee Actor 中启用实时截图视图的实用工具库。",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
+  "types": "index.d.ts",
   "type": "module",
   "exports": {
     ".": {
+      "types": "./index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     }
@@ -19,6 +21,7 @@
   },
   "files": [
     "dist/",
+    "index.d.ts",
     "README.md"
   ],
   "keywords": [