@midscene/test 1.12.4-beta-20260903111111.0 → 1.12.4

package/dist/types/ios/index.d.ts

@@ -1,4 +1,13 @@
-import { z } from 'zod/v4';
+import type { IOSAgent } from '@midscene/ios';
+import { launchInputSchema } from '@midscene/ios/test-runner';
+import { LaunchNodeInput } from '@midscene/ios/test-runner';
+import { runWdaRequestInputSchema } from '@midscene/ios/test-runner';
+import { RunWdaRequestNodeInput } from '@midscene/ios/test-runner';
+import { terminateInputSchema } from '@midscene/ios/test-runner';
+import { TerminateNodeInput } from '@midscene/ios/test-runner';
+import { WDAHttpMethod } from '@midscene/ios/test-runner';
+import { wdaRequestInputSchema } from '@midscene/ios/test-runner';
+import type { z } from 'zod/v4';
 
 declare type Awaitable<T> = T | Promise<T>;
 
@@ -10,62 +19,39 @@ declare interface CaseExecutionContext {
     readonly name: string;
     readonly sourcePath: string;
     readonly caseIndex: number;
-    readonly completedSteps: readonly StepRunResult[];
 }
 
 declare type CaseNodePhase = 'beforeEach' | 'steps' | 'afterEach';
 
-declare interface CommonNodeInput {
-    prompt?: string;
-}
-
-/** Create the P0 iOS preset Nodes for an injected iOS Agent. */
 export declare function createIOSNodes<TContext>(options: CreateIOSNodesOptions<TContext>): readonly NodeDefinition<any, any, TContext>[];
 
-/** Dependencies used by the iOS preset Nodes. */
 export declare interface CreateIOSNodesOptions<TContext> {
-    /** Return the iOS Agent associated with the current workflow. */
-    getAgent(ctx: NodeContext<TContext>): Awaitable<IOSRunnerAgent>;
+    getAgent(ctx: NodeExecutionContext<unknown, TContext>): Awaitable<IOSRunnerAgent>;
 }
 
 declare interface DefineNodeOptions<TInput = unknown, TData = unknown, TContext = unknown> {
     name: string;
     title?: string;
     description?: string;
+    /** Object field populated by string shorthand. Omit or set false to disable it. */
+    stringInputKey?: string | false;
     inputSchema?: NodeInputSchema;
     execute(ctx: NodeExecutionContext<TInput, TContext>): NodeExecutionReturn<TData>;
 }
 
-/** Device capabilities required by Android and iOS lifecycle Nodes. */
-declare interface DeviceLifecycleAgent {
-    launch(uri: string): Promise<void>;
-    terminate(uri: string): Promise<void>;
-}
-
 declare type DocumentNodePhase = 'beforeAll' | 'afterAll';
 
-/** Minimal iOS Agent capability required by the preset Node. */
-export declare interface IOSRunnerAgent extends DeviceLifecycleAgent {
-    /** Execute one WebDriverAgent request through the iOS Agent action API. */
-    runWdaRequest(input: RunWdaRequestNodeInput): Promise<unknown>;
-}
+export declare type IOSRunnerAgent = Pick<IOSAgent, 'launch' | 'terminate' | 'runWdaRequest' | 'home' | 'appSwitcher'>;
 
-/** Input schema for the device launch Node. */
-export declare const launchInputSchema: z.ZodObject<{
-    prompt: z.ZodOptional<z.ZodString>;
-    uri: z.ZodOptional<z.ZodString>;
-}, z.core.$strict>;
+export { launchInputSchema }
 
-export declare type LaunchNodeInput = z.infer<typeof launchInputSchema>;
+export { LaunchNodeInput }
 
 declare interface NodeCaseContext extends CaseExecutionContext {
     readonly phase: CaseNodePhase;
     readonly stepIndex: number;
-    readonly completedNodes: readonly StepRunResult[];
 }
 
-declare type NodeContext<TContext> = NodeExecutionContext<unknown, TContext>;
-
 declare interface NodeDefinition<TInput = unknown, TData = unknown, TContext = unknown> extends DefineNodeOptions<TInput, TData, TContext> {
 }
 
@@ -77,64 +63,43 @@ declare interface NodeDocumentContext {
     readonly sourcePath: string;
     readonly phase: DocumentNodePhase;
     readonly stepIndex: number;
-    readonly completedNodes: readonly StepRunResult[];
 }
 
 declare type NodeExecutionContext<TInput = unknown, TContext = unknown> = NodeExecutionContextBase<TInput, TContext> & ({
     /** The node is running for one case. */
     scope: 'case';
-    /** Identity and completed-step history for the case being executed. */
+    /** Identity and phase information for the case being executed. */
     case: NodeCaseContext;
     document?: never;
 } | {
     /** The node is running for the workflow document. */
     scope: 'document';
-    /** Identity and completed-node history for the document being executed. */
+    /** Identity and phase information for the document being executed. */
     document: NodeDocumentContext;
     case?: never;
 });
 
 declare interface NodeExecutionContextBase<TInput = unknown, TContext = unknown> {
-    /** The node input without `$`, including the common `prompt` input. */
-    input: TInput & CommonNodeInput;
+    /** The validated node input without `$`. */
+    input: TInput;
     /** The normalized engine metadata for this step. */
     $: Readonly<NormalizedStepMeta>;
     /** The timeout and cancellation signal for this step. */
     signal: AbortSignal;
     /** Resources shared by the current workflow document. */
     context: TContext;
-    /** Read-only results completed in the current document/case scope. */
-    history: readonly NodeHistoryEntry[];
     /** Register resource cleanup for the current case attempt or document. */
     onTeardown(teardown: NodeScopeTeardown): void;
 }
 
-declare type NodeExecutionPhase = CaseNodePhase | DocumentNodePhase;
-
 declare type NodeExecutionReturn<TData = unknown> = Promise<NodeResult<TData> | void> | NodeResult<TData> | void;
 
-declare interface NodeHistoryEntry {
-    readonly scope: 'document' | 'case';
-    readonly phase: NodeExecutionPhase;
-    readonly stepIndex: number;
-    readonly node: string;
-    readonly input?: unknown;
-    readonly intent?: string;
-    readonly status: 'passed' | 'failed' | 'skipped';
-    readonly summary?: string;
-    readonly data?: unknown;
-    readonly error?: {
-        readonly name: string;
-        readonly message: string;
-    };
-}
-
 declare type NodeInputSchema = z.ZodObject;
 
 declare interface NodeResult<TData = unknown> {
-    /** Human-readable summary for reports and later agent context. */
+    /** Human-readable summary for reports. */
     summary?: string;
-    /** Structured data for later steps. */
+    /** Structured data included in the step result. */
     data?: TData;
 }
 
@@ -150,60 +115,16 @@ declare interface NormalizedStepMeta {
     continueOnError: boolean;
 }
 
-/** Input schema for the iOS runWdaRequest Node. */
-export declare const runWdaRequestInputSchema: z.ZodObject<{
-    method: z.ZodEnum<{
-        GET: "GET";
-        POST: "POST";
-        DELETE: "DELETE";
-        PUT: "PUT";
-    }>;
-    endpoint: z.ZodString;
-    data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-}, z.core.$strict>;
-
-/** Validated input accepted by the iOS runWdaRequest Node. */
-export declare type RunWdaRequestNodeInput = z.infer<typeof runWdaRequestInputSchema>;
-
-declare interface StepRunResult<TOutputData = unknown> {
-    phase: NodeExecutionPhase;
-    stepIndex: number;
-    node: string;
-    input: unknown;
-    meta: NormalizedStepMeta;
-    status: 'success' | 'failed';
-    continuedAfterError: boolean;
-    startedAt: string;
-    endedAt: string;
-    durationMs: number;
-    output?: NodeResult<TOutputData>;
-    error?: WorkflowError;
-}
+export { runWdaRequestInputSchema }
 
-/** Input schema for the device terminate Node. */
-export declare const terminateInputSchema: z.ZodObject<{
-    prompt: z.ZodOptional<z.ZodString>;
-    uri: z.ZodOptional<z.ZodString>;
-}, z.core.$strict>;
+export { RunWdaRequestNodeInput }
 
-export declare type TerminateNodeInput = z.infer<typeof terminateInputSchema>;
+export { terminateInputSchema }
 
-declare const WDA_HTTP_METHODS: readonly ["GET", "POST", "DELETE", "PUT"];
+export { TerminateNodeInput }
 
-/** HTTP methods supported by the WebDriverAgent request Node. */
-export declare type WDAHttpMethod = (typeof WDA_HTTP_METHODS)[number];
+export { WDAHttpMethod }
 
-declare class WorkflowError extends Error {
-    readonly code: string;
-    readonly details?: unknown;
-    constructor(message: string, options?: WorkflowErrorOptions);
-    toJSON(): Record<string, unknown>;
-}
-
-declare interface WorkflowErrorOptions {
-    code?: string;
-    details?: unknown;
-    cause?: unknown;
-}
+export { wdaRequestInputSchema }
 
 export { }

package/dist/types/midscene/index.d.ts

@@ -1,3 +1,20 @@
+import { AgentTestRunnerNodeDefinition } from '@midscene/core/agent/test-runner';
+import { AgentTestRunnerNodeProvider } from '@midscene/core/agent/test-runner';
+import { aiActInputSchema } from '@midscene/core/agent/test-runner';
+import { aiActOptionsInputSchema } from '@midscene/core/agent/test-runner';
+import { aiAssertInputSchema } from '@midscene/core/agent/test-runner';
+import { aiAssertOptionsInputSchema } from '@midscene/core/agent/test-runner';
+import { aiTapInputSchema } from '@midscene/core/agent/test-runner';
+import { CommonAgentTestRunnerApi } from '@midscene/core/agent/test-runner';
+import { insightInputSchema } from '@midscene/core/agent/test-runner';
+import { insightOptionsInputSchema } from '@midscene/core/agent/test-runner';
+import { locateOptionsInputSchema } from '@midscene/core/agent/test-runner';
+import { promptImageInputSchema } from '@midscene/core/agent/test-runner';
+import { recordToReportInputSchema } from '@midscene/core/agent/test-runner';
+import { recordToReportOptionsInputSchema } from '@midscene/core/agent/test-runner';
+import { reportScreenshotInputSchema } from '@midscene/core/agent/test-runner';
+import { structuredUserPromptInputSchema } from '@midscene/core/agent/test-runner';
+import { userPromptInputSchema } from '@midscene/core/agent/test-runner';
 import { z } from 'zod/v4';
 
 export declare interface AgentExecutor<TContext> {
@@ -6,7 +23,6 @@ export declare interface AgentExecutor<TContext> {
 
 export declare interface AgentExecutorInput<TContext> {
     prompt: string;
-    history: readonly NodeHistoryEntry[];
     context: TContext;
     signal: AbortSignal;
     execution: {
@@ -35,41 +51,22 @@ export declare interface AgentReleaseResult {
     reportPath?: string;
 }
 
-export declare const aiActInputSchema: z.ZodObject<{
-    prompt: z.ZodString;
-    images: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
-        url: z.ZodString;
-    }, z.core.$strict>>>;
-    convertHttpImage2Base64: z.ZodOptional<z.ZodBoolean>;
-    options: z.ZodOptional<z.ZodObject<{
-        cacheable: z.ZodOptional<z.ZodBoolean>;
-        fileChooserAccept: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
-        deepThink: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"unset">, z.ZodBoolean]>>;
-        deepLocate: z.ZodOptional<z.ZodBoolean>;
-        context: z.ZodOptional<z.ZodString>;
-    }, z.core.$strict>>;
-}, z.core.$strict>;
+export { aiActInputSchema }
 
 export declare type AiActNodeInput = z.infer<typeof aiActInputSchema>;
 
-export declare const aiAssertInputSchema: z.ZodObject<{
-    prompt: z.ZodString;
-    images: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
-        url: z.ZodString;
-    }, z.core.$strict>>>;
-    convertHttpImage2Base64: z.ZodOptional<z.ZodBoolean>;
-    message: z.ZodOptional<z.ZodString>;
-    options: z.ZodOptional<z.ZodObject<{
-        domIncluded: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodLiteral<"visible-only">]>>;
-        screenshotIncluded: z.ZodOptional<z.ZodBoolean>;
-        context: z.ZodOptional<z.ZodString>;
-    }, z.core.$strict>>;
-}, z.core.$strict>;
+export { aiActOptionsInputSchema }
+
+export { aiAssertInputSchema }
 
 export declare type AiAssertNodeInput = z.infer<typeof aiAssertInputSchema>;
 
+export { aiAssertOptionsInputSchema }
+
+export { aiTapInputSchema }
+
+export declare type AiTapNodeInput = z.infer<typeof aiTapInputSchema>;
+
 declare type Awaitable<T> = T | Promise<T>;
 
 declare interface CaseExecutionContext {
@@ -80,22 +77,20 @@ declare interface CaseExecutionContext {
     readonly name: string;
     readonly sourcePath: string;
     readonly caseIndex: number;
-    readonly completedSteps: readonly StepRunResult[];
 }
 
 declare type CaseNodePhase = 'beforeEach' | 'steps' | 'afterEach';
 
-declare interface CommonNodeInput {
-    prompt?: string;
-}
+/** Adapt Agent-owned descriptions to executable Test Runner Nodes. */
+export declare const createAgentTestRunnerNodes: <TContext>(definitions: readonly AgentTestRunnerNodeDefinition[], getAgent: (ctx: NodeExecutionContext<unknown, TContext>) => Awaitable<unknown>) => readonly NodeDefinition<any, any, TContext>[];
 
 export declare function createMidsceneNodes<TContext>(options: CreateMidsceneNodesOptions<TContext>): readonly NodeDefinition<any, any, TContext>[];
 
 export declare interface CreateMidsceneNodesOptions<TContext> {
     getAgent?(ctx: NodeExecutionContext<unknown, TContext>): Awaitable<MidsceneUIAgent>;
     agentProvider?: AgentProvider<TContext>;
-    /** Disable when a project registers its own platform-specific launch Node. */
-    includeLaunch?: boolean;
+    /** Agent class that declares the Agent-backed Nodes to register. */
+    agentClass: AgentTestRunnerNodeProvider;
     agentExecutor?: AgentExecutor<TContext>;
 }
 
@@ -103,71 +98,27 @@ declare interface DefineNodeOptions<TInput = unknown, TData = unknown, TContext
     name: string;
     title?: string;
     description?: string;
+    /** Object field populated by string shorthand. Omit or set false to disable it. */
+    stringInputKey?: string | false;
     inputSchema?: NodeInputSchema;
     execute(ctx: NodeExecutionContext<TInput, TContext>): NodeExecutionReturn<TData>;
 }
 
 declare type DocumentNodePhase = 'beforeAll' | 'afterAll';
 
-/** Input schema for the device launch Node. */
-export declare const launchInputSchema: z.ZodObject<{
-    prompt: z.ZodOptional<z.ZodString>;
-    uri: z.ZodOptional<z.ZodString>;
-}, z.core.$strict>;
+export { insightInputSchema }
 
-export declare type LaunchNodeInput = z.infer<typeof launchInputSchema>;
-
-export declare interface MidsceneAiActOptions {
-    cacheable?: boolean;
-    fileChooserAccept?: string | string[];
-    deepThink?: 'unset' | boolean;
-    deepLocate?: boolean;
-    context?: string;
-    abortSignal?: AbortSignal;
-}
-
-export declare interface MidsceneAiAssertOptions {
-    domIncluded?: boolean | 'visible-only';
-    screenshotIncluded?: boolean;
-    context?: string;
-    abortSignal?: AbortSignal;
-    keepRawResponse?: boolean;
-}
-
-export declare interface MidscenePromptImage {
-    name: string;
-    url: string;
-}
-
-export declare interface MidsceneRecordToReportOptions {
-    content?: string;
-    screenshotBase64?: string;
-    screenshots?: MidsceneReportScreenshot[];
-}
+export declare type InsightNodeInput = z.infer<typeof insightInputSchema>;
 
-export declare interface MidsceneReportScreenshot {
-    base64: string;
-    description?: string;
-}
+export { insightOptionsInputSchema }
 
-export declare interface MidsceneUIAgent {
-    aiAct(prompt: MidsceneUserPrompt, options?: MidsceneAiActOptions): Promise<string | undefined>;
-    aiAssert(prompt: MidsceneUserPrompt, message?: string, options?: MidsceneAiAssertOptions): Promise<unknown>;
-    recordToReport(title?: string, options?: MidsceneRecordToReportOptions): Promise<unknown>;
-    /** Available on device Agents that support launching an app, URL, or URI. */
-    launch?(uri: string): Promise<void>;
-}
+export { locateOptionsInputSchema }
 
-export declare type MidsceneUserPrompt = string | {
-    prompt: string;
-    images?: MidscenePromptImage[];
-    convertHttpImage2Base64?: boolean;
-};
+export declare type MidsceneUIAgent = CommonAgentTestRunnerApi;
 
 declare interface NodeCaseContext extends CaseExecutionContext {
     readonly phase: CaseNodePhase;
     readonly stepIndex: number;
-    readonly completedNodes: readonly StepRunResult[];
 }
 
 declare interface NodeDefinition<TInput = unknown, TData = unknown, TContext = unknown> extends DefineNodeOptions<TInput, TData, TContext> {
@@ -181,64 +132,43 @@ declare interface NodeDocumentContext {
     readonly sourcePath: string;
     readonly phase: DocumentNodePhase;
     readonly stepIndex: number;
-    readonly completedNodes: readonly StepRunResult[];
 }
 
 declare type NodeExecutionContext<TInput = unknown, TContext = unknown> = NodeExecutionContextBase<TInput, TContext> & ({
     /** The node is running for one case. */
     scope: 'case';
-    /** Identity and completed-step history for the case being executed. */
+    /** Identity and phase information for the case being executed. */
     case: NodeCaseContext;
     document?: never;
 } | {
     /** The node is running for the workflow document. */
     scope: 'document';
-    /** Identity and completed-node history for the document being executed. */
+    /** Identity and phase information for the document being executed. */
     document: NodeDocumentContext;
     case?: never;
 });
 
 declare interface NodeExecutionContextBase<TInput = unknown, TContext = unknown> {
-    /** The node input without `$`, including the common `prompt` input. */
-    input: TInput & CommonNodeInput;
+    /** The validated node input without `$`. */
+    input: TInput;
     /** The normalized engine metadata for this step. */
     $: Readonly<NormalizedStepMeta>;
     /** The timeout and cancellation signal for this step. */
     signal: AbortSignal;
     /** Resources shared by the current workflow document. */
     context: TContext;
-    /** Read-only results completed in the current document/case scope. */
-    history: readonly NodeHistoryEntry[];
     /** Register resource cleanup for the current case attempt or document. */
     onTeardown(teardown: NodeScopeTeardown): void;
 }
 
-declare type NodeExecutionPhase = CaseNodePhase | DocumentNodePhase;
-
 declare type NodeExecutionReturn<TData = unknown> = Promise<NodeResult<TData> | void> | NodeResult<TData> | void;
 
-declare interface NodeHistoryEntry {
-    readonly scope: 'document' | 'case';
-    readonly phase: NodeExecutionPhase;
-    readonly stepIndex: number;
-    readonly node: string;
-    readonly input?: unknown;
-    readonly intent?: string;
-    readonly status: 'passed' | 'failed' | 'skipped';
-    readonly summary?: string;
-    readonly data?: unknown;
-    readonly error?: {
-        readonly name: string;
-        readonly message: string;
-    };
-}
-
 declare type NodeInputSchema = z.ZodObject;
 
 declare interface NodeResult<TData = unknown> {
-    /** Human-readable summary for reports and later agent context. */
+    /** Human-readable summary for reports. */
     summary?: string;
-    /** Structured data for later steps. */
+    /** Structured data included in the step result. */
     data?: TData;
 }
 
@@ -254,35 +184,19 @@ declare interface NormalizedStepMeta {
     continueOnError: boolean;
 }
 
-export declare const recordToReportInputSchema: z.ZodObject<{
-    prompt: z.ZodOptional<z.ZodString>;
-    title: z.ZodOptional<z.ZodString>;
-    content: z.ZodOptional<z.ZodString>;
-    screenshotBase64: z.ZodOptional<z.ZodString>;
-    screenshots: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        base64: z.ZodString;
-        description: z.ZodOptional<z.ZodString>;
-    }, z.core.$strict>>>;
-}, z.core.$strict>;
+export { promptImageInputSchema }
+
+export { recordToReportInputSchema }
 
 export declare type RecordToReportNodeInput = z.infer<typeof recordToReportInputSchema>;
 
-export declare const renderNodeHistory: (history: readonly NodeHistoryEntry[]) => string | undefined;
-
-declare interface StepRunResult<TOutputData = unknown> {
-    phase: NodeExecutionPhase;
-    stepIndex: number;
-    node: string;
-    input: unknown;
-    meta: NormalizedStepMeta;
-    status: 'success' | 'failed';
-    continuedAfterError: boolean;
-    startedAt: string;
-    endedAt: string;
-    durationMs: number;
-    output?: NodeResult<TOutputData>;
-    error?: WorkflowError;
-}
+export { recordToReportOptionsInputSchema }
+
+export { reportScreenshotInputSchema }
+
+export { structuredUserPromptInputSchema }
+
+export { userPromptInputSchema }
 
 export declare const waitInputSchema: z.ZodObject<{
     duration: z.ZodNumber;
@@ -295,17 +209,4 @@ export declare const waitInputSchema: z.ZodObject<{
 
 export declare type WaitNodeInput = z.infer<typeof waitInputSchema>;
 
-declare class WorkflowError extends Error {
-    readonly code: string;
-    readonly details?: unknown;
-    constructor(message: string, options?: WorkflowErrorOptions);
-    toJSON(): Record<string, unknown>;
-}
-
-declare interface WorkflowErrorOptions {
-    code?: string;
-    details?: unknown;
-    cause?: unknown;
-}
-
 export { }