@midscene/testing-framework 0.0.0

package/dist/types/types.d.ts

@@ -0,0 +1,105 @@
+import type { MidsceneYamlFlowItem } from '@midscene/core';
+/**
+ * Target types supported by the default framework setup. The first version of
+ * the UI Testing Framework only covers the `web` and `android` targets that
+ * appear in #2509 and the example project.
+ */
+export type FrameworkTargetType = 'web' | 'android';
+export interface FrameworkTargetConfig {
+    type: FrameworkTargetType;
+    options?: Record<string, unknown>;
+}
+/**
+ * Minimal agent contract the framework relies on. Any Midscene agent
+ * (PlaywrightAgent, AndroidAgent, …) satisfies it because they all expose
+ * `runYaml`.
+ */
+export interface FrameworkAgent {
+    runYaml: (yamlScriptContent: string) => Promise<unknown>;
+    /** Optional report path some agents expose after a run. */
+    reportFile?: string | null;
+}
+export interface SetupContext {
+    projectDir: string;
+    agentOptions: Record<string, unknown>;
+}
+export interface FrameworkSetupResult {
+    agent: FrameworkAgent;
+    teardown?: () => Promise<void> | void;
+    [key: string]: unknown;
+}
+export interface CustomYamlStepContext {
+    agent: FrameworkAgent;
+    state: Record<string, unknown>;
+    filePath: string;
+    stepIndex: number;
+    stepName: string;
+}
+export type CustomYamlStepHandler = (value: unknown, context: CustomYamlStepContext) => Promise<void> | void;
+export interface MidsceneFrameworkConfig {
+    target?: FrameworkTargetConfig;
+    testDir?: string;
+    include?: string[];
+    exclude?: string[];
+    testRunner?: {
+        maxConcurrency?: number;
+        bail?: number;
+        testTimeout?: number;
+        retry?: number;
+    };
+    /**
+     * Controls how `runMidsceneSuite` loads `.env` files before resolving
+     * model and runtime configuration. Defaults are intentionally close to
+     * `@midscene/cli`'s behaviour:
+     * - `path` defaults to `[<cwd>/.env, <configDir>/.env]` (deduplicated;
+     *   missing files are skipped silently).
+     * - `override` defaults to `false` (existing `process.env` wins).
+     * - `debug` defaults to `false`.
+     *
+     * Set `enabled: false` to opt out entirely (e.g. when the project handles
+     * env loading on its own).
+     */
+    env?: {
+        enabled?: boolean;
+        path?: string | string[];
+        override?: boolean;
+        debug?: boolean;
+    };
+    output?: {
+        summary?: string;
+        reportDir?: string;
+    };
+    agentOptions?: Record<string, unknown>;
+    setup?: (context: SetupContext) => Promise<FrameworkSetupResult> | FrameworkSetupResult;
+    yamlSteps?: Record<string, CustomYamlStepHandler>;
+}
+export interface LoadedMidsceneConfig {
+    path: string;
+    root: string;
+    config: MidsceneFrameworkConfig;
+}
+export interface FrameworkTestFile {
+    filePath: string;
+    relativePath: string;
+    type: 'yaml' | 'test';
+}
+export interface NormalizedYamlCase {
+    name: string;
+    flow: MidsceneYamlFlowItem[];
+    raw: Record<string, unknown>;
+}
+export interface FrameworkCaseResult {
+    file: string;
+    testName: string;
+    success: boolean;
+    duration: number;
+    error?: string;
+    report?: string;
+}
+export interface FrameworkSuiteSummary {
+    total: number;
+    passed: number;
+    failed: number;
+    durationMs: number;
+    results: FrameworkCaseResult[];
+}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@midscene/testing-framework",
+  "description": "Midscene AI-native UI testing framework runtime built on Rstest.",
+  "version": "0.0.0",
+  "repository": "https://github.com/web-infra-dev/midscene",
+  "homepage": "https://midscenejs.com/",
+  "main": "./dist/lib/index.js",
+  "types": "./dist/types/index.d.ts",
+  "module": "./dist/es/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/es/index.mjs",
+      "require": "./dist/lib/index.js"
+    },
+    "./runtime": {
+      "types": "./dist/types/runtime/index.d.ts",
+      "import": "./dist/es/runtime/index.mjs",
+      "require": "./dist/lib/runtime/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@midscene/core": "1.8.7-beta-20260601040030.0",
+    "@midscene/shared": "1.8.7-beta-20260601040030.0",
+    "dotenv": "^16.4.5",
+    "glob": "11.0.0",
+    "jiti": "2.6.1",
+    "js-yaml": "4.1.0"
+  },
+  "peerDependencies": {
+    "@midscene/android": "1.8.7-beta-20260601040030.0",
+    "@midscene/web": "1.8.7-beta-20260601040030.0",
+    "@rstest/core": "*",
+    "playwright": "^1.45.0"
+  },
+  "peerDependenciesMeta": {
+    "@midscene/android": {
+      "optional": true
+    },
+    "@midscene/web": {
+      "optional": true
+    },
+    "playwright": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@rslib/core": "^0.18.3",
+    "@rstest/core": "https://pkg.pr.new/@rstest/core@953945e",
+    "@types/js-yaml": "4.0.9",
+    "@types/node": "^18.0.0",
+    "playwright": "^1.45.0",
+    "typescript": "^5.8.3",
+    "vitest": "3.0.5",
+    "@midscene/android": "1.8.6",
+    "@midscene/web": "1.8.6"
+  },
+  "engines": {
+    "node": ">=18.19.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "license": "MIT",
+  "scripts": {
+    "dev": "npm run build:watch",
+    "build": "rslib build",
+    "build:watch": "rslib build --watch --no-clean",
+    "test": "vitest --run"
+  }
+}