@appium/types 0.25.1 → 0.25.2

package/build/lib/http.d.ts

@@ -1,3 +1,4 @@
+import type { AppiumLogger } from './logger';
 /**
  * An object of HTTP headers.
  */
@@ -8,4 +9,64 @@ export type HTTPHeaders = Record<string, string | string[] | number | boolean |
  * @see https://npm.im/axios
  */
 export type HTTPMethod = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
+export interface ProxyResponse<T = any> {
+    statusCode: number;
+    headers: HTTPHeaders;
+    body: HTTPBody<T>;
+}
+export interface ProxyOptions {
+    /**
+     * Downstream URL scheme
+     *
+     * @default 'http'
+     */
+    scheme?: string;
+    /**
+     * Downstream server hostname
+     *
+     * @default 'localhost'
+     */
+    server?: string;
+    /**
+     * Downstream server port number
+     *
+     * @default 4444
+     */
+    port?: number;
+    /**
+     * Downstream server pathname prefix
+     *
+     * @default ''
+     */
+    base?: string;
+    /**
+     * Upstream server pathname prefix
+     *
+     * @default ''
+     */
+    reqBasePath?: string;
+    /**
+     * Initial downstream session identifier value
+     *
+     * @default null
+     */
+    sessionId?: string | null;
+    /**
+     * Downstream server timeout in milliseconds
+     *
+     * @default 240000
+     */
+    timeout?: number;
+    /**
+     * Proxy logger instance. If unset then a default logger is used
+     */
+    log?: AppiumLogger;
+    /**
+     * Whether to apply HTTP Keep-Alive to the downstream server
+     *
+     * @default true
+     */
+    keepAlive?: boolean;
+}
+export type HTTPBody<T = any> = T;
 //# sourceMappingURL=http.d.ts.map

package/build/lib/http.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../lib/http.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;AAEtF;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,MAAM,GACN,SAAS,GACT,SAAS,GACT,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,MAAM,GACN,MAAM,GACN,QAAQ,GACR,QAAQ,CAAC"}
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../lib/http.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;AAEtF;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,MAAM,GACN,SAAS,GACT,SAAS,GACT,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,MAAM,GACN,MAAM,GACN,QAAQ,GACR,QAAQ,CAAC;AAEb,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,WAAW,CAAC;IACrB,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,GAAG,CAAC,EAAE,YAAY,CAAC;IACnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,MAAM,QAAQ,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC"}

package/lib/http.ts

@@ -1,3 +1,5 @@
+import type { AppiumLogger } from './logger';
+
 /**
  * An object of HTTP headers.
  */
@@ -29,3 +31,66 @@ export type HTTPMethod =
   | 'LINK'
   | 'unlink'
   | 'UNLINK';
+
+export interface ProxyResponse<T = any> {
+  statusCode: number;
+  headers: HTTPHeaders;
+  body: HTTPBody<T>;
+}
+
+export interface ProxyOptions {
+  /**
+   * Downstream URL scheme
+   *
+   * @default 'http'
+   */
+  scheme?: string;
+  /**
+   * Downstream server hostname
+   *
+   * @default 'localhost'
+   */
+  server?: string;
+  /**
+   * Downstream server port number
+   *
+   * @default 4444
+   */
+  port?: number;
+  /**
+   * Downstream server pathname prefix
+   *
+   * @default ''
+   */
+  base?: string;
+  /**
+   * Upstream server pathname prefix
+   *
+   * @default ''
+   */
+  reqBasePath?: string;
+  /**
+   * Initial downstream session identifier value
+   *
+   * @default null
+   */
+  sessionId?: string | null;
+  /**
+   * Downstream server timeout in milliseconds
+   *
+   * @default 240000
+   */
+  timeout?: number;
+  /**
+   * Proxy logger instance. If unset then a default logger is used
+   */
+  log?: AppiumLogger;
+  /**
+   * Whether to apply HTTP Keep-Alive to the downstream server
+   *
+   * @default true
+   */
+  keepAlive?: boolean;
+}
+
+export type HTTPBody<T = any> = T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appium/types",
-  "version": "0.25.1",
+  "version": "0.25.2",
   "description": "Various type declarations used across Appium",
   "keywords": [
     "automation",
@@ -40,8 +40,8 @@
   "dependencies": {
     "@appium/logger": "^1.6.1",
     "@appium/schema": "^0.8.1",
-    "@appium/tsconfig": "^0.3.4",
-    "type-fest": "4.35.0"
+    "@appium/tsconfig": "^0.3.5",
+    "type-fest": "4.37.0"
   },
   "engines": {
     "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -50,5 +50,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "715fd03c45d791ef24b28ad915a20ce6430ff946"
+  "gitHead": "7c05f5c213e284b6be0f1ecf5550a40d84e0899e"
 }