@bigbinary/neeto-playwright-commons 4.1.13 → 4.1.14

package/README.md

@@ -1,7 +1,6 @@
 # neeto-playwright-commons
 
-A library that packages common boilerplate Playwright code necessary for all
-neeto products.
+A library that packages common boilerplate Playwright code necessary for all neeto products.
 
 ## Installing neeto-playwright-commons in a Playwright Project
 
@@ -13,21 +12,20 @@ Then, install the package using Yarn:
 ```bash
 yarn add "@bigbinary/neeto-playwright-commons@latest"
 ```
-If `neeto-playwright-commons` is already listed in `package.json` of Playwright project, simply install dependencies with:
+If `neeto-playwright-commons` is already listed in `package.json` of Playwright project, simply install dependencies
+with:
 ```bash
 yarn install
 ```
 
 ## Dependencies
 
-**neeto-playwright-commons** has some peer dependencies which can be installed
-using the commands listed below:
+**neeto-playwright-commons** 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/).
+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
@@ -57,8 +55,8 @@ yarn add nano-staged
 
 ### `dotenv-webpack`
 
-`dotenv-webpack` is a secure webpack plugin that supports
-[dotenv](https://www.npmjs.com/package/dotenv) and other environment variables.
+`dotenv-webpack` is a secure webpack plugin that supports [dotenv](https://www.npmjs.com/package/dotenv) and other
+environment variables.
 
 ```
 yarn add dotenv-webpack
@@ -66,8 +64,7 @@ yarn add dotenv-webpack
 
 ### `dayjs`
 
-Dayjs is a JavaScript library that parses, validates, manipulates, and displays
-dates and times.
+Dayjs is a JavaScript library that parses, validates, manipulates, and displays dates and times.
 
 ```
 yarn add dayjs
@@ -75,8 +72,8 @@ 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.
+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
@@ -84,8 +81,7 @@ yarn add ramda
 
 ### `playwright-i18next-fixture`
 
-Use your `i18next` translations in Playwright to create multi-language
-selectors.
+Use your `i18next` translations in Playwright to create multi-language selectors.
 
 ```
 yarn add playwright-i18next-fixture
@@ -102,29 +98,27 @@ yarn add @bigbinary/neeto-cist @faker-js/faker @playwright/test nano-staged dote
 ### Methods
 
 ## MailerUtils
-Note: ENV variables `NEETO_AUTOMATION_FASTMAIL_API_KEY` and
-`FASTMAIL_DOMAIN_NAME` are required for this methods to work.
+Note: ENV variables `NEETO_AUTOMATION_FASTMAIL_API_KEY` and `FASTMAIL_DOMAIN_NAME` are required for this methods to
+work.
 ## 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.
+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 `NEETO_AUTOMATION_FASTMAIL_API_KEY`, `FASTMAIL_DOMAIN_NAME`, `ZAPIER_LOGIN_EMAIL`, `ZAPIER_LOGIN_PASSWORD`, and `ZAP_ID` are required for this methods to work.
+Note: ENV variables `NEETO_AUTOMATION_FASTMAIL_API_KEY`, `FASTMAIL_DOMAIN_NAME`, `ZAPIER_LOGIN_EMAIL`,
+`ZAPIER_LOGIN_PASSWORD`, and `ZAP_ID` are required for this methods to work.
 
 ## Usage
 
-You can import the utility functions and constants from the
-`@bigbinary/neeto-playwright-commons` wherever required.
+You can import the utility functions and constants from the `@bigbinary/neeto-playwright-commons` wherever required.
 
 ```js
 import { COMMON_SELECTORS } from "@bigbinary/neeto-playwright-common";
 ```
 
-This package is published as ESM-only. Use `import` syntax and avoid
-CommonJS `require()` for package consumption.
+This package is published as ESM-only. Use `import` syntax and avoid CommonJS `require()` for package consumption.
 
 ## Exported Functions
 

package/index.d.ts

@@ -5076,11 +5076,11 @@ interface VerifyAuditLogProps<T extends ActionDataKey> {
 declare class AuditLogsPage {
   private page;
   private neetoPlaywrightUtilities;
-  private product;
   private readonly currentDate;
   messageBuilders: MessageBuilders;
   private admin;
-  constructor(page: Page, neetoPlaywrightUtilities: CustomCommands, product: NeetoProducts);
+  constructor(page: Page, neetoPlaywrightUtilities: CustomCommands, /** @deprecated Audit log messages no longer include the product name. */
+  product?: NeetoProducts);
   /**
    *
    * Verifies an audit log entry by building the expected message based on the action type and data, then checking that the audit log content matches the expected message and current date.

package/index.js

@@ -120885,25 +120885,26 @@ dayjs.extend(timezone);
 class AuditLogsPage {
     page;
     neetoPlaywrightUtilities;
-    product;
     currentDate;
     messageBuilders;
     admin;
-    constructor(page, neetoPlaywrightUtilities, product) {
+    constructor(page, neetoPlaywrightUtilities, 
+    /** @deprecated Audit log messages no longer include the product name. */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    product) {
         this.page = page;
         this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
-        this.product = product;
         this.currentDate = dayjs().tz("Asia/Kolkata").format("MMM D, YYYY");
         this.messageBuilders = {
-            [ACTIONS.inviteUsers]: (data) => `${this.admin} added ${data.emails.join(", ").toLowerCase()} to Neeto${this.product}.`,
-            [ACTIONS.updatedUser]: (data) => `${this.admin} changed ${data.emails[0].toLowerCase()}'s email from ${data.emails[0].toLowerCase()} to ${data.emails[1].toLowerCase()} on Neeto${this.product}.`,
-            [ACTIONS.removedUser]: (data) => `${this.admin} removed ${data.emails[0].toLowerCase()} from Neeto${this.product}.`,
-            [ACTIONS.createdRole]: (data) => `${this.admin} created ${data.roleName} role on Neeto${this.product}.`,
-            [ACTIONS.addedPermission]: (data) => `${this.admin} added ${data.permissions.join(", ").toLowerCase()} permission to ${data.roleName} role on Neeto${this.product}.`,
-            [ACTIONS.removedPermission]: (data) => `${this.admin} removed ${data.permissions.join(", ")} permissions from ${data.roleName} role on Neeto${this.product}.`,
-            [ACTIONS.updatedRole]: (data) => `${this.admin} updated ${data.roleName} role on Neeto${this.product}.`,
-            [ACTIONS.deletedRole]: (data) => `${this.admin} deleted ${data.roleName} role on Neeto${this.product}.`,
-            [ACTIONS.updatedName]: (data) => `${this.admin} changed first name from ${data.name} to ${this.admin.split(" ")[0]} in Neeto${this.product}.`,
+            [ACTIONS.inviteUsers]: (data) => `${this.admin} added ${data.emails.join(", ").toLowerCase()}.`,
+            [ACTIONS.updatedUser]: (data) => `${this.admin} changed ${data.emails[0].toLowerCase()}'s email from ${data.emails[0].toLowerCase()} to ${data.emails[1].toLowerCase()}.`,
+            [ACTIONS.removedUser]: (data) => `${this.admin} removed ${data.emails[0].toLowerCase()}.`,
+            [ACTIONS.createdRole]: (data) => `${this.admin} created ${data.roleName} role.`,
+            [ACTIONS.addedPermission]: (data) => `${this.admin} added ${data.permissions.join(", ").toLowerCase()} permission to ${data.roleName} role.`,
+            [ACTIONS.removedPermission]: (data) => `${this.admin} removed ${data.permissions.join(", ")} permissions from ${data.roleName} role.`,
+            [ACTIONS.updatedRole]: (data) => `${this.admin} updated ${data.roleName} role.`,
+            [ACTIONS.deletedRole]: (data) => `${this.admin} deleted ${data.roleName} role.`,
+            [ACTIONS.updatedName]: (data) => `${this.admin} changed first name from ${data.name} to ${this.admin.split(" ")[0]}.`,
             [ACTIONS.connectedIntegration]: (data) => data.detail
                 ? `${this.admin} connected ${data.integrationName} using ${data.detail}.`
                 : `${this.admin} connected ${data.integrationName}.`,

package/package.json

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