@appium/schema

import type { JSONSchema7 } from 'json-schema'; /** * The single-source-of-truth of the Appium server configuration. * * This defines _both_ what the CLI supports and what the config files support. */ export declare const AppiumConfigJsonSchema: { readonly $schema: "http://json-schema.org/draft-07/schema"; readonly additionalProperties: false; readonly description: "A schema for Appium configuration files"; readonly properties: { readonly $schema: { readonly description: "The JSON schema for this file"; readonly default: "https://raw.githubusercontent.com/appium/appium/master/packages/schema/lib/appium-config.schema.json"; readonly type: "string"; readonly format: "uri"; }; readonly server: { readonly additionalProperties: false; readonly description: "Configuration when running Appium as a server"; readonly properties: { readonly address: { readonly appiumCliAliases: readonly ["a"]; readonly default: "0.0.0.0"; readonly description: "IPv4/IPv6 address or a hostname to listen on"; readonly title: "address config"; readonly type: "string"; readonly anyOf: readonly [{ readonly type: "string"; readonly format: "hostname"; }, { readonly type: "string"; readonly format: "ipv6"; }]; }; 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, JSONSchema7>; readonly title: "driver config"; readonly type: "object"; }; readonly 'keep-alive-timeout': { readonly appiumCliAliases: readonly ["ka"]; readonly default: 600; readonly description: string; readonly minimum: 0; readonly title: "keep-alive-timeout config"; readonly type: "integer"; }; readonly 'request-timeout': { readonly default: 3600; readonly description: string; readonly minimum: 0; readonly title: "request-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 description: "One or more log filtering rules"; readonly title: "log-filters config"; readonly type: "array"; readonly items: { readonly $ref: "#/$defs/logFilter"; }; readonly appiumCliTransformer: "json"; }; 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-format': { readonly appiumCliDest: "logFormat"; readonly default: "text"; readonly description: "Log format (text|json|pretty_json)"; readonly enum: readonly ["text", "json", "pretty_json"]; readonly title: "log-format 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 'plugins-import-chunk-size': { readonly default: 7; readonly description: "The maximum amount of plugins that could be imported in parallel on server startup"; readonly title: "plugins-import-chunk-size config"; readonly type: "number"; }; readonly 'drivers-import-chunk-size': { readonly default: 3; readonly description: "The maximum amount of drivers that could be imported in parallel on server startup"; readonly title: "drivers-import-chunk-size config"; readonly type: "number"; }; 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: "Skip various permission checks on the server startup if set to true"; 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, 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 'shutdown-timeout': { readonly default: 5000; readonly description: string; readonly title: "Graceful server shutdown timeout in milliseconds"; readonly type: "integer"; readonly minimum: 0; }; readonly 'session-override': { readonly default: false; readonly description: "Enables session override (clobbering)"; readonly title: "session-override config"; readonly type: "boolean"; }; readonly 'ssl-cert-path': { readonly description: "Full path to the .cert file if TLS is used. Must be provided together with \"ssl-key-path\""; readonly title: ".cert file path"; readonly appiumCliDest: "sslCertificatePath"; readonly type: "string"; }; readonly 'ssl-key-path': { readonly description: "Full path to the .key file if TLS is used. Must be provided together with \"ssl-cert-path\""; readonly title: ".key file path"; readonly appiumCliDest: "sslKeyPath"; readonly type: "string"; }; 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. Windows environments may require wrapping the comma-delimited string with quotes to escape the comma."; 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. Windows environments may require wrapping the comma-delimited string with quotes to escape the comma."; 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"; }; readonly 'max-ipc-data-size': { readonly appiumCliDescription: "The maximum size in bytes allowed for message objects sent on IPC topics."; readonly description: "Maximum size in bytes for IPC messages"; readonly type: "integer"; readonly minimum: 1; readonly default: 1048576; readonly title: "max-ipc-data-size config"; }; readonly 'max-ipc-topics': { readonly appiumCliDescription: "The maximum number of IPC topics allowed per session."; readonly description: "Maximum number of IPC topics per session"; readonly type: "integer"; readonly minimum: 1; readonly default: 1000; readonly title: "max-ipc-topics config"; }; }; readonly title: "server config"; readonly type: "object"; }; }; readonly title: "Appium Configuration"; readonly type: "object"; readonly $defs: { readonly logFilterText: { readonly type: "object"; readonly description: "Log filter with plain text"; readonly properties: { readonly text: { readonly description: "Text to match"; readonly type: "string"; }; }; readonly required: readonly ["text"]; readonly not: { readonly required: readonly ["pattern"]; }; }; readonly logFilterRegex: { readonly type: "object"; readonly description: "Log filter with regular expression"; readonly properties: { readonly pattern: { readonly description: "Regex pattern to match"; readonly type: "string"; readonly format: "regex"; }; }; readonly required: readonly ["pattern"]; readonly not: { readonly required: readonly ["text"]; }; }; readonly logFilter: { readonly type: "object"; readonly description: "Log filtering rule"; readonly allOf: readonly [{ readonly type: "object"; readonly properties: { readonly replacer: { readonly description: "Replacement string for matched text"; readonly type: "string"; readonly default: "**SECURE**"; }; readonly flags: { readonly description: "Matching flags; see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#advanced_searching_with_flags"; readonly type: "string"; readonly pattern: "^[igmsduy](,[igmsduy])*$"; }; }; }, { readonly anyOf: readonly [{ readonly $ref: "#/$defs/logFilterText"; }, { readonly $ref: "#/$defs/logFilterRegex"; }]; }]; }; }; }; //# sourceMappingURL=appium-config-schema.d.ts.map