@appium/base-driver 8.3.1 → 8.4.0

package/build/lib/protocol/errors.d.ts

@@ -0,0 +1,310 @@
+export class ProtocolError extends ES6Error {
+    constructor(msg: any, jsonwpCode: any, w3cStatus: any, error: any);
+    jsonwpCode: any;
+    error: any;
+    w3cStatus: any;
+    _stacktrace: any;
+    set stacktrace(arg: any);
+    get stacktrace(): any;
+}
+export class NoSuchDriverError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class NoSuchElementError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class NoSuchFrameError extends ProtocolError {
+    static code(): number;
+    static error(): string;
+    static w3cStatus(): HTTPStatusCodes;
+    constructor(err: any);
+}
+export class UnknownCommandError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class StaleElementReferenceError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class ElementNotVisibleError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class InvalidElementStateError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class UnknownError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(errorOrMessage: any);
+}
+export class UnknownMethodError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class UnsupportedOperationError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class ElementIsNotSelectableError extends ProtocolError {
+    static code(): number;
+    static error(): string;
+    static w3cStatus(): HTTPStatusCodes;
+    constructor(err: any);
+}
+export class ElementClickInterceptedError extends ProtocolError {
+    static code(): number;
+    static error(): string;
+    static w3cStatus(): HTTPStatusCodes;
+    constructor(err: any);
+}
+export class ElementNotInteractableError extends ProtocolError {
+    static code(): number;
+    static error(): string;
+    static w3cStatus(): HTTPStatusCodes;
+    constructor(err: any);
+}
+export class InsecureCertificateError extends ProtocolError {
+    static error(): string;
+    constructor(err: any);
+}
+export class JavaScriptError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class XPathLookupError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class TimeoutError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class NoSuchWindowError extends ProtocolError {
+    static code(): number;
+    static error(): string;
+    static w3cStatus(): HTTPStatusCodes;
+    constructor(err: any);
+}
+export class InvalidArgumentError extends ProtocolError {
+    static code(): number;
+    static error(): string;
+    static w3cStatus(): HTTPStatusCodes;
+    constructor(err: any);
+}
+export class InvalidCookieDomainError extends ProtocolError {
+    static code(): number;
+    static error(): string;
+    static w3cStatus(): HTTPStatusCodes;
+    constructor(err: any);
+}
+export class NoSuchCookieError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class UnableToSetCookieError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class UnexpectedAlertOpenError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class NoAlertOpenError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class NoSuchAlertError extends NoAlertOpenError {
+}
+export class ScriptTimeoutError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class InvalidElementCoordinatesError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class InvalidCoordinatesError extends InvalidElementCoordinatesError {
+}
+export class IMENotAvailableError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class IMEEngineActivationFailedError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class InvalidSelectorError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class SessionNotCreatedError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(details: any);
+}
+export class MoveTargetOutOfBoundsError extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class NoSuchContextError extends ProtocolError {
+    static code(): number;
+    constructor(err: any);
+}
+export class InvalidContextError extends ProtocolError {
+    static code(): number;
+    constructor(err: any);
+}
+export class NotYetImplementedError extends UnknownMethodError {
+}
+export class NotImplementedError extends UnknownMethodError {
+}
+export class UnableToCaptureScreen extends ProtocolError {
+    static code(): number;
+    static w3cStatus(): HTTPStatusCodes;
+    static error(): string;
+    constructor(err: any);
+}
+export class BadParametersError extends ES6Error {
+    static error(): string;
+    constructor(requiredParams: any, actualParams: any, errMessage: any);
+    w3cStatus: HTTPStatusCodes;
+}
+/**
+ * ProxyRequestError is a custom error and will be thrown up on unsuccessful proxy request and
+ * will contain information about the proxy failure.
+ * In case of ProxyRequestError should fetch the actual error by calling `getActualError()`
+ * for proxy failure to generate the client response.
+ */
+export class ProxyRequestError extends ES6Error {
+    constructor(err: any, responseError: any, httpStatus: any);
+    w3cStatus: any;
+    w3c: any;
+    jsonwp: any;
+    getActualError(): ProtocolError;
+}
+import ES6Error from "es6-error";
+import { StatusCodes as HTTPStatusCodes } from "http-status-codes";
+export namespace errors {
+    export { NotYetImplementedError };
+    export { NotImplementedError };
+    export { BadParametersError };
+    export { InvalidArgumentError };
+    export { NoSuchDriverError };
+    export { NoSuchElementError };
+    export { UnknownCommandError };
+    export { StaleElementReferenceError };
+    export { ElementNotVisibleError };
+    export { InvalidElementStateError };
+    export { UnknownError };
+    export { ElementIsNotSelectableError };
+    export { ElementClickInterceptedError };
+    export { ElementNotInteractableError };
+    export { InsecureCertificateError };
+    export { JavaScriptError };
+    export { XPathLookupError };
+    export { TimeoutError };
+    export { NoSuchWindowError };
+    export { NoSuchCookieError };
+    export { InvalidCookieDomainError };
+    export { InvalidCoordinatesError };
+    export { UnableToSetCookieError };
+    export { UnexpectedAlertOpenError };
+    export { NoAlertOpenError };
+    export { ScriptTimeoutError };
+    export { InvalidElementCoordinatesError };
+    export { IMENotAvailableError };
+    export { IMEEngineActivationFailedError };
+    export { InvalidSelectorError };
+    export { SessionNotCreatedError };
+    export { MoveTargetOutOfBoundsError };
+    export { NoSuchAlertError };
+    export { NoSuchContextError };
+    export { InvalidContextError };
+    export { NoSuchFrameError };
+    export { UnableToCaptureScreen };
+    export { UnknownMethodError };
+    export { UnsupportedOperationError };
+    export { ProxyRequestError };
+}
+export function isErrorType(err: any, type: any): boolean;
+export function isUnknownError(err: any): boolean;
+/**
+ * Retrieve an error derived from MJSONWP status
+ * @param {number} code JSONWP status code
+ * @param {string|Object} value The error message, or an object with a `message` property
+ * @return {ProtocolError} The error that is associated with provided JSONWP status code
+ */
+export function errorFromMJSONWPStatusCode(code: number, value?: string | any): ProtocolError;
+/**
+ * Retrieve an error derived from W3C JSON Code
+ * @param {string} code W3C error string (see https://www.w3.org/TR/webdriver/#handling-errors `JSON Error Code` column)
+ * @param {string} message the error message
+ * @param {?string} stacktrace an optional error stacktrace
+ * @return {ProtocolError}  The error that is associated with the W3C error string
+ */
+export function errorFromW3CJsonCode(code: string, message: string, stacktrace?: string | null): ProtocolError;
+/**
+ * Convert an Appium error to proper W3C HTTP response
+ * @param {ProtocolError} err The error that needs to be translated
+ */
+export function getResponseForW3CError(err: ProtocolError): any[];
+/**
+ * Convert an Appium error to a proper JSONWP response
+ * @param {ProtocolError} err The error to be converted
+ */
+export function getResponseForJsonwpError(err: ProtocolError): (HTTPStatusCodes.BAD_REQUEST | HTTPStatusCodes.INTERNAL_SERVER_ERROR | HTTPStatusCodes.NOT_FOUND | HTTPStatusCodes.NOT_IMPLEMENTED | {
+    status: any;
+    value: {
+        message: string;
+    };
+})[];
+//# sourceMappingURL=errors.d.ts.map

package/build/lib/protocol/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../lib/protocol/errors.js"],"names":[],"mappings":"AAWA;IACE,mEASC;IAPC,gBAA4B;IAC5B,WAAuC;IAIvC,eAAyD;IACzD,iBAAuB;IAOzB,yBAEC;IAND,sBAEC;CAKF;AAMD;IACE,sBAEC;IAED,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,uBAEC;IACD,oCAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAKC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,iCAOC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,uBAEC;IACD,oCAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,uBAEC;IACD,oCAEC;IACD,sBAKC;CACF;AAED;IACE,sBAEC;IACD,uBAEC;IACD,oCAEC;IACD,sBAIC;CACF;AAED;IACE,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,uBAEC;IACD,oCAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,uBAEC;IACD,oCAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,uBAEC;IACD,oCAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;CAAyD;AAEzD;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAIC;CACF;AAED;CAA8E;AAE9E;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAIC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,0BAOC;CACF;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAED;IACE,sBAEC;IACD,sBAEC;CACF;AAED;IACE,sBAEC;IACD,sBAGC;CACF;AAGD;CAIC;AACD;CAIC;AAED;IACE,sBAEC;IACD,oCAEC;IACD,uBAEC;IACD,sBAGC;CACF;AAID;IACE,uBAEC;IACD,qEAWC;IADC,2BAA4C;CAE/C;AAED;;;;;GAKG;AACH;IACE,2DAwBC;IATC,eAA4C;IAI1C,SAAiC;IAGjC,YAA8B;IAIlC,gCAQC;CACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiED,0DAkBC;AAzBD,kDAKC;AAsBD;;;;;GAKG;AACH,iDAJW,MAAM,UACN,MAAM,MAAO,GACZ,aAAa,CAYxB;AAED;;;;;;GAMG;AACH,2CALW,MAAM,WACN,MAAM,eACL,MAAM,UACN,aAAa,CAaxB;AAED;;;GAGG;AACH,4CAFW,aAAa,SAqCvB;AAED;;;GAGG;AACH,+CAFW,aAAa;;;;;KA+BvB"}