@appium/types - npm Package Compare versions

Comparing version 0.1.1 to 0.2.0

build/config.d.ts

@@ -45,3 +45,3 @@ import type { AppiumConfigJsonSchema } from '@appium/schema';
  */
-export declare type DriverOpts = {
+export declare type ServerArgs = {
     [Prop in keyof ServerConfigMapping as SetKeyForProp<Prop>]: KeyOrDefaultForProp<Prop>;
@@ -48,0 +48,0 @@ };

build/index.d.ts

@@ -7,3 +7,3 @@ /// <reference types="node" />
 import type { Class as _Class, MultidimensionalReadonlyArray } from 'type-fest';
-import { DriverOpts } from './config';
+import { ServerArgs } from './config';
 import { Capabilities, W3CCapabilities } from './capabilities';
@@ -13,3 +13,3 @@ export { AppiumW3CCapabilities } from './capabilities';
 export * from './appium-config';
-export { DriverOpts, Capabilities, W3CCapabilities };
+export { ServerArgs, Capabilities, W3CCapabilities };
 /**
@@ -20,4 +20,4 @@ * Methods and properties which both `AppiumDriver` and `BaseDriver` inherit.
     sessionId: string | null;
-    opts: DriverOpts;
-    initialOpts: DriverOpts;
+    opts: ServerArgs;
+    initialOpts: ServerArgs;
     caps?: Capabilities;
@@ -66,3 +66,3 @@ originalCaps?: W3CCapabilities;
     reset(): Promise<void>;
-    assignServer(server: AppiumServer, host: string, port: number, path: string): void;
+    assignServer?(server: AppiumServer, host: string, port: number, path: string): void;
 }
@@ -94,2 +94,3 @@ /**
     fullScreenWindow?(): Promise<Rect>;
+    createNewWindow?(type?: NewWindowType): Promise<NewWindow>;
     active?(): Promise<Element>;
@@ -279,2 +280,7 @@ elementSelected?(elementId: string): Promise<boolean>;
 }
+export declare type NewWindowType = 'tab' | 'window';
+export interface NewWindow {
+    handle: string;
+    type: NewWindowType;
+}
 export interface Cookie {
@@ -367,3 +373,3 @@ name: string;
 }
-export declare type AppiumServer = Server & {
+export declare type AppiumServer = Omit<Server, 'close'> & {
     close: () => Promise<void>;
@@ -414,3 +420,10 @@ };
     getLogTypes(): Promise<string[]>;
-    getLog<T>(logType: LogType<T>): Promise<any[]>;
+    /**
+     * Gets logs
+     *
+     * TODO: `logType` should be a key in `supportedLogTypes`, and the return value of this function
+     * should be the associated `LogType` object's `LogEntry` parameterized type.
+     * @param logType - Name/key of log type as defined in {@linkcode LogCommands.supportedLogTypes}.
+     */
+    getLog(logType: string): Promise<any[]>;
 }
@@ -417,0 +430,0 @@ export interface SettingsCommands {

lib/config.ts

@@ -62,3 +62,3 @@ import type { AppiumConfigJsonSchema } from '@appium/schema';
  */
-export type DriverOpts = {
+export type ServerArgs = {
   [Prop in keyof ServerConfigMapping as SetKeyForProp<Prop>]: KeyOrDefaultForProp<Prop>;
@@ -65,0 +65,0 @@ };

lib/index.ts

@@ -6,3 +6,3 @@ import type { Method as _Method } from 'axios';
 import type { Class as _Class, MultidimensionalReadonlyArray } from 'type-fest';
-import { DriverOpts } from './config';
+import { ServerArgs } from './config';
 import { Capabilities, W3CCapabilities } from './capabilities';
@@ -13,3 +13,3 @@
 export * from './appium-config';
-export { DriverOpts, Capabilities, W3CCapabilities };
+export { ServerArgs, Capabilities, W3CCapabilities };
 
@@ -21,4 +21,4 @@ /**
   sessionId: string | null;
-  opts: DriverOpts;
-  initialOpts: DriverOpts;
+  opts: ServerArgs;
+  initialOpts: ServerArgs;
   caps?: Capabilities;
@@ -78,3 +78,3 @@ originalCaps?: W3CCapabilities;
 
-  assignServer(
+  assignServer?(
     server: AppiumServer,
@@ -120,2 +120,3 @@ host: string,
   fullScreenWindow?(): Promise<Rect>;
+  createNewWindow?(type?: NewWindowType): Promise<NewWindow>;
   active?(): Promise<Element>;
@@ -413,2 +414,9 @@ elementSelected?(elementId: string): Promise<boolean>;
 
+export type NewWindowType = 'tab' | 'window';
+
+export interface NewWindow {
+  handle: string;
+  type: NewWindowType;
+}
+
 export interface Cookie {
@@ -520,3 +528,3 @@ name: string;
 
-export type AppiumServer = Server & {
+export type AppiumServer = Omit<Server, 'close'> & {
   close: () => Promise<void>;
@@ -599,3 +607,10 @@ };
   getLogTypes(): Promise<string[]>;
-  getLog<T>(logType: LogType<T>): Promise<any[]>;
+  /**
+   * Gets logs
+   * 
+   * TODO: `logType` should be a key in `supportedLogTypes`, and the return value of this function
+   * should be the associated `LogType` object's `LogEntry` parameterized type.
+   * @param logType - Name/key of log type as defined in {@linkcode LogCommands.supportedLogTypes}.
+   */
+  getLog(logType: string): Promise<any[]>;
 }
@@ -602,0 +617,0 @@

package.json

 {
   "name": "@appium/types",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Various type declarations used across Appium",
@@ -39,6 +39,6 @@ "keywords": [
   },
-  "gitHead": "319f7289e7019efaeac1271936b2d991041a02c2",
+  "gitHead": "8b7906f757f23b7abc09a0acf41a3daa6671c2ec",
   "dependencies": {
-    "@appium/schema": "^0.0.2"
+    "@appium/schema": "^0.0.3"
   }
 }

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

105503

increased by1.19%

Lines of code

1677

increased by1.57%

Dependency changes

• + Added@appium/schema@0.0.3(transitive)

• - Removed@appium/schema@0.0.2(transitive)

• Updated@appium/schema@^0.0.3