@wdio/image-comparison-core 1.0.0

package/dist/helpers/utils.interfaces.d.ts

@@ -0,0 +1,254 @@
+import type { BaseCoordinates, BaseDimensions, FilePaths, FolderPaths } from '../base.interfaces.js';
+import type { DeviceRectangles } from '../methods/rectangles.interfaces.js';
+import type { Folders } from '../base.interfaces.js';
+export interface GetAndCreatePathOptions {
+    /** The name of the browser */
+    browserName: string;
+    /** The name of the device */
+    deviceName: string;
+    /** Is the instance a mobile */
+    isMobile: boolean;
+    /** If the folder needs to have the instance name in it */
+    savePerInstance: boolean;
+}
+export interface FormatFileNameOptions {
+    /** The browser name */
+    browserName: string;
+    /** The browser version */
+    browserVersion: string;
+    /** The device name */
+    deviceName: string;
+    /** The device pixel ratio */
+    devicePixelRatio: number;
+    /** The string that needs to be formatted */
+    formatImageName: string;
+    /** Is this a mobile */
+    isMobile: boolean;
+    /** Is the test executed in a browser */
+    isTestInBrowser: boolean;
+    /** The log name of the instance */
+    logName: string;
+    /** The the name of the instance */
+    name: string;
+    /** The outer height of the screen */
+    outerHeight?: number;
+    /** The outer width of the screen */
+    outerWidth?: number;
+    /** The platform name */
+    platformName: string;
+    /** The platform version */
+    platformVersion: string;
+    /** The height of the screen */
+    screenHeight: number;
+    /** The width of the screen */
+    screenWidth: number;
+    /** The tag of the image */
+    tag: string;
+}
+export interface FormatFileDefaults extends BaseDimensions {
+    /** The browser name */
+    browserName: string;
+    /** The browser version */
+    browserVersion: string;
+    /** The device name */
+    deviceName: string;
+    /** The device pixel ratio */
+    dpr: number;
+    /** The log name of the instance */
+    logName: string;
+    /** Add `app` or nothing */
+    mobile: string;
+    /** The the name of the instance */
+    name: string;
+    /** The platform name */
+    platformName: string;
+    /** The platform version */
+    platformVersion: string;
+    /** The tag of the image */
+    tag: string;
+}
+export interface GetAddressBarShadowPaddingOptions {
+    /** The browser name */
+    browserName: string;
+    /** Is the instance a android */
+    isAndroid: boolean;
+    /** Is the instance a iOS */
+    isIOS: boolean;
+    /** Is the instance a mobile */
+    isMobile: boolean;
+    /** Is this an instance that takes a native web screenshot */
+    nativeWebScreenshot: boolean;
+    /** The address bar shadow padding */
+    addressBarShadowPadding: number;
+    /** Add the padding */
+    addShadowPadding: boolean;
+}
+export interface GetToolBarShadowPaddingOptions {
+    /** Is the instance a android */
+    isAndroid: boolean;
+    /** Is the instance a iOS */
+    isIOS: boolean;
+    /** Is the instance a mobile */
+    isMobile: boolean;
+    /** The browser name */
+    browserName: string;
+    /** The tool bar shadow padding */
+    toolBarShadowPadding: number;
+    /** Add the padding */
+    addShadowPadding: boolean;
+}
+export interface ScreenshotSize extends BaseDimensions {
+}
+export interface GetMobileViewPortPositionOptions {
+    /** The browser instance */
+    browserInstance: WebdriverIO.Browser;
+    /** The initial device rectangles */
+    initialDeviceRectangles: DeviceRectangles;
+    /** Is the context native */
+    isNativeContext: boolean;
+    /** Is the device Android */
+    isAndroid: boolean;
+    /** Is the device iOS */
+    isIOS: boolean;
+    /** Is this an instance that takes a native web screenshot */
+    nativeWebScreenshot: boolean;
+    /** The height of the screen */
+    screenHeight: number;
+    /** The width of the screen */
+    screenWidth: number;
+}
+export interface GetMobileScreenSizeOptions {
+    /** The browser instance */
+    browserInstance: WebdriverIO.Browser;
+    /** Is the device iOS */
+    isIOS: boolean;
+    /** Is the context native */
+    isNativeContext: boolean;
+}
+export interface GetIosBezelImageNames {
+    /** The name of the top image */
+    topImageName: string;
+    /** The name of the bottom image */
+    bottomImageName: string;
+}
+export interface LoadBase64HtmlOptions {
+    /** The browser instance */
+    browserInstance: WebdriverIO.Browser;
+    /** Is the device iOS */
+    isIOS: boolean;
+}
+export interface ExecuteNativeClickOptions extends BaseCoordinates {
+    /** The browser instance */
+    browserInstance: WebdriverIO.Browser;
+    /** Is the device iOS */
+    isIOS: boolean;
+}
+export interface CommonCheckVariables {
+    /** Folder paths */
+    actualFolder: string;
+    baselineFolder: string;
+    diffFolder: string;
+    /** Instance data properties */
+    browserName: string;
+    deviceName: string;
+    deviceRectangles: any;
+    isAndroid: boolean;
+    isMobile: boolean;
+    isAndroidNativeWebScreenshot: boolean;
+    /** Optional instance data (not all methods need these) */
+    platformName?: string;
+    isIOS?: boolean;
+    /** WIC options */
+    autoSaveBaseline: boolean;
+    savePerInstance: boolean;
+    /** Optional WIC options (not all methods need these) */
+    isHybridApp?: boolean;
+}
+export interface ExtractCommonCheckVariablesOptions {
+    /** The folders object */
+    folders: Folders;
+    /** The instance data object */
+    instanceData: any;
+    /** The wic options object */
+    wicOptions: any;
+}
+export interface FolderOptions {
+    /** Whether to auto-save baseline images */
+    autoSaveBaseline: boolean;
+    /** The actual folder path */
+    actualFolder: string;
+    /** The baseline folder path */
+    baselineFolder: string;
+    /** The diff folder path */
+    diffFolder: string;
+    /** The browser name */
+    browserName: string;
+    /** The device name */
+    deviceName: string;
+    /** Whether this is a mobile device */
+    isMobile: boolean;
+    /** Whether to save per instance */
+    savePerInstance: boolean;
+}
+export interface BuildFolderOptionsOptions {
+    /** Common check variables that include all the needed folder options properties */
+    commonCheckVariables: CommonCheckVariables;
+}
+export interface BaseExecuteCompareOptions {
+    /** Compare options for both wic and method */
+    compareOptions: {
+        wic: any;
+        method: any;
+    };
+    /** Device pixel ratio */
+    devicePixelRatio: number;
+    /** Device rectangles */
+    deviceRectangles: any;
+    /** File name */
+    fileName: string;
+    /** Folder options */
+    folderOptions: FolderOptions;
+    /** Whether this is Android */
+    isAndroid: boolean;
+    /** Whether this is Android native web screenshot */
+    isAndroidNativeWebScreenshot: boolean;
+    /** Optional: platform name */
+    platformName?: string;
+    /** Optional: whether this is iOS */
+    isIOS?: boolean;
+    /** Optional: whether this is hybrid app */
+    isHybridApp?: boolean;
+    /** Optional: ignore regions for special cases */
+    ignoreRegions?: any[];
+}
+export interface BuildBaseExecuteCompareOptionsOptions {
+    /** Common check variables that include device and folder info */
+    commonCheckVariables: CommonCheckVariables;
+    /** WIC compare options */
+    wicCompareOptions: any;
+    /** Method compare options */
+    methodCompareOptions: any;
+    /** Device pixel ratio from screenshot */
+    devicePixelRatio: number;
+    /** File name from screenshot */
+    fileName: string;
+    /** Whether to override wic options for element screenshots (sets blockOut* to false) */
+    isElementScreenshot?: boolean;
+    /** Additional properties to add to the options */
+    additionalProperties?: Record<string, any>;
+}
+export interface PrepareComparisonFilePathsOptions extends Folders {
+    /** The browser name */
+    browserName: string;
+    /** The device name */
+    deviceName: string;
+    /** Whether this is a mobile device */
+    isMobile: boolean;
+    /** Whether to save per instance */
+    savePerInstance: boolean;
+    /** The file name */
+    fileName: string;
+}
+export interface ComparisonFilePaths extends FilePaths, FolderPaths {
+}
+//# sourceMappingURL=utils.interfaces.d.ts.map

package/dist/helpers/utils.interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.interfaces.d.ts","sourceRoot":"","sources":["../../src/helpers/utils.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACpG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAA;AAC3E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAEpD,MAAM,WAAW,uBAAuB;IACpC,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,+BAA+B;IAC/B,QAAQ,EAAE,OAAO,CAAC;IAClB,0DAA0D;IAC1D,eAAe,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IAClC,uBAAuB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,0BAA0B;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,6BAA6B;IAC7B,gBAAgB,EAAE,MAAM,CAAC;IACzB,4CAA4C;IAC5C,eAAe,EAAE,MAAM,CAAC;IACxB,uBAAuB;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,wCAAwC;IACxC,eAAe,EAAE,OAAO,CAAC;IACzB,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wBAAwB;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,2BAA2B;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,+BAA+B;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,2BAA2B;IAC3B,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACtD,uBAAuB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,0BAA0B;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,6BAA6B;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,wBAAwB;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,2BAA2B;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,2BAA2B;IAC3B,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iCAAiC;IAC9C,uBAAuB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,4BAA4B;IAC5B,KAAK,EAAE,OAAO,CAAC;IACf,+BAA+B;IAC/B,QAAQ,EAAE,OAAO,CAAC;IAClB,6DAA6D;IAC7D,mBAAmB,EAAE,OAAO,CAAC;IAC7B,qCAAqC;IACrC,uBAAuB,EAAE,MAAM,CAAC;IAChC,sBAAsB;IACtB,gBAAgB,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,8BAA8B;IAC3C,gCAAgC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,4BAA4B;IAC5B,KAAK,EAAE,OAAO,CAAC;IACf,+BAA+B;IAC/B,QAAQ,EAAE,OAAO,CAAC;IAClB,uBAAuB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,sBAAsB;IACtB,gBAAgB,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,cAAe,SAAQ,cAAc;CAAG;AAEzD,MAAM,WAAW,gCAAgC;IAC7C,2BAA2B;IAC3B,eAAe,EAAE,WAAW,CAAC,OAAO,CAAC;IACrC,oCAAoC;IACpC,uBAAuB,EAAE,gBAAgB,CAAC;IAC1C,4BAA4B;IAC5B,eAAe,EAAE,OAAO,CAAC;IACzB,4BAA4B;IAC5B,SAAS,EAAE,OAAO,CAAC;IACnB,wBAAwB;IACxB,KAAK,EAAE,OAAO,CAAC;IACf,6DAA6D;IAC7D,mBAAmB,EAAE,OAAO,CAAC;IAC7B,+BAA+B;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACvC,2BAA2B;IAC3B,eAAe,EAAE,WAAW,CAAC,OAAO,CAAC;IACrC,wBAAwB;IACxB,KAAK,EAAE,OAAO,CAAC;IACf,4BAA4B;IAC5B,eAAe,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IAClC,gCAAgC;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IAClC,2BAA2B;IAC3B,eAAe,EAAE,WAAW,CAAC,OAAO,CAAC;IACrC,wBAAwB;IACxB,KAAK,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,yBAA0B,SAAQ,eAAe;IAC9D,2BAA2B;IAC3B,eAAe,EAAE,WAAW,CAAC,OAAO,CAAC;IACrC,wBAAwB;IACxB,KAAK,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACjC,mBAAmB;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IAEnB,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,GAAG,CAAC;IACtB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,4BAA4B,EAAE,OAAO,CAAC;IAEtC,0DAA0D;IAC1D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,kBAAkB;IAClB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,eAAe,EAAE,OAAO,CAAC;IAEzB,wDAAwD;IACxD,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,kCAAkC;IAC/C,yBAAyB;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,+BAA+B;IAC/B,YAAY,EAAE,GAAG,CAAC;IAClB,6BAA6B;IAC7B,UAAU,EAAE,GAAG,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC1B,2CAA2C;IAC3C,gBAAgB,EAAE,OAAO,CAAC;IAC1B,6BAA6B;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,+BAA+B;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,QAAQ,EAAE,OAAO,CAAC;IAClB,mCAAmC;IACnC,eAAe,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACtC,mFAAmF;IACnF,oBAAoB,EAAE,oBAAoB,CAAC;CAC9C;AAED,MAAM,WAAW,yBAAyB;IACtC,8CAA8C;IAC9C,cAAc,EAAE;QACZ,GAAG,EAAE,GAAG,CAAC;QACT,MAAM,EAAE,GAAG,CAAC;KACf,CAAC;IACF,yBAAyB;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,wBAAwB;IACxB,gBAAgB,EAAE,GAAG,CAAC;IACtB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB;IACrB,aAAa,EAAE,aAAa,CAAC;IAC7B,8BAA8B;IAC9B,SAAS,EAAE,OAAO,CAAC;IACnB,oDAAoD;IACpD,4BAA4B,EAAE,OAAO,CAAC;IACtC,8BAA8B;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oCAAoC;IACpC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iDAAiD;IACjD,aAAa,CAAC,EAAE,GAAG,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,qCAAqC;IAClD,iEAAiE;IACjE,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,0BAA0B;IAC1B,iBAAiB,EAAE,GAAG,CAAC;IACvB,6BAA6B;IAC7B,oBAAoB,EAAE,GAAG,CAAC;IAC1B,yCAAyC;IACzC,gBAAgB,EAAE,MAAM,CAAC;IACzB,gCAAgC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,wFAAwF;IACxF,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,kDAAkD;IAClD,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9C;AAED,MAAM,WAAW,iCAAkC,SAAQ,OAAO;IAC9D,uBAAuB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,QAAQ,EAAE,OAAO,CAAC;IAClB,mCAAmC;IACnC,eAAe,EAAE,OAAO,CAAC;IACzB,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAoB,SAAQ,SAAS,EAAE,WAAW;CAAG"}

package/dist/helpers/utils.interfaces.js

@@ -0,0 +1 @@
+export {};