@bigbinary/neeto-commons-frontend 4.13.127 → 4.13.128

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/.ready CHANGED
@@ -1 +1 @@
1
- Built at 2026-05-09T17:51:33.445Z
1
+ Built at 2026-06-01T06:19:20.255Z
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bigbinary/neeto-commons-frontend",
3
- "version": "4.13.127",
3
+ "version": "4.13.128",
4
4
  "description": "A package encapsulating common code across neeto projects including initializers, utility functions, common components and hooks and so on.",
5
5
  "repository": "git@github.com:bigbinary/neeto-commons-frontend.git",
6
6
  "author": "Amaljith K <amaljith.k@bigbinary.com>",
@@ -1,110 +0,0 @@
1
- declare namespace Cypress {
2
- interface Chainable {
3
- clearAndType(selector: string, text: string): Void;
4
- clearAndTypeFast(selector: string, text: string): Void;
5
- clearByClickAndTypeFast(selector: string, text: string): Void;
6
- typeFast(selector: string, text: string): Void;
7
- typeAndEnter(selector: string, text: string): Void;
8
- verifyToastMessage(message: string): Void;
9
-
10
- /**
11
- * @param closeToastr Default value is true
12
- */
13
- verifyToastIcon(closeToastr: boolean): Void;
14
- continueOnAlert(
15
- alias:
16
- | string
17
- | {
18
- title: string;
19
- description: string;
20
- alias: string;
21
- requestCount: number;
22
- toastMessage: string;
23
- verifyToastIcon: boolean;
24
- }
25
- ): Void;
26
- interceptApi(
27
- alias: string,
28
- times?: number
29
- ): Cypress.Chainable<Cypress.InterceptionOptions>;
30
- waitForMultipleRequest(
31
- alias: string,
32
- times?: number
33
- ): Chainable<JQuery<HTMLElement>>;
34
-
35
- /**
36
- * Make an HTTP request with specific method.
37
- * @see https://on.cypress.io/request
38
- */
39
- apiRequest(
40
- options: Cypress.RequestBody
41
- ): Cypress.Chainable<Cypress.Response>;
42
-
43
- reloadAndWait(requestCount?: number): Void;
44
- selectOption(containerSelector: string, optionText: string): Void;
45
- clickDropdownOption(optionText: string, dropdownSelector: string): Void;
46
- getText(selector: string): Chainable<JQuery<HTMLElement>>;
47
- getValue(selector: string): Chainable<JQuery<HTMLElement>>;
48
-
49
- /**
50
- * @deprecated Use `withinIframe` instead.
51
- */
52
- getIframe(iframeSelector: string): Chainable<JQuery<HTMLElement>>;
53
-
54
- /**
55
- * Selects and performs commands within an iframe element based on the given selector.
56
- * @param iframeSelector The selector to locate the iframe element.
57
- * @param callbackFn The callback function containing the commands to execute within the iframe.
58
- */
59
- withinIframe(iframeSelector: string, callbackFn: void): Void;
60
-
61
- /**
62
- * Command to open the url in the same window after clicking on a button that opens the url in a new tab
63
- */
64
- openInSameTabOnClick(props: {
65
- url: string;
66
- alias: string;
67
- selector: string;
68
- });
69
- globalState(key: string): Void;
70
- ifExist(selector: string, callback: Function): Void;
71
- ifNotExist(selector: string, callback: Function): Void;
72
- dragAndDrop(props: {
73
- subject: string;
74
- target: string;
75
- dragIndex: number;
76
- dropIndex: number;
77
- });
78
- verifyPlaceholder(textInputSelector: string, value: string): Void;
79
- enableOrDisableSwitch(switchButton: string, value: string): Void;
80
- interceptNonVersionedApi(props: {
81
- url: string;
82
- alias: string;
83
- times?: number; // maximum number of times to match
84
- }): Cypress.Chainable<Cypress.InterceptionOptions>;
85
- typeOnSearchField(props: {
86
- delay?: number;
87
- selector: string;
88
- value: string;
89
- skipSearchRequest?: boolean; // default true
90
- });
91
- clickByRemoveTargetAttr(selector: string): Void;
92
- navigateToPreviewPage(selector: string, requestCount: number): Void;
93
- saveChanges(aliasName: string, requestCount: number): Void;
94
- verifyAttribute(props: {
95
- selector: string;
96
- attr: string;
97
- value: string;
98
- }): Void;
99
- verifyUnsavedAlertModal(cancelButton: string): Void;
100
- verifyTooltip(selector: string, text: string): Void;
101
- /**
102
- * Command to get email content using Mailosaur API.
103
- * @param props Mailosaur API request body.
104
- * @see https://mailosaur.com/docs/frameworks-and-tools/cypress/#library-reference
105
- * @param options Used to specify additional criteria for the email retrieval
106
- * @see https://mailosaur.com/docs/email-testing/cypress#2-options
107
- */
108
- getEmailContent(props, options): Void;
109
- }
110
- }
@@ -1,597 +0,0 @@
1
- // selectors ------------------------------------------------
2
-
3
- type CommonSelectors = {
4
- alertTitle: string;
5
- alertModalSubmitButton: string;
6
- checkbox: string;
7
- checkboxLabel: string;
8
- dropdownContainer: string;
9
- dropdownIcon: string;
10
- heading: string;
11
- paneBody: string;
12
- paneHeader: string;
13
- selectOption: string;
14
- toastMessage: string;
15
- toastCloseButton: string;
16
- windowAlert: string;
17
- body: string;
18
- paneModalCrossIcon: string;
19
- inputField: string;
20
- alertConfirmationText: string;
21
- alertCancelButton: string;
22
- alertModalCrossIcon: string;
23
- saveChangesButton: string;
24
- cancelButton: string;
25
- inputFieldError: string;
26
- selectDropDownError: string;
27
- subTitleHeading: (index: number) => string;
28
- noDataTitle: string;
29
- noDataDescription: string;
30
- backdrop: string;
31
- menuBarHeading: string;
32
- tabItem: string;
33
- dropdownWrapper: (index: number) => string;
34
- toggleButton: string;
35
- tooltip: string;
36
- articlePageTitle: string;
37
- labelInputError: string;
38
- urlInputError: string;
39
- noDataPrimaryButton: string;
40
- modalHeader: string;
41
- nameInputError: string;
42
- selectContainer: string;
43
- dropdownMenu: string;
44
- nthDropdownIcon: (index: number) => string;
45
- sidebarToggle: string;
46
- customDataCy: (name: string) => string;
47
- leftSubHeader: string;
48
- subheader: string;
49
- settingsLink: string;
50
- nthInputField: (index: number) => string;
51
- nthTabItem: (index: number) => string;
52
- ticketFieldTextInput: (label: string) => string;
53
- };
54
- type MemberSelectors = {
55
- activatedMembersButton: string;
56
- activateOrDeactivateMember: string;
57
- columnCheckBox: string;
58
- continueButton: string;
59
- deactivatedAgentsButton: string;
60
- dropDownIcon: string;
61
- editButton: string;
62
- email: string;
63
- menuBarHeading: string;
64
- membersTab: string;
65
- name: string;
66
- newButton: string;
67
- role: string;
68
- roleLabel: (role: string) => string;
69
- searchTextField: string;
70
- submitButton: string;
71
- columnsButton: string;
72
- columnsDropdownContainer: string;
73
- emailDropdownItemLabel: string;
74
- roleDropdownItemLabel: string;
75
- inviteStatusDropdownItemLabel: string;
76
- heading: string;
77
- activateButton: string;
78
- deactivateButton: string;
79
- rolesButton: string;
80
- statusTag: string;
81
- };
82
- type MemberFormSelectors = {
83
- emailTextField: string;
84
- firstNameTextField: string;
85
- lastNameTextField: string;
86
- emailInput: string;
87
- emailErrorField: string;
88
- cancelButton: string;
89
- };
90
- type LoginSelectors = {
91
- appleAuthenticationButton: string;
92
- emailTextField: string;
93
- googleAuthenticationButton: string;
94
- githubAuthenticationButton: string;
95
- loginViaEmailButton: string;
96
- otpField: string;
97
- passwordTextField: string;
98
- rememberMeCheckBox: string;
99
- submitButton: string;
100
- twitterAuthenticationButton: string;
101
- };
102
- type ProfileSelectors = {
103
- tab: string;
104
- logoutLink: string;
105
- profileOptionsContainer: string;
106
- myProfileButton: string;
107
- organizationSettingsButton: string;
108
- appSwitcherBody: string;
109
- sidebarInfo: string;
110
- appSwitcherBackButton: string;
111
- };
112
- interface TableSelectors {
113
- nthColumn: (n: number) => string;
114
- tableBody: string;
115
- tableHeader: string;
116
- tableRow: string;
117
- spinner: string;
118
- nthHeading: (n: number) => string;
119
- }
120
- type SignUpSelectors = {
121
- emailTextField: string;
122
- firstNameTextField: string;
123
- lastNameTextField: string;
124
- organizationNameTextField: string;
125
- organizationSubmitButton: string;
126
- otpTextBox: string;
127
- profileSubmitButton: string;
128
- signupViaEmailButton: string;
129
- submitButton: string;
130
- subdomainNameTextField: string;
131
- subdomainError: string;
132
- };
133
- type HelpIconSelectors = {
134
- helpButton: string;
135
- documentationButton: string;
136
- keyboardShortcutButton: string;
137
- chatButton: string;
138
- whatsNewButton: string;
139
- whatsNewWidgetInfo: string;
140
- whatsNewWidgetCloseButton: string;
141
- keyboardShortcutPaneHeading: string;
142
- keyboardShortcutPaneCrossIcon: string;
143
- };
144
- type ChatWidgetSelectors = {
145
- chatWidgetHomeCard: string;
146
- widgetSubmitButton: string;
147
- chatBubbleMessage: string;
148
- chatCloseButton: string;
149
- widgetIframe: string;
150
- };
151
- type NeetoEditorSelectors = {
152
- boldOption: string;
153
- italicOption: string;
154
- underlineOption: string;
155
- strikeOption: string;
156
- codeBlockOption: string;
157
- highlightOption: string;
158
- linkInput: string;
159
- linkSubmitButton: string;
160
- commandList: (index: number) => string;
161
- imageUploadUrlSubmitButton: string;
162
- imageUploadUrlInputTextField: string;
163
- uploadInput: string;
164
- editorMenuBarWrapper: string;
165
- undoOption: string;
166
- redoOption: string;
167
- imageWrapper: string;
168
- };
169
- type IpRestrictionSelectors = {
170
- addButton: string;
171
- ipStartTextField: (index: number) => string;
172
- ipEndTextField: string;
173
- cancelButton: string;
174
- ipRangeRow: string;
175
- enableIpRestrictionCheckbox: string;
176
- };
177
- type RolesSelectors = {
178
- newButton: string;
179
- proceedButton: string;
180
- cancelButton: string;
181
- tableHeaderRoleName: string;
182
- nameTextField: string;
183
- searchTextField: string;
184
- updateRolePaneHeading: string;
185
- updateRoleCancelButton: string;
186
- descriptionTextField: string;
187
- permissionCategoryTitle: string;
188
- headerColumn: string;
189
- dropDownIcon: string;
190
- tableHeaderRoleTitle: string;
191
- };
192
- type TagsSelectors = {
193
- newTagButton: string;
194
- tagNameTextField: string;
195
- editButton: string;
196
- deleteButton: string;
197
- cancelButton: string;
198
- submitButton: string;
199
- searchTextField: string;
200
- descriptionTextArea: string;
201
- };
202
- type MergeTagsSelectors = {
203
- mergeTagsButton: string;
204
- mergeButton: string;
205
- sourceSearchTextField: string;
206
- sourceTagsList: string;
207
- destinationTagsList: string;
208
- destinationSearchTextField: string;
209
- cancelButton: string;
210
- proceedButton: string;
211
- disabledTag: string;
212
- };
213
- type NeetoFiltersSelectors = {
214
- emailSelectContainer: string;
215
- filterPaneHeading: string;
216
- neetoFiltersEmailBlock: string;
217
- neetoFiltersRoleBlock: string;
218
- neetoFiltersBarClearButton: string;
219
- neetoFiltersNameFilterField: string;
220
- neetoFilterNameBlock: string;
221
- roleSelectContainer: string;
222
- filterButton: string;
223
- filtersClearButton: string;
224
- filterDoneButton: string;
225
- filteredMembersCount: string;
226
- allMenubarBlock: string;
227
- filtersEmailFilter: string;
228
- paneModalCrossIcon: string;
229
- };
230
-
231
- // texts ------------------------------------------------
232
- type CommonTexts = {
233
- activate: string;
234
- block: string;
235
- copiedToClipboard: string;
236
- crossSiteScript: string;
237
- deactivate: string;
238
- delete: string;
239
- delete1: string;
240
- edit: string;
241
- invalidEmailMessage: string;
242
- invalidSearchInput: string;
243
- logout: string;
244
- new: string;
245
- takeAction: string;
246
- unblock: string;
247
- emailRequiredError: string;
248
- emailTakenMessage: string;
249
- nameTakenMessage: string;
250
- all: string;
251
- proceed: string;
252
- settings: string;
253
- unsavedChangesAlertTitle: string;
254
- unsavedChangesAlertMessage: string;
255
- clearFilters: string;
256
- filters: string;
257
- descriptionRequiredMessage: string;
258
- deactivated: string;
259
- nameExistsMsg: string;
260
- cancel: string;
261
- continue: string;
262
- };
263
- type MemberText = {
264
- addMember: string;
265
- admin: string;
266
- agent: string;
267
- agents: string;
268
- activeMembersHeading: string;
269
- accountActivatedToastMessage: string;
270
- activateMember: string;
271
- activateMemberAlertMessage: string;
272
- addMemberToProducts: string;
273
- deactivateAccountToastMessage: string;
274
- deactivateMember: string;
275
- deactivateMemberAlertMessage: string;
276
- editMember: string;
277
- inviteMessage: string;
278
- memberAddedMessage: string;
279
- members: string;
280
- newHeading: string;
281
- updatedMemberRole: string;
282
- searchMembers: string;
283
- noDataTitle: string;
284
- editor: string;
285
- changeRole: string;
286
- changeRoleAlertMsg: string;
287
- collaborator: string;
288
- };
289
- type MemberTableTexts = {
290
- created: string;
291
- email: string;
292
- name: string;
293
- role: string;
294
- teams: string;
295
- };
296
- type MemberFormErrorTexts = {
297
- emailRequired: string;
298
- emailInvalid: string;
299
- removeInvalidEmail: string;
300
- };
301
- type SignUpTexts = {
302
- email: string;
303
- profile: string;
304
- tryItFree: string;
305
- };
306
- type Environment = {
307
- development: string;
308
- staging: string;
309
- };
310
- type HelpIconTexts = {
311
- documentation: string;
312
- welcome: string;
313
- keyboardShortcuts: string;
314
- liveChat: string;
315
- newConversation: string;
316
- chatMessage: string;
317
- whatsNew: string;
318
- whatsNewHeading: string;
319
- };
320
- type ProfileTexts = {
321
- logout: string;
322
- productSwitcher: string;
323
- chooseYourNeetoProduct: string;
324
- myProfile: string;
325
- profileSettings: string;
326
- myOrganization: string;
327
- };
328
- type RolesTexts = {
329
- newRole: string;
330
- editRole: string;
331
- nameRequiredErrorMessage: string;
332
- deleteRole: string;
333
- alertMessage: (roleName: string) => string;
334
- adminPermissionsNotBeChangeMessage: string;
335
- manageRoles: string;
336
- manageRolesAndPermissions: string;
337
- roles: string;
338
- noRolesText: string;
339
- searchRoles: string;
340
- namePlaceholder: string;
341
- descriptionPlaceholder: string;
342
- };
343
- type TagsTexts = {
344
- articleTags: string;
345
- addNewTag: string;
346
- createTag: string;
347
- editTag: string;
348
- alertMessage: (tagName: string) => string;
349
- tagNameRequiredMessage: string;
350
- alertTitle: string;
351
- noTagsFoundText: string;
352
- manageTags: string;
353
- createAndManageTags: string;
354
- searchPlaceHolder: string;
355
- noTagsText: string;
356
- mergeTags: string;
357
- mergeTagsAlertMessage: (sourceTag: string, destinationTag: string) => string;
358
- };
359
-
360
- // fixtures ---------------------------------------------
361
-
362
- type Fake = {
363
- firstName: string;
364
- middleName: string;
365
- lastName: string;
366
- companyName: string;
367
- fullName: string;
368
- email: string;
369
- streetAddress: string;
370
- streetName: string;
371
- city: string;
372
- zipCode: string;
373
- country: string;
374
- sentence: string;
375
- number: number;
376
- amount: number;
377
- projectName: string;
378
- department: string;
379
- word: string;
380
- words: string;
381
- randomString: string;
382
- state: string;
383
- quantity: number;
384
- randomDay: number;
385
- percentage: number;
386
- uniqueName: string;
387
- uniqueDepartment: string;
388
- phoneNumber: (format: string) => string;
389
- url: string;
390
- secureUrl: string;
391
- domain: string;
392
- otp: number;
393
- longNumber: number;
394
- decimalNumber: number;
395
- };
396
-
397
- // utils ------------------------------------------------
398
-
399
- // Utils: common
400
- export function initCustomCommands(): void;
401
- export function dataCy(dataCyId: string): string;
402
- export function getTestTitle(): string;
403
- export function getUrl(path: string): string;
404
- export function initializeCredentials(props: {
405
- businessName: string;
406
- currentUserName: string;
407
- email: string;
408
- firstName: string;
409
- lastName: string;
410
- domain: string;
411
- subdomainName: string;
412
- skipSetup: boolean;
413
- }): string;
414
- /**
415
- *
416
- * The joinHyphenCase function joins an array of strings using hyphens as the
417
- *
418
- * delimiter and returns the resulting string.
419
- *
420
- * Any number of string arguments.
421
- *
422
- * @example
423
- *
424
- * joinHyphenCase("hello", "world"); // output: "hello-world"
425
- * @endexample
426
- */
427
- export function joinHyphenCase(string: string | string[]): string;
428
- export function setListCount(countSelector: string, alias: string): void;
429
- export function verifyListCount(countSelector: string, count: number): string;
430
-
431
- // Utils: organization
432
- export function createOrganization(props: {
433
- appName: string;
434
- businessName: string;
435
- email: string;
436
- firstName: string;
437
- lastName: string;
438
- subdomainName: string;
439
- }): void;
440
-
441
- // Utils: validation
442
- export function verifyCrossSiteScript(inputSelector: string, submitSelector: string): void;
443
-
444
- // exporting all utils
445
- export const authUtils: {
446
- verifySSOLoginPage: () => void;
447
- logout: (homeUrl: string) => void;
448
- };
449
- export const dateUtils: {
450
- currentDate: () => string;
451
- futureDate: (numberOfDays: number) => string;
452
- pastDate: (numberOfDays: number) => string;
453
- };
454
- type AddMemberViaUIPropsType = {
455
- email: string;
456
- role: string;
457
- appName: string;
458
- };
459
- type AddMemberViaRequestPropsType = {
460
- email: string;
461
- role: string;
462
- requestCount: number;
463
- appName: string;
464
- };
465
- type ActivateMembersPropsType = {
466
- email: string;
467
- name: string;
468
- skipSearchRequest: boolean;
469
- };
470
- type UpdateMembersPropsType = {
471
- email: string;
472
- role: string;
473
- skipSearchRequest: boolean;
474
- };
475
- type VerifyMembersPropsType = {
476
- email: string;
477
- role: string;
478
- skipSearchRequest: boolean;
479
- };
480
- type DeactivateMembersPropsType = {
481
- email: string;
482
- name: string;
483
- skipSearchRequest: boolean;
484
- };
485
- type EditMemberPropsType = {
486
- email: string;
487
- newRole: string;
488
- firstName: string;
489
- lastName: string;
490
- skipSearchRequest: boolean;
491
- updateCount: number;
492
- };
493
- type EditMemberViaRequestPropsType = {
494
- email: string;
495
- newRole: string;
496
- firstName: string;
497
- lastName: string;
498
- requestCount: number;
499
- };
500
- type VerifyTabMenuPropsType = {
501
- tabSelector: string;
502
- toolTiptext: string;
503
- alias: string;
504
- requestCount: number;
505
- };
506
- type VerifyHelpDocumentationLinkPropsType = {
507
- url: string;
508
- articleTitle: string;
509
- alias: string;
510
- requestCount: number;
511
- };
512
- interface VerifyMyProfileTabPropTypes {
513
- alias: string;
514
- requestCount?: number;
515
- }
516
- type Environments = {
517
- isDevelopment: boolean;
518
- isReview: boolean;
519
- isStaging: boolean;
520
- isProduction: boolean;
521
- isNightly: boolean;
522
- tld: string;
523
- };
524
- type SendEmailPropsType = {
525
- to: string;
526
- subject: string;
527
- body: string;
528
- senderName: string;
529
- };
530
- export const memberUtils: {
531
- addMemberViaRequest: (props: AddMemberViaRequestPropsType) => void;
532
- addMemberViaUI: (props: AddMemberViaUIPropsType) => void;
533
- activateMember: (props: ActivateMembersPropsType) => void;
534
- editMemberViaUI: (props: EditMemberPropsType) => void;
535
- editMemberViaRequest: (props: EditMemberViaRequestPropsType) => void;
536
- deactivateMember: (props: DeactivateMembersPropsType) => void;
537
- checkColumnAndVerifyTableHeader: (fieldSelector: string) => void;
538
- deactivateMemberViaRequest: (email: string, requestCount: number) => void;
539
- updateMemberRole: (props: UpdateMembersPropsType) => void;
540
- interceptMemberApi: (alias: string, times: number) => void;
541
- navigateToMembersPage: (waitForRequest: boolean) => void;
542
- unCheckColumnAndVerifyTableHeader: (fieldSelector: string) => void;
543
- verifyMemberDetails: (props: VerifyMembersPropsType) => void;
544
- clickOnColumnIcon: (props: clickOnColumnIcon) => void;
545
- };
546
- export const navigationUtils: {
547
- verifyTabMenu: (props: VerifyTabMenuPropsType) => void;
548
- clickOnHelpSubTab: (tabSelector: string, tabText: string) => void;
549
- verifyHelpDocumentationLink: (props: VerifyHelpDocumentationLinkPropsType) => void;
550
- verifyKeyboardShortcutsPane: () => void;
551
- verifyWhatsNewTab: (whatsNewHeading: string) => void;
552
- verifyChatWithUsTab: () => void;
553
- verifyMyProfileTab: (props: VerifyMyProfileTabPropTypes) => void;
554
- verifyOrganizationTab: () => void;
555
- openProfileOrHelpCenter: (props: OpenProfileOrHelpCenterPropTypes) => void;
556
- openWhatsNewPane: (props: OpenWhatsNewPanePropTypes) => void;
557
- };
558
- export const emailUtils: {
559
- sendEmail: (props: SendEmailPropsType) => void;
560
- };
561
-
562
- // exporting all selectors
563
-
564
- export const commonSelectors: CommonSelectors;
565
- export const memberSelectors: MemberSelectors;
566
- export const loginSelectors: LoginSelectors;
567
- export const profileSelectors: ProfileSelectors;
568
- export const tableSelectors: TableSelectors;
569
- export const signUpSelectors: SignUpSelectors;
570
- export const memberFormSelectors: MemberFormSelectors;
571
- export const helpIconSelectors: HelpIconSelectors;
572
- export const chatWidgetSelectors: ChatWidgetSelectors;
573
- export const mergeTagsSelectors: MergeTagsSelectors;
574
- export const tagsSelectors: TagsSelectors;
575
- export const rolesSelectors: RolesSelectors;
576
- export const ipRestrictionSelectors: IpRestrictionSelectors;
577
- export const neetoEditorSelectors: NeetoEditorSelectors;
578
- export const neetoFiltersSelectors: NeetoFiltersSelectors;
579
-
580
- // exporting all texts
581
-
582
- export const commonTexts: CommonTexts;
583
- export const memberTexts: MemberText;
584
- export const memberTableTexts: MemberTableTexts;
585
- export const memberFormErrorTexts: MemberFormErrorTexts;
586
- export const signUpTexts: SignUpTexts;
587
- export const environment: Environment;
588
- export const isStagingEnv: boolean;
589
- export const helpIconTexts: HelpIconTexts;
590
- export const profileTexts: ProfileTexts;
591
- export const rolesTexts: RolesTexts;
592
- export const tagsTexts: TagsTexts;
593
- export const env: Environments;
594
-
595
- //exporting fixtures
596
-
597
- export const fake: Fake;