@sqaitech/core 0.5.0

package/dist/types/yaml.d.ts

@@ -0,0 +1,178 @@
+import type { TUserPrompt } from './ai-model/common';
+import type { AgentOpt, Rect } from './types';
+import type { BaseElement, UIContext } from './types';
+export interface LocateOption {
+    prompt?: TUserPrompt;
+    deepThink?: boolean;
+    cacheable?: boolean;
+    xpath?: string;
+    uiContext?: UIContext<BaseElement>;
+}
+export interface InsightExtractOption {
+    domIncluded?: boolean | 'visible-only';
+    screenshotIncluded?: boolean;
+    doNotThrowError?: boolean;
+}
+export interface ReferenceImage {
+    base64: string;
+    rect?: Rect;
+}
+export interface DetailedLocateParam extends LocateOption {
+    prompt: TUserPrompt;
+    referenceImage?: ReferenceImage;
+}
+export interface ScrollParam {
+    direction: 'down' | 'up' | 'right' | 'left';
+    scrollType: 'once' | 'untilBottom' | 'untilTop' | 'untilRight' | 'untilLeft';
+    distance?: null | number;
+}
+export interface MidsceneYamlScript {
+    target?: MidsceneYamlScriptWebEnv;
+    web?: MidsceneYamlScriptWebEnv;
+    android?: MidsceneYamlScriptAndroidEnv;
+    ios?: MidsceneYamlScriptIOSEnv;
+    interface?: MidsceneYamlScriptEnvGeneralInterface;
+    config?: MidsceneYamlScriptConfig;
+    agent?: MidsceneYamlScriptAgentOpt;
+    tasks: MidsceneYamlTask[];
+}
+export interface MidsceneYamlTask {
+    name: string;
+    flow: MidsceneYamlFlowItem[];
+    continueOnError?: boolean;
+}
+export type MidsceneYamlScriptAgentOpt = Pick<AgentOpt, 'aiActionContext' | 'cache'>;
+export interface MidsceneYamlScriptConfig {
+    output?: string;
+    unstableLogContent?: boolean | string;
+}
+export interface MidsceneYamlScriptEnvGeneralInterface {
+    module: string;
+    export?: string;
+    param?: Record<string, any>;
+}
+export interface MidsceneYamlScriptWebEnv extends MidsceneYamlScriptConfig, MidsceneYamlScriptAgentOpt {
+    serve?: string;
+    url: string;
+    userAgent?: string;
+    acceptInsecureCerts?: boolean;
+    viewportWidth?: number;
+    viewportHeight?: number;
+    viewportScale?: number;
+    waitForNetworkIdle?: {
+        timeout?: number;
+        continueOnNetworkIdleError?: boolean;
+    };
+    cookie?: string;
+    forceSameTabNavigation?: boolean;
+    bridgeMode?: false | 'newTabWithUrl' | 'currentTab';
+    closeNewTabsAfterDisconnect?: boolean;
+}
+export interface MidsceneYamlScriptAndroidEnv extends MidsceneYamlScriptConfig {
+    deviceId?: string;
+    launch?: string;
+}
+export interface MidsceneYamlScriptIOSEnv extends MidsceneYamlScriptConfig {
+    wdaPort?: number;
+    wdaHost?: string;
+    autoDismissKeyboard?: boolean;
+    launch?: string;
+}
+export type MidsceneYamlScriptEnv = MidsceneYamlScriptWebEnv | MidsceneYamlScriptAndroidEnv | MidsceneYamlScriptIOSEnv;
+export interface MidsceneYamlFlowItemAIAction {
+    ai?: string;
+    aiAction?: string;
+    aiActionProgressTips?: string[];
+    cacheable?: boolean;
+}
+export interface MidsceneYamlFlowItemAIAssert {
+    aiAssert: string;
+    errorMessage?: string;
+    name?: string;
+}
+export interface MidsceneYamlFlowItemAIQuery extends InsightExtractOption {
+    aiQuery: string;
+    name?: string;
+}
+export interface MidsceneYamlFlowItemAINumber extends InsightExtractOption {
+    aiNumber: string;
+    name?: string;
+}
+export interface MidsceneYamlFlowItemAIString extends InsightExtractOption {
+    aiString: string;
+    name?: string;
+}
+export interface MidsceneYamlFlowItemAIAsk extends InsightExtractOption {
+    aiAsk: string;
+    name?: string;
+}
+export interface MidsceneYamlFlowItemAIBoolean extends InsightExtractOption {
+    aiBoolean: string;
+    name?: string;
+}
+export interface MidsceneYamlFlowItemAILocate extends LocateOption {
+    aiLocate: string;
+    name?: string;
+}
+export interface MidsceneYamlFlowItemAIWaitFor {
+    aiWaitFor: string;
+    timeout?: number;
+}
+export interface MidsceneYamlFlowItemEvaluateJavaScript {
+    javascript: string;
+    name?: string;
+}
+export interface MidsceneYamlFlowItemSleep {
+    sleep: number;
+}
+export interface MidsceneYamlFlowItemLogScreenshot {
+    logScreenshot?: string;
+    content?: string;
+}
+export type MidsceneYamlFlowItem = MidsceneYamlFlowItemAIAction | MidsceneYamlFlowItemAIAssert | MidsceneYamlFlowItemAIQuery | MidsceneYamlFlowItemAIWaitFor | MidsceneYamlFlowItemSleep | MidsceneYamlFlowItemLogScreenshot;
+export interface FreeFn {
+    name: string;
+    fn: () => void;
+}
+export interface ScriptPlayerTaskStatus extends MidsceneYamlTask {
+    status: ScriptPlayerStatusValue;
+    currentStep?: number;
+    totalSteps: number;
+    error?: Error;
+}
+export type ScriptPlayerStatusValue = 'init' | 'running' | 'done' | 'error';
+export interface MidsceneYamlConfig {
+    concurrent?: number;
+    continueOnError?: boolean;
+    summary?: string;
+    shareBrowserContext?: boolean;
+    web?: MidsceneYamlScriptWebEnv;
+    android?: MidsceneYamlScriptAndroidEnv;
+    ios?: MidsceneYamlScriptIOSEnv;
+    files: string[];
+    headed?: boolean;
+    keepWindow?: boolean;
+    dotenvOverride?: boolean;
+    dotenvDebug?: boolean;
+}
+export interface MidsceneYamlConfigOutput {
+    format?: 'json';
+    path?: string;
+}
+export interface MidsceneYamlConfigResult {
+    file: string;
+    success: boolean;
+    executed: boolean;
+    output?: string | null;
+    report?: string | null;
+    error?: string;
+    duration?: number;
+    /**
+     * Type of result:
+     * - 'success': All tasks completed successfully
+     * - 'failed': Execution failed (player error)
+     * - 'partialFailed': Some tasks failed but execution continued (continueOnError)
+     * - 'notExecuted': Not executed due to previous failures
+     */
+    resultType?: 'success' | 'failed' | 'partialFailed' | 'notExecuted';
+}

package/package.json

@@ -0,0 +1,124 @@
+{
+  "name": "@sqaitech/core",
+  "description": "Automate browser actions, extract data, and perform assertions using AI. It offers JavaScript SDK, Chrome extension, and support for scripting in YAML. See https://sqai.tech/ for details.",
+  "version": "0.5.0",
+  "repository": "https://github.com/qa-nparekh/midscene",
+  "homepage": "https://sqai.tech/",
+  "main": "./dist/lib/index.js",
+  "types": "./dist/types/index.d.ts",
+  "module": "./dist/es/index.mjs",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/es/index.mjs",
+      "require": "./dist/lib/index.js"
+    },
+    "./utils": {
+      "types": "./dist/types/utils.d.ts",
+      "import": "./dist/es/utils.mjs",
+      "require": "./dist/lib/utils.js"
+    },
+    "./ai-model": {
+      "types": "./dist/types/ai-model/index.d.ts",
+      "import": "./dist/es/ai-model/index.mjs",
+      "require": "./dist/lib/ai-model/index.js"
+    },
+    "./tree": {
+      "types": "./dist/types/tree.d.ts",
+      "import": "./dist/es/tree.mjs",
+      "require": "./dist/lib/tree.js"
+    },
+    "./device": {
+      "types": "./dist/types/device/index.d.ts",
+      "import": "./dist/es/device/index.mjs",
+      "require": "./dist/lib/device/index.js"
+    },
+    "./agent": {
+      "types": "./dist/types/agent/index.d.ts",
+      "import": "./dist/es/agent/index.mjs",
+      "require": "./dist/lib/agent/index.js"
+    },
+    "./yaml": {
+      "types": "./dist/types/yaml/index.d.ts",
+      "import": "./dist/es/yaml/index.mjs",
+      "require": "./dist/lib/yaml/index.js"
+    },
+    "./report": {
+      "types": "./dist/types/report.d.ts",
+      "import": "./dist/es/report.mjs",
+      "require": "./dist/lib/report.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types/index.d.ts"
+      ],
+      "utils": [
+        "./dist/types/utils.d.ts"
+      ],
+      "ai-model": [
+        "./dist/types/ai-model.d.ts"
+      ],
+      "tree": [
+        "./dist/types/tree.d.ts"
+      ],
+      "device": [
+        "./dist/types/device.d.ts"
+      ],
+      "agent": [
+        "./dist/types/agent.d.ts"
+      ],
+      "yaml": [
+        "./dist/types/yaml.d.ts"
+      ]
+    }
+  },
+  "dependencies": {
+    "@anthropic-ai/sdk": "0.33.1",
+    "@azure/identity": "4.5.0",
+    "@ui-tars/action-parser": "1.2.3",
+    "dotenv": "^16.4.5",
+    "https-proxy-agent": "7.0.2",
+    "jsonrepair": "3.12.0",
+    "langsmith": "0.3.7",
+    "openai": "4.81.0",
+    "socks-proxy-agent": "8.0.4",
+    "zod": "3.24.3",
+    "semver": "7.5.2",
+    "js-yaml": "4.1.0",
+    "@sqaitech/recorder": "0.5.0",
+    "@sqaitech/shared": "0.5.0"
+  },
+  "devDependencies": {
+    "@rslib/core": "^0.11.2",
+    "@types/node": "^18.0.0",
+    "@types/node-fetch": "2.6.11",
+    "@types/js-yaml": "4.0.9",
+    "@types/semver": "7.7.0",
+    "typescript": "^5.8.3",
+    "vitest": "3.0.5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "license": "MIT",
+  "scripts": {
+    "dev": "npm run build:watch",
+    "build": "rslib build",
+    "build:watch": "USE_DEV_REPORT=1 rslib build --watch",
+    "test": "vitest --run",
+    "test:u": "vitest --run -u",
+    "test:ai": "AITEST=true npm run test",
+    "computer": "TEST_COMPUTER=true npm run test:ai -- tests/ai/evaluate/computer.test.ts",
+    "test:parse-action": "npm run test:ai -- tests/ai/parse-action.test.ts"
+  }
+}