@bigbinary/neeto-playwright-commons 3.2.0 → 3.2.2

package/index.d.ts

@@ -31,6 +31,7 @@ interface ExecuteRecursivelyParams {
 interface VerifyToastParams {
   message: string;
   timeout?: number;
+  toastCloseTimeout?: number;
   closeAfterVerification: boolean;
   toastType: "success" | "error";
   customPageContext?: Page;
@@ -219,6 +220,8 @@ declare class CustomCommands {
    *
    * timeout(optional): Timeout in milliseconds to wait for the toast to appear. Default is 10_000.
    *
+   * toastCloseTimeout(optional): Timeout in milliseconds to wait for the toast to disappear after closing. Default is 10_000.
+   *
    * customPageContext(optional): Custom page context on which to verify the toast.
    *
    * @example 
@@ -228,6 +231,7 @@ declare class CustomCommands {
    *     closeAfterVerification: false,
    *     toastType: "error",
    *     timeout: 20_000,
+   *     toastCloseTimeout: 15_000,
    *     customPageContext: this.page,
    *   });
    * @endexample
@@ -237,6 +241,7 @@ declare class CustomCommands {
     toastType,
     closeAfterVerification,
     timeout,
+    toastCloseTimeout,
     customPageContext
   }?: Partial<VerifyToastParams>) => Promise<void>;
   /**
@@ -998,6 +1003,8 @@ declare class SlackApi {
   fetchMessages: (channelId: string, unixTimestamp: number) => Promise<playwright_core.APIResponse | undefined>;
   createChannel: (channelName: string) => Promise<playwright_core.APIResponse | undefined>;
   addUser: (channelId: string, userId: string) => Promise<playwright_core.APIResponse | undefined>;
+  listChannels: () => Promise<playwright_core.APIResponse | undefined>;
+  archiveChannel: (channelId: string) => Promise<playwright_core.APIResponse | undefined>;
   mockChannelDeleted: (channelId: string) => Promise<playwright_core.APIResponse | undefined>;
 }
 declare class WebhookSiteApi {
@@ -2917,6 +2924,7 @@ declare class SlackPage extends IntegrationBase {
   allowButton: Locator;
   callbackUrl: string;
   currentWorkspace: string;
+  slackApi: SlackApi;
   constructor({
     page,
     neetoPlaywrightUtilities,
@@ -3088,18 +3096,25 @@ declare class SlackPage extends IntegrationBase {
     channelName,
     kind
   }: CreateNewSlackChannelParams) => Promise<void>;
+  /**
+   * @deprecated Use {@link SlackPage.archiveChannelViaAPI} instead. This flow
+   * drives the Slack web UI to permanently delete a channel and is brittle;
+   * `archiveChannelViaAPI` archives via the Slack Web API (requires
+   * `SLACK_BOT_TOKEN`).
+   */
+  deleteSlackChannel: (channel: string) => Promise<void>;
   /**
    *
-   * Deletes a slack channel. It takes the following parameters:
+   * Archives a Slack channel by name using the Slack Web API (conversations.list then conversations.archive). Requires SLACK_BOT_TOKEN with scopes that allow listing and archiving channels. Does not drive the Slack web UI; use when tests only need the channel removed or archived on the workspace.
    *
-   * channel: Name of the Slack channel to delete.
+   * channel: Channel name to archive.
    *
    * @example 
    *
-   * await slackPage.deleteSlackChannel("old-channel");
+   * await slackPage.archiveChannelViaAPI("temp-test-channel");
    * @endexample
   */
-  deleteSlackChannel: (channel: string) => Promise<void>;
+  archiveChannelViaAPI: (name: string) => Promise<void>;
 }
 interface WebhooksPageParams {
   page: Page;
@@ -4547,8 +4562,32 @@ declare class OrganizationPage {
   page: Page;
   neetoPlaywrightUtilities: CustomCommands;
   constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
-  private fillOTP;
-  private submitEmail;
+  /**
+   *
+   * Waits for the page to load, fills the OTP field, and waits until the OTP input is hidden (up to 35s), indicating the code was accepted.
+   *
+   * otp (optional): One-time password to enter. Defaults to a random 6-digit string.
+   *
+   * @example 
+   *
+   * await organizationPage.fillOTP();
+   * // OR
+   * await organizationPage.fillOTP("123456");
+   * @endexample
+  */
+  fillOTP: (otp?: string) => Promise<void>;
+  /**
+   *
+   * Waits for the page to load, fills the signup email field, clicks submit, and waits until the submit button is hidden (up to 35s). Use this as the first step when driving the email-based signup flow before entering an OTP.
+   *
+   * email: Address to enter in the signup email field.
+   *
+   * @example 
+   *
+   * await organizationPage.submitEmail("jane@example.com");
+   * @endexample
+  */
+  submitEmail: (email: string) => Promise<void>;
   private dismissAuthenticatorSetupPromptIfPresent;
   /**
    *

package/index.js

@@ -1,4 +1,4 @@
-import { keysToSnakeCase, isPresent, hyphenate, isNotPresent, humanize, dynamicArray, findBy, truncate, isNotEmpty, isNotEqualDeep, randomPick } from '@bigbinary/neeto-cist';
+import { keysToSnakeCase, isPresent, hyphenate, isNotPresent, humanize, findBy, dynamicArray, truncate, isNotEmpty, isNotEqualDeep, randomPick } from '@bigbinary/neeto-cist';
 import { faker } from '@faker-js/faker';
 import * as fs$4 from 'fs';
 import fs__default, { readFileSync, promises, existsSync, writeFileSync, unlinkSync, mkdirSync, rmSync, createWriteStream } from 'fs';
@@ -618,6 +618,8 @@ class SlackApi {
     fetchMessages = (channelId, unixTimestamp) => this.apiRequest("history", { channel: channelId, oldest: unixTimestamp });
     createChannel = (channelName) => this.apiRequest("create", { name: channelName });
     addUser = (channelId, userId) => this.apiRequest("invite", { channel: channelId, users: userId });
+    listChannels = () => this.apiRequest("list", { exclude_archived: 1, limit: 1000 });
+    archiveChannel = (channelId) => this.apiRequest("archive", { channel: channelId });
     mockChannelDeleted = (channelId) => this.neetoPlaywrightUtilities.apiRequest({
         url: "/neeto_slack/api/v1/testing/webhooks",
         method: "post",
@@ -6048,7 +6050,7 @@ class CustomCommands {
         const startTime = Date.now();
         return await this.recursiveMethod(callback, condition, timeout, startTime, 1);
     };
-    verifyToast = async ({ message = "", toastType = "success", closeAfterVerification = true, timeout = 10_000, customPageContext = this.page, } = {}) => {
+    verifyToast = async ({ message = "", toastType = "success", closeAfterVerification = true, timeout = 10_000, toastCloseTimeout = 10_000, customPageContext = this.page, } = {}) => {
         // React-toastify does not support adding data-* attributes to toast DOM elements: https://github.com/fkhadra/react-toastify/issues/1106
         const toastrLocator = customPageContext
             .locator(COMMON_SELECTORS.neetoUiToastr)
@@ -6069,7 +6071,9 @@ class CustomCommands {
             await customPageContext.evaluate(button => {
                 button.dispatchEvent(new Event("click", { bubbles: true }));
             }, buttonHandle);
-            await expect(toastrCloseButton).toBeHidden({ timeout: 10_000 });
+            await expect(toastrCloseButton).toBeHidden({
+                timeout: toastCloseTimeout,
+            });
         }
     };
     waitForPageLoad = async ({ visibilityTimeout = 35_000, customPageContext = this.page, waitForOption = "serial", } = {}) => {
@@ -119460,6 +119464,7 @@ class SlackPage extends IntegrationBase {
     allowButton;
     callbackUrl;
     currentWorkspace;
+    slackApi;
     constructor({ page, neetoPlaywrightUtilities, integrationRouteIndex, }) {
         super({
             page,
@@ -119470,6 +119475,7 @@ class SlackPage extends IntegrationBase {
         this.allowButton = this.page.getByRole("button", {
             name: SLACK_WEB_TEXTS.allow,
         });
+        this.slackApi = new SlackApi(this.neetoPlaywrightUtilities);
     }
     setupCloseHandlers = async (slackWebappPage = this.page) => {
         const slackWebappPageDataQa = getByDataQA(slackWebappPage);
@@ -119654,6 +119660,12 @@ class SlackPage extends IntegrationBase {
         await nextButton.click();
         await this.slackWebappPageDataQa(SLACK_DATA_QA_SELECTORS.inviteToWorkspaceSkipButton).click();
     };
+    /**
+     * @deprecated Use {@link SlackPage.archiveChannelViaAPI} instead. This flow
+     * drives the Slack web UI to permanently delete a channel and is brittle;
+     * `archiveChannelViaAPI` archives via the Slack Web API (requires
+     * `SLACK_BOT_TOKEN`).
+     */
     deleteSlackChannel = async (channel) => {
         const channelItem = this.slackWebappPage.locator(SLACK_SELECTORS.channelItems, { hasText: channel });
         await channelItem.click({ button: "right" });
@@ -119674,6 +119686,12 @@ class SlackPage extends IntegrationBase {
             .click();
         await expect(channelItem).toBeHidden();
     };
+    archiveChannelViaAPI = async (name) => {
+        const response = await this.slackApi.listChannels();
+        const { channels } = (await response?.json());
+        const channel = findBy({ name }, channels);
+        channel?.id && (await this.slackApi.archiveChannel(channel.id));
+    };
 }
 
 class WebhooksPage {
@@ -126725,6 +126743,7 @@ const definePlaywrightConfig = (overrides) => {
                         name: PROJECT_NAMES.productionHealth,
                         testDir: "./e2e/health",
                         testMatch: "production.health.ts",
+                        retries: IS_CI ? 3 : 0,
                         use: {
                             ...devices["Desktop Chrome"],
                             baseURL: process.env.PLAYWRIGHT_PRODUCTION_BASE_URL,