fix(@wdio/types): add missing Appium Option type

jainam-bs · Dec 6, 2024 · 54fd52d · 54fd52d
1 parent be73313
commit 54fd52d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/packages/wdio-types/src/Capabilities.ts b/packages/wdio-types/src/Capabilities.ts
@@ -6,6 +6,11 @@ import type {
 
 type JSONLike = | { [property: string]: JSONLike } | readonly JSONLike[] | string | number | boolean | null
 
+// Type to remove 'appium:' prefix from property keys
+type RemoveAppiumPrefix<T> = {
+    [K in keyof T as K extends `appium:${infer R}` ? R : K]: T[K]
+}
+
 export type PageLoadingStrategy = 'none' | 'eager' | 'normal'
 export type LoggingPreferenceType =
     'OFF' | 'SEVERE' | 'WARNING' |
@@ -275,6 +280,8 @@ export interface WithRequestedMultiremoteCapabilities {
 export interface VendorExtensions extends EdgeCapabilities, AppiumCapabilities, WebdriverIOCapabilities,
     WebdriverIO.WDIOVSCodeServiceOptions, AppiumXCUITestCapabilities, AppiumAndroidCapabilities {
 
+    // Appium Options
+    'appium:options'?: AppiumOptions
     // Aerokube Selenoid specific
     'selenoid:options'?: SelenoidOptions
     // Aerokube Moon specific
@@ -326,6 +333,8 @@ export interface VendorExtensions extends EdgeCapabilities, AppiumCapabilities,
     'se:cdp'?: string
 }
 
+export type AppiumOptions = RemoveAppiumPrefix<AppiumCapabilities & AppiumXCUITestCapabilities & AppiumAndroidCapabilities>
+
 export interface WebdriverIOCapabilities {
     /**
      * process id of driver attached to given session

diff --git a/packages/webdriverio/src/utils/mobile.ts b/packages/webdriverio/src/utils/mobile.ts
@@ -1,6 +1,9 @@
 import type { Capabilities } from '@wdio/types'
 import type { PinchAndZoomOptions } from '../types.js'
 
+const appiumKeys = ['app', 'bundleId', 'appPackage', 'appActivity', 'appWaitActivity', 'appWaitPackage'] as const
+type AppiumKeysType = typeof appiumKeys[number]
+
 export function getNativeContext({ capabilities, isMobile }:
     { capabilities: WebdriverIO.Capabilities, isMobile: boolean }
 ): boolean {
@@ -9,8 +12,10 @@ export function getNativeContext({ capabilities, isMobile }:
     }
 
     const isAppiumAppCapPresent = (capabilities: Capabilities.RequestedStandaloneCapabilities) => {
-        const appiumKeys = ['app', 'bundleId', 'appPackage', 'appActivity', 'appWaitActivity', 'appWaitPackage']
-        return appiumKeys.some(key => (capabilities as Capabilities.AppiumCapabilities)[key as keyof Capabilities.AppiumCapabilities] !== undefined || capabilities['appium:options']?.[key] !== undefined)
+        return appiumKeys.some((key) => (
+            (capabilities as Capabilities.AppiumCapabilities)[key as keyof Capabilities.AppiumCapabilities] !== undefined ||
+            (capabilities as WebdriverIO.Capabilities)['appium:options']?.[key as AppiumKeysType] !== undefined)
+        )
     }
     const isBrowserNameFalse = !!capabilities?.browserName === false
     // @ts-expect-error