gpt-driver-node 1.0.0-alpha.13 → 1.0.0-alpha.15

package/dist/index.cjs

@@ -1,6 +1,7 @@
 'use strict';
 
 var axios = require('axios');
+var webdriverio = require('webdriverio');
 var sharp = require('sharp');
 
 const delay = async (milliseconds) => {
@@ -168,6 +169,17 @@ class GptDriver {
       }
     );
     this.gptDriverSessionId = response.data.sessionId;
+    if (this.useGptDriverCloud) {
+      const parsedUrl = new URL(response.data.appiumServerUrl);
+      this.driver = await webdriverio.attach({
+        options: {
+          hostname: parsedUrl.hostname,
+          path: parsedUrl.pathname
+        },
+        sessionId: response.data.appiumSessionId
+      });
+      this.appiumSessionStarted = true;
+    }
   }
   getSessionLink() {
     return `https://app.mobileboost.io/gpt-driver/sessions/${this.gptDriverSessionId}`;
@@ -392,6 +404,37 @@ class GptDriver {
       throw e;
     }
   }
+  /**
+   * Opens a deep link url in the Appium session.
+   *
+   * This method sends a request to the GPT Driver server to open a deep link url in the Appium session.
+   *
+   * @param {OpenDeepLinkUrlParams} params - The parameters for opening the deep link url.
+   * @returns {Promise<void>} A promise that resolves when the deep link url is opened.
+   */
+  async openDeepLinkUrl(params) {
+    if (!this.appiumSessionStarted) {
+      await this.startSession();
+    }
+    console.log("Opening deep link", params);
+    if (params.package == null && this.appiumSessionConfig?.platform === "Android") {
+      throw new Error("Package is required for Android platform");
+    }
+    await this.executeCommand(
+      {
+        url: `http://localhost:4723/session/${this.appiumSessionConfig?.id}/execute/sync`,
+        method: "POST",
+        data: {
+          "script": "mobile:deepLink",
+          "args": [{
+            url: params.url,
+            ...params.bundleId && { bundleId: params.bundleId },
+            ...params.package && { package: params.package }
+          }]
+        }
+      }
+    );
+  }
   async executeCommand(command) {
     const firstAction = command?.data?.actions?.at(0);
     if (firstAction?.type === "pause" && firstAction.duration != null) {

package/dist/index.d.cts

@@ -20,6 +20,16 @@ interface GptDriverConfig {
     useGptDriverCloud?: boolean;
     buildId?: string;
 }
+/**
+ * Parameters for opening a deep link url in the Appium session.
+ * Provide a package if the platform is Android.
+ * Provide a bundleId if the platform is iOS.
+ */
+interface OpenDeepLinkUrlParams {
+    url: string;
+    package?: string;
+    bundleId?: string;
+}
 
 declare class GptDriver {
     private apiKey;
@@ -132,6 +142,15 @@ declare class GptDriver {
      */
     extract(extractions: string[]): Promise<any>;
     private gptHandler;
+    /**
+     * Opens a deep link url in the Appium session.
+     *
+     * This method sends a request to the GPT Driver server to open a deep link url in the Appium session.
+     *
+     * @param {OpenDeepLinkUrlParams} params - The parameters for opening the deep link url.
+     * @returns {Promise<void>} A promise that resolves when the deep link url is opened.
+     */
+    openDeepLinkUrl(params: OpenDeepLinkUrlParams): Promise<void>;
     private executeCommand;
     private getScreenshot;
 }

package/dist/index.mjs

@@ -1,4 +1,5 @@
 import axios from 'axios';
+import { attach } from 'webdriverio';
 import sharp from 'sharp';
 
 const delay = async (milliseconds) => {
@@ -166,6 +167,17 @@ class GptDriver {
       }
     );
     this.gptDriverSessionId = response.data.sessionId;
+    if (this.useGptDriverCloud) {
+      const parsedUrl = new URL(response.data.appiumServerUrl);
+      this.driver = await attach({
+        options: {
+          hostname: parsedUrl.hostname,
+          path: parsedUrl.pathname
+        },
+        sessionId: response.data.appiumSessionId
+      });
+      this.appiumSessionStarted = true;
+    }
   }
   getSessionLink() {
     return `https://app.mobileboost.io/gpt-driver/sessions/${this.gptDriverSessionId}`;
@@ -390,6 +402,37 @@ class GptDriver {
       throw e;
     }
   }
+  /**
+   * Opens a deep link url in the Appium session.
+   *
+   * This method sends a request to the GPT Driver server to open a deep link url in the Appium session.
+   *
+   * @param {OpenDeepLinkUrlParams} params - The parameters for opening the deep link url.
+   * @returns {Promise<void>} A promise that resolves when the deep link url is opened.
+   */
+  async openDeepLinkUrl(params) {
+    if (!this.appiumSessionStarted) {
+      await this.startSession();
+    }
+    console.log("Opening deep link", params);
+    if (params.package == null && this.appiumSessionConfig?.platform === "Android") {
+      throw new Error("Package is required for Android platform");
+    }
+    await this.executeCommand(
+      {
+        url: `http://localhost:4723/session/${this.appiumSessionConfig?.id}/execute/sync`,
+        method: "POST",
+        data: {
+          "script": "mobile:deepLink",
+          "args": [{
+            url: params.url,
+            ...params.bundleId && { bundleId: params.bundleId },
+            ...params.package && { package: params.package }
+          }]
+        }
+      }
+    );
+  }
   async executeCommand(command) {
     const firstAction = command?.data?.actions?.at(0);
     if (firstAction?.type === "pause" && firstAction.duration != null) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gpt-driver-node",
-  "version": "1.0.0-alpha.13",
+  "version": "1.0.0-alpha.15",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",