@appium/types 0.4.0 → 0.5.0

package/build/action.d.ts

@@ -0,0 +1,176 @@
+/**
+ * @module
+ * Portions Copyright (c) 2017 Igor Muchychka
+ * @see https://github.com/w3c-webdriver/w3c-webdriver
+ */
+export interface Element {
+    'element-6066-11e4-a52e-4f735466cecf': string;
+}
+/**
+ * @group Actions
+ */
+export declare type PauseAction = {
+    type: 'pause';
+    duration: number;
+};
+/**
+ * @group Actions
+ */
+export declare type KeyDownAction = {
+    type: 'keyDown';
+    value: Key | string;
+};
+/**
+ * @group Actions
+ */
+export declare type KeyUpAction = {
+    type: 'keyUp';
+    value: Key | string;
+};
+/**
+ * @group Actions
+ */
+export declare type PointerMoveAction = {
+    type: 'pointerMove';
+    x: number;
+    y: number;
+    duration?: number;
+    origin?: 'viewport' | 'pointer' | Element;
+};
+/**
+ * @group Actions
+ */
+export declare type PointerUpAction = {
+    type: 'pointerUp';
+    button: number;
+};
+/**
+ * @group Actions
+ */
+export declare type PointerDownAction = {
+    type: 'pointerDown';
+    button: number;
+};
+/**
+ * @group Actions
+ */
+export declare type NullAction = PauseAction;
+/**
+ * @group Actions
+ */
+export declare type KeyAction = PauseAction | KeyDownAction | KeyUpAction;
+/**
+ * @group Actions
+ */
+export declare type PointerAction = PauseAction | PointerMoveAction | PointerUpAction | PointerDownAction;
+/**
+ * @group Actions
+ */
+export declare type NullActionSequence = {
+    type: 'none';
+    id: string;
+    actions: NullAction[];
+};
+/**
+ * @group Actions
+ */
+export declare type KeyActionSequence = {
+    type: 'key';
+    id: string;
+    actions: KeyAction[];
+};
+/**
+ * @group Actions
+ */
+export declare type PointerParameters = {
+    pointerType: 'mouse' | 'pen' | 'touch';
+};
+/**
+ * @group Actions
+ */
+export declare type PointerActionSequence = {
+    type: 'pointer';
+    id: string;
+    actions: PointerAction[];
+    parameters?: PointerParameters;
+};
+/**
+ * @group Actions
+ */
+export declare type ActionSequence = NullActionSequence | KeyActionSequence | PointerActionSequence;
+/**
+ * @group Actions
+ */
+export declare enum Key {
+    NULL = "\uE000",
+    CANCEL = "\uE001",
+    HELP = "\uE002",
+    BACKSPACE = "\uE003",
+    TAB = "\uE004",
+    CLEAR = "\uE005",
+    RETURN = "\uE006",
+    ENTER = "\uE007",
+    SHIFT = "\uE008",
+    CONTROL = "\uE009",
+    ALT = "\uE00A",
+    PAUSE = "\uE00B",
+    ESCAPE = "\uE00C",
+    SPACE = "\uE00D",
+    PAGE_UP = "\uE00E",
+    PAGE_DOWN = "\uE00F",
+    END = "\uE010",
+    HOME = "\uE011",
+    LEFT = "\uE012",
+    UP = "\uE013",
+    RIGHT = "\uE014",
+    DOWN = "\uE015",
+    INSERT = "\uE016",
+    DELETE = "\uE017",
+    SEMICOLON = "\uE018",
+    EQUALS = "\uE019",
+    NUMPAD0 = "\uE01A",
+    NUMPAD1 = "\uE01B",
+    NUMPAD2 = "\uE01C",
+    NUMPAD3 = "\uE01D",
+    NUMPAD4 = "\uE01E",
+    NUMPAD5 = "\uE01F",
+    NUMPAD6 = "\uE020",
+    NUMPAD7 = "\uE021",
+    NUMPAD8 = "\uE022",
+    NUMPAD9 = "\uE023",
+    MULTIPLY = "\uE024",
+    ADD = "\uE025",
+    SEPARATOR = "\uE026",
+    SUBTRACT = "\uE027",
+    DECIMAL = "\uE028",
+    DIVIDE = "\uE029",
+    F1 = "\uE031",
+    F2 = "\uE032",
+    F3 = "\uE033",
+    F4 = "\uE034",
+    F5 = "\uE035",
+    F6 = "\uE036",
+    F7 = "\uE037",
+    F8 = "\uE038",
+    F9 = "\uE039",
+    F10 = "\uE03A",
+    F11 = "\uE03B",
+    F12 = "\uE03C",
+    META = "\uE03D",
+    ZENKAKUHANKAKU = "\uE040",
+    R_SHIFT = "\uE050",
+    R_CONTROL = "\uE051",
+    R_ALT = "\uE052",
+    R_META = "\uE053",
+    R_PAGEUP = "\uE054",
+    R_PAGEDOWN = "\uE055",
+    R_END = "\uE056",
+    R_HOME = "\uE057",
+    R_ARROWLEFT = "\uE058",
+    R_ARROWUP = "\uE059",
+    R_ARROWRIGHT = "\uE05A",
+    R_ARROWDOWN = "\uE05B",
+    R_INSERT = "\uE05C",
+    R_DELETE = "\uE05D"
+}
+//# sourceMappingURL=action.d.ts.map

package/build/action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../lib/action.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,WAAW,OAAO;IACtB,qCAAqC,EAAE,MAAM,CAAC;CAC/C;AAED;;GAEG;AACH,oBAAY,WAAW,GAAG;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,oBAAY,aAAa,GAAG;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,GAAG,GAAG,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,oBAAY,WAAW,GAAG;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,GAAG,GAAG,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B,IAAI,EAAE,aAAa,CAAC;IACpB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,oBAAY,UAAU,GAAG,WAAW,CAAC;AAErC;;GAEG;AACH,oBAAY,SAAS,GAAG,WAAW,GAAG,aAAa,GAAG,WAAW,CAAC;AAElE;;GAEG;AACH,oBAAY,aAAa,GACrB,WAAW,GACX,iBAAiB,GACjB,eAAe,GACf,iBAAiB,CAAC;AAEtB;;GAEG;AACH,oBAAY,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B,IAAI,EAAE,KAAK,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,SAAS,EAAE,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B,WAAW,EAAE,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,oBAAY,qBAAqB,GAAG;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,oBAAY,cAAc,GACtB,kBAAkB,GAClB,iBAAiB,GACjB,qBAAqB,CAAC;AAE1B;;GAEG;AACH,oBAAY,GAAG;IACb,IAAI,WAAW;IACf,MAAM,WAAW;IACjB,IAAI,WAAW;IACf,SAAS,WAAW;IACpB,GAAG,WAAW;IACd,KAAK,WAAW;IAChB,MAAM,WAAW;IACjB,KAAK,WAAW;IAChB,KAAK,WAAW;IAChB,OAAO,WAAW;IAClB,GAAG,WAAW;IACd,KAAK,WAAW;IAChB,MAAM,WAAW;IACjB,KAAK,WAAW;IAChB,OAAO,WAAW;IAClB,SAAS,WAAW;IACpB,GAAG,WAAW;IACd,IAAI,WAAW;IACf,IAAI,WAAW;IACf,EAAE,WAAW;IACb,KAAK,WAAW;IAChB,IAAI,WAAW;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,SAAS,WAAW;IACpB,MAAM,WAAW;IACjB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,OAAO,WAAW;IAClB,QAAQ,WAAW;IACnB,GAAG,WAAW;IACd,SAAS,WAAW;IACpB,QAAQ,WAAW;IACnB,OAAO,WAAW;IAClB,MAAM,WAAW;IACjB,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,EAAE,WAAW;IACb,GAAG,WAAW;IACd,GAAG,WAAW;IACd,GAAG,WAAW;IACd,IAAI,WAAW;IACf,cAAc,WAAW;IACzB,OAAO,WAAW;IAClB,SAAS,WAAW;IACpB,KAAK,WAAW;IAChB,MAAM,WAAW;IACjB,QAAQ,WAAW;IACnB,UAAU,WAAW;IACrB,KAAK,WAAW;IAChB,MAAM,WAAW;IACjB,WAAW,WAAW;IACtB,SAAS,WAAW;IACpB,YAAY,WAAW;IACvB,WAAW,WAAW;IACtB,QAAQ,WAAW;IACnB,QAAQ,WAAW;CACpB"}

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,
+    },
+};