@appium/types 0.21.2 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/build/lib/appium-config.d.ts +15 -10
  2. package/build/lib/appium-config.d.ts.map +1 -1
  3. package/build/lib/server.d.ts +2 -0
  4. package/build/lib/server.d.ts.map +1 -1
  5. package/lib/appium-config.ts +15 -10
  6. package/lib/server.ts +2 -0
  7. package/package.json +5 -5
package/build/lib/appium-config.d.ts CHANGED
@@ -105,10 +105,22 @@ export type PortConfig = number;
105
105
  * Disable additional security checks, so it is possible to use some advanced features, provided by drivers supporting this option. Only enable it if all the clients are in the trusted network and it's not the case if a client could potentially break out of the session sandbox. Specific features can be overridden by using "deny-insecure"
106
106
  */
107
107
  export type RelaxedSecurityConfig = boolean;
108
+ /**
109
+ * For how long the server should delay its shutdown before force-closing all open connections to it. Setting its value to zero should close the server without waiting for active connections.
110
+ */
111
+ export type GracefulServerShutdownTimeoutInMilliseconds = number;
108
112
  /**
109
113
  * Enables session override (clobbering)
110
114
  */
111
115
  export type SessionOverrideConfig = boolean;
116
+ /**
117
+ * Full path to the .cert file if TLS is used. Must be provided together with "ssl-key-path"
118
+ */
119
+ export type CertFilePath = string;
120
+ /**
121
+ * Full path to the .key file if TLS is used. Must be provided together with "ssl-cert-path"
122
+ */
123
+ export type KeyFilePath = string;
112
124
  /**
113
125
  * Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device
114
126
  */
@@ -133,14 +145,6 @@ export type UsePluginsConfig = string[];
133
145
  * Also send log output to this http listener
134
146
  */
135
147
  export type WebhookConfig = string;
136
- /**
137
- * Full path to the .cert file if TLS is used. Must be provided together with "ssl-key-path"
138
- */
139
- export type CertFilePath = string;
140
- /**
141
- * Full path to the .key file if TLS is used. Must be provided together with "ssl-cert-path"
142
- */
143
- export type KeyFilePath = string;
144
148
  /**
145
149
  * A schema for Appium configuration files
146
150
  */
@@ -181,15 +185,16 @@ export interface ServerConfig {
181
185
  plugin?: PluginConfig;
182
186
  port?: PortConfig;
183
187
  "relaxed-security"?: RelaxedSecurityConfig;
188
+ "shutdown-timeout"?: GracefulServerShutdownTimeoutInMilliseconds;
184
189
  "session-override"?: SessionOverrideConfig;
190
+ "ssl-cert-path"?: CertFilePath;
191
+ "ssl-key-path"?: KeyFilePath;
185
192
  "strict-caps"?: StrictCapsConfig;
186
193
  tmp?: TmpConfig;
187
194
  "trace-dir"?: TraceDirConfig;
188
195
  "use-drivers"?: UseDriversConfig;
189
196
  "use-plugins"?: UsePluginsConfig;
190
197
  webhook?: WebhookConfig;
191
- "ssl-cert-path"?: CertFilePath;
192
- "ssl-key-path"?: KeyFilePath;
193
198
  }
194
199
  /**
195
200
  * Set the default desired capabilities, which will be set on each session unless overridden by received capabilities. If a string, a path to a JSON file containing the capabilities, or raw JSON.
package/build/lib/appium-config.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"appium-config.d.ts","sourceRoot":"","sources":["../../lib/appium-config.ts"],"names":[],"mappings":"AACA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC;AACtC;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAC;AAC3C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAC3C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AACxC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAC5C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,EAAE,CAAC;AAC1C;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAC5C;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC;AAC1C;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,GAAG,CAAC,aAAa,GAAG,cAAc,CAAC,CAAC;AACrC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,EAAE,CAAC;AAC3C;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,OAAO,GACP,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,OAAO,GACP,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,aAAa,CAAC;AAClB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,CAAC;AAC9D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC;AACxC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC;AACzC;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAClD;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAClD;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAC3C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC;AACzC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAChC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAC5C;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAC5C;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC;AACvC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,EAAE,CAAC;AACxC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,EAAE,CAAC;AACxC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IACvC,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IAC3C,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,mBAAmB,CAAC,EAAE,qBAAqB,CAAC;IAC5C,sBAAsB,CAAC,EAAE,yBAAyB,CAAC;IACnD,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,oBAAoB,CAAC,EAAE,sBAAsB,CAAC;IAC9C,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IACvC,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,eAAe,CAAC,EAAE,iBAAiB,CAAC;IACpC,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,2BAA2B,CAAC,EAAE,4BAA4B,CAAC;IAC3D,2BAA2B,CAAC,EAAE,4BAA4B,CAAC;IAC3D,iBAAiB,CAAC,EAAE,oBAAoB,CAAC;IACzC,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IAC3C,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IAC3C,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,eAAe,CAAC,EAAE,YAAY,CAAC;IAC/B,cAAc,CAAC,EAAE,WAAW,CAAC;CAC9B;AACD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB"}
1
+ {"version":3,"file":"appium-config.d.ts","sourceRoot":"","sources":["../../lib/appium-config.ts"],"names":[],"mappings":"AACA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC;AACtC;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAC;AAC3C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAC3C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AACxC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAC5C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,EAAE,CAAC;AAC1C;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAC5C;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC;AAC1C;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,GAAG,CAAC,aAAa,GAAG,cAAc,CAAC,CAAC;AACrC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,EAAE,CAAC;AAC3C;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,WAAW,GACX,WAAW,GACX,YAAY,GACZ,OAAO,GACP,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,OAAO,GACP,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,aAAa,CAAC;AAClB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,CAAC;AAC9D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC;AACxC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC;AACzC;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAClD;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC;AAClD;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAC3C;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC;AACzC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAChC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAC5C;;GAEG;AACH,MAAM,MAAM,2CAA2C,GAAG,MAAM,CAAC;AACjE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAC5C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAClC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AACjC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC;AACvC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AACpC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,EAAE,CAAC;AACxC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,EAAE,CAAC;AACxC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AACD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IACvC,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IAC3C,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,mBAAmB,CAAC,EAAE,qBAAqB,CAAC;IAC5C,sBAAsB,CAAC,EAAE,yBAAyB,CAAC;IACnD,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,oBAAoB,CAAC,EAAE,sBAAsB,CAAC;IAC9C,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IACvC,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,eAAe,CAAC,EAAE,iBAAiB,CAAC;IACpC,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,2BAA2B,CAAC,EAAE,4BAA4B,CAAC;IAC3D,2BAA2B,CAAC,EAAE,4BAA4B,CAAC;IAC3D,iBAAiB,CAAC,EAAE,oBAAoB,CAAC;IACzC,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IAC3C,kBAAkB,CAAC,EAAE,2CAA2C,CAAC;IACjE,kBAAkB,CAAC,EAAE,qBAAqB,CAAC;IAC3C,eAAe,CAAC,EAAE,YAAY,CAAC;IAC/B,cAAc,CAAC,EAAE,WAAW,CAAC;IAC7B,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACjC,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AACD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB"}
package/build/lib/server.d.ts CHANGED
@@ -36,6 +36,8 @@ export interface AppiumServerExtension {
36
36
  */
37
37
  getWebSocketHandlers(this: AppiumServer, keysFilter?: string | null): Promise<Record<string, WSServer>>;
38
38
  webSocketsMapping: Record<string, WSServer>;
39
+ /** Returns true if the server operates via HTTPS protocol */
40
+ isSecure(): boolean;
39
41
  }
40
42
  /**
41
43
  * @deprecated This interface will be removed
package/build/lib/server.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../lib/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAC,MAAM,IAAI,QAAQ,EAAC,MAAM,IAAI,CAAC;AAC3C,OAAO,KAAK,EAAC,MAAM,IAAI,UAAU,EAAC,MAAM,WAAW,CAAC;AACpD,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AACrC,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,qBAAqB,CAAC;AAE7E,MAAM,WAAW,qBAAqB;IACpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB;;;;OAIG;IACH,mBAAmB,CACjB,IAAI,EAAE,YAAY,EAClB,eAAe,EAAE,MAAM,EACvB,aAAa,EAAE,QAAQ,GACtB,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB;;;;;;OAMG;IACH,sBAAsB,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACtF;;;OAGG;IACH,0BAA0B,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjE;;;;;OAKG;IACH,oBAAoB,CAClB,IAAI,EAAE,YAAY,EAClB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GACzB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IACrC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,MAAM;IAChD,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,OAAO,EAAC,QAAQ,EAAC,CAAC;AAElB;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,UAAU,EAAE,OAAO,EACnB,UAAU,EAAE,YAAY,EACxB,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,KACzB,OAAO,CAAC,IAAI,CAAC,CAAC"}
1
+ {"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../lib/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,SAAS,CAAC;AACrC,OAAO,KAAK,EAAC,MAAM,IAAI,QAAQ,EAAC,MAAM,IAAI,CAAC;AAC3C,OAAO,KAAK,EAAC,MAAM,IAAI,UAAU,EAAC,MAAM,WAAW,CAAC;AACpD,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,UAAU,CAAC;AACrC,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,qBAAqB,CAAC;AAE7E,MAAM,WAAW,qBAAqB;IACpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB;;;;OAIG;IACH,mBAAmB,CACjB,IAAI,EAAE,YAAY,EAClB,eAAe,EAAE,MAAM,EACvB,aAAa,EAAE,QAAQ,GACtB,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB;;;;;;OAMG;IACH,sBAAsB,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACtF;;;OAGG;IACH,0BAA0B,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjE;;;;;OAKG;IACH,oBAAoB,CAClB,IAAI,EAAE,YAAY,EAClB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GACzB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IACrC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5C,6DAA6D;IAC7D,QAAQ,IAAI,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,MAAM;IAChD,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,OAAO,EAAC,QAAQ,EAAC,CAAC;AAElB;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,UAAU,EAAE,OAAO,EACnB,UAAU,EAAE,YAAY,EACxB,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,KACzB,OAAO,CAAC,IAAI,CAAC,CAAC"}
package/lib/appium-config.ts CHANGED
@@ -127,10 +127,22 @@ export type PortConfig = number;
127
127
  * Disable additional security checks, so it is possible to use some advanced features, provided by drivers supporting this option. Only enable it if all the clients are in the trusted network and it's not the case if a client could potentially break out of the session sandbox. Specific features can be overridden by using "deny-insecure"
128
128
  */
129
129
  export type RelaxedSecurityConfig = boolean;
130
+ /**
131
+ * For how long the server should delay its shutdown before force-closing all open connections to it. Setting its value to zero should close the server without waiting for active connections.
132
+ */
133
+ export type GracefulServerShutdownTimeoutInMilliseconds = number;
130
134
  /**
131
135
  * Enables session override (clobbering)
132
136
  */
133
137
  export type SessionOverrideConfig = boolean;
138
+ /**
139
+ * Full path to the .cert file if TLS is used. Must be provided together with "ssl-key-path"
140
+ */
141
+ export type CertFilePath = string;
142
+ /**
143
+ * Full path to the .key file if TLS is used. Must be provided together with "ssl-cert-path"
144
+ */
145
+ export type KeyFilePath = string;
134
146
  /**
135
147
  * Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device
136
148
  */
@@ -155,14 +167,6 @@ export type UsePluginsConfig = string[];
155
167
  * Also send log output to this http listener
156
168
  */
157
169
  export type WebhookConfig = string;
158
- /**
159
- * Full path to the .cert file if TLS is used. Must be provided together with "ssl-key-path"
160
- */
161
- export type CertFilePath = string;
162
- /**
163
- * Full path to the .key file if TLS is used. Must be provided together with "ssl-cert-path"
164
- */
165
- export type KeyFilePath = string;
166
170
 
167
171
  /**
168
172
  * A schema for Appium configuration files
@@ -204,15 +208,16 @@ export interface ServerConfig {
204
208
  plugin?: PluginConfig;
205
209
  port?: PortConfig;
206
210
  "relaxed-security"?: RelaxedSecurityConfig;
211
+ "shutdown-timeout"?: GracefulServerShutdownTimeoutInMilliseconds;
207
212
  "session-override"?: SessionOverrideConfig;
213
+ "ssl-cert-path"?: CertFilePath;
214
+ "ssl-key-path"?: KeyFilePath;
208
215
  "strict-caps"?: StrictCapsConfig;
209
216
  tmp?: TmpConfig;
210
217
  "trace-dir"?: TraceDirConfig;
211
218
  "use-drivers"?: UseDriversConfig;
212
219
  "use-plugins"?: UsePluginsConfig;
213
220
  webhook?: WebhookConfig;
214
- "ssl-cert-path"?: CertFilePath;
215
- "ssl-key-path"?: KeyFilePath;
216
221
  }
217
222
  /**
218
223
  * Set the default desired capabilities, which will be set on each session unless overridden by received capabilities. If a string, a path to a JSON file containing the capabilities, or raw JSON.
package/lib/server.ts CHANGED
@@ -45,6 +45,8 @@ export interface AppiumServerExtension {
45
45
  keysFilter?: string | null
46
46
  ): Promise<Record<string, WSServer>>;
47
47
  webSocketsMapping: Record<string, WSServer>;
48
+ /** Returns true if the server operates via HTTPS protocol */
49
+ isSecure(): boolean;
48
50
  }
49
51
 
50
52
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appium/types",
3
- "version": "0.21.2",
3
+ "version": "0.22.0",
4
4
  "description": "Various type declarations used across Appium",
5
5
  "keywords": [
6
6
  "automation",
@@ -39,11 +39,11 @@
39
39
  },
40
40
  "dependencies": {
41
41
  "@appium/logger": "^1.6.1",
42
- "@appium/schema": "^0.6.1",
42
+ "@appium/schema": "^0.7.0",
43
43
  "@appium/tsconfig": "^0.3.3",
44
- "@types/express": "4.17.21",
44
+ "@types/express": "5.0.0",
45
45
  "@types/ws": "8.5.12",
46
- "type-fest": "4.23.0"
46
+ "type-fest": "4.26.1"
47
47
  },
48
48
  "engines": {
49
49
  "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -52,5 +52,5 @@
52
52
  "publishConfig": {
53
53
  "access": "public"
54
54
  },
55
- "gitHead": "edf2593e1729d8f06002fa5c5622e26d71d79545"
55
+ "gitHead": "e3f7bd07f773c42d06b43a69f15e0c8fed0e10aa"
56
56
  }