feat: qbd direct connector setup connector ts changes

[DhaaraniCIT]

Description

feat: qbd direct connector setup connector ts changes

Clickup

https://app.clickup.com/t/86cwzceph

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced interactivity with the addition of event emitters for continueClick, doneClick, and nextClick in the QBD Direct components.
  • Improved user feedback when copying passwords to the clipboard.

• UI Improvements

  • Increased icon sizes for better visibility in the setup connection interface.
  • Standardized naming conventions for password visibility icons.

• Input Requirements

  • Enforced required input properties for better component usage consistency.

[coderabbitai]

Walkthrough

The changes in this pull request involve enhancements to the QbdDirectDataSyncComponent and QbdDirectSetupConnectionComponent. The QbdDirectDataSyncComponent now includes an output property for event emission, allowing parent components to respond to user actions. The QbdDirectSetupConnectionComponent has been updated with new input properties that are required, along with additional output properties for event handling. Modifications to the HTML template improve icon visibility. Overall, these changes aim to enhance interactivity and user feedback within the components.

Changes

File	Change Summary
src/app/integrations/qbd-direct/qbd-direct-shared/qbd-direct-data-sync/qbd-direct-data-sync.component.ts	Added @Output() continueClick event emitter; modified onContinueClick method to emit the event. Added import for EventEmitter.
src/app/integrations/qbd-direct/qbd-direct-shared/qbd-direct-setup-connection/qbd-direct-setup-connection.component.html	Adjusted icon sizes for password visibility and duplicate action icons; simplified SVG source names for consistency.
src/app/integrations/qbd-direct/qbd-direct-shared/qbd-direct-setup-connection/qbd-direct-setup-connection.component.ts	Added required @Input properties and new @Output properties (doneClick, nextClick). Enhanced onClipboardCopy method for user feedback and clipboard functionality. Updated showPassword method.

Possibly related PRs

• fix: qbd direct export settings folder fix #1050: The changes in the QbdDirectExportSettingsComponent involve adding an import for QBDExportSettingFormOption, which is relevant to the export settings functionality in the same context as the main PR's updates to event handling in the QBD Direct integration.
• feat: Expose QBD Direct Integration #1052: The modifications in the QbdDirectAuthService and the introduction of the login method enhance the authentication process for QBD Direct, which aligns with the main PR's focus on improving interactivity and event handling in the QBD Direct components.

Suggested labels

size/M, deploy

Suggested reviewers

• ashwin1111

🐇 In the garden where we play,
New features hop in bright array.
Clicks and icons, all in line,
With every change, our joy will shine!
So let’s embrace this lively dance,
In our code, we take a chance! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[ashwin1111]

pls add a TODO to remove it later

[github-actions]

Unit Test Coverage	%	values
Statements	35.26%	( 4241 / 12027 )
Branches	28.91%	( 1227 / 4244 )
Functions	27.83%	( 939 / 3374 )
Lines	35.39%	( 4167 / 11773 )

[coderabbitai]

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (4)

src/app/integrations/qbd-direct/qbd-direct-shared/qbd-direct-data-sync/qbd-direct-data-sync.component.ts (2)

20-20: Consider adding type safety to EventEmitter

While the implementation is correct, consider adding type safety to the EventEmitter to make the component's contract more explicit.

- @Output() continueClick = new EventEmitter();
+ @Output() continueClick = new EventEmitter<void>();

---

Line range hint 1-38: Consider documenting the component's purpose and event behavior

The component lacks documentation about its purpose and when the continueClick event is emitted. Consider adding JSDoc comments to improve maintainability.

+ /**
+  * Component responsible for QBD data synchronization UI.
+  * Displays synchronization fields and provides navigation control.
+  */
 @Component({
   selector: 'app-qbd-direct-data-sync',
   standalone: true,
   imports: [CommonModule, SharedModule],
   templateUrl: './qbd-direct-data-sync.component.html',
   styleUrl: './qbd-direct-data-sync.component.scss'
 })
 export class QbdDirectDataSyncComponent implements OnInit {

+  /** Configuration fields for QBD synchronization */
   @Input({required: true}) qbdFields: SyncDataType;

+  /** Controls whether the continue action is enabled */
   @Input({required: true}) isCTAEnabled: boolean;

+  /** Emitted when user confirms the synchronization settings */
   @Output() continueClick = new EventEmitter<void>();

src/app/integrations/qbd-direct/qbd-direct-shared/qbd-direct-setup-connection/qbd-direct-setup-connection.component.html (2)

Line range hint 71-73: Consider using privacy-enhanced mode for YouTube embed.

The current YouTube embed might allow user tracking. Consider using the privacy-enhanced domain (youtube-nocookie.com).

-<iframe width="427" height="259" src="https://www.youtube.com/embed/2oYdc8KcQnk" frameborder="0"></iframe>
+<iframe width="427" height="259" src="https://www.youtube-nocookie.com/embed/2oYdc8KcQnk" frameborder="0" loading="lazy"></iframe>

---

Line range hint 71-73: Add accessibility attributes to the YouTube embed.

The iframe element should include accessibility attributes to improve screen reader support.

-<iframe width="427" height="259" src="https://www.youtube.com/embed/2oYdc8KcQnk" frameborder="0"></iframe>
+<iframe
+  width="427"
+  height="259"
+  src="https://www.youtube.com/embed/2oYdc8KcQnk"
+  frameborder="0"
+  title="QuickBooks Web Connector Setup Guide"
+  allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen>
+</iframe>

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d02b468 and 3a53ce1.

📒 Files selected for processing (3)

• src/app/integrations/qbd-direct/qbd-direct-shared/qbd-direct-data-sync/qbd-direct-data-sync.component.ts (2 hunks)
• src/app/integrations/qbd-direct/qbd-direct-shared/qbd-direct-setup-connection/qbd-direct-setup-connection.component.html (1 hunks)
• src/app/integrations/qbd-direct/qbd-direct-shared/qbd-direct-setup-connection/qbd-direct-setup-connection.component.ts (3 hunks)

🔇 Additional comments (5)

src/app/integrations/qbd-direct/qbd-direct-shared/qbd-direct-data-sync/qbd-direct-data-sync.component.ts (1)

2-2: LGTM: Import statement follows Angular best practices

The EventEmitter import is correctly added alongside other Angular core imports, maintaining clean organization.

src/app/integrations/qbd-direct/qbd-direct-shared/qbd-direct-setup-connection/qbd-direct-setup-connection.component.ts (2)

19-27: LGTM: Input property declarations

The required inputs are properly decorated and typed, ensuring that parent components must provide these values.

---

29-31: LGTM: Event emitters and methods

The event emitters are properly typed and the methods are concise and focused on their specific responsibilities.

Also applies to: 43-48, 68-70

src/app/integrations/qbd-direct/qbd-direct-shared/qbd-direct-setup-connection/qbd-direct-setup-connection.component.html (2)

45-46: LGTM! Improved password visibility toggle accessibility.

The increased icon size (24px) for password visibility controls enhances touch targets and accessibility.

---

49-49: LGTM! Enhanced copy button visibility.

The increased size (22px) of the duplicate icon improves visibility and usability of the copy functionality.

[coderabbitai]

💡 Codebase verification

The continueClick event is not properly handled in the parent component

The parent component QbdDirectOnboardingConnectorComponent has the app-qbd-direct-data-sync component commented out in its template and doesn't implement any event handling for the continueClick event. This could lead to the event being emitted but not captured, potentially breaking the intended flow.

• src/app/integrations/qbd-direct/qbd-direct-onboarding/qbd-direct-onboarding-connector/qbd-direct-onboarding-connector.component.html: Uncomment the component and add the event binding
• src/app/integrations/qbd-direct/qbd-direct-onboarding/qbd-direct-onboarding-connector/qbd-direct-onboarding-connector.component.ts: Implement the event handler method

🔗 Analysis chain

Verify the parent component's handling of continueClick event

The event emission is implemented correctly, but we should ensure proper handling in parent components.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for components using qbd-direct-data-sync and verify event handling
ast-grep --pattern '
<app-qbd-direct-data-sync
  $$$
  (continueClick)="$_"
  $$$
>'

Length of output: 86

---

Script:

#!/bin/bash
# Search for files containing qbd-direct-data-sync component usage
rg -l "qbd-direct-data-sync" --type html

# Then search for continueClick event handling in those files
rg "continueClick" -A 5 -B 5 --type html

Length of output: 214

---

Script:

#!/bin/bash
# Let's check the content of the parent component's HTML and its corresponding TypeScript file
cat src/app/integrations/qbd-direct/qbd-direct-onboarding/qbd-direct-onboarding-connector/qbd-direct-onboarding-connector.component.html

# Also check the TypeScript implementation
cat src/app/integrations/qbd-direct/qbd-direct-onboarding/qbd-direct-onboarding-connector/qbd-direct-onboarding-connector.component.ts

Length of output: 1003

[coderabbitai]

⚠️ Potential issue

Remove hard-coded password value

Having a default password value in the code poses a security risk, even if it's just a placeholder. The password should be initialized as an empty string or undefined.

Apply this diff:

- @Input({required: true}) password: string = '098765';
+ @Input({required: true}) password: string = '';

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	@Input({required: true}) password: string = '098765';
	@Input({required: true}) password: string = '';

[coderabbitai]

🛠️ Refactor suggestion

Modernize clipboard functionality and fix event handling

The current implementation has several issues:

1. Uses deprecated document.execCommand('copy')
2. Creates/removes DOM elements unnecessarily
3. Uses undeclared event parameter

Consider this modern implementation:

- onClipboardCopy() {
-   const selBox = document.createElement('textarea');
-   selBox.value = this.password;
-   document.body.appendChild(selBox);
-   selBox.select();
-   selBox.click();
-   document.execCommand('copy');
-
-   this.messageService.add({
-     severity: 'success',
-     summary: 'Password copied to clipboard'
-   });
-
-   document.body.removeChild(selBox);
-   event?.stopPropagation();
+ async onClipboardCopy(event?: Event) {
+   try {
+     await navigator.clipboard.writeText(this.password);
+     this.messageService.add({
+       severity: 'success',
+       summary: 'Password copied to clipboard'
+     });
+   } catch (err) {
+     this.messageService.add({
+       severity: 'error',
+       summary: 'Failed to copy password'
+     });
+   }
+   event?.stopPropagation();
}

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	onClipboardCopy() {
	// Copy password to clipboard
	const selBox = document.createElement('textarea');
	selBox.value = this.password;
	document.body.appendChild(selBox);
	selBox.select();
	selBox.click();
	document.execCommand('copy');
	this.messageService.add({
	severity: 'success',
	summary: 'Password copied to clipboard'
	});
	document.body.removeChild(selBox);
	event?.stopPropagation();
	async onClipboardCopy(event?: Event) {
	try {
	await navigator.clipboard.writeText(this.password);
	this.messageService.add({
	severity: 'success',
	summary: 'Password copied to clipboard'
	});
	} catch (err) {
	this.messageService.add({
	severity: 'error',
	summary: 'Failed to copy password'
	});
	}
	event?.stopPropagation();
	}