prompttest-mobile 1.5.1

package/dist/index.d.ts

@@ -0,0 +1,143 @@
+/**
+ * PromptTest — Ultra-fast, zero-code autonomous mobile testing & visual QA brain for Android
+ *
+ * Programmatic SDK & Core Engine Exports
+ *
+ * Architecture Overview:
+ * This module serves as the primary public SDK entry point for the PromptTest framework.
+ * It provides the building blocks (classes, types, and factory functions) to embed, extend,
+ * or orchestrate the testing engine in a multi-instance, parallelizable manner.
+ *
+ * NOTE: Singleton instances (promptRunner, androidDriver, etc.) are intentionally
+ * NOT exported from the public API. Use the factory functions below to create
+ * isolated instances with no shared state, which is required for parallel runs,
+ * programmatic embedding, and unit testing.
+ */
+import { PromptRunner } from './lib/prompt-runner.js';
+import { AndroidDriver } from './lib/adb.js';
+import { AutonomousExplorer } from './lib/explorer.js';
+import { MemoryEngine } from './lib/memory.js';
+import { QaReporter } from './lib/reporter.js';
+import { AutonomousRecorder } from './lib/recorder.js';
+import { SemanticFormFiller } from './lib/form-filler.js';
+import { BaselineManager } from './lib/baseline.js';
+/** Core engine classes and execution types for test runs. */
+export { PromptRunner, type PromptStep, type RunOptions } from './lib/prompt-runner.js';
+/** ADB wrapper for low-level Android device interaction. */
+export { AndroidDriver, type AndroidDevice } from './lib/adb.js';
+/** Autonomous crawler and UI discovery engine. */
+export { AutonomousExplorer } from './lib/explorer.js';
+/** Dynamic locator learning and UI mapping storage. */
+export { MemoryEngine, type LearnedMapping } from './lib/memory.js';
+/** Audit and visual report generation tools. */
+export { QaReporter, type QaReportData, type AuditStep, type ReportFormat } from './lib/reporter.js';
+/** Interactive test creation via manual recording. */
+export { AutonomousRecorder, type RecordedEvent } from './lib/recorder.js';
+/** AI-powered semantic data generation for form filling. */
+export { SemanticFormFiller, type TestDataPool, type FormFillResult } from './lib/form-filler.js';
+/** Framework logging utilities. */
+export { Logger, logger, type LogLevel } from './lib/logger.js';
+/** Concurrency management for device access. */
+export { acquireDeviceLock, releaseDeviceLock, type DeviceLock } from './lib/lock.js';
+/** Visual regression testing and baseline image management. */
+export { BaselineManager, baselineManager, type BaselineDiffResult, type MaskRegion, type BaselineCompareOptions, } from './lib/baseline.js';
+/** Standard error classes and CLI exit codes. */
+export { ExitCode, PromptTestError, DeviceError, LocatorError, ConfigError, LockError, SpecRecursionError, } from './lib/errors.js';
+/** Additional utility modules and types */
+export * from './lib/crawler.js';
+export * from './lib/patterns.js';
+export * from './lib/dictionary.js';
+export * from './lib/config.js';
+export * from './lib/config-loader.js';
+export * from './lib/step-handlers.js';
+export * from './lib/data-loader.js';
+export * from './lib/live-server.js';
+export * from './lib/runner-utils.js';
+export * from './lib/ai/index.js';
+export * from './lib/benchmark.js';
+export * from './lib/doctor.js';
+export * from './lib/repl.js';
+export * from './lib/driver-interface.js';
+export * from './lib/ios-driver.js';
+export * from './lib/enterprise.js';
+export * from './lib/triage.js';
+export * from './lib/wizard.js';
+export * from './lib/feedback.js';
+/**
+ * Factory functions to create isolated instances with no shared global state.
+ */
+/**
+ * Creates an isolated PromptRunner instance.
+ * @param driver - Optional custom AndroidDriver instance to use.
+ * @param memory - Optional MemoryEngine instance for locator resolution.
+ * @param reporter - Optional QaReporter instance to log test results.
+ * @returns A fresh PromptRunner instance.
+ * @example
+ * const driver = createAndroidDriver();
+ * const runner = createPromptRunner(driver);
+ * await runner.runFile('test.txt');
+ */
+export declare function createPromptRunner(driver?: AndroidDriver, memory?: MemoryEngine, reporter?: QaReporter): PromptRunner;
+/**
+ * Creates an isolated AutonomousExplorer instance.
+ * @param driver - Optional custom AndroidDriver to control the device.
+ * @param formFiller - Optional SemanticFormFiller for input generation.
+ * @param reporter - Optional QaReporter for visual and audit logs.
+ * @returns A fresh AutonomousExplorer instance.
+ * @example
+ * const explorer = createAutonomousExplorer();
+ * await explorer.explore('com.example.app');
+ */
+export declare function createAutonomousExplorer(driver?: AndroidDriver, formFiller?: SemanticFormFiller, reporter?: QaReporter): AutonomousExplorer;
+/**
+ * Creates an isolated AndroidDriver instance.
+ * @param serial - Optional device serial number to target a specific device.
+ * @returns A fresh AndroidDriver instance.
+ * @example
+ * const driver = createAndroidDriver('emulator-5554');
+ * await driver.init();
+ */
+export declare function createAndroidDriver(serial?: string): AndroidDriver;
+/**
+ * Creates an isolated MemoryEngine instance.
+ * @returns A fresh MemoryEngine instance.
+ * @example
+ * const memory = createMemoryEngine();
+ * await memory.load();
+ */
+export declare function createMemoryEngine(): MemoryEngine;
+/**
+ * Creates an isolated QaReporter instance.
+ * @param outputDir - Optional custom directory path to write reports.
+ * @returns A fresh QaReporter instance.
+ * @example
+ * const reporter = createQaReporter('./reports');
+ * reporter.logStep('Started run');
+ */
+export declare function createQaReporter(outputDir?: string): QaReporter;
+/**
+ * Creates an isolated AutonomousRecorder instance.
+ * @param driver - Optional custom AndroidDriver for recording events.
+ * @returns A fresh AutonomousRecorder instance.
+ * @example
+ * const recorder = createAutonomousRecorder();
+ * await recorder.start();
+ */
+export declare function createAutonomousRecorder(driver?: AndroidDriver): AutonomousRecorder;
+/**
+ * Creates an isolated SemanticFormFiller instance.
+ * @param customDataPath - Optional path to custom form data definitions.
+ * @param driver - Optional AndroidDriver instance.
+ * @returns A fresh SemanticFormFiller instance.
+ * @example
+ * const filler = createFormFiller('./custom-data.json');
+ * await filler.fillCurrentScreen();
+ */
+export declare function createFormFiller(customDataPath?: string, driver?: AndroidDriver): SemanticFormFiller;
+/**
+ * Creates an isolated BaselineManager instance.
+ * @param baselineDir - Optional directory path to store baseline images.
+ * @param threshold - Optional default threshold ratio.
+ * @returns A fresh BaselineManager instance.
+ */
+export declare function createBaselineManager(baselineDir?: string, threshold?: number): BaselineManager;