Refactor: Move NudgesService to libs/angular/vault (#14843)

* move NudgesService to libs/angular/vault to avoid circular dependencies

* remove fix for spotlight component in storybook

libs/angular/src/vault/services/nudges.service.ts

@@ -0,0 +1,170 @@
+import { inject, Injectable } from "@angular/core";
+import { combineLatest, map, Observable, of, shareReplay, switchMap } from "rxjs";
+
+import { FeatureFlag } from "@bitwarden/common/enums/feature-flag.enum";
+import { ConfigService } from "@bitwarden/common/platform/abstractions/config/config.service";
+import { UserKeyDefinition, NUDGES_DISK } from "@bitwarden/common/platform/state";
+import { UserId } from "@bitwarden/common/types/guid";
+
+import {
+  HasItemsNudgeService,
+  EmptyVaultNudgeService,
+  AutofillNudgeService,
+  DownloadBitwardenNudgeService,
+  NewItemNudgeService,
+} from "./custom-nudges-services";
+import { DefaultSingleNudgeService, SingleNudgeService } from "./default-single-nudge.service";
+
+export type NudgeStatus = {
+  hasBadgeDismissed: boolean;
+  hasSpotlightDismissed: boolean;
+};
+
+/**
+ * Enum to list the various nudge types, to be used by components/badges to show/hide the nudge
+ */
+// FIXME: update to use a const object instead of a typescript enum
+// eslint-disable-next-line @bitwarden/platform/no-enums
+export enum NudgeType {
+  /** Nudge to show when user has no items in their vault
+   * Add future nudges here
+   */
+  EmptyVaultNudge = "empty-vault-nudge",
+  HasVaultItems = "has-vault-items",
+  AutofillNudge = "autofill-nudge",
+  DownloadBitwarden = "download-bitwarden",
+  NewLoginItemStatus = "new-login-item-status",
+  NewCardItemStatus = "new-card-item-status",
+  NewIdentityItemStatus = "new-identity-item-status",
+  NewNoteItemStatus = "new-note-item-status",
+  NewSshItemStatus = "new-ssh-item-status",
+}
+
+export const NUDGE_DISMISSED_DISK_KEY = new UserKeyDefinition<
+  Partial<Record<NudgeType, NudgeStatus>>
+>(NUDGES_DISK, "vaultNudgeDismissed", {
+  deserializer: (nudge) => nudge,
+  clearOn: [], // Do not clear dismissals
+});
+
+@Injectable({
+  providedIn: "root",
+})
+export class NudgesService {
+  private newItemNudgeService = inject(NewItemNudgeService);
+
+  /**
+   * Custom nudge services to use for specific nudge types
+   * Each nudge type can have its own service to determine when to show the nudge
+   * @private
+   */
+  private customNudgeServices: Partial<Record<NudgeType, SingleNudgeService>> = {
+    [NudgeType.HasVaultItems]: inject(HasItemsNudgeService),
+    [NudgeType.EmptyVaultNudge]: inject(EmptyVaultNudgeService),
+    [NudgeType.AutofillNudge]: inject(AutofillNudgeService),
+    [NudgeType.DownloadBitwarden]: inject(DownloadBitwardenNudgeService),
+    [NudgeType.NewLoginItemStatus]: this.newItemNudgeService,
+    [NudgeType.NewCardItemStatus]: this.newItemNudgeService,
+    [NudgeType.NewIdentityItemStatus]: this.newItemNudgeService,
+    [NudgeType.NewNoteItemStatus]: this.newItemNudgeService,
+    [NudgeType.NewSshItemStatus]: this.newItemNudgeService,
+  };
+
+  /**
+   * Default nudge service to use when no custom service is available
+   * Simply stores the dismissed state in the user's state
+   * @private
+   */
+  private defaultNudgeService = inject(DefaultSingleNudgeService);
+  private configService = inject(ConfigService);
+
+  private getNudgeService(nudge: NudgeType): SingleNudgeService {
+    return this.customNudgeServices[nudge] ?? this.defaultNudgeService;
+  }
+
+  /**
+   * Check if a nudge Spotlight should be shown to the user
+   * @param nudge
+   * @param userId
+   */
+  showNudgeSpotlight$(nudge: NudgeType, userId: UserId): Observable<boolean> {
+    return this.configService.getFeatureFlag$(FeatureFlag.PM8851_BrowserOnboardingNudge).pipe(
+      switchMap((hasVaultNudgeFlag) => {
+        if (!hasVaultNudgeFlag) {
+          return of(false);
+        }
+        return this.getNudgeService(nudge)
+          .nudgeStatus$(nudge, userId)
+          .pipe(map((nudgeStatus) => !nudgeStatus.hasSpotlightDismissed));
+      }),
+    );
+  }
+
+  /**
+   * Check if a nudge Badge should be shown to the user
+   * @param nudge
+   * @param userId
+   */
+  showNudgeBadge$(nudge: NudgeType, userId: UserId): Observable<boolean> {
+    return this.configService.getFeatureFlag$(FeatureFlag.PM8851_BrowserOnboardingNudge).pipe(
+      switchMap((hasVaultNudgeFlag) => {
+        if (!hasVaultNudgeFlag) {
+          return of(false);
+        }
+        return this.getNudgeService(nudge)
+          .nudgeStatus$(nudge, userId)
+          .pipe(map((nudgeStatus) => !nudgeStatus.hasBadgeDismissed));
+      }),
+    );
+  }
+
+  /**
+   * Check if a nudge should be shown to the user
+   * @param nudge
+   * @param userId
+   */
+  showNudgeStatus$(nudge: NudgeType, userId: UserId) {
+    return this.configService.getFeatureFlag$(FeatureFlag.PM8851_BrowserOnboardingNudge).pipe(
+      switchMap((hasVaultNudgeFlag) => {
+        if (!hasVaultNudgeFlag) {
+          return of({ hasBadgeDismissed: true, hasSpotlightDismissed: true } as NudgeStatus);
+        }
+        return this.getNudgeService(nudge).nudgeStatus$(nudge, userId);
+      }),
+    );
+  }
+
+  /**
+   * Dismiss a nudge for the user so that it is not shown again
+   * @param nudge
+   * @param userId
+   */
+  async dismissNudge(nudge: NudgeType, userId: UserId, onlyBadge: boolean = false) {
+    const dismissedStatus = onlyBadge
+      ? { hasBadgeDismissed: true, hasSpotlightDismissed: false }
+      : { hasBadgeDismissed: true, hasSpotlightDismissed: true };
+    await this.getNudgeService(nudge).setNudgeStatus(nudge, dismissedStatus, userId);
+  }
+
+  /**
+   * Check if there are any active badges for the user to show Berry notification in Tabs
+   * @param userId
+   */
+  hasActiveBadges$(userId: UserId): Observable<boolean> {
+    // Add more nudge types here if they have the settings badge feature
+    const nudgeTypes = [NudgeType.EmptyVaultNudge, NudgeType.DownloadBitwarden];
+
+    const nudgeTypesWithBadge$ = nudgeTypes.map((nudge) => {
+      return this.getNudgeService(nudge)
+        .nudgeStatus$(nudge, userId)
+        .pipe(
+          map((status) => !status?.hasBadgeDismissed),
+          shareReplay({ refCount: false, bufferSize: 1 }),
+        );
+    });
+
+    return combineLatest(nudgeTypesWithBadge$).pipe(
+      map((results) => results.some((result) => result === true)),
+    );
+  }
+}