@appium/base-driver 8.7.3 → 9.1.0

package/build/lib/basedriver/capabilities.d.ts

@@ -13,159 +13,11 @@ export type ValidateCapsOpts = {
      */
     skipPresenceConstraint?: boolean | undefined;
 };
-export type NSCapabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = {
-    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;
-    };
-}, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').NSCapabilities<C, Extra>;
-export type Capabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = {
-    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;
-    };
-}, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').Capabilities<C, Extra>;
-export type W3CCapabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = {
-    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;
-    };
-}, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').W3CCapabilities<C, Extra>;
+export type NSCapabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof import("@appium/types").BASE_DESIRED_CAP_CONSTRAINTS, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').NSCapabilities<C, Extra>;
+export type Capabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof import("@appium/types").BASE_DESIRED_CAP_CONSTRAINTS, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').Capabilities<C, Extra>;
+export type W3CCapabilities<C extends Readonly<Record<string, import("@appium/types").Constraint>> = typeof import("@appium/types").BASE_DESIRED_CAP_CONSTRAINTS, Extra extends void | import("@appium/types").StringRecord = void> = import('@appium/types').W3CCapabilities<C, Extra>;
+export type Merge<T, U> = import('type-fest').Merge<T, U>;
+export type StringKeyOf<T> = import('type-fest').StringKeyOf<T>;
 /**
  * Parse capabilities
  * @template {Constraints} [C={}]
@@ -203,12 +55,11 @@ export function validateCaps<C extends Readonly<Record<string, import("@appium/t
  * @template {Constraints} [U={}]
  * @param {Capabilities<T>} [primary]
  * @param {Capabilities<U>} [secondary]
- * @returns {import('type-fest').Merge<Capabilities<T>, Capabilities<U>>}
+ * @returns {Merge<Capabilities<T>, Capabilities<U>>}
  * @see https://www.w3.org/TR/webdriver/#dfn-merging-capabilities)
  */
 export function mergeCaps<T extends Readonly<Record<string, import("@appium/types").Constraint>> = {}, U extends Readonly<Record<string, import("@appium/types").Constraint>> = {}>(primary?: Partial<import("@appium/types").ConstraintsToCaps<T> & void> | undefined, secondary?: Partial<import("@appium/types").ConstraintsToCaps<U> & void> | undefined): import("type-fest").Simplify<(import("type-fest/source/merge").SimpleMerge<import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>> & import("type-fest/source/merge").SimpleMerge<import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>> extends infer T_1 ? { [Key in keyof T_1 as import("type-fest/source/enforce-optional").RequiredFilter<import("type-fest/source/merge").SimpleMerge<import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>> & import("type-fest/source/merge").SimpleMerge<import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>>, Key>]: (import("type-fest/source/merge").SimpleMerge<import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>> & import("type-fest/source/merge").SimpleMerge<import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>>)[Key]; } : never) & (import("type-fest/source/merge").SimpleMerge<import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>> & import("type-fest/source/merge").SimpleMerge<import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>> extends infer T_2 ? { [Key_1 in keyof T_2 as import("type-fest/source/enforce-optional").OptionalFilter<import("type-fest/source/merge").SimpleMerge<import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>> & import("type-fest/source/merge").SimpleMerge<import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>>, Key_1>]?: Exclude<(import("type-fest/source/merge").SimpleMerge<import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").PickIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>> & import("type-fest/source/merge").SimpleMerge<import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<T> & void>>, import("type-fest").OmitIndexSignature<Partial<import("@appium/types").ConstraintsToCaps<U> & void>>>)[Key_1], undefined> | undefined; } : never)>;
 export const APPIUM_VENDOR_PREFIX: "appium:";
-export const APPIUM_OPTS_CAP: "options";
 /**
  * Get an array of all the unprefixed caps that are being used in 'alwaysMatch' and all of the 'firstMatch' object
  * @template {Constraints} [C={}]
@@ -231,15 +82,12 @@ export function isStandardCap(cap: string): boolean;
 export function stripAppiumPrefixes<C extends Readonly<Record<string, import("@appium/types").Constraint>> = {}>(caps: Partial<import("@appium/types").CapsToNSCaps<import("@appium/types").ConstraintsToCaps<C> & void, "appium">>): Partial<import("@appium/types").ConstraintsToCaps<C> & void>;
 /**
  * Return a copy of a capabilities object which has taken everything within the 'options'
- * capability and promoted it to the top level. Note that this function is assumed to be run after
- * all vendor prefixes have already been stripped from the top level. So we are dealing with e.g.
- * 'options' and not 'appium:options' at this point. Any prefixes _inside_ the 'options' capability
- * will themselves be stripped. This is designed as an internal function, not one to operate on
- * user-constructed capabilities.
+ * capability and promoted it to the top level.
  *
- * @param {object} originalCaps - the capabilities to analyze and promote from 'options'
- * @return {object!} - the capabilities with 'options' promoted if necessary
+ * @template {Constraints} C
+ * @param {import('@appium/types').W3CCapabilities<C>} originalCaps
+ * @return {import('@appium/types').W3CCapabilities<C>} the capabilities with 'options' promoted if necessary
  */
-export function promoteAppiumOptions(originalCaps: object): object;
+export function promoteAppiumOptions<C extends Readonly<Record<string, import("@appium/types").Constraint>>>(originalCaps: import("@appium/types").W3CCapabilities<C, void>): import("@appium/types").W3CCapabilities<C, void>;
 export const PREFIXED_APPIUM_OPTS_CAP: string;
 //# sourceMappingURL=capabilities.d.ts.map

package/build/lib/basedriver/capabilities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../../lib/basedriver/capabilities.js"],"names":[],"mappings":"AA2FA;;;GAGG;AACH,uGAcE;0BA2RW,OAAO,eAAe,EAAE,WAAW;yBACnC,OAAO,eAAe,EAAE,UAAU;2BAClC,OAAO,eAAe,EAAE,YAAY;uCACpC,OAAO,eAAe,EAAE,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uEAWhD,OAAO,eAAe,EAAE,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uEAMhD,OAAO,eAAe,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uEAM9C,OAAO,eAAe,EAAE,eAAe,CAAC,CAAC,EAAE,KAAK,CAAC;AAhO9D;;;;;;;GAOG;AACH;;;;;;EAmGC;AAGD;;;;;;GAMG;AACH,4SAuBC;AApSD;;;;;;GAMG;AACH,8SAwCC;AA7ED;;;;;;;;GAQG;AACH,kmHAkBC;AA/BD,6CAAuC;AACvC,wCAAkC;AAuKlC;;;;GAIG;AACH,0MAWC;AA/ED;;;GAGG;AACH,mCAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;;;GAOG;AACH,mSA6CC;AAkKD;;;;;;;;;;GAUG;AACH,mDAHW,MAAM,GACL,MAAM,CA8BjB;AA7WD,8CAA6E"}
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../../lib/basedriver/capabilities.js"],"names":[],"mappings":"AA0FA;;;GAGG;AACH,uGAeE;0BA8TW,OAAO,eAAe,EAAE,WAAW;yBACnC,OAAO,eAAe,EAAE,UAAU;2BAClC,OAAO,eAAe,EAAE,YAAY;uCACpC,OAAO,eAAe,EAAE,wBAAwB;;;;;;;qOAWhD,OAAO,eAAe,EAAE,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC;mOAMhD,OAAO,eAAe,EAAE,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC;sOAM9C,OAAO,eAAe,EAAE,eAAe,CAAC,CAAC,EAAE,KAAK,CAAC;0BAKjD,OAAO,WAAW,EAAE,KAAK,CAAC,CAAC,EAAC,CAAC,CAAC;6BAI9B,OAAO,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;AA7Q/C;;;;;;;GAOG;AACH;;;;;;EAmGC;AAGD;;;;;;GAMG;AACH,4SAuBC;AApSD;;;;;;GAMG;AACH,8SAwCC;AA7ED;;;;;;;;GAQG;AACH,kmHAkBC;AA9BD,6CAAuC;AAuKvC;;;;GAIG;AACH,0MAWC;AA9ED;;;GAGG;AACH,mCAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;;;GAOG;AACH,mSA4CC;AAkKD;;;;;;;GAOG;AACH,+NAoEC;AAlZD,8CAAkE"}