@wdio/appium-service 8.15.6 → 8.15.8

package/README.md

@@ -85,10 +85,10 @@ export const config = {
 ### args
 Map of arguments for the Appium server, passed directly to `appium`.
 
-See [the documentation](https://appium.github.io/appium.io/docs/en/writing-running-appium/server-args/index.html) for possible arguments.
-The arguments should be supplied in lower camel case, so `--pre-launch true` becomes `preLaunch: true` or passed as an array.
+See [the documentation](https://github.com/appium/appium/blob/master/packages/appium/docs/en/cli/args.md) for possible arguments.
+The arguments are supplied in lower camel case. For instance, `debugLogSpacing: true` transforms into `--debug-log-spacing`, or they can be supplied as outlined in the Appium documentation.
 
-Type: `Object` or `Array`
+Type: `Object`
 
 Default: `{}`
 
@@ -101,16 +101,15 @@ export const config = {
             args: {
                 // ...
                 debugLogSpacing: true,
-                platformName: 'iOS',
+                platformName: 'iOS'
                 // ...
             }
-            // or
-            // args: ['-p', '4722', '--relaxed-security', '--log-level', 'info:info']
         }]
     ],
     // ...
 }
 ```
+**Note:** The utilization of aliases is discouraged and unsupported. Instead, please use the full property name in lower camel case.
 
 ----
 

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAGlE,OAAO,KAAK,EAAyB,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAY5E,MAAM,CAAC,OAAO,OAAO,cAAe,YAAW,QAAQ,CAAC,eAAe;IAO/D,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO,CAAC;IARpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAQ;IAClC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAe;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuB;IAC7C,OAAO,CAAC,QAAQ,CAAC,CAA+C;gBAGpD,QAAQ,EAAE,mBAAmB,EAC7B,aAAa,EAAE,YAAY,CAAC,kBAAkB,EAC9C,OAAO,CAAC,gCAAoB;YAS1B,WAAW;IAqBzB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAgDlB,SAAS;IAkBf,UAAU;IAOV,OAAO,CAAC,YAAY;YA2BN,kBAAkB;mBAeX,iBAAiB;CAezC"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAGlE,OAAO,KAAK,EAAyB,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAY5E,MAAM,CAAC,OAAO,OAAO,cAAe,YAAW,QAAQ,CAAC,eAAe;IAO/D,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO,CAAC;IARpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAQ;IAClC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAe;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuB;IAC7C,OAAO,CAAC,QAAQ,CAAC,CAA+C;gBAGpD,QAAQ,EAAE,mBAAmB,EAC7B,aAAa,EAAE,YAAY,CAAC,kBAAkB,EAC9C,OAAO,CAAC,gCAAoB;YAS1B,WAAW;IAqBzB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAgDlB,SAAS;IAyBf,UAAU;IAOV,OAAO,CAAC,YAAY;YA2BN,kBAAkB;mBAeX,iBAAiB;CAezC"}

package/build/launcher.js

@@ -85,6 +85,13 @@ export default class AppiumLauncher {
         });
     }
     async onPrepare() {
+        /**
+         * Throws an error if `this._options.args` is defined and is an array.
+         * @throws {Error} If `this._options.args` is an array.
+         */
+        if (Array.isArray(this._options.args)) {
+            throw new Error('Args should be an object');
+        }
         /**
          * Append remaining arguments
          */

package/build/types.d.ts

@@ -1,10 +1,112 @@
 export type AppiumServerArguments = {
-    [capability: string]: any;
+    /**
+     * Hostname to listen on
+     */
+    address?: string;
+    /**
+     * Allow web browser connections from any host
+     */
+    allowCors?: boolean;
+    /**
+     * Comma-separated list of insecure features which are allowed to run in server session
+     */
+    allowInsecure?: string;
+    /**
+     * Base path to use as the prefix for all webdriver routes running on the server
+     */
+    basePath?: string;
+    /**
+     * Callback IP address
+     */
+    callbackAddress?: string;
+    /**
+     * Callback Port
+     */
+    callbackPort?: number | string;
+    /**
+     * Add exaggerated spacing in logs
+     */
+    debugLogSpacing?: boolean;
+    /**
+     * Default desired capabilities, which will be added to each session unless overridden by received capabilities
+     */
+    defaultCapabilities?: object;
+    /**
+     * Comma-separated list of insecure features which are not allowed to run in server session
+     */
+    denyInsecure?: string;
+    /**
+     * Number of seconds the server applies as both the keep-alive timeout and the connection timeout for all requests
+     */
+    keepAliveTimeout?: number | string;
+    /**
+     * Use local timezone for timestamps
+     */
+    localTimezone?: boolean;
+    /**
+     * Send log output to the file
+     */
+    log?: string;
+    /**
+     * Log level
+     */
+    logLevel?: string;
+    /**
+     * Use color in console output
+     */
+    logNoColors?: boolean;
+    /**
+     * Show timestamps in console output
+     */
+    logTimestamp?: boolean;
+    /**
+     * Add long stack traces to log entries
+     */
+    longStacktrace?: boolean;
+    /**
+     * Do not check that needed files are readable and/or writable
+     */
+    noPermsCheck?: boolean;
+    /**
+     * Path to configuration JSON file or the configuration itself
+     */
+    nodeconfig?: string | object;
     /**
      * Port to listen on
      */
     port?: number | string;
-    basePath?: string;
+    /**
+     * Disable additional security checks
+     */
+    relaxedSecurity?: boolean;
+    /**
+     * Enables session override (clobbering)
+     */
+    sessionOverride?: boolean;
+    /**
+     * Trigger session failures when provided desired capabilities are not recognized as valid
+     */
+    strictCaps?: boolean;
+    /**
+     * Absolute path to directory used for managing temporary files
+     */
+    tmp?: string;
+    /**
+     * Absolute path to directory used to save iOS instrument traces
+     */
+    traceDir?: string;
+    /**
+     * Comma-separated list of drivers to activate
+     */
+    useDrivers?: string;
+    /**
+     * Comma-separated list of plugins to activate
+     */
+    usePlugins?: string;
+    /**
+     * Directs the log output to the listener
+     */
+    webhook?: string;
 };
 export interface AppiumSessionCapabilities {
     /**
@@ -29,9 +131,9 @@ export interface AppiumServiceConfig {
      * Map of arguments for the Appium server, passed directly to `appium`.
      * @default {}
      */
-    args?: AppiumServerArguments | Array<string>;
+    args?: AppiumServerArguments;
 }
-export type ArgValue = string | number | boolean | null;
+export type ArgValue = string | number | boolean | null | object;
 export type KeyValueArgs = {
     [key: string]: ArgValue;
 };

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAAG;IAChC,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,CAAA;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,qBAAqB,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;CAC/C;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;AACvD,MAAM,MAAM,YAAY,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;CAAE,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAAG;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAClC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,WAAW,yBAAyB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,qBAAqB,CAAA;CAC/B;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,CAAA;AAChE,MAAM,MAAM,YAAY,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;CAAE,CAAA"}

package/build/utils.d.ts

@@ -6,7 +6,7 @@ import type { ArgValue, KeyValueArgs } from './types.js';
  * @return {String}                 absolute file path
  */
 export declare function getFilePath(filePath: string, defaultFilename: string): string;
-export declare function formatCliArgs(args: KeyValueArgs | ArgValue[]): string[];
+export declare function formatCliArgs(args: KeyValueArgs): string[];
 export declare function sanitizeCliOptionValue(value: ArgValue): string;
 export declare function isWindows(): boolean;
 //# sourceMappingURL=utils.d.ts.map

package/build/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAIxD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM,CAU9E;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,YAAY,GAAG,QAAQ,EAAE,GAAG,MAAM,EAAE,CAoBvE;AAED,wBAAgB,sBAAsB,CAAE,KAAK,EAAE,QAAQ,UAItD;AAED,wBAAgB,SAAS,IAAI,OAAO,CAEnC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAIxD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM,CAU9E;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,EAAE,CAgB1D;AAED,wBAAgB,sBAAsB,CAAE,KAAK,EAAE,QAAQ,UAItD;AAED,wBAAgB,SAAS,IAAI,OAAO,CAEnC"}

package/build/utils.js

@@ -17,9 +17,6 @@ export function getFilePath(filePath, defaultFilename) {
     return absolutePath;
 }
 export function formatCliArgs(args) {
-    if (Array.isArray(args)) {
-        return args.map(arg => sanitizeCliOptionValue(arg));
-    }
     const cliArgs = [];
     for (const key in args) {
         const value = args[key];
@@ -36,7 +33,7 @@ export function formatCliArgs(args) {
     return cliArgs;
 }
 export function sanitizeCliOptionValue(value) {
-    const valueString = String(value);
+    const valueString = typeof value === 'object' ? JSON.stringify(value) : String(value);
     // Encapsulate the value string in single quotes if it contains a white space
     return /\s/.test(valueString) ? `'${valueString}'` : valueString;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/appium-service",
-  "version": "8.15.6",
+  "version": "8.15.8",
   "description": "A WebdriverIO service to start & stop Appium Server",
   "author": "Morten Bjerg Gregersen <morten@mogee.dk>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-appium-service",
@@ -33,15 +33,15 @@
   },
   "typeScriptVersion": "3.8.3",
   "dependencies": {
-    "@wdio/config": "8.15.6",
+    "@wdio/config": "8.15.8",
     "@wdio/logger": "8.11.0",
-    "@wdio/types": "8.15.0",
+    "@wdio/types": "8.15.7",
     "import-meta-resolve": "^3.0.0",
     "param-case": "^3.0.4",
-    "webdriverio": "8.15.6"
+    "webdriverio": "8.15.8"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c205398c7773823b1eb365a5abeadbcc2fb6b8a3"
+  "gitHead": "ed14f208c4a88e2caae4e001c642ee9272fac52c"
 }