@appium/types 0.4.1 → 0.5.0

package/build/action.js

@@ -0,0 +1,84 @@
+"use strict";
+/**
+ * @module
+ * Portions Copyright (c) 2017 Igor Muchychka
+ * @see https://github.com/w3c-webdriver/w3c-webdriver
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Key = void 0;
+/**
+ * @group Actions
+ */
+var Key;
+(function (Key) {
+    Key["NULL"] = "\uE000";
+    Key["CANCEL"] = "\uE001";
+    Key["HELP"] = "\uE002";
+    Key["BACKSPACE"] = "\uE003";
+    Key["TAB"] = "\uE004";
+    Key["CLEAR"] = "\uE005";
+    Key["RETURN"] = "\uE006";
+    Key["ENTER"] = "\uE007";
+    Key["SHIFT"] = "\uE008";
+    Key["CONTROL"] = "\uE009";
+    Key["ALT"] = "\uE00A";
+    Key["PAUSE"] = "\uE00B";
+    Key["ESCAPE"] = "\uE00C";
+    Key["SPACE"] = "\uE00D";
+    Key["PAGE_UP"] = "\uE00E";
+    Key["PAGE_DOWN"] = "\uE00F";
+    Key["END"] = "\uE010";
+    Key["HOME"] = "\uE011";
+    Key["LEFT"] = "\uE012";
+    Key["UP"] = "\uE013";
+    Key["RIGHT"] = "\uE014";
+    Key["DOWN"] = "\uE015";
+    Key["INSERT"] = "\uE016";
+    Key["DELETE"] = "\uE017";
+    Key["SEMICOLON"] = "\uE018";
+    Key["EQUALS"] = "\uE019";
+    Key["NUMPAD0"] = "\uE01A";
+    Key["NUMPAD1"] = "\uE01B";
+    Key["NUMPAD2"] = "\uE01C";
+    Key["NUMPAD3"] = "\uE01D";
+    Key["NUMPAD4"] = "\uE01E";
+    Key["NUMPAD5"] = "\uE01F";
+    Key["NUMPAD6"] = "\uE020";
+    Key["NUMPAD7"] = "\uE021";
+    Key["NUMPAD8"] = "\uE022";
+    Key["NUMPAD9"] = "\uE023";
+    Key["MULTIPLY"] = "\uE024";
+    Key["ADD"] = "\uE025";
+    Key["SEPARATOR"] = "\uE026";
+    Key["SUBTRACT"] = "\uE027";
+    Key["DECIMAL"] = "\uE028";
+    Key["DIVIDE"] = "\uE029";
+    Key["F1"] = "\uE031";
+    Key["F2"] = "\uE032";
+    Key["F3"] = "\uE033";
+    Key["F4"] = "\uE034";
+    Key["F5"] = "\uE035";
+    Key["F6"] = "\uE036";
+    Key["F7"] = "\uE037";
+    Key["F8"] = "\uE038";
+    Key["F9"] = "\uE039";
+    Key["F10"] = "\uE03A";
+    Key["F11"] = "\uE03B";
+    Key["F12"] = "\uE03C";
+    Key["META"] = "\uE03D";
+    Key["ZENKAKUHANKAKU"] = "\uE040";
+    Key["R_SHIFT"] = "\uE050";
+    Key["R_CONTROL"] = "\uE051";
+    Key["R_ALT"] = "\uE052";
+    Key["R_META"] = "\uE053";
+    Key["R_PAGEUP"] = "\uE054";
+    Key["R_PAGEDOWN"] = "\uE055";
+    Key["R_END"] = "\uE056";
+    Key["R_HOME"] = "\uE057";
+    Key["R_ARROWLEFT"] = "\uE058";
+    Key["R_ARROWUP"] = "\uE059";
+    Key["R_ARROWRIGHT"] = "\uE05A";
+    Key["R_ARROWDOWN"] = "\uE05B";
+    Key["R_INSERT"] = "\uE05C";
+    Key["R_DELETE"] = "\uE05D";
+})(Key = exports.Key || (exports.Key = {}));

package/build/appium-config.js

@@ -0,0 +1,8 @@
+"use strict";
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/capabilities.d.ts

@@ -1,47 +1,126 @@
 import type { Capabilities as WdioCaps } from '@wdio/types';
+import { StringRecord, Constraint, Constraints } from '.';
+import { BaseDriverCapConstraints } from './constraints';
+export declare type StandardCapabilities = WdioCaps.Capabilities;
+export declare type W3C_APPIUM_PREFIX = 'appium';
 /**
- * The mask of a W3C-style namespaced capability proped name.
+ * Base capabilities as derived from {@linkcode BaseDriverCapConstraints}.
  */
-declare type Namespaced = `${string}:${string}`;
+export declare type BaseCapabilities = ConstraintsToCaps<BaseDriverCapConstraints>;
 /**
- * An object with keys conforming to {@linkcode Namespaced}.
+ * Like {@linkcode BaseCapabilities}, except all Appium-specific keys are namespaced.
  */
-declare type NamespacedRecord = Record<Namespaced, any>;
+export declare type BaseNSCapabilities = CapsToNSCaps<ConstraintsToCaps<BaseDriverCapConstraints>>;
 /**
- * An object with keys for strings.
+ * These may (or should) be reused by drivers.
  */
-declare type StringRecord = Record<string, any>;
+export declare type AppiumAndroidCapabilities = WdioCaps.AppiumAndroidCapabilities;
+export declare type AppiumIOSCapabilities = WdioCaps.AppiumIOSCapabilities;
+export declare type AppiumXCUICommandTimeouts = WdioCaps.AppiumXCUICommandTimeouts;
+export declare type AppiumXCUIProcessArguments = WdioCaps.AppiumXCUIProcessArguments;
+export declare type AppiumXCUISafariGlobalPreferences = WdioCaps.AppiumXCUISafariGlobalPreferences;
+export declare type AppiumXCUITestCapabilities = WdioCaps.AppiumXCUITestCapabilities;
 /**
- * All known capabilities derived from wdio's {@linkcode WdioCaps.Capabilities Capabilities} type, accepting additional optional caps.
- * All properties are optional.
+ * Given a {@linkcode Constraint} `C` and a type `T`, see if `inclusion`/`inclusionCaseInsensitive` is present, and create a union of its allowed literals; otherwise just use `T`.
  */
-declare type BaseCapabilities<OptionalCaps extends StringRecord = StringRecord> = Partial<WdioCaps.Capabilities & OptionalCaps>;
+declare type ConstraintChoice<C extends Constraint, T> = C['inclusionCaseInsensitive'] extends ReadonlyArray<T> ? AnyCase<C['inclusionCaseInsensitive'][number]> : C['inclusion'] extends ReadonlyArray<T> ? C['inclusion'][number] : T;
 /**
- * All known capabilities derived from wdio's {@linkcode WdioCaps.Capabilities Capabilities} type and wdio's {@linkcode WdioCaps.AppiumCapabilities} type, accepting additional optional caps.
+ * Given {@linkcode Constraint} `C`, determine the associated type of the capability.
+ *
+ * Notes:
  *
- * In practice, the properties `platformName` and `automationName` are required by Appium.
+ * - Only `number` and `string` values can have "choices" (`inclusion`/`inclusionCaseInesnsitive`) associated with them.
+ * - If `isArray` is `true`, the type is always of type `string[]`. If this is incorrect, then it will be `any[]`.
+ * - There is no way to express the shape of an object if `ifObject` is `true`.
  */
-export declare type Capabilities<OptionalCaps extends StringRecord = StringRecord> = BaseCapabilities<WdioCaps.AppiumCapabilities & OptionalCaps>;
+declare type ConstraintToCapKind<C extends Constraint> = C['isString'] extends true ? ConstraintChoice<C, string> : C['isNumber'] extends true ? ConstraintChoice<C, number> : C['isBoolean'] extends true ? boolean : C['isArray'] extends true ? string[] : C['isObject'] extends true ? object : any;
 /**
- * All known capabilities derived from wdio's {@linkcode WdioCaps.Capabilities Capabilities} type and wdio's {@linkcode WdioCaps.AppiumW3CCapabilities} type, accepting additional optional _namespaced_ caps.
+ * Given {@linkcode Constraint} `C`, determine if it is required or optional.
+ *
+ * In practice, _all_ capabilities are considered optional per types, but various errors might be thrown if some are not present.
  */
-export declare type AppiumW3CCapabilities<OptionalNamespacedCaps extends NamespacedRecord = NamespacedRecord> = BaseCapabilities<WdioCaps.AppiumW3CCapabilities & OptionalNamespacedCaps>;
+export declare type ConstraintToCap<C extends Constraint> = C['presence'] extends true | {
+    allowEmpty: boolean;
+} ? ConstraintToCapKind<C> : ConstraintToCapKind<C> | undefined;
 /**
- * All known capabilities derived from wdio's {@linkcode WdioCaps.Capabilities Capabilities} type and wdio's {@linkcode WdioCaps.AppiumW3Capabilities} type, accepting additional optional _namespaced_ caps, in W3C-compatible format (`alwaysMatch`/`firstMatch`).
- * In practice, the properties `appium:platformName` and `appium:automationName` are required by Appium _somewhere_ in this object; this cannot be expressed in TypeScript.
+ * Given `string` `T`, this is a case-insensitive version of `T`.
  */
-export declare type W3CCapabilities<OptionalNamespacedCaps extends NamespacedRecord = NamespacedRecord> = {
-    alwaysMatch: AppiumW3CCapabilities<OptionalNamespacedCaps>;
-    firstMatch: AppiumW3CCapabilities<OptionalNamespacedCaps>[];
+export declare type AnyCase<T extends string> = string extends T ? string : T extends `${infer F1}${infer F2}${infer R}` ? `${Uppercase<F1> | Lowercase<F1>}${Uppercase<F2> | Lowercase<F2>}${AnyCase<R>}` : T extends `${infer F}${infer R}` ? `${Uppercase<F> | Lowercase<F>}${AnyCase<R>}` : '';
+/**
+ * Given {@linkcode StringRecord} `T` and namespace string `NS`, a type with the key names prefixed by `${NS}:` _except_ for standard capabilities.  `NS` defaults to `appium`.
+ *
+ * If `T` is already namespaced, well, it'll get _double_-namespaced.
+ */
+export declare type CapsToNSCaps<T extends StringRecord, NS extends string = W3C_APPIUM_PREFIX> = {
+    [K in keyof T as K extends keyof StandardCapabilities ? K : NamespacedString<K & string, NS>]: T[K];
 };
+export declare type NamespacedString<S extends string, NS extends string = W3C_APPIUM_PREFIX> = `${NS}:${S}`;
 /**
- * These may (or should) be reused by drivers.
+ * Converts {@linkcode Constraint} `C` to a {@linkcode Capabilities} object.
  */
-export declare type AppiumAndroidCapabilities = WdioCaps.AppiumAndroidCapabilities;
-export declare type AppiumIOSCapabilities = WdioCaps.AppiumIOSCapabilities;
-export declare type AppiumXCUICommandTimeouts = WdioCaps.AppiumXCUICommandTimeouts;
-export declare type AppiumXCUIProcessArguments = WdioCaps.AppiumXCUIProcessArguments;
-export declare type AppiumXCUISafariGlobalPreferences = WdioCaps.AppiumXCUISafariGlobalPreferences;
-export declare type AppiumXCUITestCapabilities = WdioCaps.AppiumXCUITestCapabilities;
+export declare type ConstraintsToCaps<C extends Constraints> = {
+    -readonly [K in keyof C]: ConstraintToCap<C[K]>;
+};
+/**
+ * Given some constraints, return the entire set of supported capabilities it supports (including whatever is in its desired caps).
+ *
+ * Does not contain {@linkcode BaseCapabilities}; see {@linkcode DriverCaps}.
+ */
+export declare type Capabilities<C extends Constraints = BaseDriverCapConstraints, Extra extends StringRecord | void = void> = Partial<ConstraintsToCaps<C> & Extra>;
+/**
+ * Like {@linkcode Capabilities}, except W3C-style.
+ *
+ * Does not contain {@linkcode BaseCapabilities}; see {@linkcode W3CDriverCaps}.
+ */
+export declare type W3CCapabilities<C extends Constraints = BaseDriverCapConstraints, Extra extends StringRecord | void = void> = {
+    alwaysMatch: NSCapabilities<C, Extra>;
+    firstMatch: NSCapabilities<C, Extra>[];
+};
+/**
+ * Namespaced caps (where appropriate).
+ *
+ * Does not contain {@linkcode BaseCapabilities}; see {@linkcode NSDriverCaps}.
+ */
+export declare type NSCapabilities<C extends Constraints = BaseDriverCapConstraints, Extra extends StringRecord | void = void, NS extends string = W3C_APPIUM_PREFIX> = Partial<CapsToNSCaps<ConstraintsToCaps<C> & Extra, NS>>;
+/**
+ * Capabilities for drivers extending `BaseDriver`.
+ *
+ * Includes {@linkcode BaseCapabilities}.
+ *
+ * @example
+ * ```ts
+ * class MyDriver extends BaseDriver {
+ *   async createSession (w3ccaps: W3CDriverCaps<MyDriverConstraints>, ...args: any[]) {
+ *     const [
+ *       sessionId: string,
+ *       caps: DriverCaps<MyDriverConstraints>
+ *     ] = await super.createSession(w3ccaps, ...args);
+ *     // ...
+ *   }
+ * }
+ * ```
+ */
+export declare type DriverCaps<C extends Constraints, Extra extends StringRecord | void = void> = Capabilities<BaseDriverCapConstraints & C, Extra>;
+/**
+ * W3C-style capabilities for drivers extending `BaseDriver`.
+ *
+ * Includes {@linkcode BaseCapabilities}.
+ *
+ * @example
+ * ```ts
+ * class MyDriver extends BaseDriver {
+ *   async createSession (w3ccaps: W3CDriverCaps<MyDriverConstraints>, ...args: any[]) {
+ *     // ...
+ *   }
+ * }
+ * ```
+ */
+export declare type W3CDriverCaps<C extends Constraints, Extra extends StringRecord | void = void> = W3CCapabilities<BaseDriverCapConstraints & C, Extra>;
+/**
+ * Namespaced capabilities for drivers extending `BaseDriver`.
+ *
+ * Includes {@linkcode BaseCapabilities}.
+ */
+export declare type NSDriverCaps<C extends Constraints, Extra extends StringRecord | void = void> = NSCapabilities<BaseDriverCapConstraints & C, Extra>;
 export {};
 //# sourceMappingURL=capabilities.d.ts.map

package/build/capabilities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../lib/capabilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,IAAI,QAAQ,EAAC,MAAM,aAAa,CAAC;AAE1D;;GAEG;AACH,aAAK,UAAU,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAExC;;GAEG;AACH,aAAK,gBAAgB,GAAG,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;AAEhD;;GAEG;AACH,aAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAExC;;;GAGG;AACH,aAAK,gBAAgB,CAAC,YAAY,SAAS,YAAY,GAAG,YAAY,IAAI,OAAO,CAC/E,QAAQ,CAAC,YAAY,GAAG,YAAY,CACrC,CAAC;AAEF;;;;GAIG;AACH,oBAAY,YAAY,CAAC,YAAY,SAAS,YAAY,GAAG,YAAY,IAAI,gBAAgB,CAC3F,QAAQ,CAAC,kBAAkB,GAAG,YAAY,CAC3C,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,CAC/B,sBAAsB,SAAS,gBAAgB,GAAG,gBAAgB,IAChE,gBAAgB,CAAC,QAAQ,CAAC,qBAAqB,GAAG,sBAAsB,CAAC,CAAC;AAE9E;;;GAGG;AACH,oBAAY,eAAe,CAAC,sBAAsB,SAAS,gBAAgB,GAAG,gBAAgB,IAAI;IAChG,WAAW,EAAE,qBAAqB,CAAC,sBAAsB,CAAC,CAAC;IAC3D,UAAU,EAAE,qBAAqB,CAAC,sBAAsB,CAAC,EAAE,CAAC;CAC7D,CAAC;AAEF;;GAEG;AACH,oBAAY,yBAAyB,GAAG,QAAQ,CAAC,yBAAyB,CAAC;AAC3E,oBAAY,qBAAqB,GAAG,QAAQ,CAAC,qBAAqB,CAAC;AACnE,oBAAY,yBAAyB,GAAG,QAAQ,CAAC,yBAAyB,CAAC;AAC3E,oBAAY,0BAA0B,GAAG,QAAQ,CAAC,0BAA0B,CAAC;AAC7E,oBAAY,iCAAiC,GAAG,QAAQ,CAAC,iCAAiC,CAAC;AAC3F,oBAAY,0BAA0B,GAAG,QAAQ,CAAC,0BAA0B,CAAC"}
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../lib/capabilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,YAAY,IAAI,QAAQ,EAAC,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAC,YAAY,EAAE,UAAU,EAAE,WAAW,EAAC,MAAM,GAAG,CAAC;AACxD,OAAO,EAAC,wBAAwB,EAAC,MAAM,eAAe,CAAC;AAEvD,oBAAY,oBAAoB,GAAG,QAAQ,CAAC,YAAY,CAAC;AACzD,oBAAY,iBAAiB,GAAG,QAAQ,CAAC;AAEzC;;GAEG;AACH,oBAAY,gBAAgB,GAAG,iBAAiB,CAAC,wBAAwB,CAAC,CAAC;AAE3E;;GAEG;AACH,oBAAY,kBAAkB,GAAG,YAAY,CAAC,iBAAiB,CAAC,wBAAwB,CAAC,CAAC,CAAC;AAE3F;;GAEG;AACH,oBAAY,yBAAyB,GAAG,QAAQ,CAAC,yBAAyB,CAAC;AAC3E,oBAAY,qBAAqB,GAAG,QAAQ,CAAC,qBAAqB,CAAC;AACnE,oBAAY,yBAAyB,GAAG,QAAQ,CAAC,yBAAyB,CAAC;AAC3E,oBAAY,0BAA0B,GAAG,QAAQ,CAAC,0BAA0B,CAAC;AAC7E,oBAAY,iCAAiC,GAAG,QAAQ,CAAC,iCAAiC,CAAC;AAC3F,oBAAY,0BAA0B,GAAG,QAAQ,CAAC,0BAA0B,CAAC;AAE7E;;GAEG;AACH,aAAK,gBAAgB,CACnB,CAAC,SAAS,UAAU,EACpB,CAAC,IACC,CAAC,CAAC,0BAA0B,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,GACtD,OAAO,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC,GAC9C,CAAC,CAAC,WAAW,CAAC,SAAS,aAAa,CAAC,CAAC,CAAC,GACvC,CAAC,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,GACtB,CAAC,CAAC;AAEN;;;;;;;;GAQG;AACH,aAAK,mBAAmB,CAAC,CAAC,SAAS,UAAU,IAAI,CAAC,CAAC,UAAU,CAAC,SAAS,IAAI,GACvE,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,GAC3B,CAAC,CAAC,UAAU,CAAC,SAAS,IAAI,GAC1B,gBAAgB,CAAC,CAAC,EAAE,MAAM,CAAC,GAC3B,CAAC,CAAC,WAAW,CAAC,SAAS,IAAI,GAC3B,OAAO,GACP,CAAC,CAAC,SAAS,CAAC,SAAS,IAAI,GACzB,MAAM,EAAE,GACR,CAAC,CAAC,UAAU,CAAC,SAAS,IAAI,GAC1B,MAAM,GACN,GAAG,CAAC;AAER;;;;GAIG;AACH,oBAAY,eAAe,CAAC,CAAC,SAAS,UAAU,IAAI,CAAC,CAAC,UAAU,CAAC,SAC7D,IAAI,GACJ;IAAC,UAAU,EAAE,OAAO,CAAA;CAAC,GACrB,mBAAmB,CAAC,CAAC,CAAC,GACtB,mBAAmB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;AAEvC;;GAEG;AACH,oBAAY,OAAO,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,SAAS,CAAC,GACpD,MAAM,GACN,CAAC,SAAS,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,EAAE,GAC5C,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,GAC/E,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,GAChC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,GAC7C,EAAE,CAAC;AAEP;;;;GAIG;AACH,oBAAY,YAAY,CAAC,CAAC,SAAS,YAAY,EAAE,EAAE,SAAS,MAAM,GAAG,iBAAiB,IAAI;KACvF,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,MAAM,oBAAoB,GACjD,CAAC,GACD,gBAAgB,CAAC,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC5C,CAAC;AAEF,oBAAY,gBAAgB,CAC1B,CAAC,SAAS,MAAM,EAChB,EAAE,SAAS,MAAM,GAAG,iBAAiB,IACnC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;AAEjB;;GAEG;AACH,oBAAY,iBAAiB,CAAC,CAAC,SAAS,WAAW,IAAI;IACrD,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAChD,CAAC;AAEF;;;;GAIG;AACH,oBAAY,YAAY,CACtB,CAAC,SAAS,WAAW,GAAG,wBAAwB,EAChD,KAAK,SAAS,YAAY,GAAG,IAAI,GAAG,IAAI,IACtC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;AAE1C;;;;GAIG;AACH,oBAAY,eAAe,CACzB,CAAC,SAAS,WAAW,GAAG,wBAAwB,EAChD,KAAK,SAAS,YAAY,GAAG,IAAI,GAAG,IAAI,IACtC;IACF,WAAW,EAAE,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACtC,UAAU,EAAE,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,oBAAY,cAAc,CACxB,CAAC,SAAS,WAAW,GAAG,wBAAwB,EAChD,KAAK,SAAS,YAAY,GAAG,IAAI,GAAG,IAAI,EACxC,EAAE,SAAS,MAAM,GAAG,iBAAiB,IACnC,OAAO,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;AAE5D;;;;;;;;;;;;;;;;;GAiBG;AAEH,oBAAY,UAAU,CACpB,CAAC,SAAS,WAAW,EACrB,KAAK,SAAS,YAAY,GAAG,IAAI,GAAG,IAAI,IACtC,YAAY,CAAC,wBAAwB,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;AAEtD;;;;;;;;;;;;;GAaG;AACH,oBAAY,aAAa,CACvB,CAAC,SAAS,WAAW,EACrB,KAAK,SAAS,YAAY,GAAG,IAAI,GAAG,IAAI,IACtC,eAAe,CAAC,wBAAwB,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;AAEzD;;;;GAIG;AACH,oBAAY,YAAY,CACtB,CAAC,SAAS,WAAW,EACrB,KAAK,SAAS,YAAY,GAAG,IAAI,GAAG,IAAI,IACtC,cAAc,CAAC,wBAAwB,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC"}

package/build/capabilities.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/config.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// end conditionals

package/build/constraints.d.ts

@@ -0,0 +1,53 @@
+export declare const BASE_DESIRED_CAP_CONSTRAINTS: {
+    readonly platformName: {
+        readonly presence: true;
+        readonly isString: true;
+    };
+    readonly app: {
+        readonly isString: true;
+    };
+    readonly deviceName: {
+        readonly isString: true;
+    };
+    readonly platformVersion: {
+        readonly isString: true;
+    };
+    readonly newCommandTimeout: {
+        readonly isNumber: true;
+    };
+    readonly automationName: {
+        readonly isString: true;
+    };
+    readonly autoLaunch: {
+        readonly isBoolean: true;
+    };
+    readonly udid: {
+        readonly isString: true;
+    };
+    readonly orientation: {
+        readonly inclusion: readonly ["LANDSCAPE", "PORTRAIT"];
+    };
+    readonly autoWebview: {
+        readonly isBoolean: true;
+    };
+    readonly noReset: {
+        readonly isBoolean: true;
+    };
+    readonly fullReset: {
+        readonly isBoolean: true;
+    };
+    readonly language: {
+        readonly isString: true;
+    };
+    readonly locale: {
+        readonly isString: true;
+    };
+    readonly eventTimings: {
+        readonly isBoolean: true;
+    };
+    readonly printPageSourceOnFindFailure: {
+        readonly isBoolean: true;
+    };
+};
+export declare type BaseDriverCapConstraints = typeof BASE_DESIRED_CAP_CONSTRAINTS;
+//# sourceMappingURL=constraints.d.ts.map

package/build/constraints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constraints.d.ts","sourceRoot":"","sources":["../lib/constraints.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkD/B,CAAC;AAEX,oBAAY,wBAAwB,GAAG,OAAO,4BAA4B,CAAC"}

package/build/constraints.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BASE_DESIRED_CAP_CONSTRAINTS = void 0;
+exports.BASE_DESIRED_CAP_CONSTRAINTS = {
+    platformName: {
+        presence: true,
+        isString: true,
+    },
+    app: {
+        isString: true,
+    },
+    deviceName: {
+        isString: true,
+    },
+    platformVersion: {
+        isString: true,
+    },
+    newCommandTimeout: {
+        isNumber: true,
+    },
+    automationName: {
+        isString: true,
+    },
+    autoLaunch: {
+        isBoolean: true,
+    },
+    udid: {
+        isString: true,
+    },
+    orientation: {
+        inclusion: ['LANDSCAPE', 'PORTRAIT'],
+    },
+    autoWebview: {
+        isBoolean: true,
+    },
+    noReset: {
+        isBoolean: true,
+    },
+    fullReset: {
+        isBoolean: true,
+    },
+    language: {
+        isString: true,
+    },
+    locale: {
+        isString: true,
+    },
+    eventTimings: {
+        isBoolean: true,
+    },
+    printPageSourceOnFindFailure: {
+        isBoolean: true,
+    },
+};

package/build/driver.d.ts

@@ -1,8 +1,7 @@
 /// <reference types="node" />
 import type { EventEmitter } from 'events';
 import { Element, ActionSequence } from './action';
-import { HTTPMethod, Capabilities, AppiumServer, UpdateServerCallback, Class, MethodMap, AppiumLogger } from '.';
-import { W3CCapabilities } from './capabilities';
+import { HTTPMethod, AppiumServer, UpdateServerCallback, Class, MethodMap, AppiumLogger, StringRecord, ConstraintsToCaps, BaseDriverCapConstraints, W3CCapabilities, Capabilities } from '.';
 import { ServerArgs } from './config';
 export interface TimeoutCommands {
     timeouts(type: string, ms: number | string, script?: number, pageLoad?: number, implicit?: number | string): Promise<void>;
@@ -29,7 +28,7 @@ export interface SessionCommands {
     getSession(): Promise<SingularSessionData>;
 }
 export interface ExecuteCommands {
-    executeMethod(script: string, args: [Record<string, any>] | []): Promise<any>;
+    executeMethod(script: string, args: [StringRecord] | []): Promise<any>;
 }
 export interface ExecuteMethodDef {
     command: string;
@@ -39,12 +38,13 @@ export interface ExecuteMethodDef {
     };
 }
 export declare type ExecuteMethodMap = Record<string, ExecuteMethodDef>;
-export interface MultiSessionData {
+export interface MultiSessionData<C extends Constraints = BaseDriverCapConstraints, Extra extends StringRecord | void = void> {
     id: string;
-    capabilities: Capabilities;
+    capabilities: Capabilities<C, Extra>;
 }
-export declare type SingularSessionData = Capabilities & {
+export declare type SingularSessionData<C extends Constraints = BaseDriverCapConstraints, Extra extends StringRecord | void = void> = Capabilities<C, Extra> & {
     events?: EventHistory;
+    error?: string;
 };
 export interface FindCommands {
     findElement(strategy: string, selector: string): Promise<Element>;
@@ -68,11 +68,11 @@ export interface LogCommands {
     getLog(logType: string): Promise<any[]>;
 }
 export interface SettingsCommands {
-    updateSettings: (settings: Record<string, any>) => Promise<void>;
-    getSettings(): Promise<Record<string, any>>;
+    updateSettings: (settings: StringRecord) => Promise<void>;
+    getSettings(): Promise<StringRecord>;
 }
-export interface SessionHandler<CreateResult, DeleteResult> {
-    createSession(w3cCaps1: W3CCapabilities, w3cCaps2?: W3CCapabilities, w3cCaps?: W3CCapabilities, driverData?: DriverData[]): Promise<CreateResult>;
+export interface SessionHandler<CreateResult, DeleteResult, C extends Constraints = BaseDriverCapConstraints, Extra extends StringRecord | void = void> {
+    createSession(w3cCaps1: W3CCapabilities<C, Extra>, w3cCaps2?: W3CCapabilities<C, Extra>, w3cCaps?: W3CCapabilities<C, Extra>, driverData?: DriverData[]): Promise<CreateResult>;
     deleteSession(sessionId?: string, driverData?: DriverData[]): Promise<DeleteResult>;
 }
 /**
@@ -93,25 +93,25 @@ export declare type DriverData = Record<string, unknown>;
  * }
  */
 export interface Constraint {
-    presence?: boolean | {
+    readonly presence?: boolean | Readonly<{
         allowEmpty: boolean;
-    };
-    isString?: boolean;
-    isNumber?: boolean;
-    isBoolean?: boolean;
-    isObject?: boolean;
-    isArray?: boolean;
-    deprecated?: boolean;
-    inclusion?: any[];
-    inclusionCaseInsensitive?: any[];
+    }>;
+    readonly isString?: boolean;
+    readonly isNumber?: boolean;
+    readonly isBoolean?: boolean;
+    readonly isObject?: boolean;
+    readonly isArray?: boolean;
+    readonly deprecated?: boolean;
+    readonly inclusion?: Readonly<[any, ...any[]]>;
+    readonly inclusionCaseInsensitive?: Readonly<[any, ...any[]]>;
 }
-export declare type Constraints = Record<string, Constraint>;
-export interface DriverHelpers {
+export declare type Constraints = Readonly<Record<string, Constraint>>;
+export interface DriverHelpers<C extends Constraints> {
     configureApp: (app: string, supportedAppExtensions: string[]) => Promise<string>;
     isPackageOrBundle: (app: string) => boolean;
     duplicateKeys: <T>(input: T, firstKey: string, secondKey: string) => T;
     parseCapsArray: (cap: string | string[]) => string[];
-    generateDriverLogPrefix: (obj: Core, sessionId?: string) => string;
+    generateDriverLogPrefix: (obj: Core<C>, sessionId?: string) => string;
 }
 export declare type SettingsUpdateListener<T extends Record<string, unknown> = Record<string, unknown>> = (prop: keyof T, newValue: unknown, curValue: unknown) => Promise<void>;
 export interface DeviceSettings<T = any> {
@@ -193,15 +193,13 @@ export interface EventHistoryCommand {
  *
  * This should not be used directly by external code.
  */
-export interface Core {
+export interface Core<C extends Constraints = BaseDriverCapConstraints> {
     shouldValidateCaps: boolean;
     sessionId: string | null;
-    opts: DriverOpts;
+    opts: DriverOpts<C>;
     initialOpts: ServerArgs;
-    caps?: Capabilities;
-    originalCaps?: W3CCapabilities;
     protocol?: string;
-    helpers: DriverHelpers;
+    helpers: DriverHelpers<C>;
     basePath: string;
     relaxedSecurityEnabled: boolean;
     allowInsecure: string[];
@@ -232,21 +230,23 @@ export interface Core {
     getManagedDrivers(): Driver[];
     clearNewCommandTimeout(): Promise<void>;
     logEvent(eventName: string): void;
-    driverForSession(sessionId: string): Core | null;
+    driverForSession(sessionId: string): Core<C> | null;
 }
 /**
  * `BaseDriver` implements this.  It contains default behavior;
  * external drivers are expected to implement {@linkcode ExternalDriver} instead.
  */
-export interface Driver extends SessionCommands, LogCommands, FindCommands, SettingsCommands, TimeoutCommands, EventCommands, SessionHandler<[string, any], void>, ExecuteCommands, Core {
-    cliArgs?: Record<string, any>;
+export interface Driver<C extends Constraints = BaseDriverCapConstraints, A extends StringRecord = StringRecord> extends SessionCommands, LogCommands, FindCommands, SettingsCommands, TimeoutCommands, EventCommands, SessionHandler<[string, any], void, C>, ExecuteCommands, Core {
+    cliArgs?: A;
     executeCommand(cmd: string, ...args: any[]): Promise<any>;
     startUnexpectedShutdown(err?: Error): Promise<void>;
     startNewCommandTimeout(): Promise<void>;
     reset(): Promise<void>;
-    desiredCapConstraints: Constraints;
-    validateDesiredCaps(caps: Capabilities): boolean;
-    logExtraCaps(caps: Capabilities): void;
+    caps?: Capabilities<C>;
+    originalCaps?: W3CCapabilities<C>;
+    desiredCapConstraints: C;
+    validateDesiredCaps(caps: Capabilities<C>): boolean;
+    logExtraCaps(caps: Capabilities<C>): void;
     assignServer?(server: AppiumServer, host: string, port: number, path: string): void;
 }
 /**
@@ -424,12 +424,16 @@ export interface DriverStatic {
  * This is likely unusable by external consumers, but YMMV!
  */
 export declare type DriverClass<D extends Driver = ExternalDriver, S extends DriverStatic = DriverStatic> = Class<D, S, [] | [Partial<ServerArgs>] | [Partial<ServerArgs>, boolean]>;
+export interface ExtraDriverOpts {
+    fastReset?: boolean;
+    skipUninstall?: boolean;
+}
 /**
  * Options as passed into a driver constructor, which is just a union of {@linkcode ServerArgs} and {@linkcode Capabilities}.
  *
  * The combination happens within Appium prior to calling the constructor.
  */
-export declare type DriverOpts = ServerArgs & Capabilities;
+export declare type DriverOpts<C extends Constraints = BaseDriverCapConstraints> = ServerArgs & ExtraDriverOpts & Partial<ConstraintsToCaps<C>>;
 export declare type DriverCommand<TArgs = any, TReturn = unknown> = (...args: TArgs[]) => Promise<TReturn>;
 export declare type DriverCommands<TArgs = any, TReturn = unknown> = Record<string, DriverCommand<TArgs, TReturn>>;
 /**