@probolabs/playwright 1.2.1 → 1.4.0-rc.1

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Locator, Page } from 'playwright';
-import { SmartSelector, ElementTag, ProboLogLevel, PlaywrightTimeoutConfig, PlaywrightAction, TotpConfig, AIModel, InitialPageState, FindCandidateInput, ServerResponse } from '@probolabs/probo-shared';
-export { AIModel, ElementInfo, ElementTag, PlaywrightAction, ProboLogLevel } from '@probolabs/probo-shared';
+import { SmartSelector, ElementTag, ProboLogLevel, PlaywrightTimeoutConfig, PlaywrightAction, TotpConfig, RecorderSettings, AIModel, InitialPageState, FindCandidateInput, ServerResponse } from '@probolabs/probo-shared';
+export { AIModel, CodeGeneratorOptions, ElementInfo, ElementTag, PlaywrightAction, ProboLogLevel, createUrlSlug, extractRequiredEnvVars, generateCode, getRequiredEnvVars } from '@probolabs/probo-shared';
 import { Page as Page$1 } from '@playwright/test';
 
 /**
@@ -93,6 +93,11 @@ declare class Highlighter {
     getMatchingCandidateCached(page: Page): Promise<any>;
 }
 
+interface ScreenshotUrls {
+    base_screenshot_url?: string | null;
+    candidates_screenshot_url?: string | null;
+    actual_interaction_screenshot_url?: string | null;
+}
 interface RunStepParams extends Partial<PlaywrightTimeoutConfig> {
     iframeSelector?: string;
     elementSelector?: string;
@@ -104,6 +109,9 @@ interface RunStepParams extends Partial<PlaywrightTimeoutConfig> {
     pollingInterval?: number;
     timeout?: number;
     totpConfig?: TotpConfig;
+    onScreenshots?: (urls: ScreenshotUrls) => void;
+    takeScreenshot?: (page: Page$1, type?: 'base' | 'candidates' | 'actual') => Promise<string>;
+    isApplyAIContext?: boolean;
 }
 interface ProboPlaywrightConfig {
     timeoutConfig?: Partial<PlaywrightTimeoutConfig>;
@@ -117,6 +125,7 @@ declare class ProboPlaywright {
     private page;
     private params;
     private isCanceled;
+    private highlighter;
     constructor({ enableSmartSelectors, timeoutConfig, debugLevel, isCanceled }: ProboPlaywrightConfig, page?: Page$1 | null);
     /**
     * Sets the Playwright page instance for this ProboPlaywright instance.
@@ -372,6 +381,148 @@ declare class OTP {
     private static parseTimestamp;
 }
 
+/**
+ * Options for code generation
+ */
+interface CodeGenOptions {
+    useDefaultSettings?: boolean;
+    recorderSettings?: RecorderSettings;
+    viewPort?: {
+        width: number;
+        height: number;
+    };
+}
+/**
+ * Result of generating code for a test suite
+ */
+interface TestSuiteCodeGenResult {
+    testSuiteId: number;
+    testSuiteName: string;
+    scenarios: Array<{
+        scenarioId: number;
+        scenarioName: string;
+        code: string;
+    }>;
+}
+/**
+ * ProboCodeGenerator - Handles fetching test suite/scenario data and generating Playwright code
+ */
+declare class ProboCodeGenerator {
+    /**
+     * Normalize API URL by removing trailing slash
+     */
+    private static normalizeApiUrl;
+    private static readResponseErrorText;
+    /**
+     * Fetch scenario data from the backend API
+     */
+    private static fetchScenarioData;
+    /**
+     * Fetch test suite data from the backend API
+     */
+    private static fetchTestSuiteData;
+    /**
+     * Convert backend interaction format to Interaction[] format
+     */
+    private static convertBackendInteractionsToInteractionFormat;
+    /**
+     * Get default recorder settings for code generation
+     */
+    private static getDefaultRecorderSettings;
+    /**
+     * Get default viewport dimensions
+     */
+    private static getDefaultViewPort;
+    /**
+     * Generate code for a single scenario
+     * Fetches scenario data, converts to Interaction[], generates code
+     */
+    static generateCodeForScenario(scenarioId: number, apiToken: string, apiUrl: string, options?: CodeGenOptions): Promise<string>;
+    /**
+     * Generate code for all scenarios in a test suite
+     * Returns map of scenario names to generated code
+     */
+    static generateCodeForTestSuite(testSuiteId: number, apiToken: string, apiUrl: string, options?: CodeGenOptions): Promise<TestSuiteCodeGenResult>;
+}
+
+/**
+ * Result of running a test suite
+ */
+interface TestSuiteRunResult {
+    success: boolean;
+    exitCode: number;
+    stdout: string;
+    stderr: string;
+    error?: string;
+    runId?: number;
+}
+/**
+ * Test statistics parsed from Playwright output
+ */
+interface TestStatistics {
+    passed: number;
+    failed: number;
+    skipped: number;
+}
+/**
+ * Options for running a test suite
+ */
+interface TestSuiteRunOptions {
+    outputDir?: string;
+    includeReporter?: boolean;
+    onStatusUpdate?: (updates: Partial<{
+        status: string;
+        exit_code: number;
+        error_message: string;
+        stdout: string;
+        stderr: string;
+        tests_total: number;
+        tests_passed: number;
+        tests_failed: number;
+        tests_skipped: number;
+    }>) => void | Promise<void>;
+    onStdout?: (chunk: string) => void | Promise<void>;
+    onStderr?: (chunk: string) => void | Promise<void>;
+    onReporterEvent?: (event: any) => void | Promise<void>;
+}
+/**
+ * TestSuiteRunner - Handles test suite file generation and execution
+ */
+declare class TestSuiteRunner {
+    /**
+     * Lookup test suite ID by name and project
+     */
+    static lookupTestSuiteByName(testSuiteName: string, projectName: string, apiToken: string, apiUrl: string): Promise<number>;
+    /**
+     * Generate all files for a test suite
+     */
+    static generateTestSuiteFiles(testSuiteId: number, apiToken: string, apiUrl: string, outputDir?: string, testSuiteName?: string, includeReporter?: boolean, runId?: number): Promise<void>;
+    /**
+     * Generate package.json file
+     */
+    static generatePackageJson(outputDir: string, codeGenResult: TestSuiteCodeGenResult): Promise<void>;
+    /**
+     * Generate playwright.config.ts file
+     */
+    static generatePlaywrightConfig(outputDir: string, includeReporter?: boolean, runId?: number): Promise<void>;
+    /**
+     * Generate Probo custom Playwright reporter (for live step/test events)
+     */
+    static generateProboReporter(outputDir: string): Promise<void>;
+    /**
+     * Run a test suite
+     * Generates files, installs dependencies, and executes tests
+     */
+    static runTestSuite(testSuiteId: number, apiToken: string, apiUrl: string, testSuiteName?: string, runId?: number, options?: TestSuiteRunOptions): Promise<TestSuiteRunResult>;
+    /**
+     * Upload artifacts for a test suite run
+     *
+     * NOTE: This method is preserved for potential future use but is currently disabled.
+     * Artifacts are now accessed locally via the trace viewer instead of being uploaded to the backend.
+     */
+    static uploadArtifacts(runId: number, testSuiteId: number, testSuiteDir: string, apiToken: string, apiUrl: string): Promise<void>;
+}
+
 /**
  * Configuration options for Probo client
  */
@@ -436,5 +587,5 @@ declare class Probo {
     askAIHelper(page: Page, question: string, options: AskAIOptions, assertAnswer?: string): Promise<ServerResponse>;
 }
 
-export { Highlighter, NavTracker, OTP, Probo, ProboPlaywright, findClosestVisibleElement };
-export type { AskAIOptions, ElementTagType, MailinatorMessage, RunStepOptions };
+export { Highlighter, NavTracker, OTP, Probo, ProboCodeGenerator, ProboPlaywright, TestSuiteRunner, findClosestVisibleElement };
+export type { AskAIOptions, CodeGenOptions, ElementTagType, MailinatorMessage, RunStepOptions, TestStatistics, TestSuiteCodeGenResult, TestSuiteRunOptions, TestSuiteRunResult };