@bigbinary/neeto-playwright-commons 1.9.27 → 1.9.28

package/README.md

@@ -11,6 +11,121 @@ Install from npm:
 yarn add "@bigbinary/neeto-playwright-commons@latest"
 ```
 
+## Dependencies
+
+**neetoPlaywrightCommons** has some peer dependencies which can be installed
+using the commands listed below:
+
+### `neeto-cist`
+
+A collection of common utility functions used across all our
+[neeto](https://www.neeto.com/) products. Try out the utility functions live at
+[neetoCommons REPL](https://neeto-cist.neeto.com/).
+
+```
+yarn add @bigbinary/neeto-cist
+```
+
+### `faker`
+
+Faker is used to generate fake data.
+
+```
+yarn add @faker-js/faker
+```
+
+### `playwright/test`
+
+```
+yarn add @playwright/test
+```
+
+### `lint-staged`
+
+Run linters against staged git files.
+
+```
+yarn add lint-staged
+```
+
+### `dotenv-webpack`
+
+`dotenv-webpack` is a secure webpack plugin that supports
+[dotenv](https://www.npmjs.com/package/dotenv) and other environment variables.
+
+```
+yarn add dotenv-webpack
+```
+
+### `mailosaur`
+
+Using `Mailosaur` you can automate email and SMS tests.
+
+```
+yarn add mailosaur
+```
+
+### `dayjs`
+
+Dayjs is a JavaScript library that parses, validates, manipulates, and displays
+dates and times.
+
+```
+yarn add dayjs
+```
+
+### `ramda`
+
+Ramda is a JavaScript library that facilitates functional programming in
+JavaScript. It provides a collection of utility functions that operate on data.
+
+```
+yarn add ramda
+```
+
+### `playwright-i18next-fixture`
+
+Use your `i18next` translations in Playwright to create multi-language
+selectors.
+
+```
+yarn add playwright-i18next-fixture
+```
+
+We can install all the above peer dependencies by running a single command.
+
+```
+yarn add @bigbinary/neeto-cist @faker-js/faker @playwright/test lint-staged dotenv-webpack mailosaur dayjs ramda playwright-i18next-fixture
+```
+
+## External dependencies
+
+### Methods
+
+## mailosaurUtils
+
+Note: ENV variables `MAILOUSAUR_KEY` and `MAILOSAUR_SERVER_ID` are required for
+this methods to work.
+
+We can find `MAILOUSAUR_KEY` by visiting https://mailosaur.com/app/account/keys
+and `MAILOSAUR_SERVER_ID` by visiting https://mailosaur.com/app/servers
+
+## Slack integration methods
+
+Note: Either ENV variables `SLACK_WORKSPACE`, `SLACK_LOGIN_PASSWORD` and
+`SLACK_LOGIN_EMAIL` is required for this method to work or custom credentials
+`workspace`, `loginPassword` and `loginEmail` must be passed.
+
+## Zapier integration methods
+
+Note: ENV variables `INTEGRATION_MAILOSAUR_API_KEY`,
+`INTEGRATION_MAILOSAUR_SERVER_ID`, `ZAPIER_LOGIN_PASSWORD`,
+`ZAPIER_LOGIN_EMAIL`, and `ZAP_ID` are required for this methods to work.
+
+We can find `INTEGRATION_MAILOSAUR_SERVER_ID` by visiting
+https://mailosaur.com/app/servers and `INTEGRATION_MAILOSAUR_API_KEY` by
+visiting https://mailosaur.com/app/servers/ymn2s6kt/keys
+
 ## Usage
 
 You can import the utility functions and constants from the

package/index.d.ts

@@ -362,9 +362,9 @@ declare class MailosaurUtils {
    *     email: `someone@${process.env.MAILOSAUR_SERVER_ID}.mailosaur.net`,
    *     subjectSubstring: "is your OTP",
    *     timeout: 60 * 1000,
-   *     receivedAfter: new Date()
-   *   })
-   * })
+   *     receivedAfter: new Date(),
+   *   });
+   * });
    * @endexample
   */
   getEmailContent: ({
@@ -400,9 +400,9 @@ declare class MailosaurUtils {
    *     email: `someone@${process.env.MAILOSAUR_SERVER_ID}.mailosaur.net`,
    *     subjectSubstring: "is your OTP",
    *     timeout: 60 * 1000,
-   *     receivedAfter: new Date()
-   *   })
-   * })
+   *     receivedAfter: new Date(),
+   *   });
+   * });
    * @endexample
   */
   fetchOtpFromEmail: FetchOtpFromEmail;
@@ -414,7 +414,7 @@ declare class MailosaurUtils {
    *
    * test("sample test", async ({ mailosaurUtils }) => {
    *   const email = mailosaurUtils.generateRandomMailosaurEmail();
-   * })
+   * });
    * @endexample
   */
   generateRandomMailosaurEmail: () => string;
@@ -947,7 +947,7 @@ declare class SlackPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await slackPage.setupCloseHandlers(slackWebappPageInstance);
+   * await slackPage.setupCloseHandlers(slackWebappPageInstance);
    * @endexample
   */
   setupCloseHandlers: (slackWebappPage?: Page) => Promise<void>;
@@ -963,7 +963,11 @@ declare class SlackPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await slackPage.connectAndVerifyIntegration(/example\.com/, customSteps, "general");
+   * await slackPage.connectAndVerifyIntegration(
+   *   /example\.com/,
+   *   customSteps,
+   *   "general"
+   * );
    * @endexample
   */
   connectAndVerifyIntegration: (redirectUrl: RedirectUrl, customSteps?: AsyncNoArgsFunction, channelToConfigure?: string) => Promise<void>;
@@ -973,7 +977,7 @@ declare class SlackPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await slackPage.disconnectAndVerifyIntegration();
+   * await slackPage.disconnectAndVerifyIntegration();
    * @endexample
   */
   disconnectAndVerifyIntegration: () => Promise<void>;
@@ -1041,6 +1045,12 @@ declare class SlackPage extends IntegrationBase {
   */
   clickOnChannelListRefreshButton: (refreshInterceptMultipleResponsesParams?: PartialInterceptMultipleResponsesParams) => Promise<void>;
   /**
+   *
+   * Note: Either ENV variables SLACK_WORKSPACE, SLACK_LOGIN_PASSWORD and
+   *
+   * SLACK_LOGIN_EMAIL is required for this method to work or custom credentials
+   *
+   * workspace, loginPassword and loginEmail must be passed.
    *
    * Logs into slack web app. It takes the following parameters:
    *
@@ -1050,13 +1060,13 @@ declare class SlackPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await slackPage.loginToSlackWebapp(slackWebappPageInstance);
-   *     // OR
-   *   await slackPage.loginToSlackWebapp(slackWebappPageInstance,{
-   *     loginEmail:"jhondoe@gmail.com",
-   *     loginPassword: "123456789",
-   *     workspace: "your-workspace-name",
-   *   })
+   * await slackPage.loginToSlackWebapp(slackWebappPageInstance);
+   * // OR
+   * await slackPage.loginToSlackWebapp(slackWebappPageInstance, {
+   *   loginEmail: "johndoe@gmail.com",
+   *   loginPassword: "123456789",
+   *   workspace: "your-workspace-name",
+   * });
    * @endexample
   */
   loginToSlackWebapp: (slackWebappPage: Page, customCredentials?: Record<"workspace" | "loginPassword" | "loginEmail", string | undefined>) => Promise<void>;
@@ -1066,7 +1076,7 @@ declare class SlackPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await slackPage.logoutFromSlackWebApp();
+   * await slackPage.logoutFromSlackWebApp();
    * @endexample
   */
   logoutFromSlackWebApp: () => Promise<void>;
@@ -1078,7 +1088,7 @@ declare class SlackPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await slackPage.goToSlackChannel("general");
+   * await slackPage.goToSlackChannel("general");
    * @endexample
   */
   goToSlackChannel: (slackChannel: string) => Promise<void>;
@@ -1092,7 +1102,10 @@ declare class SlackPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await slackPage.createNewSlackChannel({ channelName: "new-channel", kind: "public" });
+   * await slackPage.createNewSlackChannel({
+   *   channelName: "new-channel",
+   *   kind: "public",
+   * });
    * @endexample
   */
   createNewSlackChannel: ({
@@ -1110,7 +1123,7 @@ declare class SlackPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await slackPage.deleteSlackChannel("old-channel");
+   * await slackPage.deleteSlackChannel("old-channel");
    * @endexample
   */
   deleteSlackChannel: (channel: string) => Promise<void>;
@@ -1263,7 +1276,7 @@ declare class ZapierPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await zapierPage.loginToZapier(zapierWebPageInstance);
+   * await zapierPage.loginToZapier(zapierWebPageInstance);
    * @endexample
   */
   loginToZapier: (zapierWebPage: Page) => Promise<void>;
@@ -1273,7 +1286,7 @@ declare class ZapierPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await zapierPage.logoutFromZapier();
+   * await zapierPage.logoutFromZapier();
    * @endexample
   */
   logoutFromZapier: () => Promise<void>;
@@ -1285,7 +1298,7 @@ declare class ZapierPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await zapierPage.reconnectAccountAndPublish("your-zapier-api-key");
+   * await zapierPage.reconnectAccountAndPublish("your-zapier-api-key");
    * @endexample
   */
   reconnectAccountAndPublish: (zapierApiKey: string) => Promise<void>;
@@ -1297,7 +1310,7 @@ declare class ZapierPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await zapierPage.deleteAllConnections("https://zapier.com/app/dashboard");
+   * await zapierPage.deleteAllConnections("https://zapier.com/app/dashboard");
    * @endexample
   */
   deleteAllConnections: (zapierAppLink: string) => Promise<void>;
@@ -1313,11 +1326,11 @@ declare class ZapierPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await zapierPage.verifyZapIsTriggered({
-   *     submittedEmail: "example@example.com",
-   *     zapTriggeredAfter: new Date(),
-   *     productName: "neetoChat"
-   *   });
+   * await zapierPage.verifyZapIsTriggered({
+   *   submittedEmail: "example@example.com",
+   *   zapTriggeredAfter: new Date(),
+   *   productName: "neetoChat",
+   * });
    * @endexample
   */
   verifyZapIsTriggered: ({
@@ -1335,7 +1348,7 @@ declare class ZapierPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await zapierPage.skipIfTaskLimitIsExhausted();
+   * await zapierPage.skipIfTaskLimitIsExhausted();
    * @endexample
   */
   skipIfTaskLimitIsExhausted: () => Promise<void>;
@@ -1349,7 +1362,7 @@ declare class ZapierPage extends IntegrationBase {
    *
    * @example 
    *
-   *   const apiKey = await zapierPage.connectAndVerify({ apiKeyLabel: "Your API Key" });
+   * const apiKey = await zapierPage.connectAndVerify({ apiKeyLabel: "Your API Key" });
    * @endexample
   */
   connectAndVerify: ({
@@ -1363,7 +1376,7 @@ declare class ZapierPage extends IntegrationBase {
    *
    * @example 
    *
-   *   await zapierPage.disconnectAndVerify();
+   * await zapierPage.disconnectAndVerify();
    * @endexample
   */
   disconnectAndVerify: () => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-playwright-commons",
-  "version": "1.9.27",
+  "version": "1.9.28",
   "description": "A package encapsulating common playwright code across neeto projects.",
   "repository": "git@github.com:bigbinary/neeto-playwright-commons.git",
   "license": "apache-2.0",