wdio-ui5-service/cjs/types/wdi5.types.d.ts

WebdriverIO plugin for testing UI5 browser-based apps

import Log from "sap/base/Log";
import RecordReplay from "sap/ui/test/RecordReplay";
import { ControlSelector } from "sap/ui/test/RecordReplay";
import { WDI5Object } from "../lib/wdi5-object.js";
export type wdi5LogLevel = "silent" | "error" | "verbose";
export interface wdi5Config extends WebdriverIO.Config {
    wdi5?: {
        /** wdi5-specific logging of UI5-related operations */
        logLevel?: wdi5LogLevel;
        /**
         * FQDN-suffix to append to `baseUrl` of wdio config,
         * typically "index.html"
         * @example http://localhost:8080/index.html -> "index.html"
         * @example https://ui5.sap.com/anotherIndex.html -> "anotherIndex.html"
         * @deprecated
         */
        url?: string;
        /** path relative to the command `wdio` is run from to store screenshots */
        screenshotPath?: string;
        /**
         * whether to generally disable/enable screenshots
         */
        screenshotsDisabled?: boolean;
        /**
         * late-inject wdi5 <-> UI5 bridge, useful for testing in hybrid non-UI5/UI5 apps
         */
        skipInjectUI5OnStart?: boolean;
        /**
         * maximum waiting time while checking for UI5 (control) availability
         */
        waitForUI5Timeout?: number;
        /**
         * indicated whether wdi5 operates on an app
         * in a SAP Build Workzone Standard Edition (fka Launchpad) environment
         */
        btpWorkZoneEnablement?: boolean;
        /**
         * Regex for XHR/Fetch requests to be ignored by the auto waiter
         * Ideal for long polling as this would result in the waiter waiting forever
         */
        ignoreAutoWaitUrls?: string[];
    };
    capabilities: wdi5Capabilities[] | wdi5MultiRemoteCapability;
}
/**
 * the "wdi5" prefix is to comply with W3C standards
 */
export interface wdi5Capabilities extends WebdriverIO.Capabilities {
    /**
     * workaround for typing the max instances per capability until
     * that WebdriverIO issue is resolved allowing for extending the typed per-browser capability:
     * https://github.com/webdriverio/webdriverio/pull/11992
     */
    maxInstances?: number;
    "wdi5:authentication"?: BTPAuthenticator | BasicAuthAuthenticator | CustomAuthenticator | Office365Authenticator;
}
export interface wdi5MultiRemoteCapability {
    [key: string]: {
        capabilities: wdi5Capabilities;
    };
}
export type BTPAuthenticator = {
    provider: "BTP";
    usernameSelector?: string;
    passwordSelector?: string;
    submitSelector?: string;
    /**
     * set this, when IAS is in use as custom IdP
     * IAS provides this biometric login option which wdi5 as of now does not support for authentication
     */
    disableBiometricAuthentication?: boolean;
    /**
     * set this when `disableBiometricAuthentication` is set to `true`
     * the domain of the custom IdP, e.g. "your-IAS-tenant.accounts.ondemand.com"
     */
    idpDomain?: string;
};
export type CertAuthenticator = {
    provider: "Certificate";
    certificateOrigin: string;
    certificateUrl: string;
    certificatePfxPath: string;
    certificatePfxPassword: string;
};
export type BasicAuthAuthenticator = {
    provider: "BasicAuth";
    basicAuthUrls?: Array<string>;
};
export type CustomAuthenticator = {
    provider: "custom";
    usernameSelector: string;
    passwordSelector: string;
    submitSelector: string;
};
export type Office365Authenticator = {
    provider: "Office365";
    usernameSelector?: string;
    passwordSelector?: string;
    submitSelector?: string;
    staySignedIn?: boolean;
};
interface wdi5ControlSelector {
    /**
     * Descendant matcher, {@link sap.ui.test.matchers.Descendant}
     */
    descendant?: any;
    /**
     * ID of a control (global or within viewName, if viewName is defined)
     */
    id?: string | RegExp;
    /**
     * Name of the control's view parent
     */
    viewName?: string;
    /**
     * in Fiori Element land, this attribute is used in dynamic UI compositions
     */
    viewId?: string;
    /**
     * Fully qualified control class name in dot notation, eg: "sap.m.ObjectHeader"
     */
    controlType?: string;
    /**
     * Binding path matcher, {@link sap.ui.test.matchers.BindingPath}
     */
    bindingPath?: Record<string, unknown>;
    /**
     * I18N Text matcher, {@link sap.ui.test.matchers.i18NText}
     */
    i18NText?: Record<string, unknown>;
    /**
     * Label matcher, {@link sap.ui.test.matchers.LabelFor}
     */
    labelFor?: Record<string, unknown>;
    /**
     * Properties matcher, {@link sap.ui.test.matchers.Properties}
     */
    properties?: Record<string, unknown>;
    /**
     * Property strict equals matcher, {@link sap.ui.test.matchers.PropertyStrictEquals}
     */
    propertyStrictEquals?: {
        name: string;
        value: any;
    };
    /**
     * Ancestor matcher, {@link sap.ui.test.matchers.Ancestor}
     */
    ancestor?: Record<string, unknown>;
    /**
     * Sibling matcher, {@link sap.ui.test.matchers.Sibling}
     */
    sibling?: Record<string, unknown>;
    /**
     * Interactable matcher, {@link sap.ui.test.matchers.Interactable}
     */
    interactable?: boolean;
    /**
     * Aggregation length equals matcher, {@link sap.ui.test.matchers.AggregationLengthEquals}
     */
    aggregationLengthEquals?: {
        name: string;
        length: number;
    };
    /**
     * Aggregation filled matcher, {@link sap.ui.test.matchers.AggregationFilled}
     */
    aggregationFilled?: {
        name: string;
    };
    /**
     * Aggregation empty matcher, {@link sap.ui.test.matchers.AggregationEmpty}
     */
    aggregationEmpty?: {
        name: string;
    };
    /**
     * Aggregation contains property equal matcher, {@link sap.ui.test.matchers.AggregationContainsPropertyEqual}
     */
    aggregationContainsPropertyEqual?: {
        aggregationName: string;
        propertyName: string;
        propertyValue: string;
    };
    /**
     * search in dialogs
     */
    searchOpenDialogs?: boolean;
    /**
     * interaction adapter
     */
    interaction?: "root" | "focus" | "press" | "auto" | {
        idSuffix: string;
    };
}
export interface wdi5Selector {
    /**
     * optional unique internal key to map and find a control
     * if not provided, wdi5 will calculate a unique key
     */
    wdio_ui5_key?: string;
    /**
     * forces the to re-retrieve the control from the browser context,
     * even if it was retrieved previously
     */
    forceSelect?: boolean;
    /**
     * OPA5-style selectors from RecordReplay
     */
    selector: wdi5ControlSelector;
    /**
     * disables the logging for the selector
     */
    logging?: boolean;
}
/**
 * 0 = success
 * 1 = error
 */
export type wdi5StatusCode = 0 | 1;
export interface clientSide_ui5Response {
    status: wdi5StatusCode;
    result?: any;
    message?: string;
    domElement?: WebdriverIO.Element;
    id?: string;
    aProtoFunctions?: Array<string>;
    className?: string;
    returnType?: string;
    nonCircularResultObject?: any;
    uuid?: string;
    object: WDI5Object;
}
export interface clientSide_ui5Object {
    uuid: string;
    status: wdi5StatusCode;
    aProtoFunctions?: [];
    className?: string;
    object: WDI5Object;
}
/**
 *
 */
export interface wdi5ControlMetadata {
    id?: string;
    methods?: string[];
    className?: string;
    $?: Array<string>;
    key?: string;
}
export interface wdi5Bridge extends Window {
    bridge: RecordReplay;
    wdi5: {
        createMatcher: (selector: ControlSelector) => ControlSelector;
        getUI5CtlForWebObj: (ui5Control: any) => any;
        retrieveControlMethods: (ui5Control: any) => string[];
        isPrimitive: (value: any) => boolean;
        createControlIdMap: (ui5Controls: any[]) => Map<"id", string>;
        createControlId: (ui5Control: any) => {
            id: string;
        };
        isInitialized: boolean;
        Log: Log;
        waitForUI5Options: {
            timeout: number;
            interval: number;
        };
    };
}
export type { WDI5Control as wdi5Control } from "../lib/wdi5-control.js";
//# sourceMappingURL=wdi5.types.d.ts.map