@_deep4wee/agent-lens 1.1.0 → 1.2.0

package/dist/dsl-BIjVN1M0.d.mts

@@ -0,0 +1,204 @@
+import { Page, BrowserContext, Browser } from 'playwright';
+
+interface ConsoleEntry {
+    level: 'error' | 'warning' | 'info' | 'log' | 'debug';
+    text: string;
+    url: string;
+    timestamp: string;
+    stack?: string;
+}
+
+type MockIpcResponseType = 'SUCCESS' | 'ERROR';
+interface MockIpcEntry {
+    action: string;
+    data: any;
+    type?: MockIpcResponseType;
+    delayMs?: number;
+}
+
+interface ReportSection {
+    title: string;
+    content: string;
+}
+interface ReportData {
+    scenario: VisualScenario;
+    snapshots: SnapshotMetadata[];
+    consoleErrors: ConsoleEntry[];
+    consoleWarnings: ConsoleEntry[];
+    outputDir: string;
+    targetMode: 'desktop' | 'preview' | string;
+    durationMs: number;
+    customSections?: ReportSection[];
+}
+
+interface DriverLaunchResult {
+    page: Page;
+    context: BrowserContext;
+    browser?: Browser;
+    stop?: () => Promise<void>;
+}
+interface PluginHookContext {
+    scenario?: VisualScenario;
+    targetMode: 'desktop' | 'preview' | string;
+    artifactsDir: string;
+    cliOptions?: Record<string, unknown>;
+    state: Map<string, unknown>;
+}
+interface AgentLensPlugin {
+    /** Unique plugin identifier (e.g. 'desktop-webview2', 'live-controller', 'mock-ipc') */
+    name: string;
+    version?: string;
+    /** Lifecycle hook: initial setup before drivers and scenarios start */
+    setup?: (context: PluginHookContext) => Promise<void> | void;
+    /**
+     * Microkernel driver hook: allows a plugin to provide a custom browser/page session
+     * (e.g., desktop WebView2 CDP connection, custom remote browser).
+     */
+    launchSession?: (options: {
+        currentViewport: {
+            width: number;
+            height: number;
+        };
+        headed?: boolean;
+    }, hookContext: PluginHookContext) => Promise<DriverLaunchResult | undefined>;
+    /** Lifecycle hook: called when browser context is ready */
+    onContextCreated?: (context: BrowserContext, hookContext: PluginHookContext) => Promise<void> | void;
+    /** Lifecycle hook: called when the test page is created/navigated */
+    onPageCreated?: (page: Page, context: BrowserContext, hookContext: PluginHookContext) => Promise<void> | void;
+    /**
+     * Context extension: inject custom methods or properties directly into TestContext (ctx)
+     */
+    extendContext?: (ctx: TestContext, page: Page, hookContext: PluginHookContext) => Record<string, any> | Promise<Record<string, any>>;
+    /** Lifecycle hook: called after scenario runs and report data is calculated */
+    onAfterRun?: (reportData: ReportData, hookContext: PluginHookContext) => Promise<void> | void;
+    /** Lifecycle hook: teardown and cleanup guaranteed to run */
+    teardown?: (hookContext: PluginHookContext) => Promise<void> | void;
+}
+declare function definePlugin(plugin: AgentLensPlugin): AgentLensPlugin;
+
+interface ViewportPreset {
+    name: string;
+    width: number;
+    height: number;
+}
+declare const VIEWPORT_PRESETS: {
+    /** Minimum supported window size */
+    MIN_SUPPORTED: ViewportPreset;
+    /** Standard default window size */
+    DEFAULT: ViewportPreset;
+    /** Wide screen for checking grids and tables */
+    WIDE: ViewportPreset;
+    /** Full HD */
+    FULL_HD: ViewportPreset;
+};
+interface MockRouteEntry {
+    url: string;
+    method?: string;
+    status?: number;
+    body: any;
+    delayMs?: number;
+    headers?: Record<string, string>;
+}
+interface CaptureOptions {
+    selector?: string;
+    fullPage?: boolean;
+    mask?: string[];
+}
+interface CaptureBurstOptions {
+    /** Total duration of burst animation capture in milliseconds */
+    durationMs: number;
+    /** Interval between frames in milliseconds (default: 80ms) */
+    intervalMs?: number;
+    /** Restrict capture to a specific element */
+    selector?: string;
+}
+interface SnapshotMetadata {
+    index: number;
+    name: string;
+    fileName: string;
+    filePath: string;
+    relativeUri: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+    timestamp: string;
+    isBurstFrame?: boolean;
+    burstGroup?: string;
+    frameIndex?: number;
+    selector?: string;
+}
+interface TestContext {
+    [key: string]: any;
+    page: Page;
+    context: BrowserContext;
+    targetMode: 'desktop' | 'preview';
+    currentViewport: {
+        width: number;
+        height: number;
+    };
+    capture: (name: string, options?: CaptureOptions) => Promise<SnapshotMetadata>;
+    captureBurst: (name: string, options: CaptureBurstOptions) => Promise<SnapshotMetadata[]>;
+    navigate: (route: string) => Promise<void>;
+    resize: (width: number, height: number) => Promise<void>;
+    setPreset: (preset: ViewportPreset) => Promise<void>;
+    resizeToFit: (selector?: string, padding?: number) => Promise<void>;
+    wait: (ms: number) => Promise<void>;
+    waitForSelector: (selector: string, timeoutMs?: number) => Promise<void>;
+    click: (selector: string) => Promise<void>;
+    rightClick: (selector: string) => Promise<void>;
+    type: (selector: string, text: string) => Promise<void>;
+    selectOption: (selector: string, value: string) => Promise<void>;
+    hover: (selector: string) => Promise<void>;
+    scroll: (selector: string, deltaY: number) => Promise<void>;
+    log: (message: string) => void;
+    setMockIpc: (action: string, data: any, options?: {
+        type?: MockIpcResponseType;
+        delayMs?: number;
+    }) => Promise<void>;
+    setMockRoute: (url: string, body: any, options?: {
+        method?: string;
+        status?: number;
+        delayMs?: number;
+        headers?: Record<string, string>;
+    }) => Promise<void>;
+    getConsoleErrors: () => ConsoleEntry[];
+    getConsoleWarnings: () => ConsoleEntry[];
+    hasConsoleErrors: () => boolean;
+    readText: (selector: string) => Promise<string | null>;
+    getPageText: () => Promise<string>;
+    isVisible: (selector: string) => Promise<boolean>;
+    getElementCount: (selector: string) => Promise<number>;
+}
+interface VisualScenario {
+    /** Unique scenario identifier (kebab-case) */
+    id: string;
+    /** Human-readable title for the report */
+    title: string;
+    /** Description of what is being tested */
+    description?: string;
+    /** Initial route to navigate to (e.g., '/instances', '/settings') */
+    route?: string;
+    /** List of viewport sizes to test */
+    viewports?: ViewportPreset[];
+    /** Initial IPC mock data for preview mode */
+    mockIpc?: Array<{
+        action: string;
+        data: any;
+        type?: MockIpcResponseType;
+        delayMs?: number;
+    }>;
+    /** Initial HTTP REST/GraphQL route mocks for preview mode */
+    mockRoutes?: MockRouteEntry[];
+    /** Optional plugins required for this scenario */
+    plugins?: (string | AgentLensPlugin)[];
+    /** Setup hook executed before scenario runs */
+    setup?: () => Promise<void> | void;
+    /** The main body of the scenario */
+    run: (ctx: TestContext) => Promise<void>;
+    /** Teardown hook guaranteed to run on completion */
+    teardown?: () => Promise<void> | void;
+}
+declare function defineVisualTest(scenario: VisualScenario): VisualScenario;
+
+export { type AgentLensPlugin as A, type ConsoleEntry as C, type DriverLaunchResult as D, type MockIpcResponseType as M, type PluginHookContext as P, type ReportData as R, type SnapshotMetadata as S, type TestContext as T, type VisualScenario as V, type MockIpcEntry as a, type CaptureOptions as b, type CaptureBurstOptions as c, type MockRouteEntry as d, type ReportSection as e, VIEWPORT_PRESETS as f, type ViewportPreset as g, definePlugin as h, defineVisualTest as i };

package/dist/dsl-BIjVN1M0.d.ts

@@ -0,0 +1,204 @@
+import { Page, BrowserContext, Browser } from 'playwright';
+
+interface ConsoleEntry {
+    level: 'error' | 'warning' | 'info' | 'log' | 'debug';
+    text: string;
+    url: string;
+    timestamp: string;
+    stack?: string;
+}
+
+type MockIpcResponseType = 'SUCCESS' | 'ERROR';
+interface MockIpcEntry {
+    action: string;
+    data: any;
+    type?: MockIpcResponseType;
+    delayMs?: number;
+}
+
+interface ReportSection {
+    title: string;
+    content: string;
+}
+interface ReportData {
+    scenario: VisualScenario;
+    snapshots: SnapshotMetadata[];
+    consoleErrors: ConsoleEntry[];
+    consoleWarnings: ConsoleEntry[];
+    outputDir: string;
+    targetMode: 'desktop' | 'preview' | string;
+    durationMs: number;
+    customSections?: ReportSection[];
+}
+
+interface DriverLaunchResult {
+    page: Page;
+    context: BrowserContext;
+    browser?: Browser;
+    stop?: () => Promise<void>;
+}
+interface PluginHookContext {
+    scenario?: VisualScenario;
+    targetMode: 'desktop' | 'preview' | string;
+    artifactsDir: string;
+    cliOptions?: Record<string, unknown>;
+    state: Map<string, unknown>;
+}
+interface AgentLensPlugin {
+    /** Unique plugin identifier (e.g. 'desktop-webview2', 'live-controller', 'mock-ipc') */
+    name: string;
+    version?: string;
+    /** Lifecycle hook: initial setup before drivers and scenarios start */
+    setup?: (context: PluginHookContext) => Promise<void> | void;
+    /**
+     * Microkernel driver hook: allows a plugin to provide a custom browser/page session
+     * (e.g., desktop WebView2 CDP connection, custom remote browser).
+     */
+    launchSession?: (options: {
+        currentViewport: {
+            width: number;
+            height: number;
+        };
+        headed?: boolean;
+    }, hookContext: PluginHookContext) => Promise<DriverLaunchResult | undefined>;
+    /** Lifecycle hook: called when browser context is ready */
+    onContextCreated?: (context: BrowserContext, hookContext: PluginHookContext) => Promise<void> | void;
+    /** Lifecycle hook: called when the test page is created/navigated */
+    onPageCreated?: (page: Page, context: BrowserContext, hookContext: PluginHookContext) => Promise<void> | void;
+    /**
+     * Context extension: inject custom methods or properties directly into TestContext (ctx)
+     */
+    extendContext?: (ctx: TestContext, page: Page, hookContext: PluginHookContext) => Record<string, any> | Promise<Record<string, any>>;
+    /** Lifecycle hook: called after scenario runs and report data is calculated */
+    onAfterRun?: (reportData: ReportData, hookContext: PluginHookContext) => Promise<void> | void;
+    /** Lifecycle hook: teardown and cleanup guaranteed to run */
+    teardown?: (hookContext: PluginHookContext) => Promise<void> | void;
+}
+declare function definePlugin(plugin: AgentLensPlugin): AgentLensPlugin;
+
+interface ViewportPreset {
+    name: string;
+    width: number;
+    height: number;
+}
+declare const VIEWPORT_PRESETS: {
+    /** Minimum supported window size */
+    MIN_SUPPORTED: ViewportPreset;
+    /** Standard default window size */
+    DEFAULT: ViewportPreset;
+    /** Wide screen for checking grids and tables */
+    WIDE: ViewportPreset;
+    /** Full HD */
+    FULL_HD: ViewportPreset;
+};
+interface MockRouteEntry {
+    url: string;
+    method?: string;
+    status?: number;
+    body: any;
+    delayMs?: number;
+    headers?: Record<string, string>;
+}
+interface CaptureOptions {
+    selector?: string;
+    fullPage?: boolean;
+    mask?: string[];
+}
+interface CaptureBurstOptions {
+    /** Total duration of burst animation capture in milliseconds */
+    durationMs: number;
+    /** Interval between frames in milliseconds (default: 80ms) */
+    intervalMs?: number;
+    /** Restrict capture to a specific element */
+    selector?: string;
+}
+interface SnapshotMetadata {
+    index: number;
+    name: string;
+    fileName: string;
+    filePath: string;
+    relativeUri: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+    timestamp: string;
+    isBurstFrame?: boolean;
+    burstGroup?: string;
+    frameIndex?: number;
+    selector?: string;
+}
+interface TestContext {
+    [key: string]: any;
+    page: Page;
+    context: BrowserContext;
+    targetMode: 'desktop' | 'preview';
+    currentViewport: {
+        width: number;
+        height: number;
+    };
+    capture: (name: string, options?: CaptureOptions) => Promise<SnapshotMetadata>;
+    captureBurst: (name: string, options: CaptureBurstOptions) => Promise<SnapshotMetadata[]>;
+    navigate: (route: string) => Promise<void>;
+    resize: (width: number, height: number) => Promise<void>;
+    setPreset: (preset: ViewportPreset) => Promise<void>;
+    resizeToFit: (selector?: string, padding?: number) => Promise<void>;
+    wait: (ms: number) => Promise<void>;
+    waitForSelector: (selector: string, timeoutMs?: number) => Promise<void>;
+    click: (selector: string) => Promise<void>;
+    rightClick: (selector: string) => Promise<void>;
+    type: (selector: string, text: string) => Promise<void>;
+    selectOption: (selector: string, value: string) => Promise<void>;
+    hover: (selector: string) => Promise<void>;
+    scroll: (selector: string, deltaY: number) => Promise<void>;
+    log: (message: string) => void;
+    setMockIpc: (action: string, data: any, options?: {
+        type?: MockIpcResponseType;
+        delayMs?: number;
+    }) => Promise<void>;
+    setMockRoute: (url: string, body: any, options?: {
+        method?: string;
+        status?: number;
+        delayMs?: number;
+        headers?: Record<string, string>;
+    }) => Promise<void>;
+    getConsoleErrors: () => ConsoleEntry[];
+    getConsoleWarnings: () => ConsoleEntry[];
+    hasConsoleErrors: () => boolean;
+    readText: (selector: string) => Promise<string | null>;
+    getPageText: () => Promise<string>;
+    isVisible: (selector: string) => Promise<boolean>;
+    getElementCount: (selector: string) => Promise<number>;
+}
+interface VisualScenario {
+    /** Unique scenario identifier (kebab-case) */
+    id: string;
+    /** Human-readable title for the report */
+    title: string;
+    /** Description of what is being tested */
+    description?: string;
+    /** Initial route to navigate to (e.g., '/instances', '/settings') */
+    route?: string;
+    /** List of viewport sizes to test */
+    viewports?: ViewportPreset[];
+    /** Initial IPC mock data for preview mode */
+    mockIpc?: Array<{
+        action: string;
+        data: any;
+        type?: MockIpcResponseType;
+        delayMs?: number;
+    }>;
+    /** Initial HTTP REST/GraphQL route mocks for preview mode */
+    mockRoutes?: MockRouteEntry[];
+    /** Optional plugins required for this scenario */
+    plugins?: (string | AgentLensPlugin)[];
+    /** Setup hook executed before scenario runs */
+    setup?: () => Promise<void> | void;
+    /** The main body of the scenario */
+    run: (ctx: TestContext) => Promise<void>;
+    /** Teardown hook guaranteed to run on completion */
+    teardown?: () => Promise<void> | void;
+}
+declare function defineVisualTest(scenario: VisualScenario): VisualScenario;
+
+export { type AgentLensPlugin as A, type ConsoleEntry as C, type DriverLaunchResult as D, type MockIpcResponseType as M, type PluginHookContext as P, type ReportData as R, type SnapshotMetadata as S, type TestContext as T, type VisualScenario as V, type MockIpcEntry as a, type CaptureOptions as b, type CaptureBurstOptions as c, type MockRouteEntry as d, type ReportSection as e, VIEWPORT_PRESETS as f, type ViewportPreset as g, definePlugin as h, defineVisualTest as i };