@mablhq/mabl-cli 2.8.25 → 2.12.7

package/mablscript/mobile/tests/steps/ScrollStep.mobiletest.js

@@ -1,37 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ScrollStep_1 = require("../../steps/ScrollStep");
+const ScrollStepDescriptor_1 = require("../../../types/mobile/ScrollStepDescriptor");
 const StepTestsUtil_1 = require("../StepTestsUtil");
+const domUtil_1 = require("../../../../domUtil");
 describe('Scroll steps parse correctly', () => {
-    it('Parses a Scroll step', () => {
-        const windowSize = { width: 1440, height: 2392 };
-        const scrollStepDescriptor = {
-            id: 'scrolliePolieOlie',
-            coordinates: {
-                from: {
-                    xPercent: 1074 / windowSize.width,
-                    yPercent: 2350 / windowSize.height,
-                },
-                to: {
-                    xPercent: 1074 / windowSize.width,
-                    yPercent: 100 / windowSize.height,
-                },
-            },
-            actionCode: 'scroll',
-        };
-        const steps = [
-            {
-                Scroll: scrollStepDescriptor,
-            },
-        ];
-        (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, ScrollStep_1.ScrollStep.stepName, scrollStepDescriptor);
-        const scrollStep = new ScrollStep_1.ScrollStep(scrollStepDescriptor);
-        expect(scrollStep.stepId()).toEqual(scrollStepDescriptor.id);
-    });
-    it('Humanizes a scroll step', () => {
-        const windowSize = { width: 1440, height: 2392 };
-        const stepYaml = {
-            Scroll: {
+    describe('ScrollType.ScrollDeviceScreen', () => {
+        it('Parses a ScrollDeviceScreen step', () => {
+            const windowSize = { width: 1440, height: 2392 };
+            const scrollStepDescriptor = {
+                id: 'scrolliePolieOlie',
                 coordinates: {
                     from: {
                         xPercent: 1074 / windowSize.width,
@@ -43,79 +21,312 @@ describe('Scroll steps parse correctly', () => {
                     },
                 },
                 actionCode: 'scroll',
-            },
-        };
-        const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
-        expect(step.stepDescription()).toEqual(`Scroll down 94.06% of the screen`);
-    });
-    it('Humanizes scroll directions as expected', () => {
-        const scrollUpStepYaml = {
-            Scroll: {
-                coordinates: {
-                    from: {
-                        xPercent: 0.109212,
-                        yPercent: 0.241223,
+                scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Down,
+                scrollType: ScrollStepDescriptor_1.ScrollType.ScrollDeviceScreen,
+            };
+            const steps = [
+                {
+                    Scroll: scrollStepDescriptor,
+                },
+            ];
+            (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, ScrollStep_1.ScrollStep.stepName, scrollStepDescriptor);
+            const scrollStep = new ScrollStep_1.ScrollStep(scrollStepDescriptor);
+            expect(scrollStep.stepId()).toEqual(scrollStepDescriptor.id);
+        });
+        it('Humanizes a ScrollDeviceScreen step', () => {
+            const windowSize = { width: 1440, height: 2392 };
+            const stepYaml = {
+                Scroll: {
+                    coordinates: {
+                        from: {
+                            xPercent: 1074 / windowSize.width,
+                            yPercent: 2350 / windowSize.height,
+                        },
+                        to: {
+                            xPercent: 1074 / windowSize.width,
+                            yPercent: 100 / windowSize.height,
+                        },
                     },
-                    to: {
-                        xPercent: 0.145543,
-                        yPercent: 0.865454,
+                    actionCode: 'scroll',
+                    scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Down,
+                    scrollType: ScrollStepDescriptor_1.ScrollType.ScrollDeviceScreen,
+                },
+            };
+            const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
+            expect(step.stepDescription()).toEqual(`Scroll down 94.06% of the screen`);
+        });
+        it('Humanizes scroll directions as expected', () => {
+            const scrollUpStepYaml = {
+                Scroll: {
+                    coordinates: {
+                        from: {
+                            xPercent: 0.109212,
+                            yPercent: 0.241223,
+                        },
+                        to: {
+                            xPercent: 0.145543,
+                            yPercent: 0.865454,
+                        },
                     },
+                    actionCode: 'scroll',
+                    scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Up,
+                    scrollType: ScrollStepDescriptor_1.ScrollType.ScrollDeviceScreen,
+                },
+            };
+            const scrollUpStep = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(scrollUpStepYaml);
+            expect(scrollUpStep.stepDescription()).toEqual(`Scroll up 62.42% of the screen`);
+            const scrollDownStepYaml = {
+                Scroll: {
+                    coordinates: {
+                        from: {
+                            xPercent: 0.48351,
+                            yPercent: 0.89123,
+                        },
+                        to: {
+                            xPercent: 0.4515,
+                            yPercent: 0.0874,
+                        },
+                    },
+                    actionCode: 'scroll',
+                    scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Down,
+                    scrollType: ScrollStepDescriptor_1.ScrollType.ScrollDeviceScreen,
+                },
+            };
+            const scrollDownStep = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(scrollDownStepYaml);
+            expect(scrollDownStep.stepDescription()).toEqual(`Scroll down 80.38% of the screen`);
+            const scrollLeftStepYaml = {
+                Scroll: {
+                    coordinates: {
+                        from: {
+                            xPercent: 0.08111,
+                            yPercent: 0.46123,
+                        },
+                        to: {
+                            xPercent: 0.90295,
+                            yPercent: 0.4574,
+                        },
+                    },
+                    actionCode: 'scroll',
+                    scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Right,
+                    scrollType: ScrollStepDescriptor_1.ScrollType.ScrollDeviceScreen,
+                },
+            };
+            const scrollLeftStep = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(scrollLeftStepYaml);
+            expect(scrollLeftStep.stepDescription()).toEqual(`Scroll left 82.18% of the screen`);
+            const scrollRightStepYaml = {
+                Scroll: {
+                    coordinates: {
+                        from: {
+                            xPercent: 0.88111,
+                            yPercent: 0.46123,
+                        },
+                        to: {
+                            xPercent: 0.09295,
+                            yPercent: 0.4574,
+                        },
+                    },
+                    actionCode: 'scroll',
+                    scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Left,
+                    scrollType: ScrollStepDescriptor_1.ScrollType.ScrollDeviceScreen,
+                },
+            };
+            const scrollRightStep = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(scrollRightStepYaml);
+            expect(scrollRightStep.stepDescription()).toEqual(`Scroll right 78.82% of the screen`);
+        });
+    });
+    describe('ScrollType.ScrollToElement', () => {
+        const find = {
+            findType: domUtil_1.FindType.FIND_ONE,
+            findTarget: {
+                selector: {
+                    iOS: {
+                        name: 'Name field',
+                    },
+                    uuid: '',
                 },
-                actionCode: 'scroll',
             },
         };
-        const scrollUpStep = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(scrollUpStepYaml);
-        expect(scrollUpStep.stepDescription()).toEqual(`Scroll up 62.42% of the screen`);
-        const scrollDownStepYaml = {
-            Scroll: {
-                coordinates: {
-                    from: {
-                        xPercent: 0.48351,
-                        yPercent: 0.89123,
-                    },
-                    to: {
-                        xPercent: 0.4515,
-                        yPercent: 0.0874,
+        const innerFindTarget = {
+            findType: domUtil_1.FindType.FIND_ONE,
+            findTarget: {
+                selector: {
+                    iOS: {
+                        name: 'Email field',
                     },
+                    uuid: '',
                 },
+            },
+        };
+        it('Parses a ScrollToElement step', () => {
+            const scrollStepDescriptor = {
+                id: 'scrollMe',
+                actionCode: 'scroll',
+                find,
+                maxScrollAttempts: 6,
+                scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Right,
+                scrollType: ScrollStepDescriptor_1.ScrollType.ScrollToElement,
+                targetElementDescriptor: innerFindTarget,
+            };
+            const steps = [
+                {
+                    Scroll: scrollStepDescriptor,
+                },
+            ];
+            (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, ScrollStep_1.ScrollStep.stepName, scrollStepDescriptor);
+            const scrollStep = new ScrollStep_1.ScrollStep(scrollStepDescriptor);
+            expect(scrollStep.stepId()).toEqual(scrollStepDescriptor.id);
+        });
+        it('Humanizes a ScrollToElement step', () => {
+            const scrollStepDescriptor = {
+                id: 'scrollMe',
                 actionCode: 'scroll',
+                find,
+                maxScrollAttempts: 6,
+                scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Right,
+                scrollType: ScrollStepDescriptor_1.ScrollType.ScrollToElement,
+                targetElementDescriptor: innerFindTarget,
+            };
+            const stepYaml = {
+                Scroll: scrollStepDescriptor,
+            };
+            const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
+            expect(step.stepDescription()).toEqual(`Scroll right a maximum of 6 times within the "Name field" element until the "Email field" element is visible`);
+        });
+    });
+    describe('ScrollType.ScrollWithinElement', () => {
+        const find = {
+            findType: domUtil_1.FindType.FIND_ONE,
+            findTarget: {
+                selector: {
+                    iOS: {
+                        name: 'Name field',
+                    },
+                    uuid: '',
+                },
             },
         };
-        const scrollDownStep = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(scrollDownStepYaml);
-        expect(scrollDownStep.stepDescription()).toEqual(`Scroll down 80.38% of the screen`);
-        const swipeRightStepYaml = {
-            Scroll: {
+        it('Parses a ScrollWithinElement step', () => {
+            const scrollStepDescriptor = {
+                id: 'scrollMe',
+                actionCode: 'scroll',
                 coordinates: {
                     from: {
-                        xPercent: 0.08111,
-                        yPercent: 0.46123,
+                        xPercent: 0.9,
+                        yPercent: 0.6,
                     },
                     to: {
-                        xPercent: 0.90295,
-                        yPercent: 0.4574,
+                        xPercent: 0.1,
+                        yPercent: 0.5,
                     },
                 },
+                find,
+                scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Left,
+                scrollType: ScrollStepDescriptor_1.ScrollType.ScrollWithinElement,
+            };
+            const steps = [
+                {
+                    Scroll: scrollStepDescriptor,
+                },
+            ];
+            (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, ScrollStep_1.ScrollStep.stepName, scrollStepDescriptor);
+            const scrollStep = new ScrollStep_1.ScrollStep(scrollStepDescriptor);
+            expect(scrollStep.stepId()).toEqual(scrollStepDescriptor.id);
+        });
+        it('Humanizes a ScrollWithinElement step', () => {
+            const scrollStepDescriptor = {
+                id: 'scrollMe',
                 actionCode: 'scroll',
-            },
-        };
-        const swipeRightStep = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(swipeRightStepYaml);
-        expect(swipeRightStep.stepDescription()).toEqual(`Swipe right 82.18% of the screen`);
-        const swipeLeftStepYaml = {
-            Scroll: {
                 coordinates: {
                     from: {
-                        xPercent: 0.88111,
-                        yPercent: 0.46123,
+                        xPercent: 0.9,
+                        yPercent: 0.6,
                     },
                     to: {
-                        xPercent: 0.09295,
-                        yPercent: 0.4574,
+                        xPercent: 0.1,
+                        yPercent: 0.5,
                     },
                 },
-                actionCode: 'scroll',
+                find,
+                scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Left,
+                scrollType: ScrollStepDescriptor_1.ScrollType.ScrollWithinElement,
+            };
+            const stepYaml = {
+                Scroll: scrollStepDescriptor,
+            };
+            const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
+            expect(step.stepDescription()).toEqual(`Scroll right 80% within the "Name field" element`);
+        });
+    });
+});
+describe('getScrollDirectionAndPercentageFromCoordinates', () => {
+    it('returned default down 80% if no coordinates supplied', () => {
+        expect((0, ScrollStep_1.getScrollDirectionAndPercentageFromCoordinates)(undefined)).toEqual({
+            scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Down,
+            scrollPercent: '80%',
+        });
+    });
+    it('determines correct down direction and percentage', () => {
+        const scrollCoordinates = {
+            from: {
+                xPercent: 0.3,
+                yPercent: 0.75,
+            },
+            to: {
+                xPercent: 0.5,
+                yPercent: 0.25,
+            },
+        };
+        expect((0, ScrollStep_1.getScrollDirectionAndPercentageFromCoordinates)(scrollCoordinates)).toEqual({
+            scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Down,
+            scrollPercent: '50%',
+        });
+    });
+    it('determines correct up direction and percentage', () => {
+        const scrollCoordinates = {
+            from: {
+                xPercent: 0.7,
+                yPercent: 0,
+            },
+            to: {
+                xPercent: 0.4,
+                yPercent: 1,
+            },
+        };
+        expect((0, ScrollStep_1.getScrollDirectionAndPercentageFromCoordinates)(scrollCoordinates)).toEqual({
+            scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Up,
+            scrollPercent: '100%',
+        });
+    });
+    it('determines correct right direction and percentage', () => {
+        const scrollCoordinates = {
+            from: {
+                xPercent: 0.95,
+                yPercent: 0.4,
+            },
+            to: {
+                xPercent: 0.12,
+                yPercent: 0.5,
+            },
+        };
+        expect((0, ScrollStep_1.getScrollDirectionAndPercentageFromCoordinates)(scrollCoordinates)).toEqual({
+            scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Right,
+            scrollPercent: '83%',
+        });
+    });
+    it('determines correct left direction and percentage', () => {
+        const scrollCoordinates = {
+            from: {
+                xPercent: 0.04,
+                yPercent: 0.7,
+            },
+            to: {
+                xPercent: 0.82,
+                yPercent: 0.4,
             },
         };
-        const swipeLeftStep = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(swipeLeftStepYaml);
-        expect(swipeLeftStep.stepDescription()).toEqual(`Swipe left 78.82% of the screen`);
+        expect((0, ScrollStep_1.getScrollDirectionAndPercentageFromCoordinates)(scrollCoordinates)).toEqual({
+            scrollDirection: ScrollStepDescriptor_1.ScrollDirection.Left,
+            scrollPercent: '78%',
+        });
     });
 });

package/mablscript/mobile/tests/steps/UninstallAppStep.mobiletest.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const UninstallAppStep_1 = require("../../steps/UninstallAppStep");
+const StepTestsUtil_1 = require("../StepTestsUtil");
+describe('Uninstall App steps parse correctly', () => {
+    it('Parses an UninstallApp step', () => {
+        const stepDescriptor = {
+            id: 'noAppForYou',
+            actionCode: 'uninstallApp',
+        };
+        const steps = [
+            {
+                UninstallApp: stepDescriptor,
+            },
+        ];
+        (0, StepTestsUtil_1.parseAndValidateYamlConversion)(steps, UninstallAppStep_1.UninstallAppStep.stepName, stepDescriptor);
+        const tapStep = new UninstallAppStep_1.UninstallAppStep(stepDescriptor);
+        expect(tapStep.stepId()).toEqual(stepDescriptor.id);
+    });
+});

package/mablscript/steps/AwaitTabStep.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AwaitTabStep = void 0;
+exports.hasCustomFindOptions = exports.AwaitTabStep = void 0;
 const domUtil_1 = require("../../domUtil");
 const MablStep_1 = require("../MablStep");
 class AwaitTabStep extends MablStep_1.MablStep {
@@ -23,19 +23,47 @@ class AwaitTabStep extends MablStep_1.MablStep {
         return step;
     }
     toMablscript() {
+        return `await_tab(${AwaitTabStep.getMablscriptSelectorFromTabFindAction(this.tab)})`;
+    }
+    static hasCustomFindOptions(tab) {
+        var _a, _b;
+        return Object.keys((_b = (_a = tab.configuration) === null || _a === void 0 ? void 0 : _a.propertyPreferences) !== null && _b !== void 0 ? _b : {}).length > 0;
+    }
+    static getMablscriptSelectorFromTabFindAction(tab) {
         const mablscriptSelectorChunks = ['selector_type: "tab"'];
-        if (this.tab.title !== undefined) {
-            mablscriptSelectorChunks.push(`title: "${(0, domUtil_1.escapeMablscriptString)(this.tab.title)}"`);
+        if (tab.title !== undefined) {
+            mablscriptSelectorChunks.push(`title: "${(0, domUtil_1.escapeMablscriptString)(tab.title)}"`);
         }
-        if (this.tab.url !== undefined) {
-            mablscriptSelectorChunks.push(`url: "${(0, domUtil_1.escapeMablscriptString)(this.tab.url)}"`);
+        if (tab.url !== undefined) {
+            mablscriptSelectorChunks.push(`url: "${(0, domUtil_1.escapeMablscriptString)(tab.url)}"`);
         }
-        if (this.tab.uuid !== undefined) {
-            mablscriptSelectorChunks.push(`uuid: "${(0, domUtil_1.escapeMablscriptString)(this.tab.uuid)}"`);
+        if (tab.uuid !== undefined) {
+            mablscriptSelectorChunks.push(`uuid: "${(0, domUtil_1.escapeMablscriptString)(tab.uuid)}"`);
         }
-        return `await_tab({${mablscriptSelectorChunks.join(', ')}})`;
+        let descriptor = mablscriptSelectorChunks.join(', ');
+        if (tab.configuration) {
+            descriptor = `${descriptor}, ${AwaitTabStep.getConfigurationString(tab)}`;
+        }
+        return `{${descriptor}}`;
+    }
+    static getConfigurationString(tabSelector) {
+        let configString;
+        if (hasCustomFindOptions(tabSelector)) {
+            configString = (0, domUtil_1.buildStepArgumentString)({
+                params: { ...tabSelector.configuration },
+                legacy: true,
+            });
+        }
+        if (configString) {
+            return `configuration: ${configString}`;
+        }
+        return '';
     }
 }
 exports.AwaitTabStep = AwaitTabStep;
 AwaitTabStep.mablScriptStepNames = ['await_tab'];
 AwaitTabStep.yamlMablScriptNames = ['AwaitTab'];
+function hasCustomFindOptions(tab) {
+    return AwaitTabStep.hasCustomFindOptions(tab);
+}
+exports.hasCustomFindOptions = hasCustomFindOptions;

package/mablscript/types/mobile/InstallAppStepDescriptor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/mablscript/types/mobile/PrepareSessionStepDescriptor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/mablscript/types/mobile/ScrollStepDescriptor.js

@@ -1,2 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScrollType = exports.ScrollDirection = void 0;
+var ScrollDirection;
+(function (ScrollDirection) {
+    ScrollDirection["Down"] = "down";
+    ScrollDirection["Left"] = "left";
+    ScrollDirection["Right"] = "right";
+    ScrollDirection["Up"] = "up";
+})(ScrollDirection = exports.ScrollDirection || (exports.ScrollDirection = {}));
+var ScrollType;
+(function (ScrollType) {
+    ScrollType["ScrollDeviceScreen"] = "scroll_device_screen";
+    ScrollType["ScrollToElement"] = "scroll_to_element";
+    ScrollType["ScrollWithinElement"] = "scroll_within_element";
+})(ScrollType = exports.ScrollType || (exports.ScrollType = {}));

package/mablscript/types/mobile/UninstallAppStepDescriptor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });