[PM-8455] [PM-7683] Dynamic list items - Copy Action (#9410)

* [PM-7683] Add fullAddressForCopy helper to identity.view * [PM-7683] Introduce CopyCipherFieldService to the Vault library - A new CopyCipherFieldService that can be used to copy a cipher's field to the user clipboard - A new appCopyField directive to make it easy to copy a cipher's fields in templates - Tests for the CopyCipherFieldService * [PM-7683] Introduce item-copy-actions.component * [PM-7683] Fix username value in copy cipher directive * [PM-7683] Add title to View item link * [PM-7683] Move disabled logic into own method
2025-12-16 16:23:44 +00:00 · 2024-06-04 14:09:09 -07:00
parent fc2953a126
commit d1a9d6f613
10 changed files with 580 additions and 12 deletions
--- a/libs/vault/src/services/copy-cipher-field.service.ts
+++ b/libs/vault/src/services/copy-cipher-field.service.ts
@@ -0,0 +1,142 @@
+import { Injectable } from "@angular/core";
+import { firstValueFrom } from "rxjs";
+
+import { EventCollectionService } from "@bitwarden/common/abstractions/event/event-collection.service";
+import { BillingAccountProfileStateService } from "@bitwarden/common/billing/abstractions/account/billing-account-profile-state.service";
+import { EventType } from "@bitwarden/common/enums";
+import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
+import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
+import { TotpService } from "@bitwarden/common/vault/abstractions/totp.service";
+import { CipherRepromptType } from "@bitwarden/common/vault/enums";
+import { CipherView } from "@bitwarden/common/vault/models/view/cipher.view";
+import { ToastService } from "@bitwarden/components";
+import { PasswordRepromptService } from "@bitwarden/vault";
+
+/**
+ * The types of fields that can be copied from a cipher.
+ */
+export type CopyAction =
+  | "username"
+  | "password"
+  | "totp"
+  | "cardNumber"
+  | "securityCode"
+  | "email"
+  | "phone"
+  | "address"
+  | "secureNote"
+  | "hiddenField";
+
+type CopyActionInfo = {
+  /**
+   * The i18n key for the type of field being copied. Will be used to display a toast message.
+   */
+  typeI18nKey: string;
+
+  /**
+   * Whether the field is protected and requires password re-prompting before being copied.
+   */
+  protected: boolean;
+
+  /**
+   * Optional event to collect when the field is copied.
+   */
+  event?: EventType;
+};
+
+const CopyActions: Record<CopyAction, CopyActionInfo> = {
+  username: { typeI18nKey: "username", protected: false },
+  password: {
+    typeI18nKey: "password",
+    protected: true,
+    event: EventType.Cipher_ClientCopiedPassword,
+  },
+  totp: { typeI18nKey: "verificationCodeTotp", protected: true },
+  cardNumber: { typeI18nKey: "number", protected: true },
+  securityCode: {
+    typeI18nKey: "securityCode",
+    protected: true,
+    event: EventType.Cipher_ClientCopiedCardCode,
+  },
+  email: { typeI18nKey: "email", protected: false },
+  phone: { typeI18nKey: "phone", protected: false },
+  address: { typeI18nKey: "address", protected: false },
+  secureNote: { typeI18nKey: "note", protected: false },
+  hiddenField: {
+    typeI18nKey: "value",
+    protected: true,
+    event: EventType.Cipher_ClientCopiedHiddenField,
+  },
+};
+
+@Injectable({
+  providedIn: "root",
+})
+export class CopyCipherFieldService {
+  constructor(
+    private platformUtilsService: PlatformUtilsService,
+    private toastService: ToastService,
+    private eventCollectionService: EventCollectionService,
+    private passwordRepromptService: PasswordRepromptService,
+    private totpService: TotpService,
+    private i18nService: I18nService,
+    private billingAccountProfileStateService: BillingAccountProfileStateService,
+  ) {}
+
+  /**
+   * Copy a field value from a cipher to the clipboard.
+   * @param valueToCopy The value to copy.
+   * @param actionType The type of field being copied.
+   * @param cipher The cipher containing the field to copy.
+   * @param skipReprompt Whether to skip password re-prompting.
+   */
+  async copy(
+    valueToCopy: string,
+    actionType: CopyAction,
+    cipher: CipherView,
+    skipReprompt: boolean = false,
+  ) {
+    const action = CopyActions[actionType];
+    if (
+      !skipReprompt &&
+      cipher.reprompt !== CipherRepromptType.None &&
+      action.protected &&
+      !(await this.passwordRepromptService.showPasswordPrompt())
+    ) {
+      return;
+    }
+
+    if (valueToCopy == null || !cipher.viewPassword) {
+      return;
+    }
+
+    if (actionType === "totp") {
+      if (!(await this.totpAllowed(cipher))) {
+        return;
+      }
+      valueToCopy = await this.totpService.getCode(valueToCopy);
+    }
+
+    this.platformUtilsService.copyToClipboard(valueToCopy);
+    this.toastService.showToast({
+      variant: "success",
+      message: this.i18nService.t("valueCopied", this.i18nService.t(action.typeI18nKey)),
+      title: null,
+    });
+
+    if (action.event !== undefined) {
+      await this.eventCollectionService.collect(action.event, cipher.id);
+    }
+  }
+
+  /**
+   * Determines if TOTP generation is allowed for a cipher and user.
+   */
+  async totpAllowed(cipher: CipherView): Promise<boolean> {
+    return (
+      (cipher?.login?.hasTotp ?? false) &&
+      (cipher.organizationUseTotp ||
+        (await firstValueFrom(this.billingAccountProfileStateService.hasPremiumFromAnySource$)))
+    );
+  }
+}