@appium/types 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright JS Foundation and other contributors, https://js.foundation
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# @appium/types
+
+> A collection of TypeScript type declarations used across various [Appium](https://github.com/appium/appium) packages.
+
+**Warning: This is a work-in-progress; expect breaking changes!**
+
+## Install
+
+```bash
+npm install @appium/types -D
+```
+
+## Notes
+
+- The sources are `.ts` files, _not_ `.d.ts` files. This allows other packages in the root TypeScript "project" to define a dependency upon this one, and enables incremental builds an "watch" mode.
+- If there is a way to switch to `.d.ts` files and configure this package to work in our "project" context _without_ needing to actually "emit" anything, then we should do that instead.  Help accepted!
+- `lib/appium-config.ts` is generated by this package from `@appium/schema`, but is under version control to avoid chicken-or-egg build problems.
+
+## License
+
+Apache-2.0

package/build/appium-config.d.ts

@@ -0,0 +1,175 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * IP address to listen on
+ */
+export declare type AddressConfig = string;
+/**
+ * Whether the Appium server should allow web browser connections from any host
+ */
+export declare type AllowCorsConfig = boolean;
+/**
+ * Set which insecure features are allowed to run in this server's sessions. Features are defined on a driver level; see documentation for more details. Note that features defined via "deny-insecure" will be disabled, even if also listed here. If string, a path to a text file containing policy or a comma-delimited list.
+ */
+export declare type AllowInsecureConfig = string[];
+/**
+ * Base path to use as the prefix for all webdriver routes running on the server
+ */
+export declare type BasePathConfig = string;
+/**
+ * Callback IP address (default: same as "address")
+ */
+export declare type CallbackAddressConfig = string;
+/**
+ * Callback port (default: same as "port")
+ */
+export declare type CallbackPortConfig = number;
+/**
+ * Add exaggerated spacing in logs to help with visual inspection
+ */
+export declare type DebugLogSpacingConfig = boolean;
+/**
+ * Set which insecure features are not allowed to run in this server's sessions. Features are defined on a driver level; see documentation for more details. Features listed here will not be enabled even if also listed in "allow-insecure", and even if "relaxed-security" is enabled. If string, a path to a text file containing policy or a comma-delimited list.
+ */
+export declare type DenyInsecureConfig = string[];
+/**
+ * Number of seconds the Appium server should apply as both the keep-alive timeout and the connection timeout for all requests. A value of 0 disables the timeout.
+ */
+export declare type KeepAliveTimeoutConfig = number;
+/**
+ * Use local timezone for timestamps
+ */
+export declare type LocalTimezoneConfig = boolean;
+/**
+ * Also send log output to this file
+ */
+export declare type LogConfig = string;
+/**
+ * One or more log filtering rules
+ */
+export declare type LogFiltersConfig = string[];
+/**
+ * Log level (console[:file])
+ */
+export declare type LogLevelConfig = "info" | "info:debug" | "info:info" | "info:warn" | "info:error" | "warn" | "warn:debug" | "warn:info" | "warn:warn" | "warn:error" | "error" | "error:debug" | "error:info" | "error:warn" | "error:error" | "debug" | "debug:debug" | "debug:info" | "debug:warn" | "debug:error";
+/**
+ * Do not use color in console output
+ */
+export declare type LogNoColorsConfig = boolean;
+/**
+ * Show timestamps in console output
+ */
+export declare type LogTimestampConfig = boolean;
+/**
+ * Add long stack traces to log entries. Recommended for debugging only.
+ */
+export declare type LongStacktraceConfig = boolean;
+/**
+ * Do not check that needed files are readable and/or writable
+ */
+export declare type NoPermsCheckConfig = boolean;
+/**
+ * Port to listen on
+ */
+export declare type PortConfig = number;
+/**
+ * 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"
+ */
+export declare type RelaxedSecurityConfig = boolean;
+/**
+ * Enables session override (clobbering)
+ */
+export declare type SessionOverrideConfig = boolean;
+/**
+ * Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device
+ */
+export declare type StrictCapsConfig = boolean;
+/**
+ * Absolute path to directory Appium can use to manage temp files. Defaults to C:\Windows\Temp on Windows and /tmp otherwise.
+ */
+export declare type TmpConfig = string;
+/**
+ * Absolute path to directory Appium can use to save iOS instrument traces; defaults to <tmp>/appium-instruments
+ */
+export declare type TraceDirConfig = string;
+/**
+ * A list of drivers to activate. By default, all installed drivers will be activated.
+ */
+export declare type UseDriversConfig = string[];
+/**
+ * A list of plugins to activate. To activate all plugins, the value should be an array with a single item "all".
+ */
+export declare type UsePluginsConfig = string[];
+/**
+ * Also send log output to this http listener
+ */
+export declare type WebhookConfig = string;
+/**
+ * A schema for Appium configuration files
+ */
+export interface AppiumConfiguration {
+    server?: ServerConfig;
+}
+/**
+ * Configuration when running Appium as a server
+ */
+export interface ServerConfig {
+    address?: AddressConfig;
+    "allow-cors"?: AllowCorsConfig;
+    "allow-insecure"?: AllowInsecureConfig;
+    "base-path"?: BasePathConfig;
+    "callback-address"?: CallbackAddressConfig;
+    "callback-port"?: CallbackPortConfig;
+    "debug-log-spacing"?: DebugLogSpacingConfig;
+    "default-capabilities"?: DefaultCapabilitiesConfig;
+    "deny-insecure"?: DenyInsecureConfig;
+    driver?: DriverConfig;
+    "keep-alive-timeout"?: KeepAliveTimeoutConfig;
+    "local-timezone"?: LocalTimezoneConfig;
+    log?: LogConfig;
+    "log-filters"?: LogFiltersConfig;
+    "log-level"?: LogLevelConfig;
+    "log-no-colors"?: LogNoColorsConfig;
+    "log-timestamp"?: LogTimestampConfig;
+    "long-stacktrace"?: LongStacktraceConfig;
+    "no-perms-check"?: NoPermsCheckConfig;
+    nodeconfig?: NodeconfigConfig;
+    plugin?: PluginConfig;
+    port?: PortConfig;
+    "relaxed-security"?: RelaxedSecurityConfig;
+    "session-override"?: SessionOverrideConfig;
+    "strict-caps"?: StrictCapsConfig;
+    tmp?: TmpConfig;
+    "trace-dir"?: TraceDirConfig;
+    "use-drivers"?: UseDriversConfig;
+    "use-plugins"?: UsePluginsConfig;
+    webhook?: WebhookConfig;
+}
+/**
+ * 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.
+ */
+export interface DefaultCapabilitiesConfig {
+    [k: string]: unknown;
+}
+/**
+ * Driver-specific configuration. Keys should correspond to driver package names
+ */
+export interface DriverConfig {
+    [k: string]: unknown;
+}
+/**
+ * Path to configuration JSON file to register Appium as a node with Selenium Grid 3; otherwise the configuration itself
+ */
+export interface NodeconfigConfig {
+    [k: string]: unknown;
+}
+/**
+ * Plugin-specific configuration. Keys should correspond to plugin package names
+ */
+export interface PluginConfig {
+    [k: string]: unknown;
+}
+//# sourceMappingURL=appium-config.d.ts.map

package/build/appium-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"appium-config.d.ts","sourceRoot":"","sources":["../lib/appium-config.ts"],"names":[],"mappings":"AACA;;;;GAIG;AAEH;;GAEG;AACH,oBAAY,aAAa,GAAG,MAAM,CAAC;AACnC;;GAEG;AACH,oBAAY,eAAe,GAAG,OAAO,CAAC;AACtC;;GAEG;AACH,oBAAY,mBAAmB,GAAG,MAAM,EAAE,CAAC;AAC3C;;GAEG;AACH,oBAAY,cAAc,GAAG,MAAM,CAAC;AACpC;;GAEG;AACH,oBAAY,qBAAqB,GAAG,MAAM,CAAC;AAC3C;;GAEG;AACH,oBAAY,kBAAkB,GAAG,MAAM,CAAC;AACxC;;GAEG;AACH,oBAAY,qBAAqB,GAAG,OAAO,CAAC;AAC5C;;GAEG;AACH,oBAAY,kBAAkB,GAAG,MAAM,EAAE,CAAC;AAC1C;;GAEG;AACH,oBAAY,sBAAsB,GAAG,MAAM,CAAC;AAC5C;;GAEG;AACH,oBAAY,mBAAmB,GAAG,OAAO,CAAC;AAC1C;;GAEG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAC;AAC/B;;GAEG;AACH,oBAAY,gBAAgB,GAAG,MAAM,EAAE,CAAC;AACxC;;GAEG;AACH,oBAAY,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,oBAAY,iBAAiB,GAAG,OAAO,CAAC;AACxC;;GAEG;AACH,oBAAY,kBAAkB,GAAG,OAAO,CAAC;AACzC;;GAEG;AACH,oBAAY,oBAAoB,GAAG,OAAO,CAAC;AAC3C;;GAEG;AACH,oBAAY,kBAAkB,GAAG,OAAO,CAAC;AACzC;;GAEG;AACH,oBAAY,UAAU,GAAG,MAAM,CAAC;AAChC;;GAEG;AACH,oBAAY,qBAAqB,GAAG,OAAO,CAAC;AAC5C;;GAEG;AACH,oBAAY,qBAAqB,GAAG,OAAO,CAAC;AAC5C;;GAEG;AACH,oBAAY,gBAAgB,GAAG,OAAO,CAAC;AACvC;;GAEG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAC;AAC/B;;GAEG;AACH,oBAAY,cAAc,GAAG,MAAM,CAAC;AACpC;;GAEG;AACH,oBAAY,gBAAgB,GAAG,MAAM,EAAE,CAAC;AACxC;;GAEG;AACH,oBAAY,gBAAgB,GAAG,MAAM,EAAE,CAAC;AACxC;;GAEG;AACH,oBAAY,aAAa,GAAG,MAAM,CAAC;AAEnC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,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,eAAe,CAAC,EAAE,iBAAiB,CAAC;IACpC,eAAe,CAAC,EAAE,kBAAkB,CAAC;IACrC,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;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,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/capabilities.d.ts

@@ -0,0 +1,47 @@
+import type { Capabilities as WdioCaps } from '@wdio/types';
+/**
+ * The mask of a W3C-style namespaced capability proped name.
+ */
+declare type Namespaced = `${string}:${string}`;
+/**
+ * An object with keys conforming to {@linkcode Namespaced}.
+ */
+declare type NamespacedRecord = Record<Namespaced, any>;
+/**
+ * An object with keys for strings.
+ */
+declare type StringRecord = Record<string, any>;
+/**
+ * All known capabilities derived from wdio's {@linkcode WdioCaps.Capabilities Capabilities} type, accepting additional optional caps.
+ * All properties are optional.
+ */
+declare type BaseCapabilities<OptionalCaps extends StringRecord = StringRecord> = Partial<WdioCaps.Capabilities & OptionalCaps>;
+/**
+ * All known capabilities derived from wdio's {@linkcode WdioCaps.Capabilities Capabilities} type and wdio's {@linkcode WdioCaps.AppiumCapabilities} type, accepting additional optional caps.
+ *
+ * In practice, the properties `platformName` and `automationName` are required by Appium.
+ */
+export declare type Capabilities<OptionalCaps extends StringRecord = StringRecord> = BaseCapabilities<WdioCaps.AppiumCapabilities & OptionalCaps>;
+/**
+ * All known capabilities derived from wdio's {@linkcode WdioCaps.Capabilities Capabilities} type and wdio's {@linkcode WdioCaps.AppiumW3CCapabilities} type, accepting additional optional _namespaced_ caps.
+ */
+export declare type AppiumW3CCapabilities<OptionalNamespacedCaps extends NamespacedRecord = NamespacedRecord> = BaseCapabilities<WdioCaps.AppiumW3CCapabilities & OptionalNamespacedCaps>;
+/**
+ * All known capabilities derived from wdio's {@linkcode WdioCaps.Capabilities Capabilities} type and wdio's {@linkcode WdioCaps.AppiumW3Capabilities} type, accepting additional optional _namespaced_ caps, in W3C-compatible format (`alwaysMatch`/`firstMatch`).
+ * In practice, the properties `appium:platformName` and `appium:automationName` are required by Appium _somewhere_ in this object; this cannot be expressed in TypeScript.
+ */
+export declare type W3CCapabilities<OptionalNamespacedCaps extends NamespacedRecord = NamespacedRecord> = {
+    alwaysMatch: AppiumW3CCapabilities<OptionalNamespacedCaps>;
+    firstMatch: AppiumW3CCapabilities<OptionalNamespacedCaps>[];
+};
+/**
+ * These may (or should) be reused by drivers.
+ */
+export declare type AppiumAndroidCapabilities = WdioCaps.AppiumAndroidCapabilities;
+export declare type AppiumIOSCapabilities = WdioCaps.AppiumIOSCapabilities;
+export declare type AppiumXCUICommandTimeouts = WdioCaps.AppiumXCUICommandTimeouts;
+export declare type AppiumXCUIProcessArguments = WdioCaps.AppiumXCUIProcessArguments;
+export declare type AppiumXCUISafariGlobalPreferences = WdioCaps.AppiumXCUISafariGlobalPreferences;
+export declare type AppiumXCUITestCapabilities = WdioCaps.AppiumXCUITestCapabilities;
+export {};
+//# sourceMappingURL=capabilities.d.ts.map

package/build/capabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../lib/capabilities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,IAAI,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5D;;GAEG;AACH,aAAK,UAAU,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAExC;;GAEG;AACH,aAAK,gBAAgB,GAAG,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;AAEhD;;GAEG;AACH,aAAK,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAExC;;;GAGG;AACH,aAAK,gBAAgB,CAAC,YAAY,SAAS,YAAY,GAAG,YAAY,IACpE,OAAO,CAAC,QAAQ,CAAC,YAAY,GAAG,YAAY,CAAC,CAAC;AAEhD;;;;GAIG;AACH,oBAAY,YAAY,CAAC,YAAY,SAAS,YAAY,GAAG,YAAY,IACvE,gBAAgB,CAAC,QAAQ,CAAC,kBAAkB,GAAG,YAAY,CAAC,CAAC;AAE/D;;GAEG;AACH,oBAAY,qBAAqB,CAC/B,sBAAsB,SAAS,gBAAgB,GAAG,gBAAgB,IAChE,gBAAgB,CAAC,QAAQ,CAAC,qBAAqB,GAAG,sBAAsB,CAAC,CAAC;AAE9E;;;GAGG;AACH,oBAAY,eAAe,CACzB,sBAAsB,SAAS,gBAAgB,GAAG,gBAAgB,IAChE;IACF,WAAW,EAAE,qBAAqB,CAAC,sBAAsB,CAAC,CAAC;IAC3D,UAAU,EAAE,qBAAqB,CAAC,sBAAsB,CAAC,EAAE,CAAC;CAC7D,CAAC;AAEF;;GAEG;AACH,oBAAY,yBAAyB,GAAG,QAAQ,CAAC,yBAAyB,CAAC;AAC3E,oBAAY,qBAAqB,GAAG,QAAQ,CAAC,qBAAqB,CAAC;AACnE,oBAAY,yBAAyB,GAAG,QAAQ,CAAC,yBAAyB,CAAC;AAC3E,oBAAY,0BAA0B,GAAG,QAAQ,CAAC,0BAA0B,CAAC;AAC7E,oBAAY,iCAAiC,GAC3C,QAAQ,CAAC,iCAAiC,CAAC;AAC7C,oBAAY,0BAA0B,GAAG,QAAQ,CAAC,0BAA0B,CAAC"}

package/build/config.d.ts

@@ -0,0 +1,80 @@
+import type { AppiumConfigJsonSchema } from '@appium/schema';
+import { AppiumConfiguration, ServerConfig } from './appium-config';
+/**
+ * The Appium configuration as it would be in a user-provided configuration file.
+ */
+export declare type AppiumConfig = Partial<AppiumConfiguration>;
+/**
+ * Derive the "constant" type of the server properties from the schema.
+ */
+declare type AppiumServerJsonSchema = typeof AppiumConfigJsonSchema['properties']['server']['properties'];
+/**
+ * This type associates the types generated from the schema ({@linkcode AppiumConfiguration})
+ * with the schema itself (beginning with the `server` prop).
+ */
+declare type ServerConfigMapping = Associated<ServerConfig, AppiumServerJsonSchema>;
+/**
+ * Camel-cased server config. _Not_ flattened.
+ */
+export declare type NormalizedServerConfig = {
+    [Prop in keyof ServerConfigMapping as AppiumServerJsonSchema[Prop] extends WithDest ? AppiumServerJsonSchema[Prop]['appiumCliDest'] : KebabToCamel<Prop>]: ServerConfig[Prop];
+};
+/**
+ * "Normalized" config, which is camel-cased (instead of kebab-case, like the schema). It is _not_ flattened.
+ */
+export declare type NormalizedAppiumConfig = {
+    server: NormalizedServerConfig;
+};
+/**
+ * This type checks if `appiumCliDest` is present in the object via
+ * {@linkcode WithDest}, and uses the _value_ of that property for the key name;
+ * otherwise uses the camel-cased value of the key name.
+ */
+declare type SetKeyForProp<Prop extends keyof ServerConfigMapping> = AppiumServerJsonSchema[Prop] extends WithDest ? AppiumServerJsonSchema[Prop]['appiumCliDest'] : KebabToCamel<Prop>;
+/**
+ * Checks for the existence of default values, and ensures those properties will
+ * always be defined (eliminates `| undefined` from the type).
+ * If no default value, just a type.
+ */
+declare type KeyOrDefaultForProp<Prop extends keyof ServerConfigMapping> = AppiumServerJsonSchema[Prop] extends WithDefault ? NonNullable<ServerConfig[Prop]> : ServerConfig[Prop];
+/**
+ * The final shape of the parsed CLI arguments.
+ *
+ * These will be camel-cased unless overridden by `appiumCliDest` field in schema(s).
+ */
+export declare type DriverOpts = {
+    [Prop in keyof ServerConfigMapping as SetKeyForProp<Prop>]: KeyOrDefaultForProp<Prop>;
+};
+/**
+ * Converts a kebab-cased string into a camel-cased string.
+ */
+declare type KebabToCamel<S extends string> = S extends `${infer P1}-${infer P2}${infer P3}` ? `${Lowercase<P1>}${Uppercase<P2>}${KebabToCamel<P3>}` : Lowercase<S>;
+/**
+ * Object `B` has all the keys as object `A` (even if those keys in `A` are otherwise optional).
+ */
+declare type Associated<A extends object, B extends {
+    [key in keyof Required<A>]: unknown;
+}> = {
+    [Prop in keyof Required<A>]: B[Prop];
+};
+/**
+ * Certain properties have an `appiumCliDest` prop, which affects the shape of
+ * `ParsedArgs`. This type helps recognize these properties.
+ *
+ * See `appium/lib/schema/keywords` for definition of `appiumCliDest`.
+ */
+interface WithDest {
+    appiumCliDest: string;
+}
+/**
+ * Some properties have a `default` prop, which means practically they will not
+ * be `undefined` upon parsing.
+ *
+ * We use this to ensure that the `ParsedArgs` makes guarantees
+ * about the presence of properties.
+ */
+interface WithDefault<T = any> {
+    default: T;
+}
+export {};
+//# sourceMappingURL=config.d.ts.map

package/build/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpE;;GAEG;AACH,oBAAY,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAExD;;GAEG;AACF,aAAK,sBAAsB,GAC3B,OAAO,sBAAsB,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC;AAErE;;;GAGG;AACH,aAAK,mBAAmB,GAAG,UAAU,CAAC,YAAY,EAAE,sBAAsB,CAAC,CAAC;AAE5E;;GAEG;AACH,oBAAY,sBAAsB,GAAG;KAClC,IAAI,IAAI,MAAM,mBAAmB,IAAI,sBAAsB,CAAC,IAAI,CAAC,SAAS,QAAQ,GAC/E,sBAAsB,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,GAC7C,YAAY,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,oBAAY,sBAAsB,GAAG;IACnC,MAAM,EAAE,sBAAsB,CAAC;CAChC,CAAC;AAEF;;;;GAIG;AACH,aAAK,aAAa,CAAC,IAAI,SAAS,MAAM,mBAAmB,IACvD,sBAAsB,CAAC,IAAI,CAAC,SAAS,QAAQ,GACzC,sBAAsB,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,GAC7C,YAAY,CAAC,IAAI,CAAC,CAAC;AAEzB;;;;GAIG;AACH,aAAK,mBAAmB,CAAC,IAAI,SAAS,MAAM,mBAAmB,IAC7D,sBAAsB,CAAC,IAAI,CAAC,SAAS,WAAW,GAC5C,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,GAC/B,YAAY,CAAC,IAAI,CAAC,CAAC;AAEzB;;;;GAIG;AACH,oBAAY,UAAU,GAAG;KACtB,IAAI,IAAI,MAAM,mBAAmB,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,IAAI,CAAC;CACtF,CAAC;AAGF;;GAEG;AACF,aAAK,YAAY,CAAC,CAAC,SAAS,MAAM,IAClC,CAAC,SAAS,GAAG,MAAM,EAAE,IAAI,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,GAC1C,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,EAAE,CAAC,EAAE,GACrD,SAAS,CAAC,CAAC,CAAC,CAAC;AAoBlB;;GAEG;AACH,aAAK,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS;KAAG,GAAG,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO;CAAE,IAAI;KACpF,IAAI,IAAI,MAAM,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;CACrC,CAAA;AAQD;;;;;GAKG;AACF,UAAU,QAAQ;IACjB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,UAAU,WAAW,CAAC,CAAC,GAAG,GAAG;IAC3B,OAAO,EAAE,CAAC,CAAC;CACZ"}