@appium/schema 0.0.1

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,50 @@
+# @appium/schema
+
+> JSON schema for [Appium](https://github.com/appium/appium) configuration files
+
+## Description
+
+This package is used internally by Appium, but can also be used to validate Appium configuration files in other contexts.
+
+## Install
+
+```bash
+npm i @appium/schema
+```
+
+## Usage
+
+The schema is exported as a JS object:
+
+```js
+const { AppiumConfigJsonSchema } = require('@appium/schema');
+```
+
+It is also provided as a JSON file (since this is a JSON schema, after all):
+
+```js
+const schema = require('@appium/schema/lib/appium-config.schema.json');
+```
+
+## See Also
+
+[@appium/types](https://npm.im/@appium/types) exports a TypeScript type `AppiumConfig` (generated from this package) for typesafe configuration objects; this may be useful if your Appium configuration is written in JS (e.g., `.appiumrc.js`). Example:
+
+```js
+// @ts-check
+/** @type {import('@appium/types').AppiumConfig} */
+module.exports = {
+  server: {
+    port: 1234,
+    host: '127.0.0.1'
+  }
+}
+```
+
+## Notes
+
+`lib/appium-config.schema.json` is generated by this package from `lib/appium-config-schema.js` (the single source of truth), but is under version control to avoid chicken-or-egg build problems.
+
+## License
+
+Apache-2.0

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

@@ -0,0 +1,245 @@
+export namespace AppiumConfigJsonSchema {
+    export const $schema: "http://json-schema.org/draft-07/schema";
+    export const additionalProperties: false;
+    export const description: "A schema for Appium configuration files";
+    export namespace properties {
+        namespace server {
+            const additionalProperties_1: false;
+            export { additionalProperties_1 as additionalProperties };
+            const description_1: "Configuration when running Appium as a server";
+            export { description_1 as description };
+            const properties_1: {
+                readonly address: {
+                    readonly $comment: "I think hostname covers both DNS and IPv4...could be wrong";
+                    readonly appiumCliAliases: readonly ["a"];
+                    readonly default: "0.0.0.0";
+                    readonly description: "IP address to listen on";
+                    readonly format: "hostname";
+                    readonly title: "address config";
+                    readonly type: "string";
+                };
+                readonly 'allow-cors': {
+                    readonly description: "Whether the Appium server should allow web browser connections from any host";
+                    readonly title: "allow-cors config";
+                    readonly type: "boolean";
+                    readonly default: false;
+                };
+                readonly 'allow-insecure': {
+                    readonly appiumCliTransformer: "csv";
+                    readonly default: readonly [];
+                    readonly description: "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.";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly title: "allow-insecure config";
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                };
+                readonly 'base-path': {
+                    readonly appiumCliAliases: readonly ["pa"];
+                    readonly default: "";
+                    readonly description: "Base path to use as the prefix for all webdriver routes running on the server";
+                    readonly title: "base-path config";
+                    readonly type: "string";
+                };
+                readonly 'callback-address': {
+                    readonly appiumCliAliases: readonly ["ca"];
+                    readonly description: "Callback IP address (default: same as \"address\")";
+                    readonly title: "callback-address config";
+                    readonly type: "string";
+                };
+                readonly 'callback-port': {
+                    readonly appiumCliAliases: readonly ["cp"];
+                    readonly default: 4723;
+                    readonly description: "Callback port (default: same as \"port\")";
+                    readonly maximum: 65535;
+                    readonly minimum: 1;
+                    readonly title: "callback-port config";
+                    readonly type: "integer";
+                };
+                readonly 'debug-log-spacing': {
+                    readonly default: false;
+                    readonly description: "Add exaggerated spacing in logs to help with visual inspection";
+                    readonly title: "debug-log-spacing config";
+                    readonly type: "boolean";
+                };
+                readonly 'default-capabilities': {
+                    readonly $comment: "TODO";
+                    readonly appiumCliAliases: readonly ["dc"];
+                    readonly description: "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.";
+                    readonly title: "default-capabilities config";
+                    readonly type: "object";
+                };
+                readonly 'deny-insecure': {
+                    readonly $comment: "Allowed values are defined by drivers";
+                    readonly appiumCliTransformer: "csv";
+                    readonly default: readonly [];
+                    readonly description: "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.";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly title: "deny-insecure config";
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                };
+                readonly driver: {
+                    readonly description: "Driver-specific configuration. Keys should correspond to driver package names";
+                    readonly properties: Record<string, import("json-schema").JSONSchema7>;
+                    readonly title: "driver config";
+                    readonly type: "object";
+                };
+                readonly 'keep-alive-timeout': {
+                    readonly appiumCliAliases: readonly ["ka"];
+                    readonly default: 600;
+                    readonly description: "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.";
+                    readonly minimum: 0;
+                    readonly title: "keep-alive-timeout config";
+                    readonly type: "integer";
+                };
+                readonly 'local-timezone': {
+                    readonly default: false;
+                    readonly description: "Use local timezone for timestamps";
+                    readonly title: "local-timezone config";
+                    readonly type: "boolean";
+                };
+                readonly log: {
+                    readonly appiumCliAliases: readonly ["g"];
+                    readonly appiumCliDest: "logFile";
+                    readonly description: "Also send log output to this file";
+                    readonly title: "log config";
+                    readonly type: "string";
+                };
+                readonly 'log-filters': {
+                    readonly $comment: "TODO";
+                    readonly description: "One or more log filtering rules";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly title: "log-filters config";
+                    readonly type: "array";
+                };
+                readonly 'log-level': {
+                    readonly appiumCliDest: "loglevel";
+                    readonly default: "debug";
+                    readonly description: "Log level (console[:file])";
+                    readonly enum: readonly ["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"];
+                    readonly title: "log-level config";
+                    readonly type: "string";
+                };
+                readonly 'log-no-colors': {
+                    readonly default: false;
+                    readonly description: "Do not use color in console output";
+                    readonly title: "log-no-colors config";
+                    readonly type: "boolean";
+                };
+                readonly 'log-timestamp': {
+                    readonly default: false;
+                    readonly description: "Show timestamps in console output";
+                    readonly title: "log-timestamp config";
+                    readonly type: "boolean";
+                };
+                readonly 'long-stacktrace': {
+                    readonly default: false;
+                    readonly description: "Add long stack traces to log entries. Recommended for debugging only.";
+                    readonly title: "long-stacktrace config";
+                    readonly type: "boolean";
+                };
+                readonly 'no-perms-check': {
+                    readonly default: false;
+                    readonly description: "Do not check that needed files are readable and/or writable";
+                    readonly title: "no-perms-check config";
+                    readonly type: "boolean";
+                };
+                readonly nodeconfig: {
+                    readonly $comment: "Selenium Grid 3 is unmaintained and Selenium Grid 4 no longer supports this file.";
+                    readonly description: "Path to configuration JSON file to register Appium as a node with Selenium Grid 3; otherwise the configuration itself";
+                    readonly title: "nodeconfig config";
+                    readonly type: "object";
+                };
+                readonly plugin: {
+                    readonly description: "Plugin-specific configuration. Keys should correspond to plugin package names";
+                    readonly properties: Record<string, import("json-schema").JSONSchema7>;
+                    readonly title: "plugin config";
+                    readonly type: "object";
+                };
+                readonly port: {
+                    readonly appiumCliAliases: readonly ["p"];
+                    readonly default: 4723;
+                    readonly description: "Port to listen on";
+                    readonly maximum: 65535;
+                    readonly minimum: 1;
+                    readonly title: "port config";
+                    readonly type: "integer";
+                };
+                readonly 'relaxed-security': {
+                    readonly default: false;
+                    readonly description: "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\"";
+                    readonly title: "relaxed-security config";
+                    readonly type: "boolean";
+                    readonly appiumCliDest: "relaxedSecurityEnabled";
+                };
+                readonly 'session-override': {
+                    readonly default: false;
+                    readonly description: "Enables session override (clobbering)";
+                    readonly title: "session-override config";
+                    readonly type: "boolean";
+                };
+                readonly 'strict-caps': {
+                    readonly default: false;
+                    readonly description: "Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device";
+                    readonly title: "strict-caps config";
+                    readonly type: "boolean";
+                };
+                readonly tmp: {
+                    readonly appiumCliDest: "tmpDir";
+                    readonly description: "Absolute path to directory Appium can use to manage temp files. Defaults to C:\\Windows\\Temp on Windows and /tmp otherwise.";
+                    readonly title: "tmp config";
+                    readonly type: "string";
+                };
+                readonly 'trace-dir': {
+                    readonly description: "Absolute path to directory Appium can use to save iOS instrument traces; defaults to <tmp>/appium-instruments";
+                    readonly title: "trace-dir config";
+                    readonly type: "string";
+                };
+                readonly 'use-drivers': {
+                    readonly appiumCliDescription: "A list of drivers to activate. Can be a comma-delimited string or path to CSV file. By default, all installed drivers will be activated.";
+                    readonly default: readonly [];
+                    readonly description: "A list of drivers to activate. By default, all installed drivers will be activated.";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly title: "use-drivers config";
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                };
+                readonly 'use-plugins': {
+                    readonly appiumCliDescription: "A list of plugins to activate. Can be a comma-delimited string, path to CSV file, or the string \"all\" to use all installed plugins.";
+                    readonly default: readonly [];
+                    readonly description: "A list of plugins to activate. To activate all plugins, the value should be an array with a single item \"all\".";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly title: "use-plugins config";
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                };
+                readonly webhook: {
+                    readonly $comment: "This should probably use a uri-template format to restrict the protocol to http/https";
+                    readonly appiumCliAliases: readonly ["G"];
+                    readonly description: "Also send log output to this http listener";
+                    readonly format: "uri";
+                    readonly title: "webhook config";
+                    readonly type: "string";
+                };
+            };
+            export { properties_1 as properties };
+            export const title: "server config";
+            export const type: "object";
+        }
+    }
+    const title_1: "Appium Configuration";
+    export { title_1 as title };
+    const type_1: "object";
+    export { type_1 as type };
+}
+//# sourceMappingURL=appium-config-schema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"appium-config-schema.d.ts","sourceRoot":"","sources":["../lib/appium-config-schema.js"],"names":[],"mappings":""}