@wix-pilot/webdriverio-appium 1.0.1 → 1.0.2

package/dist/index.js

@@ -99,31 +99,49 @@ class WebdriverIOAppiumFrameworkDriver {
                             signature: `$('~accessibilityId')`,
                             description: "Locate an element by its accessibility ID (commonly used in Appium).",
                             example: `const loginButton = await $('~loginButton'); // Accessibility ID`,
+                            guidelines: [
+                                "Always prefer using test IDs when available; if no ID is present, use another stable identifier.",
+                            ],
                         },
                         {
                             signature: `$('android=uiSelector')`,
                             description: "Locate an element using an Android UIAutomator selector.",
                             example: `const el = await $('android=new UiSelector().text("Login")');`,
+                            guidelines: [
+                                "For Android, use UIAutomator selectors to target elements by text, resource-id, or other properties. Ensure selectors are precise to avoid ambiguity.",
+                            ],
                         },
                         {
                             signature: `$('ios=predicateString')`,
                             description: "Locate an element using an iOS NSPredicate string.",
                             example: `const el = await $('ios=predicate string:type == "XCUIElementTypeButton" AND name == "Login"');`,
+                            guidelines: [
+                                "For iOS, use NSPredicate strings to define clear and concise conditions for element identification. Validate the predicate to ensure it uniquely identifies the element.",
+                            ],
                         },
                         {
                             signature: `$$('#elementSelector')`,
                             description: "Locate all elements with a given selector",
                             example: `const firstSite = await $$('#Site')[index];`,
+                            guidelines: [
+                                "Use this to select multiple elements. Make sure your selector targets a specific subset of elements to avoid excessive matches.",
+                            ],
                         },
                         {
                             signature: `$('//*[@text="Login"]')`,
                             description: "Locate an element using an XPath expression.",
                             example: `const el = await $('//*[@text="Login"]');`,
+                            guidelines: [
+                                "Use XPath as a last resort when other selectors are not available, as XPath can be slower and more brittle. Ensure your XPath expression is optimized for performance.",
+                            ],
                         },
                         {
                             signature: `$('#elementId'), $('elementTag'), $('.className')`,
                             description: "Web-like selectors (useful if your app is a hybrid or has a web context).",
                             example: `const el = await $('.someNativeClass');`,
+                            guidelines: [
+                                "Use web-like selectors in hybrid apps or web contexts. Ensure selectors are unique and adhere to best practices for CSS selectors.",
+                            ],
                         },
                     ],
                 },
@@ -136,6 +154,9 @@ class WebdriverIOAppiumFrameworkDriver {
                             example: `
               await (await $('~loginButton')).waitForEnabled();
               await (await $('~loginButton')).click();`,
+                            guidelines: [
+                                "Before clicking on an element make sure it is enabled",
+                            ],
                         },
                         {
                             signature: `.setValue(value: string)`,
@@ -163,11 +184,6 @@ await (await $('~dragHandle')).touchAction([
 ]);
               `,
                         },
-                        {
-                            signature: `.scrollIntoView() (web/hybrid context only)`,
-                            description: "Scrolls the element into view (if in a web context).",
-                            example: `await (await $('#someElement')).scrollIntoView();`,
-                        },
                         {
                             signature: `.dragAndDrop(target, duration?)`,
                             description: "Drags the element to the target location (native or web context).",
@@ -187,31 +203,49 @@ await (await $('~draggable')).dragAndDrop(
                             signature: `toBeDisplayed()`,
                             description: "Asserts that the element is displayed (visible).",
                             example: `await expect(await $('~loginButton')).toBeDisplayed();`,
+                            guidelines: [
+                                "Use this matcher to verify that the element is visible to the user.",
+                            ],
                         },
                         {
                             signature: `toExist()`,
                             description: "Asserts that the element exists in the DOM/hierarchy.",
                             example: `await expect(await $('~usernameInput')).toExist();`,
+                            guidelines: [
+                                "Use this matcher to check that the element exists in the DOM or view hierarchy.",
+                            ],
                         },
                         {
                             signature: `toHaveText(text: string)`,
                             description: "Asserts that the element's text matches the given string.",
                             example: `await expect(await $('~welcomeMessage')).toHaveText('Welcome, user!');`,
+                            guidelines: [
+                                "Use this matcher to verify the text content of an element exactly matches the expected value.",
+                            ],
                         },
                         {
                             signature: `toHaveValue(value: string)`,
                             description: "Asserts that the element's value matches the given string (for inputs, etc.).",
                             example: `await expect(await $('~usernameInput')).toHaveValue('myusername');`,
+                            guidelines: [
+                                "Use this matcher for form elements to verify that the input value is correct.",
+                            ],
                         },
                         {
                             signature: `toBeEnabled() / toBeDisabled()`,
                             description: "Asserts that an element is enabled/disabled (if applicable).",
                             example: `await expect(await $('~submitButton')).toBeEnabled();`,
+                            guidelines: [
+                                "Use these matchers to assert that an element is enabled or disabled as required by the test scenario.",
+                            ],
                         },
                         {
                             signature: `not`,
                             description: "Negates the expectation.",
                             example: `await expect(await $('~spinner')).not.toBeDisplayed();`,
+                            guidelines: [
+                                "Use this matcher to invert the condition of any expectation, ensuring the element does not meet the specified criteria.",
+                            ],
                         },
                     ],
                 },

package/dist/wdio.conf.d.ts

@@ -0,0 +1,28 @@
+export declare const config: {
+    runner: string;
+    specs: string[];
+    maxInstances: number;
+    capabilities: {
+        platformName: string;
+        deviceName: string;
+        automationName: string;
+        app: string;
+    }[];
+    logLevel: string;
+    bail: number;
+    baseUrl: string;
+    waitforTimeout: number;
+    connectionRetryTimeout: number;
+    connectionRetryCount: number;
+    services: string[];
+    appium: {
+        command: string;
+    };
+    framework: string;
+    reporters: string[];
+    mochaOpts: {
+        ui: string;
+        timeout: number;
+    };
+    before: () => void;
+};

package/dist/wdio.conf.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = void 0;
+// wdio.conf.ts
+exports.config = {
+    runner: 'local',
+    specs: ['./examples/**/*.test.ts'],
+    maxInstances: 1,
+    capabilities: [{
+            platformName: 'iOS',
+            deviceName: 'iPhone 14',
+            automationName: 'XCUITest',
+            app: './Users/tzviels/Library/Developer/Xcode/DerivedData/ExampleApp-ccggovixskkojadmtpriqiridvii/Build/Products/Debug-iphonesimulator/ExampleApp.app',
+        }],
+    logLevel: 'info',
+    bail: 0,
+    baseUrl: 'http://localhost',
+    waitforTimeout: 10000,
+    connectionRetryTimeout: 90000,
+    connectionRetryCount: 3,
+    services: ['appium'],
+    appium: {
+        command: 'appium',
+    },
+    framework: 'mocha',
+    reporters: ['spec'],
+    mochaOpts: {
+        ui: 'bdd',
+        timeout: 60000,
+    },
+    before: function () {
+        global.driver = browser;
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix-pilot/webdriverio-appium",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "WebdriverIO and Appium driver for Wix Pilot usage",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",