@wdio/ocr-service 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,331 @@
+/// <reference types="./standalone.js" />
+/**
+ * Class options for OCR
+ */
+export interface OcrOptions {
+    /**
+     * Adjusts the contrast of the image, value between -1 and 1
+     * Default: 0.25
+     */
+    contrast?: number;
+    /**
+     * The path to store the images for OCR
+     */
+    imagesFolder?: string;
+    /**
+     * The language to use for OCR, can be found here:
+     * ocr/utils/constants.ts > SUPPORTED_LANGUAGES
+     * Default: eng
+     */
+    language?: string;
+}
+/**
+ * Browser command options
+ */
+type DefaultCommandOptions = {
+    contrast?: number;
+    haystack?: WebdriverIO.Element | ChainablePromiseElement | RectReturn;
+    language?: string;
+};
+export type GetTextOptions = DefaultCommandOptions & {};
+export type GetElementPositionByTextOptions = DefaultCommandOptions & {
+    fuzzyFindOptions?: FuzzySearchOptions;
+    text: string;
+};
+export type WaitForTextDisplayedOptions = GetElementPositionByTextOptions & {
+    timeout?: number;
+    timeoutMsg?: string;
+};
+export type ClickOnTextOptions = GetElementPositionByTextOptions & {
+    clickDuration?: Number;
+    relativePosition?: RelativePosition;
+};
+export type SetValueOptions = ClickOnTextOptions & {
+    submitValue?: boolean;
+    value: string;
+};
+/**
+ * Method options
+ */
+type DefaultMethodOptions = DefaultCommandOptions & {
+    contrast: number;
+    isTesseractAvailable: boolean;
+    language: string;
+    ocrImagesPath: string;
+};
+export type OcrGetTextOptions = DefaultMethodOptions & {};
+export type GetDataOptions = DefaultMethodOptions & {
+    cliFile?: string;
+};
+export type OcrGetElementPositionByTextOptions = DefaultMethodOptions & {
+    fuzzyFindOptions?: FuzzySearchOptions;
+    relativePosition?: RelativePosition;
+    text: string;
+};
+export type OcrWaitForTextDisplayedOptions = OcrGetElementPositionByTextOptions & {
+    timeout?: number;
+    timeoutMsg?: string;
+};
+export type OcrClickOnTextOptions = OcrGetElementPositionByTextOptions & {
+    clickDuration?: Number;
+};
+export type OcrSetValueOptions = OcrClickOnTextOptions & {
+    submitValue?: boolean;
+    value: string;
+};
+/**
+ * Internal Methods
+ */
+export type GetOcrData = {
+    text: string;
+    lines: Line[];
+    words: Words[];
+};
+/**
+ * Internal types
+ */
+export type Line = {
+    text: string;
+    bbox: Rectangles;
+};
+export type Rectangles = {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+};
+export type Words = Line & {
+    wc: number;
+};
+export type TessaractDataOptions = {
+    filePath: string;
+    language: string;
+};
+export type ParseWordData = {
+    bbox: Rectangles;
+    wc: number;
+};
+export type GetTextPositionsOptions = DefaultMethodOptions & {};
+export type GetTextPositions = {
+    dprPosition: Rectangles;
+    filePath: string;
+    originalPosition: Rectangles;
+    text: string;
+};
+export type FuzzyFindOptions = {
+    pattern: string;
+    searchOptions?: FuzzySearchOptions;
+    textArray: {
+        /**
+         * the matched string
+         */
+        text: string;
+        /**
+         * The original position
+         */
+        originalPosition: Rectangles;
+        /**
+         * The position after DPR check
+         * screenshots for iOS are with DPR
+         * position on the screen for iOS is smaller
+         */
+        dprPosition: Rectangles;
+    }[];
+};
+export type FuzzySearchOptions = {
+    /**
+     * Determines how close the match must be to the fuzzy location (specified by location). An exact letter match
+     * which is distance characters away from the fuzzy location would score as a complete mismatch. A distance of
+     * 0 requires the match be at the exact location specified. A distance of 1000 would require a perfect match to
+     * be within 800 characters of the location to be found using a threshold of 0.8.
+     * Default: 100
+     */
+    distance?: number;
+    /**
+     * Whether the search should be case sensitive
+     * Default: false
+     */
+    isCaseSensitive?: boolean;
+    /**
+     * Only the matches whose length exceeds this value will be returned.
+     * (For instance, if you want to ignore single character matches in the result, set it to 2)
+     * Default: 2
+     */
+    minMatchCharLength?: number;
+    /**
+     * When true, the matching function will continue to the end of a search pattern even if a perfect match has
+     * already been located in the string.
+     * Default: false
+     */
+    findAllMatches?: boolean;
+    /**
+     * Determines approximately where in the text is the pattern expected to be found
+     * Default: 0
+     */
+    location?: number;
+    /**
+     * At what point does the match algorithm give up. A threshold of 0.0 requires a perfect match (of both letters
+     * and location), a threshold of 1.0 would match anything.
+     * Default: 0.6
+     */
+    threshold?: number;
+};
+export type FuzzyElement = {
+    /**
+     * The found item
+     */
+    item: {
+        /**
+         * The position after DPR check
+         * screenshots for iOS are with DPR
+         * position on the screen for iOS is smaller
+         */
+        dprPosition: Rectangles;
+        /**
+         * The path of the OCR screenshot
+         */
+        filePath: string;
+        /**
+         * The original position
+         */
+        originalPosition: Rectangles;
+        /**
+         * the matched string
+         */
+        text: string;
+    };
+    /**
+     * Index of the fuzzy logic check
+     */
+    refIndex: number;
+    /**
+     * Matched score of the fuzzy logic check
+     */
+    score: number;
+};
+export type DetermineClickPointOptions = {
+    rectangles: Rectangles;
+};
+export type ClickPoint = {
+    x: number;
+    y: number;
+};
+export type RectReturn = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export type RelativePosition = {
+    above?: number;
+    below?: number;
+    left?: number;
+    right?: number;
+};
+export type ProcessImageOptions = {
+    contrast: number;
+    elementRectangles?: RectReturn;
+    isAndroid: boolean;
+    isIOS: boolean;
+    ocrImagesPath: string;
+    screenshot: string;
+};
+export type ProcessImage = {
+    filePath: string;
+};
+export type DrawHighlightedWords = {
+    filePath: string;
+    highlights: Rectangles[];
+};
+export type ScreenshotSize = {
+    height: number;
+    width: number;
+};
+/**
+ * xml2js System Tessaract Types
+ */
+export type UnprocessedSystemBlock = {
+    TextBlock?: UnprocessedSystemTextBlockElement[];
+};
+export type UnprocessedSystemTextBlockElement = {
+    TextLine: UnprocessedSystemTextLineElement[];
+};
+export type UnprocessedSystemTextLineElement = {
+    $: {
+        HPOS: string;
+        VPOS: string;
+        WIDTH: string;
+        HEIGHT: string;
+    };
+    String: UnprocessedSystemStringElement[];
+};
+export type UnprocessedSystemStringElement = {
+    $: {
+        CONTENT: string;
+        HPOS: string;
+        VPOS: string;
+        WIDTH: string;
+        HEIGHT: string;
+        WC: string;
+    };
+};
+export type TargetOptions = {
+    filePath: string;
+    targetX: number;
+    targetY: number;
+};
+/**
+ * xml2js Nodejs Tessaract Types
+ */
+export type UnprocessedNodejsBlock = {
+    p?: UnprocessedNodejsParagraph[];
+};
+export type UnprocessedNodejsParagraph = {
+    span?: UnprocessedNodejsLine[];
+};
+export type UnprocessedNodejsLine = {
+    span?: UnprocessedNodejsWord[];
+};
+export type UnprocessedNodejsWord = {
+    _: string;
+    $: {
+        title: string;
+    };
+};
+/**
+ * Browser command return types
+ */
+export interface GetData extends GetOcrData {
+    dpr: number;
+    filePath: string;
+}
+export type OcrGetElementPositionByText = {
+    /**
+     * The position after DPR check
+     * screenshots for iOS are with DPR
+     * position on the screen for iOS is smaller
+     */
+    dprPosition: Rectangles;
+    /**
+     * The path of the OCR screenshot
+     */
+    filePath: string;
+    /**
+     * the matched string
+     */
+    matchedString: string;
+    /**
+     * The original position
+     */
+    originalPosition: Rectangles;
+    /**
+     * the original search value
+     */
+    searchValue: string;
+    /**
+     * Matched score of the fuzzy logic check
+     */
+    score: number;
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,KAAK,qBAAqB,GAAG;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,WAAW,CAAC,OAAO,GAAG,uBAAuB,GAAG,UAAU,CAAC;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,qBAAqB,GAAG,EAAE,CAAA;AAEvD,MAAM,MAAM,+BAA+B,GAAG,qBAAqB,GAAG;IAClE,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,IAAI,EAAE,MAAM,CAAC;CAChB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,+BAA+B,GAAG;IACxE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,+BAA+B,GAAG;IAC/D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACvC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,kBAAkB,GAAG;IAC/C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAA;AAED;;GAEG;AACH,KAAK,oBAAoB,GAAG,qBAAqB,GAAG;IAChD,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB,EAAE,OAAO,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACzB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,GAAG,EAAE,CAAA;AAEzD,MAAM,MAAM,cAAc,GAAG,oBAAoB,GAAG;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAA;AAED,MAAM,MAAM,kCAAkC,GAAG,oBAAoB,GAAG;IACpE,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;CAChB,CAAA;AAED,MAAM,MAAM,8BAA8B,GAAG,kCAAkC,GAAG;IAC9E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,kCAAkC,GAAG;IACrE,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,qBAAqB,GAAG;IACrD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,KAAK,EAAE,CAAC;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,UAAU,CAAC;CACpB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAClB,CAAA;AAED,MAAM,MAAM,KAAK,GAAG,IAAI,GAAG;IACvB,EAAE,EAAE,MAAM,CAAC;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IACxB,IAAI,EAAE,UAAU,CAAC;IACjB,EAAE,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,GAAG,EAAE,CAAA;AAE/D,MAAM,MAAM,gBAAgB,GAAG;IAC3B,WAAW,EAAE,UAAU,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,UAAU,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;CAChB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC,SAAS,EAAE;QACT;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,gBAAgB,EAAE,UAAU,CAAC;QAC7B;;;;WAIG;QACH,WAAW,EAAE,UAAU,CAAC;KACzB,EAAE,CAAC;CACP,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACvB;;OAEG;IACH,IAAI,EAAE;QACF;;;;WAIG;QACH,WAAW,EAAE,UAAU,CAAC;QACxB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,gBAAgB,EAAE,UAAU,CAAC;QAC7B;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACrC,UAAU,EAAE,UAAU,CAAC;CAC1B,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACrB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACb,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACrB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAClB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAI;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,UAAU,CAAC;IAC/B,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;CACtB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACvB,QAAQ,EAAE,MAAM,CAAC;CACpB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,UAAU,EAAE,CAAC;CAC5B,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACjB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACjC,SAAS,CAAC,EAAE,iCAAiC,EAAE,CAAC;CACnD,CAAA;AAED,MAAM,MAAM,iCAAiC,GAAG;IAC5C,QAAQ,EAAE,gCAAgC,EAAE,CAAC;CAChD,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC3C,CAAC,EAAE;QACC,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,MAAM,EAAE,8BAA8B,EAAE,CAAC;CAC5C,CAAA;AAED,MAAM,MAAM,8BAA8B,GAAG;IACzC,CAAC,EAAE;QACC,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,EAAE,EAAE,MAAM,CAAC;KACd,CAAC;CACL,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACnB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IAChC,CAAC,CAAC,EAAE,0BAA0B,EAAE,CAAC;CACrC,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACrC,IAAI,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAClC,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAE;IAC/B,IAAI,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAClC,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAChC,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE;QACC,KAAK,EAAE,MAAM,CAAC;KACjB,CAAC;CACL,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,UAAU;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,2BAA2B,GAAG;IACtC;;;;OAIG;IACH,WAAW,EAAE,UAAU,CAAC;IACxB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,gBAAgB,EAAE,UAAU,CAAC;IAC7B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACjB,CAAA"}

package/dist/types.js

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

package/dist/utils/constants.d.ts

@@ -0,0 +1,67 @@
+export declare const DEFAULT_IMAGES_FOLDER = ".tmp/";
+export declare const SUPPORTED_LANGUAGES: {
+    AFRIKAANS: string;
+    AMHARIC: string;
+    ARABIC: string;
+    ASSANESE: string;
+    AZERBAIJANI: string;
+    BELARUSIAN: string;
+    BENGALI: string;
+    TIBETAN: string;
+    BOSNIAN: string;
+    BULGARIAN: string;
+    CATALAN: string;
+    CZECH: string;
+    CHINESE: string;
+    CORSICAN: string;
+    DANISH: string;
+    GERMAN: string;
+    GREEK: string;
+    ENGLISH: string;
+    MATH: string;
+    ESTONIAN: string;
+    FINNISH: string;
+    FRENCH: string;
+    GAELIC: string;
+    IRISH: string;
+    HINDI: string;
+    CROATIAN: string;
+    HUNGARIAN: string;
+    ARMENIAN: string;
+    ITALIAN: string;
+    JAPANESE: string;
+    KANNADA: string;
+    KOREAN: string;
+    LATIN: string;
+    LATVIAN: string;
+    LITHUANIAN: string;
+    LUXEMBOURGISH: string;
+    MACEDONIAN: string;
+    DUTCH: string;
+    NORWEGIAN: string;
+    POLISH: string;
+    PORTUGUESE: string;
+    ROMANIAN: string;
+    RUSSIAN: string;
+    SLOVAK: string;
+    SLOVENIAN: string;
+    SPANISH: string;
+    ALBANIAN: string;
+    SERBIAN: string;
+    SWAHILI: string;
+    SWEDISH: string;
+    THAI: string;
+    TURKISH: string;
+    UKRAINIAN: string;
+    VIETNAMESE: string;
+};
+export declare const CONTRAST = 0.25;
+export declare const DEFAULT_FUZZY_OPTIONS: {
+    distance: number;
+    isCaseSensitive: boolean;
+    findAllMatches: boolean;
+    location: number;
+    minMatchCharLength: number;
+    threshold: number;
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/utils/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/utils/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,UAAU,CAAA;AAC5C,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuD/B,CAAA;AACD,eAAO,MAAM,QAAQ,OAAO,CAAA;AAC5B,eAAO,MAAM,qBAAqB;;;;;;;CAOjC,CAAA"}

package/dist/utils/constants.js

@@ -0,0 +1,66 @@
+export const DEFAULT_IMAGES_FOLDER = '.tmp/';
+export const SUPPORTED_LANGUAGES = {
+    AFRIKAANS: 'afr',
+    AMHARIC: 'amh',
+    ARABIC: 'ara',
+    ASSANESE: 'asm',
+    AZERBAIJANI: 'aze',
+    BELARUSIAN: 'bel',
+    BENGALI: 'bel',
+    TIBETAN: 'bod',
+    BOSNIAN: 'bos',
+    BULGARIAN: 'bul',
+    CATALAN: 'cat',
+    CZECH: 'cat',
+    CHINESE: 'chi_sim',
+    CORSICAN: 'cos',
+    DANISH: 'dan',
+    GERMAN: 'deu',
+    GREEK: 'ell',
+    ENGLISH: 'eng',
+    MATH: 'equ',
+    ESTONIAN: 'est',
+    FINNISH: 'fin',
+    FRENCH: 'fra',
+    GAELIC: 'gla',
+    IRISH: 'gle',
+    HINDI: 'hin',
+    CROATIAN: 'hrv',
+    HUNGARIAN: 'hun',
+    ARMENIAN: 'hye',
+    ITALIAN: 'ita',
+    JAPANESE: 'jpn',
+    KANNADA: 'kan',
+    KOREAN: 'kor',
+    LATIN: 'lat',
+    LATVIAN: 'lav',
+    LITHUANIAN: 'lit',
+    LUXEMBOURGISH: 'ltz',
+    MACEDONIAN: 'mkd',
+    DUTCH: 'nld',
+    NORWEGIAN: 'nor',
+    POLISH: 'pol',
+    PORTUGUESE: 'por',
+    ROMANIAN: 'ron',
+    RUSSIAN: 'rus',
+    SLOVAK: 'slk',
+    SLOVENIAN: 'slv',
+    SPANISH: 'spa',
+    ALBANIAN: 'sqi',
+    SERBIAN: 'srp',
+    SWAHILI: 'swa',
+    SWEDISH: 'swe',
+    THAI: 'tha',
+    TURKISH: 'tur',
+    UKRAINIAN: 'ukr',
+    VIETNAMESE: 'vie'
+};
+export const CONTRAST = 0.25;
+export const DEFAULT_FUZZY_OPTIONS = {
+    distance: 100,
+    isCaseSensitive: false,
+    findAllMatches: false,
+    location: 0,
+    minMatchCharLength: 2,
+    threshold: 0.6,
+};

package/dist/utils/fuzzySearch.d.ts

@@ -0,0 +1,3 @@
+import type { FuzzyElement, FuzzyFindOptions } from '../types.js';
+export declare function fuzzyFind(options: FuzzyFindOptions): FuzzyElement[] | [];
+//# sourceMappingURL=fuzzySearch.d.ts.map

package/dist/utils/fuzzySearch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fuzzySearch.d.ts","sourceRoot":"","sources":["../../src/utils/fuzzySearch.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAGjE,wBAAgB,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,YAAY,EAAE,GAAG,EAAE,CA4BxE"}

package/dist/utils/fuzzySearch.js

@@ -0,0 +1,29 @@
+import Fuse from 'fuse.js';
+import { DEFAULT_FUZZY_OPTIONS } from './constants.js';
+export function fuzzyFind(options) {
+    const { textArray, pattern, searchOptions } = options;
+    const fuzzyOptions = {
+        // Defaults that can be overwritten
+        ...DEFAULT_FUZZY_OPTIONS,
+        // Provided options
+        ...searchOptions,
+        // Defaults that should not be overwritten
+        // See https://fusejs.io/api/options.html for more options
+        ...{
+            includeMatches: false,
+            includeScore: true,
+            ignoreFieldNorm: false,
+            ignoreLocation: false,
+            keys: ['text'],
+            shouldSort: true,
+            useExtendedSearch: false,
+        },
+    };
+    const fuse = new Fuse(textArray, fuzzyOptions);
+    return fuse.search(pattern).map((item) => {
+        if (item.score) {
+            item.score = item.score < 1e-10 ? 0 : item.score;
+            return item;
+        }
+    }).filter((item) => item !== undefined);
+}

package/dist/utils/getData.d.ts

@@ -0,0 +1,3 @@
+import type { GetData, GetDataOptions } from '../types.js';
+export default function getData(options: GetDataOptions): Promise<GetData>;
+//# sourceMappingURL=getData.d.ts.map

package/dist/utils/getData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getData.d.ts","sourceRoot":"","sources":["../../src/utils/getData.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAoB,OAAO,EAAE,cAAc,EAAqB,MAAM,aAAa,CAAA;AAM/F,wBAA8B,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CA+E/E"}

package/dist/utils/getData.js

@@ -0,0 +1,71 @@
+import logger from '@wdio/logger';
+import { browser } from '@wdio/globals';
+import { getNodeOcrData, getSystemOcrData } from './tesseract.js';
+import { adjustElementBbox, getScreenshotSize, isRectanglesObject } from './index.js';
+import { drawHighlightedWords, processImage } from './imageProcessing.js';
+const log = logger('@wdio/ocr-service:getData');
+export default async function getData(options) {
+    const { contrast, cliFile, haystack, isTesseractAvailable, language, ocrImagesPath, } = options;
+    try {
+        let dpr = 1;
+        let screenshot;
+        if (!cliFile) {
+            const screenSize = await browser.getWindowSize();
+            screenshot = await browser.takeScreenshot();
+            const { width } = getScreenshotSize(screenshot);
+            dpr = width / screenSize.width;
+        }
+        else {
+            screenshot = cliFile;
+        }
+        const { filePath } = await processImage({ contrast, isAndroid: browser.isAndroid = false, isIOS: browser.isIOS = false, ocrImagesPath, screenshot });
+        let elementRectangles;
+        let croppedFilePath;
+        if (haystack) {
+            elementRectangles = isRectanglesObject(haystack) ? haystack : await browser.getElementRect((await haystack).elementId);
+            croppedFilePath = (await processImage({
+                contrast,
+                elementRectangles,
+                isAndroid: cliFile ? false : browser.isAndroid,
+                isIOS: cliFile ? false : browser.isIOS,
+                ocrImagesPath,
+                screenshot,
+            })).filePath;
+        }
+        // OCR the image
+        let ocrData;
+        const start = process.hrtime();
+        if (isTesseractAvailable) {
+            log.info('Using system installed version of Tesseract');
+            ocrData = await getSystemOcrData({ filePath: croppedFilePath || filePath, language });
+        }
+        else {
+            log.info('Using NodeJS version of Tesseract');
+            ocrData = await getNodeOcrData({ filePath: croppedFilePath || filePath, language });
+        }
+        if (haystack && elementRectangles) {
+            ocrData.lines.forEach((line) => {
+                line.bbox = adjustElementBbox(line.bbox, elementRectangles);
+            });
+            ocrData.words.forEach((word) => {
+                word.bbox = adjustElementBbox(word.bbox, elementRectangles);
+            });
+        }
+        const diff = process.hrtime(start);
+        const processTime = ((diff[0] * 1000000 + diff[1] / 1000) / 1000000).toFixed(3);
+        log.info(`It took '${processTime}s' to process the image.`);
+        log.info(`The following text was found through OCR:\n\n${ocrData.text.replace(/[\r\n]{2,}/g, '\n')}`);
+        // Get all words and highlight them
+        const highlights = ocrData.words.map((word) => word.bbox);
+        await drawHighlightedWords({ filePath, highlights });
+        log.info(`OCR Image with found text can be found here:\n\n${filePath}`);
+        return {
+            dpr,
+            filePath,
+            ...ocrData,
+        };
+    }
+    catch (e) {
+        throw new Error(String(e));
+    }
+}

package/dist/utils/getTextPositions.d.ts

@@ -0,0 +1,3 @@
+import type { GetTextPositions, GetTextPositionsOptions } from '../types.js';
+export default function getTextPositions(options: GetTextPositionsOptions): Promise<GetTextPositions[]>;
+//# sourceMappingURL=getTextPositions.d.ts.map

package/dist/utils/getTextPositions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getTextPositions.d.ts","sourceRoot":"","sources":["../../src/utils/getTextPositions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAQ,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAElF,wBAA8B,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAa5G"}

package/dist/utils/getTextPositions.js

@@ -0,0 +1,13 @@
+import getData from './getData.js';
+import { getDprPositions } from './index.js';
+export default async function getTextPositions(options) {
+    const { dpr, filePath, words } = await getData(options);
+    return (words
+        .map(({ text, bbox }) => ({
+        dprPosition: getDprPositions(JSON.parse(JSON.stringify(bbox)), dpr),
+        filePath,
+        originalPosition: bbox,
+        text: text.replace(/(^\s+|\s+$)/g, ''),
+    }))
+        .filter((word) => word.text));
+}

package/dist/utils/imageProcessing.d.ts

@@ -0,0 +1,5 @@
+import type { DrawHighlightedWords, ProcessImage, ProcessImageOptions, TargetOptions } from '../types.js';
+export declare function processImage({ contrast, elementRectangles, isAndroid, isIOS, ocrImagesPath, screenshot }: ProcessImageOptions): Promise<ProcessImage>;
+export declare function drawTarget({ filePath, targetX, targetY }: TargetOptions): Promise<void>;
+export declare function drawHighlightedWords({ filePath, highlights }: DrawHighlightedWords): Promise<void>;
+//# sourceMappingURL=imageProcessing.d.ts.map

package/dist/utils/imageProcessing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"imageProcessing.d.ts","sourceRoot":"","sources":["../../src/utils/imageProcessing.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,oBAAoB,EAAE,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAKzG,wBAAsB,YAAY,CAAC,EAAE,QAAQ,EAAE,iBAAiB,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,EAAC,mBAAmB,GAChI,OAAO,CAAC,YAAY,CAAC,CAyBvB;AAED,wBAAsB,UAAU,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,aAAa,iBAc7E;AAED,wBAAsB,oBAAoB,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,oBAAoB,iBA+BxF"}