@appium/types - npm Package Compare versions

Comparing version 0.2.5 to 0.3.0

build/driver.d.ts

@@ -231,3 +231,3 @@ /// <reference types="node" />
     isFeatureEnabled(name: string): boolean;
-    ensureFeatureEnabled(name: string): void;
+    assertFeatureEnabled(name: string): void;
     validateLocatorStrategy(strategy: string, webContext?: boolean): void;
@@ -234,0 +234,0 @@ proxyActive(sessionId?: string): boolean;

build/index.d.ts

 /// <reference types="node" />
-import type { Method as _Method } from 'axios';
+/// <reference types="node" />
+import type { Server as WSServer } from 'ws';
+import type { Socket } from 'net';
 import type { Server } from 'http';
@@ -44,10 +46,10 @@ import type { Class as _Class, ConditionalPick, MultidimensionalReadonlyArray } from 'type-fest';
     prefix?: AppiumLoggerPrefix;
-    debug: (...args: any[]) => void;
-    info: (...args: any[]) => void;
-    warn: (...args: any[]) => void;
-    error: (...args: any[]) => void;
-    verbose: (...args: any[]) => void;
-    silly: (...args: any[]) => void;
-    http: (...args: any[]) => void;
-    errorAndThrow: (...args: any[]) => never;
+    debug(...args: any[]): void;
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+    verbose(...args: any[]): void;
+    silly(...args: any[]): void;
+    http(...args: any[]): void;
+    errorAndThrow(...args: any[]): never;
 }
@@ -57,5 +59,14 @@ /**
  */
-export declare type AppiumServer = Omit<Server, 'close'> & {
-    close: () => Promise<void>;
-};
+export declare type AppiumServer = Omit<Server, 'close'> & AppiumServerExtension;
+export interface AppiumServerExtension {
+    close(): Promise<void>;
+    addWebSocketHandler(handlerPathname: string, handlerServer: WSServer): Promise<void>;
+    removeWebSocketHandler(handlerPathname: string): Promise<boolean>;
+    removeAllWebSocketHandlers(): Promise<boolean>;
+    getWebSocketHandlers(keysFilter: string | null | undefined): Promise<Record<string, WSServer>>;
+    webSocketsMapping: Record<string, WSServer>;
+}
+export interface AppiumServerSocket extends Socket {
+    _openReqCount: number;
+}
 /**
@@ -137,3 +148,3 @@ * The definition of an extension method, which will be provided via Appium's API.
  */
-export declare type HTTPMethod = _Method;
+export declare type HTTPMethod = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
 //# sourceMappingURL=index.d.ts.map

lib/driver.ts

@@ -306,3 +306,3 @@ import type {EventEmitter} from 'events';
   isFeatureEnabled(name: string): boolean;
-  ensureFeatureEnabled(name: string): void;
+  assertFeatureEnabled(name: string): void;
   validateLocatorStrategy(strategy: string, webContext?: boolean): void;
@@ -309,0 +309,0 @@ proxyActive(sessionId?: string): boolean;

lib/index.ts

@@ -1,2 +0,3 @@
-import type {Method as _Method} from 'axios';
+import type {Server as WSServer} from 'ws';
+import type {Socket} from 'net';
 import type {Server} from 'http';
@@ -47,10 +48,10 @@ import type {Class as _Class, ConditionalPick, MultidimensionalReadonlyArray} from 'type-fest';
   prefix?: AppiumLoggerPrefix;
-  debug: (...args: any[]) => void;
-  info: (...args: any[]) => void;
-  warn: (...args: any[]) => void;
-  error: (...args: any[]) => void;
-  verbose: (...args: any[]) => void;
-  silly: (...args: any[]) => void;
-  http: (...args: any[]) => void;
-  errorAndThrow: (...args: any[]) => never;
+  debug(...args: any[]): void;
+  info(...args: any[]): void;
+  warn(...args: any[]): void;
+  error(...args: any[]): void;
+  verbose(...args: any[]): void;
+  silly(...args: any[]): void;
+  http(...args: any[]): void;
+  errorAndThrow(...args: any[]): never;
 }
@@ -61,6 +62,22 @@
  */
-export type AppiumServer = Omit<Server, 'close'> & {
-  close: () => Promise<void>;
-};
+export type AppiumServer = Omit<Server, 'close'> & AppiumServerExtension;
 
+export interface AppiumServerExtension {
+  close(): Promise<void>;
+  addWebSocketHandler(
+    handlerPathname: string,
+    handlerServer: WSServer
+  ): Promise<void>;
+  removeWebSocketHandler(handlerPathname: string): Promise<boolean>;
+  removeAllWebSocketHandlers(): Promise<boolean>;
+  getWebSocketHandlers(
+    keysFilter: string | null | undefined
+  ): Promise<Record<string, WSServer>>;
+  webSocketsMapping: Record<string, WSServer>;
+}
+
+export interface AppiumServerSocket extends Socket {
+  _openReqCount: number;
+}
+
 /**
@@ -157,2 +174,13 @@ * The definition of an extension method, which will be provided via Appium's API.
  */
-export type HTTPMethod = _Method;
+export type HTTPMethod =
+  | 'get' | 'GET'
+  | 'delete' | 'DELETE'
+  | 'head' | 'HEAD'
+  | 'options' | 'OPTIONS'
+  | 'post' | 'POST'
+  | 'put' | 'PUT'
+  | 'patch' | 'PATCH'
+  | 'purge' | 'PURGE'
+  | 'link' | 'LINK'
+  | 'unlink' | 'UNLINK';
+

package.json

 {
   "name": "@appium/types",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "description": "Various type declarations used across Appium",
@@ -31,6 +31,11 @@ "keywords": [
     "lint": "eslint -c ../../.eslintrc --ignore-path ../../.eslintignore .",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "test:smoke": "echo 'No smoke test for this package'"
   },
   "dependencies": {
-    "@appium/schema": "^0.0.7"
+    "@appium/schema": "^0.0.8",
+    "@types/express": "4.17.13",
+    "@types/npmlog": "4.1.4",
+    "@wdio/types": "7.20.7",
+    "type-fest": "2.17.0"
   },
@@ -44,3 +49,3 @@ "engines": {
   },
-  "gitHead": "62b97417fcb7b0c0e2d6bab30bf9406e09bfb2ed"
+  "gitHead": "f6e6d7234e7fe92f989f4e37a71007044985dedf"
 }

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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

126100

increased by1.82%

Lines of code

2123

increased by1.72%

Worsened metrics

Dependency count

5

increased by400%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@types/express@4.17.13

• + Added@types/npmlog@4.1.4

• + Added@wdio/types@7.20.7

• + Addedtype-fest@2.17.0

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

• + Added@sindresorhus/is@4.6.0(transitive)

• + Added@szmarczak/http-timer@4.0.6(transitive)

• + Added@types/body-parser@1.19.5(transitive)

• + Added@types/cacheable-request@6.0.3(transitive)

• + Added@types/connect@3.4.38(transitive)

• + Added@types/express@4.17.13(transitive)

• + Added@types/express-serve-static-core@4.19.6(transitive)

• + Added@types/http-cache-semantics@4.0.4(transitive)

• + Added@types/http-errors@2.0.4(transitive)

• + Added@types/json-schema@7.0.11(transitive)

• + Added@types/keyv@3.1.4(transitive)

• + Added@types/mime@1.3.5(transitive)

• + Added@types/node@18.19.6822.10.2(transitive)

• + Added@types/npmlog@4.1.4(transitive)

• + Added@types/qs@6.9.17(transitive)

• + Added@types/range-parser@1.2.7(transitive)

• + Added@types/responselike@1.0.3(transitive)

• + Added@types/send@0.17.4(transitive)

• + Added@types/serve-static@1.15.7(transitive)

• + Added@wdio/types@7.20.7(transitive)

• + Addedcacheable-lookup@5.0.4(transitive)

• + Addedcacheable-request@7.0.4(transitive)

• + Addedclone-response@1.0.3(transitive)

• + Addeddecompress-response@6.0.0(transitive)

• + Addeddefer-to-connect@2.0.1(transitive)

• + Addedend-of-stream@1.4.4(transitive)

• + Addedget-stream@5.2.0(transitive)

• + Addedgot@11.8.6(transitive)

• + Addedhttp-cache-semantics@4.1.1(transitive)

• + Addedhttp2-wrapper@1.0.3(transitive)

• + Addedjson-buffer@3.0.1(transitive)

• + Addedjson-schema@0.4.0(transitive)

• + Addedkeyv@4.5.4(transitive)

• + Addedlowercase-keys@2.0.0(transitive)

• + Addedmimic-response@1.0.13.1.0(transitive)

• + Addednormalize-url@6.1.0(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedp-cancelable@2.1.1(transitive)

• + Addedpump@3.0.2(transitive)

• + Addedquick-lru@5.1.1(transitive)

• + Addedresolve-alpn@1.2.1(transitive)

• + Addedresponselike@2.0.1(transitive)

• + Addedtype-fest@2.17.0(transitive)

• + Addedtypescript@4.9.5(transitive)

• + Addedundici-types@5.26.56.20.0(transitive)

• + Addedwrappy@1.0.2(transitive)

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

• Updated@appium/schema@^0.0.8