gpt-driver-node 1.0.0-alpha.14 → 1.0.0-alpha.16

package/dist/index.cjs

@@ -26,7 +26,7 @@ class GptDriver {
   driver;
   appiumSessionStarted;
   useGptDriverCloud;
-  gptDriverCloudPlatform;
+  gptDriverCloudConfig;
   buildId;
   /**
    * Creates an instance of the GptDriver class.
@@ -55,7 +55,11 @@ class GptDriver {
       if (config.serverConfig?.device?.platform == null) {
         throw new Error("Platform is missing. Please specify the platform when using GPTDriver Cloud.");
       }
-      this.gptDriverCloudPlatform = config.serverConfig.device?.platform;
+      this.gptDriverCloudConfig = {
+        platform: config.serverConfig.device?.platform,
+        deviceName: config.serverConfig.device?.deviceName,
+        platformVersion: config.serverConfig.device?.platformVersion
+      };
     } else {
       this.initializeDriver(config);
       this.initializeAppiumConfig(config);
@@ -160,9 +164,9 @@ class GptDriver {
         api_key: this.apiKey,
         appium_session_id: this.appiumSessionConfig?.id,
         device_config: {
-          platform: this.appiumSessionConfig?.platform ?? this.gptDriverCloudPlatform,
-          device: this.appiumSessionConfig?.deviceName,
-          os: this.appiumSessionConfig?.platformVersion
+          platform: this.appiumSessionConfig?.platform ?? this.gptDriverCloudConfig?.platform,
+          device: this.appiumSessionConfig?.deviceName ?? this.gptDriverCloudConfig?.deviceName,
+          os: this.appiumSessionConfig?.platformVersion ?? this.gptDriverCloudConfig?.platformVersion
         },
         use_internal_virtual_device: this.useGptDriverCloud,
         build_id: this.buildId
@@ -404,6 +408,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;
@@ -29,7 +39,7 @@ declare class GptDriver {
     private driver?;
     private appiumSessionStarted?;
     private useGptDriverCloud?;
-    private gptDriverCloudPlatform?;
+    private gptDriverCloudConfig?;
     private buildId?;
     /**
      * Creates an instance of the GptDriver class.
@@ -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

@@ -24,7 +24,7 @@ class GptDriver {
   driver;
   appiumSessionStarted;
   useGptDriverCloud;
-  gptDriverCloudPlatform;
+  gptDriverCloudConfig;
   buildId;
   /**
    * Creates an instance of the GptDriver class.
@@ -53,7 +53,11 @@ class GptDriver {
       if (config.serverConfig?.device?.platform == null) {
         throw new Error("Platform is missing. Please specify the platform when using GPTDriver Cloud.");
       }
-      this.gptDriverCloudPlatform = config.serverConfig.device?.platform;
+      this.gptDriverCloudConfig = {
+        platform: config.serverConfig.device?.platform,
+        deviceName: config.serverConfig.device?.deviceName,
+        platformVersion: config.serverConfig.device?.platformVersion
+      };
     } else {
       this.initializeDriver(config);
       this.initializeAppiumConfig(config);
@@ -158,9 +162,9 @@ class GptDriver {
         api_key: this.apiKey,
         appium_session_id: this.appiumSessionConfig?.id,
         device_config: {
-          platform: this.appiumSessionConfig?.platform ?? this.gptDriverCloudPlatform,
-          device: this.appiumSessionConfig?.deviceName,
-          os: this.appiumSessionConfig?.platformVersion
+          platform: this.appiumSessionConfig?.platform ?? this.gptDriverCloudConfig?.platform,
+          device: this.appiumSessionConfig?.deviceName ?? this.gptDriverCloudConfig?.deviceName,
+          os: this.appiumSessionConfig?.platformVersion ?? this.gptDriverCloudConfig?.platformVersion
         },
         use_internal_virtual_device: this.useGptDriverCloud,
         build_id: this.buildId
@@ -402,6 +406,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.14",
+  "version": "1.0.0-alpha.16",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",