feat: implement UTIO (UI-TARS Insights and Observation) (#60)

Author: ulivz

package.json

@@ -44,6 +44,7 @@
     "@electron-toolkit/utils": "^3.0.0",
     "@ui-tars/action-parser": "workspace:*",
     "@ui-tars/shared": "workspace:*",
+    "@ui-tars/utio": "workspace:*",
     "async-retry": "^1.3.3",
     "big.js": "^6.2.2",
     "dotenv": "^16.4.7",

packages/utio/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@ui-tars/utio",
+  "version": "1.0.0",
+  "description": "UTIO (UI-TARS Insights and Observation)",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "prepare": "npm run build",
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "prepack": "npm run build"
+  },
+  "keywords": [
+    "UI-TARS"
+  ],
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2"
+  }
+}

packages/utio/src/index.ts

@@ -0,0 +1,27 @@
+import { EventPayload, EventType } from './types';
+
+export type { EventPayload as UTIOPayload };
+
+export class UTIO {
+  constructor(private readonly endpoint: string) {}
+
+  async send<T extends EventType>(data: EventPayload<T>): Promise<void> {
+    if (!this.endpoint) return;
+
+    try {
+      const response = await fetch(this.endpoint, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify(data),
+      });
+
+      if (!response.ok) {
+        throw new Error(`UTIO upload failed with status: ${response.status}`);
+      }
+    } catch (error) {
+      // Silent fail
+    }
+  }
+}

packages/utio/src/types.ts

@@ -0,0 +1,61 @@
+/**
+ * Copyright (c) 2025 Bytedance, Inc. and its affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * Supported event types
+ */
+export type EventType = 'appLaunched' | 'sendInstruction' | 'shareReport';
+
+interface BaseEvent<T extends EventType> {
+  type: T;
+}
+
+/**
+ * Application launched event
+ */
+export interface AppLaunchedEvent extends BaseEvent<'appLaunched'> {
+  /** Platform type */
+  platform: string;
+  /** OS version in "major.minor.patch" format */
+  osVersion: string;
+  /** Screen width in pixels */
+  screenWidth: number;
+  /** Screen height in pixels */
+  screenHeight: number;
+}
+
+/**
+ * User-sent instruction event
+ */
+export interface SendInstructionEvent extends BaseEvent<'sendInstruction'> {
+  /** Instruction content */
+  instruction: string;
+}
+
+/**
+ * Report sharing event
+ */
+export interface ShareReportEvent extends BaseEvent<'shareReport'> {
+  /** Optional last screenshot path */
+  lastScreenshot?: string;
+  /** Optional report content */
+  report?: string;
+  /** Related instruction */
+  instruction: string;
+}
+
+/**
+ * Event type to payload mapping
+ */
+export type EventPayloadMap = {
+  appLaunched: AppLaunchedEvent;
+  sendInstruction: SendInstructionEvent;
+  shareReport: ShareReportEvent;
+};
+
+/**
+ * Utility type to extract payloads by event type
+ */
+export type EventPayload<T extends EventType> = EventPayloadMap[T];

packages/utio/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "Bundler",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

packages/utio/tsup.config.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) 2025 Bytedance, Inc. and its affiliates.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { defineConfig } from 'tsup';
+
+export default defineConfig((options) => {
+  return {
+    entry: ['src/**/*.ts'],
+    format: ['esm', 'cjs'],
+    dts: true,
+    clean: true,
+    bundle: false,
+    outDir: 'dist',
+  };
+});