wuying-agentbay-sdk 0.10.2 → 0.12.0

package/docs/examples/mobile-use/mobile-get-adb-url/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "mobile-get-adb-url-example",
+  "version": "1.0.0",
+  "description": "Example demonstrating Mobile.getAdbUrl functionality",
+  "main": "index.ts",
+  "scripts": {
+    "start": "ts-node index.ts"
+  },
+  "dependencies": {
+    "@aliyun/wuying-agentbay-sdk": "file:../../../"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.0"
+  }
+}
+

package/docs/examples/mobile-use/mobile-simulate-basic-usage.ts

@@ -0,0 +1,202 @@
+/**
+ * Mobile Simulate Example
+ * 
+ * This example demonstrates how to use the mobile simulate feature to simulate
+ * different mobile devices across sessions.
+ */
+
+// @ts-nocheck
+import { AgentBay, Session, MobileSimulateService, MobileSimulateMode } from 'wuying-agentbay-sdk';
+import { readFileSync } from 'fs';
+import { join } from 'path';
+
+let session1: Session | null = null;
+let session2: Session | null = null;
+let mobileSimContextId: string | null = null;
+
+async function runOnFirstMobileSession(client: AgentBay): Promise<void> {
+  console.log('=== First Mobile Session ===');
+  
+  try {
+    // Upload mobile info file for first time
+    // How to get the mobile info file please contact the support team.
+    console.log('Uploading mobile info file for first time...');
+    
+    // Get the path to mobile_info_model_a.json
+    // Navigate from typescript/docs/examples/mobile-use/mobile-simulate-example to resource/
+    const mobileInfoFilePath = join(
+      __dirname,
+      '..',
+      '..',
+      '..',
+      '..',
+      'resource',
+      'mobile_info_model_a.json'
+    );
+    
+    // Read the mobile info file
+    const mobileInfoContent = readFileSync(mobileInfoFilePath, 'utf-8');
+    
+    // Upload mobile info
+    const simulateService = new MobileSimulateService(client);
+    simulateService.setSimulateEnable(true);
+    simulateService.setSimulateMode(MobileSimulateMode.PropertiesOnly);
+    const uploadResult = await simulateService.uploadMobileInfo(mobileInfoContent);
+    if (!uploadResult.success) {
+      throw new Error(`Failed to upload mobile info file: ${uploadResult.errorMessage}`);
+    }
+    
+    mobileSimContextId = uploadResult.mobileSimulateContextId!;
+    console.log(`Mobile simulate context id uploaded successfully: ${mobileSimContextId}`);
+    
+    // Create session with mobile simulate configuration
+    console.log('Creating first session...');
+    const sessionResult = await client.create({
+      imageId: 'mobile_latest',
+      extraConfigs: {
+        mobile: {
+          // Set mobile simulate config
+          simulateConfig: simulateService.getSimulateConfig(),
+        },
+      },
+    });
+    
+    if (!sessionResult.success || !sessionResult.session) {
+      throw new Error(`Failed to create session: ${sessionResult.errorMessage}`);
+    }
+    
+    session1 = sessionResult.session;
+    console.log(`Session created with ID: ${session1!.sessionId}`);
+    
+    // Wait for mobile simulate to complete
+    console.log('Waiting for mobile simulate to complete...');
+    await new Promise(resolve => setTimeout(resolve, 5000));
+    
+    // Get device model after mobile simulate
+    console.log('Getting device model after mobile simulate...');
+    const result = await session1!.command.executeCommand('getprop ro.product.model');
+    if (!result.success) {
+      throw new Error(`Failed to get device model: ${result.errorMessage}`);
+    }
+    
+    const productModel = result.output.trim();
+    console.log(`First session device model: ${productModel}`);
+    
+  } catch (error) {
+    throw new Error(`Error during run_on_first_mobile_session: ${error instanceof Error ? error.message : String(error)}`);
+  }
+}
+
+async function runOnSecondMobileSession(client: AgentBay): Promise<void> {
+  console.log('\n=== Second Mobile Session ===');
+  
+  try {
+    // Use the same mobile simulate context id as the first session
+    console.log('Creating second session...');
+    const simulateService = new MobileSimulateService(client);
+    simulateService.setSimulateEnable(true);
+    simulateService.setSimulateMode(MobileSimulateMode.PropertiesOnly);
+    simulateService.setSimulateContextId(mobileSimContextId!);
+    const sessionResult = await client.create({
+      imageId: 'mobile_latest',
+      extraConfigs: {
+        mobile: {
+          lockResolution: false,
+          // Set mobile simulate config
+          simulateConfig: simulateService.getSimulateConfig(),
+        },
+      },
+    });
+    
+    if (!sessionResult.success || !sessionResult.session) {
+      throw new Error(`Failed to create session: ${sessionResult.errorMessage}`);
+    }
+    
+    session2 = sessionResult.session;
+    console.log(`Session created with ID: ${session2!.sessionId}`);
+    
+    // Wait for mobile simulate to complete
+    console.log('Waiting for mobile simulate to complete...');
+    await new Promise(resolve => setTimeout(resolve, 5000));
+    
+    // Get device model after mobile simulate
+    console.log('Getting device model after mobile simulate...');
+    const result = await session2!.command.executeCommand('getprop ro.product.model');
+    if (!result.success) {
+      throw new Error(`Failed to get device model: ${result.errorMessage}`);
+    }
+    
+    const productModel = result.output.trim();
+    console.log(`Second session device model: ${productModel}`);
+    
+  } catch (error) {
+    throw new Error(`Error during run_on_second_mobile_session: ${error instanceof Error ? error.message : String(error)}`);
+  }
+}
+
+async function main() {
+  console.log('=== Mobile Simulate Example ===\n');
+  
+  // Get API key from environment variable
+  const apiKey = process.env.AGENTBAY_API_KEY;
+  if (!apiKey) {
+    console.error('Error: AGENTBAY_API_KEY environment variable is not set');
+    console.error('Please set it with: export AGENTBAY_API_KEY=your_api_key');
+    process.exit(1);
+  }
+  
+  // Initialize AgentBay client
+  const client = new AgentBay({ apiKey });
+  console.log('AgentBay client initialized');
+  
+  try {
+    // Run on first mobile session
+    await runOnFirstMobileSession(client);
+    
+    // Delete first session
+    console.log('\nDeleting first session...');
+    const deleteResult1 = await session1!.delete();
+    if (!deleteResult1.success) {
+      throw new Error(`Failed to delete first session: ${deleteResult1.errorMessage}`);
+    }
+    console.log(`First session deleted successfully (RequestID: ${deleteResult1.requestId})`);
+    
+    // Run on second mobile session
+    await runOnSecondMobileSession(client);
+    
+    // Delete second session
+    console.log('\nDeleting second session...');
+    const deleteResult2 = await session2!.delete();
+    if (!deleteResult2.success) {
+      throw new Error(`Failed to delete second session: ${deleteResult2.errorMessage}`);
+    }
+    console.log(`Second session deleted successfully (RequestID: ${deleteResult2.requestId})`);
+    
+    console.log('\n=== Example completed successfully ===');
+    
+  } catch (error) {
+    console.error('Error:', error instanceof Error ? error.message : String(error));
+    
+    // Cleanup sessions on error
+    if (session1) {
+      try {
+        await session1.delete();
+      } catch (e) {
+        console.warn('Warning: Failed to cleanup first session');
+      }
+    }
+    if (session2) {
+      try {
+        await session2.delete();
+      } catch (e) {
+        console.warn('Warning: Failed to cleanup second session');
+      }
+    }
+    
+    process.exit(1);
+  }
+}
+
+// Run the example
+main();
+

package/docs/examples/mobile-use/mobile-simulate-with-ctx.ts

@@ -0,0 +1,170 @@
+/**
+ * Mobile Simulate with User Specific Context Example
+ * 
+ * This example demonstrates how to use the mobile simulate feature with a user specific context 
+ * to simulate mobile devices across sessions.
+ * 
+ * Steps:
+ * 1. Get a user specific context
+ * 2. Check if the mobile dev info file exists in user's specific context, if not, get a mobile dev info file from DumpSDK or real device
+ * 3. Upload mobile dev info file to user's specific context
+ * 4. Create a session with mobile simulate configuration and user's specific context
+ * 5. Wait for mobile simulate to complete
+ * 6. Get device model after mobile simulate
+ * 7. Delete session
+ */
+
+// @ts-nocheck
+import { AgentBay, Session, MobileSimulateService, MobileSimulateMode, ContextSync, SyncPolicy, BWList, WhiteList } from 'wuying-agentbay-sdk';
+import { readFileSync } from 'fs';
+import { join } from 'path';
+
+let session: Session | null = null;
+
+async function runOnMobileSession(client: AgentBay): Promise<void> {
+  try {
+    console.log('Getting a user specific context...');
+    const contextResult = await client.context.get('13000000001', true);
+    if (!contextResult.success || !contextResult.context) {
+      throw new Error(`Failed to get context: ${contextResult.errorMessage}`);
+    }
+    
+    const context = contextResult.context;
+    console.log(`context.id = ${context.id}, context.name = ${context.name}`);
+    
+    // Create sync policy with white list
+    const syncPolicy: SyncPolicy = {
+      bwList: {
+        whiteLists: [
+          {
+            path: '/com.wuying.devinfo',
+            excludePaths: []
+          }
+        ]
+      }
+    };
+    
+    const contextSync: ContextSync = {
+      contextId: context.id,
+      path: '/data/data',
+      policy: syncPolicy
+    };
+    
+    console.log('Checking or uploading mobile dev info file...');
+
+    const simulateService = new MobileSimulateService(client);
+    simulateService.setSimulateEnable(true);
+    simulateService.setSimulateMode(MobileSimulateMode.PropertiesOnly);
+    
+    // Check if the mobile dev info file exists in user's specific context
+    const hasMobileInfo = await simulateService.hasMobileInfo(contextSync);
+    if (!hasMobileInfo) {
+      // If not, get a mobile dev info file from DumpSDK or real device
+      const mobileInfoFilePath = join(
+        __dirname,
+        '..',
+        '..',
+        '..',
+        '..',
+        'resource',
+        'mobile_info_model_a.json'
+      );
+      
+      const mobileInfoContent = readFileSync(mobileInfoFilePath, 'utf-8');
+      
+      const uploadResult = await simulateService.uploadMobileInfo(mobileInfoContent, contextSync);
+      if (!uploadResult.success) {
+        throw new Error(`Failed to upload mobile dev info: ${uploadResult.errorMessage}`);
+      }
+      console.log('Mobile dev info uploaded successfully');
+    } else {
+      console.log(`Mobile dev info already exists: ${hasMobileInfo}`);
+    }
+    
+    // Create session with mobile simulate configuration and user's specific context
+    console.log('Creating session...');
+    const sessionResult = await client.create({
+      imageId: 'mobile_latest',
+      contextSync: [contextSync],
+      extraConfigs: {
+        mobile: {
+          // Set mobile simulate config
+          simulateConfig: simulateService.getSimulateConfig(),
+        },
+      },
+    });
+    
+    if (!sessionResult.success || !sessionResult.session) {
+      throw new Error(`Failed to create session: ${sessionResult.errorMessage}`);
+    }
+    
+    session = sessionResult.session;
+    console.log(`Session created with ID: ${session.sessionId}`);
+    
+    // Wait for mobile simulate to complete
+    console.log('Waiting for mobile simulate to complete...');
+    await new Promise(resolve => setTimeout(resolve, 5000));
+    
+    // Get device model after mobile simulate
+    console.log('Getting device model after mobile simulate...');
+    const result = await session.command.executeCommand('getprop ro.product.model');
+    if (!result.success) {
+      throw new Error(`Failed to get device model: ${result.errorMessage}`);
+    }
+    
+    const productModel = result.output.trim();
+    console.log(`Session device model: ${productModel}`);
+    
+  } catch (error) {
+    throw new Error(`Error during runOnMobileSession: ${error instanceof Error ? error.message : String(error)}`);
+  }
+}
+
+async function main() {
+  console.log('=== Mobile Simulate with User Specific Context Example ===\n');
+  
+  // Get API key from environment variable
+  const apiKey = process.env.AGENTBAY_API_KEY;
+  if (!apiKey) {
+    console.error('Error: AGENTBAY_API_KEY environment variable is not set');
+    console.error('Please set it with: export AGENTBAY_API_KEY=your_api_key');
+    process.exit(1);
+  }
+  
+  // Initialize AgentBay client
+  const client = new AgentBay({ apiKey });
+  console.log('AgentBay client initialized');
+  
+  try {
+    // Run on mobile session
+    await runOnMobileSession(client);
+    
+    // Delete session
+    console.log('\nDeleting session...');
+    const deleteResult = await session!.delete({ syncContext: true });
+    if (!deleteResult.success) {
+      throw new Error(`Failed to delete session: ${deleteResult.errorMessage}`);
+    }
+    console.log(`Session deleted successfully (RequestID: ${deleteResult.requestId})`);
+    
+    console.log('\n=== Example completed successfully ===');
+    
+  } catch (error) {
+    console.error('Error:', error instanceof Error ? error.message : String(error));
+    
+    // Cleanup session on error
+    if (session) {
+      try {
+        await session.delete({ syncContext: true });
+      } catch (e) {
+        console.warn('Warning: Failed to cleanup session');
+      }
+    }
+    
+    process.exit(1);
+  }
+}
+
+// Run the example
+main();
+

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "wuying-agentbay-sdk",
-    "version": "0.10.2",
+    "version": "0.12.0",
     "description": "TypeScript SDK for interacting with the Wuying AgentBay cloud runtime environment",
     "main": "./dist/index.cjs",
     "module": "./dist/index.mjs",
@@ -13,15 +13,17 @@
         "./package.json": "./package.json"
     },
     "scripts": {
-        "build": "tsup src/index.ts --dts --format cjs,esm",
+        "build": "node scripts/run_with_fallback.js tsup tsup@8.5.0 src/index.ts --dts --format cjs,esm",
         "prepublishOnly": "npm run build",
-        "test": "jest",
-        "test:unit": "jest tests/unit",
-        "test:integration": "jest tests/integration",
-        "test:coverage": "jest --coverage",
-        "lint": "eslint src/**/*.ts",
-        "format": "prettier --write \"src/**/*.ts\"",
-        "prepare": "npm run build"
+        "test": "node scripts/run_with_fallback.js jest jest@26.6.3",
+        "test:unit": "node scripts/run_with_fallback.js jest jest@26.6.3 tests/unit",
+        "test:integration": "node scripts/run_with_fallback.js jest jest@26.6.3 tests/integration",
+        "test:coverage": "node scripts/run_with_fallback.js jest jest@26.6.3 --coverage",
+        "lint": "node scripts/run_with_fallback.js eslint eslint@8.35.0 \"src/**/*.ts\"",
+        "format": "node scripts/run_with_fallback.js prettier prettier@2.8.4 --write \"src/**/*.ts\"",
+        "prepare": "npm run build",
+        "docs:generate": "node scripts/generate_api_docs.js",
+        "examples:check": "node scripts/run_with_fallback.js tsc typescript@4.9.5 --project examples/tsconfig.json"
     },
     "author": "Wuying AI Team <wuying-ai-team@alibabacloud.com> (https://github.com/aliyun/wuying-agentbay-sdk)",
     "contributors": [
@@ -46,8 +48,9 @@
     "devDependencies": {
         "@types/chai": "^5.2.2",
         "@types/jest": "^26.0.24",
+        "@types/js-yaml": "^4.0.9",
         "@types/mocha": "^10.0.10",
-        "@types/node": "^18.15.0",
+        "@types/node": "^18.19.130",
         "@types/sinon": "^10.0.0",
         "@typescript-eslint/eslint-plugin": "^5.54.0",
         "@typescript-eslint/parser": "^5.54.0",
@@ -57,12 +60,15 @@
         "dotenv": "^16.5.0",
         "eslint": "^8.35.0",
         "jest": "^26.6.3",
+        "js-yaml": "^4.1.0",
         "prettier": "^2.8.4",
         "sinon": "^15.2.0",
         "ts-jest": "^26.5.6",
         "ts-node": "^10.9.2",
         "tsup": "^8.5.0",
-        "typescript": "^4.9.5"
+        "typedoc": "^0.25.0",
+        "typedoc-plugin-markdown": "^3.16.0",
+        "typescript": "4.9.5"
     },
     "dependencies": {
         "@alicloud/openapi-core": "^1.0.4",
@@ -74,7 +80,8 @@
     },
     "sideEffects": false,
     "files": [
-        "dist/**/*"
+        "dist/**/*",
+        "docs/**/*"
     ],
     "repository": {
         "type": "git",

package/dist/application-KZWXH46T.mjs

@@ -1,17 +0,0 @@
-
-        import { createRequire } from 'module';
-        const require = createRequire(import.meta.url);
-          (function() {
-            if (typeof OpenApi !== 'undefined' && !OpenApi.default) {
-              OpenApi.default = OpenApi;
-            }
-          })();
-        
-import {
-  Application
-} from "./chunk-BQNGKBQF.mjs";
-import "./chunk-KNEDRAP6.mjs";
-export {
-  Application
-};
-//# sourceMappingURL=application-KZWXH46T.mjs.map

package/dist/application-LMA7KSRH.cjs

@@ -1,8 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkX6MS7Z5Lcjs = require('./chunk-X6MS7Z5L.cjs');
-require('./chunk-4IPTHWLM.cjs');
-
-
-exports.Application = _chunkX6MS7Z5Lcjs.Application;
-//# sourceMappingURL=application-LMA7KSRH.cjs.map

package/dist/application-LMA7KSRH.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["/home/runner/work/wuying-agentbay-sdk/wuying-agentbay-sdk/typescript/dist/application-LMA7KSRH.cjs"],"names":[],"mappings":"AAAA;AACE;AACF,wDAA6B;AAC7B,gCAA6B;AAC7B;AACE;AACF,oDAAC","file":"/home/runner/work/wuying-agentbay-sdk/wuying-agentbay-sdk/typescript/dist/application-LMA7KSRH.cjs"}