SmartMirror-Projektarbeit/node_modules/@wdio/protocols/index.d.ts

declare namespace WDIOProtocols {
    type CommandPath = 'string'
    type CommandMethod = 'POST' | 'GET' | 'DELETE'
    type Protocol = Record<CommandPath, Record<CommandMethod, CommandEndpoint>>

    /**
     * describes a command endpoint
     */
    interface CommandEndpoint {
        /**
         * command name
         */
        command: string
        /**
         * command description
         */
        description: string
        /**
         * link to specification reference
         */
        ref: string
        /**
         * supported command parameters
         */
        parameters: CommandParameters[]
        /**
         * variables within the command path (e.g. /:sessionId/element)
         */
        variables?: CommandPathVariables[]
        /**
         * supported environments
         */
        support?: SupportedEnvironments
        /**
         * set to true if command is only supported in Selenium Hub Node
         */
        isHubCommand?: boolean,
        /**
         * information on return data
         */
        returns?: CommandReturnObject
    }

    interface CommandReturnObject {
        type: string
        name: string
        description: string
    }

    interface CommandPathVariables {
        name: string
        description: string

        /**
         * the following are given for path variables, we should still define
         * it as values are populated automatically
         */
        required?: boolean
        type?: string
    }

    interface CommandParameters {
        name: string,
        type: string,
        description: string,
        required: boolean
    }

    type Platform = 'ios' | 'android'
    type Environments = 'XCUITest' | 'UIAutomation' | 'UiAutomator'

    /**
     * supported mobile environments, e.g.
     * ```
     * "ios": {
     *   "UIAutomation": "8.0 to 9.3"
     * }
     * ```
     */
    type SupportedEnvironments = Record<Platform, Record<Environments, string>>
}

declare module "@wdio/protocols" {
    export default WDIOProtocols
    export const WebDriverProtocol: WDIOProtocols.Protocol
    export const MJsonWProtocol: WDIOProtocols.Protocol
    export const JsonWProtocol: WDIOProtocols.Protocol
    export const AppiumProtocol: WDIOProtocols.Protocol
    export const ChromiumProtocol: WDIOProtocols.Protocol
    export const SauceLabsProtocol: WDIOProtocols.Protocol
    export const SeleniumProtocol: WDIOProtocols.Protocol
}