[PM-24534] Archive via CLI (#16502)

* refactor `canInteract` into a component level usage. - The default service is going to be used in the CLI which won't make use of the UI-related aspects * all nested entities to be imported from the vault * initial add of archive command to the cli * add archive to oss serve * check for deleted cipher when attempting to archive * add searchability/list functionality for archived ciphers * restore an archived cipher * unarchive a cipher when a user is editing it and has lost their premium status * add missing feature flags * re-export only needed services from the vault * add needed await * add prompt when applicable for editing an archived cipher * move cipher archive service into `common/vault` * fix testing code
2026-01-05 01:53:55 +00:00 · 2025-09-30 09:45:04 -05:00
parent 7848b7d480
commit 727689d827
27 changed files with 401 additions and 131 deletions
--- a/apps/cli/src/vault/archive.command.ts
+++ b/apps/cli/src/vault/archive.command.ts
@@ -0,0 +1,109 @@
+import { firstValueFrom } from "rxjs";
+
+import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
+import { getUserId } from "@bitwarden/common/auth/services/account.service";
+import { BillingAccountProfileStateService } from "@bitwarden/common/billing/abstractions";
+import { FeatureFlag } from "@bitwarden/common/enums/feature-flag.enum";
+import { ConfigService } from "@bitwarden/common/platform/abstractions/config/config.service";
+import { CipherId } from "@bitwarden/common/types/guid";
+import { CipherArchiveService } from "@bitwarden/common/vault/abstractions/cipher-archive.service";
+import { CipherService } from "@bitwarden/common/vault/abstractions/cipher.service";
+import { CipherView } from "@bitwarden/common/vault/models/view/cipher.view";
+import { CipherViewLikeUtils } from "@bitwarden/common/vault/utils/cipher-view-like-utils";
+import { UserId } from "@bitwarden/user-core";
+
+import { Response } from "../models/response";
+
+export class ArchiveCommand {
+  constructor(
+    private cipherService: CipherService,
+    private accountService: AccountService,
+    private configService: ConfigService,
+    private cipherArchiveService: CipherArchiveService,
+    private billingAccountProfileStateService: BillingAccountProfileStateService,
+  ) {}
+
+  async run(object: string, id: string): Promise<Response> {
+    const featureFlagEnabled = await this.configService.getFeatureFlag(
+      FeatureFlag.PM19148_InnovationArchive,
+    );
+
+    if (!featureFlagEnabled) {
+      return Response.notFound();
+    }
+
+    if (id != null) {
+      id = id.toLowerCase();
+    }
+
+    const normalizedObject = object.toLowerCase();
+
+    if (normalizedObject === "item") {
+      return this.archiveCipher(id);
+    }
+
+    return Response.badRequest("Unknown object.");
+  }
+
+  private async archiveCipher(cipherId: string) {
+    const activeUserId = await firstValueFrom(this.accountService.activeAccount$.pipe(getUserId));
+    const cipher = await this.cipherService.get(cipherId, activeUserId);
+
+    if (cipher == null) {
+      return Response.notFound();
+    }
+
+    const cipherView = await this.cipherService.decrypt(cipher, activeUserId);
+
+    const { canArchive, errorMessage } = await this.userCanArchiveCipher(cipherView, activeUserId);
+
+    if (!canArchive) {
+      return Response.error(errorMessage);
+    }
+
+    try {
+      await this.cipherArchiveService.archiveWithServer(cipherView.id as CipherId, activeUserId);
+      return Response.success();
+    } catch (e) {
+      return Response.error(e);
+    }
+  }
+
+  /**
+   * Determines if the user can archive the given cipher.
+   * When the user cannot archive the cipher, an appropriate error message is provided.
+   */
+  private async userCanArchiveCipher(
+    cipher: CipherView,
+    userId: UserId,
+  ): Promise<
+    { canArchive: true; errorMessage?: never } | { canArchive: false; errorMessage: string }
+  > {
+    const hasPremiumFromAnySource = await firstValueFrom(
+      this.billingAccountProfileStateService.hasPremiumFromAnySource$(userId),
+    );
+
+    switch (true) {
+      case !hasPremiumFromAnySource: {
+        return {
+          canArchive: false,
+          errorMessage: "Premium status is required to use this feature.",
+        };
+      }
+      case CipherViewLikeUtils.isArchived(cipher): {
+        return { canArchive: false, errorMessage: "Item is already archived." };
+      }
+      case CipherViewLikeUtils.isDeleted(cipher): {
+        return {
+          canArchive: false,
+          errorMessage: "Item is in the trash, the item must be restored before archiving.",
+        };
+      }
+      case cipher.organizationId != null: {
+        return { canArchive: false, errorMessage: "Cannot archive items in an organization." };
+      }
+      default:
+        return { canArchive: true };
+    }
+  }
+}