@appium/types - npm Package Compare versions

Comparing version 0.15.0 to 0.16.0

build/lib/command.d.ts

@@ -116,2 +116,11 @@ import { ConditionalPick, MultidimensionalReadonlyArray } from 'type-fest';
 export type ExecuteMethodMap<T extends Plugin | Driver> = T extends Plugin ? Readonly<StringRecord<PluginExecuteMethodDef<T>>> : T extends Driver ? Readonly<StringRecord<DriverExecuteMethodDef<T>>> : never;
+export interface BidiMethodDef extends BaseExecuteMethodDef {
+    command: string;
+}
+export interface BidiMethodMap {
+    [k: string]: BidiMethodDef;
+}
+export interface BidiModuleMap {
+    [k: string]: BidiMethodMap;
+}
 //# sourceMappingURL=command.d.ts.map

build/lib/index.d.ts

@@ -13,2 +13,3 @@ export * from './command';
 export * from './logger';
+export * from './doctor';
 //# sourceMappingURL=index.d.ts.map

build/lib/index.js

@@ -29,2 +29,3 @@ "use strict";
 __exportStar(require("./logger"), exports);
+__exportStar(require("./doctor"), exports);
 //# sourceMappingURL=index.js.map

build/lib/logger.d.ts

@@ -37,4 +37,8 @@ import type { Logger } from 'npmlog';
     http(...args: any[]): void;
+    /**
+     * @deprecated Use {@link errorWithException} instead
+     */
     errorAndThrow(...args: any[]): never;
+    errorWithException(...args: any[]): Error;
 }
 //# sourceMappingURL=logger.d.ts.map

lib/command.ts

@@ -140,1 +140,13 @@ import {ConditionalPick, MultidimensionalReadonlyArray} from 'type-fest';
   : never;
+
+export interface BidiMethodDef extends BaseExecuteMethodDef {
+  command: string;
+}
+
+export interface BidiMethodMap {
+  [k: string]: BidiMethodDef;
+}
+
+export interface BidiModuleMap {
+  [k: string]: BidiMethodMap;
+}

lib/driver.ts

@@ -35,3 +35,3 @@ import type {EventEmitter} from 'node:events';
     pageLoad?: number,
-    implicit?: number | string
+    implicit?: number | string,
   ): Promise<void>;
@@ -173,6 +173,6 @@
     TArgs extends readonly any[] | readonly [StringRecord<unknown>] = unknown[],
-    TReturn = unknown
+    TReturn = unknown,
   >(
     script: string,
-    args: TArgs
+    args: TArgs,
   ): Promise<TReturn>;
@@ -195,3 +195,3 @@ }
   C extends Constraints = Constraints,
-  T extends StringRecord = StringRecord
+  T extends StringRecord = StringRecord,
 > = DriverCaps<C> & {
@@ -254,3 +254,3 @@ events?: EventHistory;
     selector: string,
-    elementId: string
+    elementId: string,
   ): Promise<Element[]>;
@@ -270,3 +270,3 @@
     selector: string,
-    shadowId: string
+    shadowId: string,
   ): Promise<Element>;
@@ -286,3 +286,3 @@
     selector: string,
-    shadowId: string
+    shadowId: string,
   ): Promise<Element[]>;
@@ -318,3 +318,3 @@
     mult: true,
-    context?: any
+    context?: any,
   ): Promise<Element[]>;
@@ -325,3 +325,3 @@ findElOrElsWithProcessing(
     mult: false,
-    context?: any
+    context?: any,
   ): Promise<Element>;
@@ -357,2 +357,7 @@
 
+export interface IBidiCommands {
+  bidiSubscribe(events: string[], contexts: string[]): Promise<void>;
+  bidiUnsubscribe(events: string[], contexts: string[]): Promise<void>;
+}
+
 /**
@@ -405,3 +410,3 @@ * A record of {@linkcode LogDef} objects, keyed by the log type name.
   sessionId: string,
-  capabilities: DriverCaps<C>
+  capabilities: DriverCaps<C>,
 ];
@@ -421,3 +426,3 @@
   DeleteResult = DefaultDeleteSessionResult,
-  SessionData extends StringRecord = StringRecord
+  SessionData extends StringRecord = StringRecord,
 > {
@@ -445,3 +450,3 @@ /**
     w3cCaps3?: W3CDriverCaps<C>,
-    driverData?: DriverData[]
+    driverData?: DriverData[],
   ): Promise<CreateResult>;
@@ -500,3 +505,3 @@
     app: string,
-    supportedAppExtensions?: string | string[] | ConfigureAppOptions
+    supportedAppExtensions?: string | string[] | ConfigureAppOptions,
   ) => Promise<string>;
@@ -512,3 +517,3 @@ isPackageOrBundle: (app: string) => boolean;
   newValue: unknown,
-  curValue: unknown
+  curValue: unknown,
 ) => Promise<void>;
@@ -613,2 +618,4 @@
   eventHistory: EventHistory;
+  bidiEventSubs: Record<string, string[]>;
+  doesSupportBidi: boolean;
   onUnexpectedShutdown(handler: () => any): void;
@@ -654,2 +661,3 @@ /**
   proxyActive(sessionId?: string): boolean;
+  get bidiProxyUrl(): string | null;
   getProxyAvoidList(sessionId?: string): RouteMatcher[];
@@ -679,3 +687,3 @@ canProxy(sessionId?: string): boolean;
   DeleteResult = DefaultDeleteSessionResult,
-  SessionData extends StringRecord = StringRecord
+  SessionData extends StringRecord = StringRecord,
 > extends ILogCommands,
@@ -711,2 +719,8 @@ IFindCommands,
 
+  /** Execute a driver (WebDriver Bidi protocol) command by its name as defined in the bidi commands file
+   * @param bidiCmd - the name of the command in the bidi spec
+   * @param args - arguments to pass to the command
+   */
+  executeBidiCommand(bidiCmd: string, ...args: any[]): Promise<any>;
+
   /**
@@ -792,3 +806,3 @@ * Signify to any owning processes that this driver encountered an error which should cause the
   DeleteResult = DefaultDeleteSessionResult,
-  SessionData extends StringRecord = StringRecord
+  SessionData extends StringRecord = StringRecord,
 > extends Driver<C, CArgs, Settings, CreateResult, DeleteResult, SessionData> {
@@ -1269,3 +1283,3 @@ // WebDriver spec commands
     dataType: string,
-    dataReadTimeout?: number
+    dataReadTimeout?: number,
   ): Promise<any>;
@@ -1468,3 +1482,3 @@
     keyCode?: string,
-    keyName?: string
+    keyName?: string,
   ): Promise<boolean>;
@@ -1572,3 +1586,3 @@
     optionalIntentArguments?: string,
-    dontStopAppOnReset?: boolean
+    dontStopAppOnReset?: boolean,
   ): Promise<void>;
@@ -1784,3 +1798,3 @@
     yOffset?: number,
-    speed?: number
+    speed?: number,
   ): Promise<void>;
@@ -1911,3 +1925,3 @@
     isUserConsenting?: boolean,
-    isUserVerified?: boolean
+    isUserVerified?: boolean,
   ): Promise<string>;
@@ -1942,3 +1956,3 @@
     signCount: number,
-    authenticatorId: string
+    authenticatorId: string,
   ): Promise<void>;
@@ -1991,3 +2005,3 @@
     method: HTTPMethod,
-    body?: TReq
+    body?: TReq,
   ): Promise<TRes>;
@@ -2137,5 +2151,5 @@ }
   onPostProcess?: (
-    obj: PostProcessOptions
+    obj: PostProcessOptions,
   ) => Promise<PostProcessResult | undefined> | PostProcessResult | undefined;
   supportedExtensions: string[];
 }

lib/index.ts

@@ -13,1 +13,2 @@ export * from './command';
 export * from './logger';
+export * from './doctor';

lib/logger.ts

@@ -40,3 +40,7 @@ import type {Logger} from 'npmlog';
   http(...args: any[]): void;
+  /**
+   * @deprecated Use {@link errorWithException} instead
+   */
   errorAndThrow(...args: any[]): never;
+  errorWithException(...args: any[]): Error;
 }

package.json

 {
   "name": "@appium/types",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Various type declarations used across Appium",
@@ -46,3 +46,3 @@ "keywords": [
     "@types/ws": "8.5.10",
-    "type-fest": "4.8.3"
+    "type-fest": "4.9.0"
   },
@@ -56,3 +56,3 @@ "engines": {
   },
-  "gitHead": "5c1d20517cfc8773cd5ffb0f8bb996668d71116b"
+  "gitHead": "76df4d600dcb7c867c37c3d7d302dc7fcc95ae09"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

282488

increased by2.12%

Number of package files

80

increased by6.67%

Lines of code

6399

increased by2.35%

Dependency changes

• + Addedtype-fest@4.9.0(transitive)

• - Removedtype-fest@4.8.3(transitive)

• Updatedtype-fest@4.9.0