@bigbinary/neeto-playwright-commons 1.13.1 → 1.13.2

package/index.d.ts

@@ -7,6 +7,7 @@ import { I18nPlaywrightFixture } from 'playwright-i18next-fixture';
 import { TFunction } from 'i18next';
 import { TOTP, Secret } from 'otpauth';
 import * as playwright_core from 'playwright-core';
+import { MemberApis } from 'apis/members';
 import { TagsApi } from 'apis/tags';
 import { Protocol } from 'playwright-core/types/protocol';
 import * as ts_toolbelt_out_Function_Curry from 'ts-toolbelt/out/Function/Curry';
@@ -1816,6 +1817,157 @@ declare class ZapierPage extends IntegrationBase {
   */
   disconnectAndVerify: () => Promise<void>;
 }
+interface AddMemberProps$1 {
+  email: string;
+  role?: string;
+  appName: string;
+  requestCount?: number;
+  neetoPlaywrightUtilities: CustomCommands;
+}
+interface EditMemberProps$2 {
+  email: string;
+  firstName?: string;
+  lastName?: string;
+  newRole?: string;
+  requestCount?: number;
+  neetoPlaywrightUtilities: CustomCommands;
+}
+interface DeactiveMemberProps$1 {
+  email: string;
+  neetoPlaywrightUtilities: CustomCommands;
+  requestCount?: number;
+}
+declare class Member {
+  private neetoPlaywrightUtilities;
+  memberApis: MemberApis;
+  constructor(neetoPlaywrightUtilities: CustomCommands);
+  /**
+   *
+   * Adds a member to the team via API request. It takes the following parameters:
+   *
+   * email: Email of the member to be added.
+   *
+   * role: Role of the member (default: "Agent").
+   *
+   * appName: Name of the application.
+   *
+   * neetoPlaywrightUtilities: Custom utility functions for API requests.
+   *
+   * requestCount (optional): Specify the number of requests.
+   *
+   * @example 
+   *
+   *   import { memberUtils } from "@bigbinary/neeto-playwright-commons";
+   * 
+   *   await memberUtils.addMemberViaRequest({
+   *       email: "example@example.com",
+   *       appName: "MyApp",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *   });
+   * 
+   *   // OR
+   * 
+   *   await memberUtils.addMemberViaRequest({
+   *       email: "example@example.com",
+   *       appName: "MyApp",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *       requestCount:10
+   *   });
+   * @endexample
+  */
+  addMemberViaRequest: ({
+    email,
+    role,
+    appName
+  }: AddMemberProps$1) => Promise<void>;
+  /**
+   *
+   * Edits a member's details via API request. It takes the following parameters:
+   *
+   * email: Email of the member to be edited.
+   *
+   * firstName (optional): New first name of the member.
+   *
+   * lastName (optional): New last name of the member.
+   *
+   * newRole (optional): New role of the member.
+   *
+   * neetoPlaywrightUtilities: Custom utility functions for API requests.
+   *
+   * requestCount (optional): Specify the number of requests.
+   *
+   * @example 
+   *
+   *   import { memberUtils } from "@bigbinary/neeto-playwright-commons";
+   * 
+   *   await memberUtils.editMemberViaRequest({
+   *       email: "example@example.com",
+   *       firstName: "John",
+   *       lastName: "Doe",
+   *       newRole: "Admin",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *   });
+   * 
+   *   await memberUtils.editMemberViaRequest({
+   *       email: "example@example.com",
+   *       firstName: "John",
+   *       lastName: "Doe",
+   *       newRole: "Admin",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *       requestCount:10
+   *   })
+   * @endexample
+  */
+  editMemberViaRequest: ({
+    email,
+    firstName,
+    lastName,
+    newRole
+  }: EditMemberProps$2) => Promise<void>;
+  /**
+   *
+   * Deactivates a member via API request. It takes the following parameters:
+   *
+   * email: Email of the member to be deactivated.
+   *
+   * neetoPlaywrightUtilities: Custom utility functions for API requests.
+   *
+   * requestCount (optional): Specify the number of requests.
+   *
+   * @example 
+   *
+   *   import { memberUtils } from "@bigbinary/neeto-playwright-commons";
+   * 
+   *   await memberUtils.deactivateMemberViaRequest({
+   *       email: "example@example.com",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *   });
+   * 
+   *   // OR
+   * 
+   *   await memberUtils.deactivateMemberViaRequest({
+   *       email: "example@example.com",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *       requestCount:2
+   *   });
+   * @endexample
+  */
+  deactivateMemberViaRequest: ({
+    email
+  }: DeactiveMemberProps$1) => Promise<playwright_core.APIResponse | undefined>;
+  generateRandomTeamMembers: ({
+    count,
+    role
+  }: {
+    count?: number | undefined;
+    role?: string | undefined;
+  }) => {
+    firstName: string;
+    lastName: string;
+    email: string;
+    role: string;
+  }[];
+}
 interface KeyValuePair {
   key: string;
   value: string;
@@ -5716,4 +5868,4 @@ interface Overrides {
  * @endexample
 */
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;
-export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENGAGE_TEXTS, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_SELECTORS, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WEBHOOK_SELECTORS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, type CustomFixture, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENGAGE_TEXTS, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_SELECTORS, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, MailosaurUtils, Member, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WEBHOOK_SELECTORS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, _default as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };

package/index.js

@@ -15,7 +15,7 @@ import stealth$1 from 'puppeteer-extra-plugin-stealth';
 import Stream$4 from 'stream';
 import require$$0$4 from 'events';
 import { getI18nInstance, initI18n } from 'playwright-i18next-fixture';
-import { isNotPresent, isNotEmpty, humanize, truncate, isPresent, dynamicArray } from '@bigbinary/neeto-cist';
+import { isNotPresent, isNotEmpty, humanize, dynamicArray, truncate, isPresent } from '@bigbinary/neeto-cist';
 import http$1 from 'http';
 import Url from 'url';
 import require$$0$5 from 'punycode';
@@ -24098,6 +24098,72 @@ class ZapierPage extends IntegrationBase {
     }
 }
 
+class MemberApis {
+    constructor(neetoPlaywrightUtilities) {
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.create = (body) => this.neetoPlaywrightUtilities.apiRequest({
+            method: "post",
+            url: "/team_members/teams",
+            body: { user: body },
+        });
+        this.fetch = (params) => this.neetoPlaywrightUtilities.apiRequest({
+            method: "get",
+            url: "/team_members/teams",
+            params,
+        });
+        this.update = (memberId, body) => this.neetoPlaywrightUtilities.apiRequest({
+            method: "put",
+            url: `/team_members/teams/${memberId}`,
+            body: { team: body },
+        });
+        this.bulkUpdate = (body) => this.neetoPlaywrightUtilities.apiRequest({
+            method: "patch",
+            url: "/team_members/teams/bulk_update",
+            body: { users: body },
+        });
+    }
+}
+
+class Member {
+    constructor(neetoPlaywrightUtilities) {
+        this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
+        this.addMemberViaRequest = ({ email, role = MEMBER_TEXTS.agent, appName, }) => expect
+            .poll(async () => {
+            const response = await this.memberApis.create({
+                emails: [email],
+                organization_role: role,
+                app_roles: [
+                    { app_name: appName, active_role: role, is_enabled: true },
+                ],
+            });
+            return response === null || response === void 0 ? void 0 : response.status();
+        }, { timeout: 30000 })
+            .toBe(200);
+        this.editMemberViaRequest = async ({ email, firstName, lastName, newRole, }) => {
+            const response = await this.memberApis.fetch({ search: email });
+            if (response) {
+                const responseBodyBuffer = await response.body();
+                const responseBody = JSON.parse(responseBodyBuffer.toString());
+                const memberDetails = responseBody === null || responseBody === void 0 ? void 0 : responseBody.members[0];
+                await this.memberApis.update(memberDetails.id, {
+                    active: true,
+                    first_name: firstName,
+                    last_name: lastName,
+                    organization_role: newRole,
+                });
+            }
+        };
+        this.deactivateMemberViaRequest = ({ email }) => this.memberApis.bulkUpdate({ active: false, emails: [email] });
+        this.generateRandomTeamMembers = ({ count = 1, role = "standard" }) => dynamicArray(count, () => ({
+            firstName: faker.person.firstName(),
+            lastName: faker.person.lastName(),
+            email: faker.internet.exampleEmail(),
+            role,
+        }));
+        this.memberApis = new MemberApis(neetoPlaywrightUtilities);
+    }
+}
+
 const DESCRIPTION_EDITOR_TEXTS = {
     fontSize: "Font size",
     paragraph: "Paragraph",
@@ -157295,5 +157361,5 @@ const definePlaywrightConfig = (overrides) => {
     });
 };
 
-export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENGAGE_TEXTS, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_SELECTORS, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, MailosaurUtils, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WEBHOOK_SELECTORS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, stealth as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
+export { API_ROUTES, BASE_URL, CHANGELOG_WIDGET_SELECTORS, CHAT_WIDGET_SELECTORS, CHAT_WIDGET_TEXTS, COMMON_SELECTORS, CREDENTIALS, CustomCommands, DESCRIPTION_EDITOR_TEXTS, EMBED_SELECTORS, EMOJI_LABEL, ENGAGE_TEXTS, ENVIRONMENT, EXPANDED_FONT_SIZE, EditorPage, EmbedBase, FONT_SIZE_SELECTORS, GLOBAL_TRANSLATIONS_PATTERN, GOOGLE_CALENDAR_DATE_FORMAT, GOOGLE_LOGIN_SELECTORS, GOOGLE_LOGIN_TEXTS, GooglePage, HELP_CENTER_SELECTORS, HelpAndProfilePage, INTEGRATIONS_TEXTS, INTEGRATION_SELECTORS, IS_STAGING_ENV, ImageUploader, IntegrationBase, KEYBOARD_SHORTCUTS_SELECTORS, LIST_MODIFIER_SELECTORS, LIST_MODIFIER_TAGS, LOGIN_SELECTORS, MEMBER_FORM_SELECTORS, MEMBER_SELECTORS, MEMBER_TEXTS, MERGE_TAGS_SELECTORS, MailerUtils, MailosaurUtils, Member, NEETO_AUTH_BASE_URL, NEETO_EDITOR_SELECTORS, NEETO_FILTERS_SELECTORS, NEETO_IMAGE_UPLOADER_SELECTORS, NEETO_ROUTES, NEETO_TEXT_MODIFIER_SELECTORS, OTP_EMAIL_PATTERN, OrganizationPage, PLURAL, PROFILE_SECTION_SELECTORS, PROJECT_TRANSLATIONS_PATH, ROLES_SELECTORS, ROUTES, SELECT_COUNTRY, SIGNUP_SELECTORS, SINGULAR, SLACK_DATA_QA_SELECTORS, SLACK_DEFAULT_CHANNEL, SLACK_SELECTORS, SLACK_WEB_TEXTS, STORAGE_STATE, SidebarSection, SlackPage, TAB_SELECTORS, TAGS_SELECTORS, TEXT_MODIFIER_ROLES, TEXT_MODIFIER_SELECTORS, TEXT_MODIFIER_TAGS, THANK_YOU_SELECTORS, THIRD_PARTY_ROUTES, TOASTR_MESSAGES, TagsPage, TeamMembers, ThankYouPage, USER_AGENTS, WEBHOOK_SELECTORS, WebhooksPage, ZAPIER_LIMIT_EXHAUSTED_MESSAGE, ZAPIER_SELECTORS, ZAPIER_TEST_EMAIL, ZAPIER_WEB_TEXTS, ZapierPage, basicHTMLContent, clearCredentials, commands, cpuThrottlingUsingCDP, currencyUtils, decodeQRCodeFromFile, definePlaywrightConfig, executeWithThrottledResources, extractSubdomainFromError, filterUtils, generateRandomBypassEmail, generateStagingData, getByDataQA, getGlobalUserState, getImagePathAndName, getListCount, headerUtils, hexToRGB, hyphenize, i18nFixture, initializeCredentials, initializeTotp, joinHyphenCase, joinString, login, loginWithoutSSO, memberUtils, networkConditions, networkThrottlingUsingCDP, readFileSyncIfExists, removeCredentialFile, shouldSkipSetupAndTeardown, skipTest, squish, stealth as stealthTest, tableUtils, toCamelCase, updateCredentials, writeDataToFile };
 //# sourceMappingURL=index.js.map