[PM-14416] Risk Insights - Initial security task service

libs/common/src/abstractions/api.service.ts

@@ -1,9 +1,9 @@
 // FIXME: Update this file to be type safe and remove this and next line
 // @ts-strict-ignore
 import {
-  CollectionRequest,
   CollectionAccessDetailsResponse,
   CollectionDetailsResponse,
+  CollectionRequest,
   CollectionResponse,
 } from "@bitwarden/admin-console/common";
 
@@ -137,7 +137,7 @@ import { OptionalCipherResponse } from "../vault/models/response/optional-cipher
  */
 export abstract class ApiService {
   send: (
-    method: "GET" | "POST" | "PUT" | "DELETE",
+    method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH",
     path: string,
     body: any,
     authed: boolean,

libs/common/src/platform/state/state-definitions.ts

@@ -182,3 +182,4 @@ export const NEW_DEVICE_VERIFICATION_NOTICE = new StateDefinition(
   "disk",
 );
 export const VAULT_APPEARANCE = new StateDefinition("vaultAppearance", "disk");
+export const SECURITY_TASKS_DISK = new StateDefinition("securityTasks", "disk");

libs/common/src/services/api.service.ts

@@ -3,9 +3,9 @@
 import { firstValueFrom } from "rxjs";
 
 import {
-  CollectionRequest,
   CollectionAccessDetailsResponse,
   CollectionDetailsResponse,
+  CollectionRequest,
   CollectionResponse,
 } from "@bitwarden/admin-console/common";
 import { LogoutReason } from "@bitwarden/auth/common";
@@ -1835,7 +1835,7 @@ export class ApiService implements ApiServiceAbstraction {
   }
 
   async send(
-    method: "GET" | "POST" | "PUT" | "DELETE",
+    method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH",
     path: string,
     body: any,
     authed: boolean,
@@ -1875,7 +1875,7 @@ export class ApiService implements ApiServiceAbstraction {
       return responseJson;
     } else if (hasResponse && response.status === 200 && responseIsCsv) {
       return await response.text();
-    } else if (response.status !== 200) {
+    } else if (response.status !== 200 && response.status !== 204) {
       const error = await this.handleError(response, false, authed);
       return Promise.reject(error);
     }

libs/common/src/types/guid.ts

@@ -10,3 +10,4 @@ export type PolicyId = Opaque<string, "PolicyId">;
 export type CipherId = Opaque<string, "CipherId">;
 export type SendId = Opaque<string, "SendId">;
 export type IndexedEntityId = Opaque<string, "IndexedEntityId">;
+export type SecurityTaskId = Opaque<string, "SecurityTaskId">;

libs/vault/src/index.ts

@@ -16,3 +16,5 @@ export { DownloadAttachmentComponent } from "./components/download-attachment/do
 export { PasswordHistoryViewComponent } from "./components/password-history-view/password-history-view.component";
 
 export * as VaultIcons from "./icons";
+
+export * from "./tasks";

libs/vault/src/tasks/abstractions/task.service.ts

@@ -0,0 +1,45 @@
+import { Observable } from "rxjs";
+
+import { SecurityTaskId, UserId } from "@bitwarden/common/types/guid";
+import { SecurityTask } from "@bitwarden/vault";
+
+export abstract class TaskService {
+  /**
+   * Observable indicating if tasks are enabled for a given user.
+   *
+   * @remarks Internally, this checks the user's organization details to determine if tasks are enabled.
+   * @param userId
+   */
+  abstract tasksEnabled$(userId: UserId): Observable<boolean>;
+
+  /**
+   * Observable of all tasks for a given user.
+   * @param userId
+   */
+  abstract tasks$(userId: UserId): Observable<SecurityTask[]>;
+
+  /**
+   * Observable of pending tasks for a given user.
+   * @param userId
+   */
+  abstract pendingTasks$(userId: UserId): Observable<SecurityTask[]>;
+
+  /**
+   * Retrieves tasks from the API for a given user and updates the local state.
+   * @param userId
+   */
+  abstract refreshTasks(userId: UserId): Promise<void>;
+
+  /**
+   * Clears all the tasks from state for the given user.
+   * @param userId
+   */
+  abstract clear(userId: UserId): Promise<void>;
+
+  /**
+   * Marks a task as complete in local state and updates the server.
+   * @param taskId - The ID of the task to mark as complete.
+   * @param userId - The user who is completing the task.
+   */
+  abstract markAsComplete(taskId: SecurityTaskId, userId: UserId): Promise<void>;
+}

libs/vault/src/tasks/enums/index.ts

@@ -0,0 +1,2 @@
+export * from "./security-task-status.enum";
+export * from "./security-task-type.enum";

libs/vault/src/tasks/enums/security-task-status.enum.ts

@@ -0,0 +1,11 @@
+export enum SecurityTaskStatus {
+  /**
+   * Default status for newly created tasks that have not been completed.
+   */
+  Pending = 0,
+
+  /**
+   * Status when a task is considered complete and has no remaining actions
+   */
+  Completed = 1,
+}

libs/vault/src/tasks/enums/security-task-type.enum.ts

@@ -0,0 +1,6 @@
+export enum SecurityTaskType {
+  /**
+   * Task to update a cipher's password that was found to be at-risk by an administrator
+   */
+  UpdateAtRiskCredential = 0,
+}

libs/vault/src/tasks/index.ts

@@ -0,0 +1,5 @@
+export * from "./enums";
+export * from "./models";
+
+export * from "./abstractions/task.service";
+export * from "./services/default-task.service";

libs/vault/src/tasks/models/index.ts

@@ -0,0 +1 @@
+export * from "./security-task";

libs/vault/src/tasks/models/security-task.data.ts

@@ -0,0 +1,38 @@
+import { Jsonify } from "type-fest";
+
+import { CipherId, OrganizationId, SecurityTaskId } from "@bitwarden/common/types/guid";
+
+import { SecurityTaskStatus, SecurityTaskType } from "../enums";
+
+import { SecurityTaskResponse } from "./security-task.response";
+
+export class SecurityTaskData {
+  id: SecurityTaskId;
+  organizationId: OrganizationId;
+  cipherId: CipherId | undefined;
+  type: SecurityTaskType;
+  status: SecurityTaskStatus;
+  creationDate: Date;
+  revisionDate: Date;
+
+  constructor(response?: SecurityTaskResponse) {
+    if (response == null) {
+      return;
+    }
+
+    this.id = response.id;
+    this.organizationId = response.organizationId;
+    this.cipherId = response.cipherId;
+    this.type = response.type;
+    this.status = response.status;
+    this.creationDate = response.creationDate;
+    this.revisionDate = response.revisionDate;
+  }
+
+  static fromJSON(obj: Jsonify<SecurityTaskData>) {
+    return Object.assign(new SecurityTaskData(), obj, {
+      creationDate: new Date(obj.creationDate),
+      revisionDate: new Date(obj.revisionDate),
+    });
+  }
+}

libs/vault/src/tasks/models/security-task.response.ts

@@ -0,0 +1,28 @@
+import { BaseResponse } from "@bitwarden/common/models/response/base.response";
+import { CipherId, OrganizationId, SecurityTaskId } from "@bitwarden/common/types/guid";
+
+import { SecurityTaskStatus, SecurityTaskType } from "../enums";
+
+export class SecurityTaskResponse extends BaseResponse {
+  id: SecurityTaskId;
+  organizationId: OrganizationId;
+  /**
+   * Optional cipherId for tasks that are related to a cipher.
+   */
+  cipherId: CipherId | undefined;
+  type: SecurityTaskType;
+  status: SecurityTaskStatus;
+  creationDate: Date;
+  revisionDate: Date;
+
+  constructor(response: any) {
+    super(response);
+    this.id = this.getResponseProperty("Id");
+    this.organizationId = this.getResponseProperty("OrganizationId");
+    this.cipherId = this.getResponseProperty("CipherId") || undefined;
+    this.type = this.getResponseProperty("Type");
+    this.status = this.getResponseProperty("Status");
+    this.creationDate = this.getResponseProperty("CreationDate");
+    this.revisionDate = this.getResponseProperty("RevisionDate");
+  }
+}

libs/vault/src/tasks/models/security-task.ts

@@ -0,0 +1,32 @@
+import { CipherId, OrganizationId, SecurityTaskId } from "@bitwarden/common/types/guid";
+
+import { SecurityTaskStatus, SecurityTaskType } from "../enums";
+
+import { SecurityTaskData } from "./security-task.data";
+
+export class SecurityTask {
+  id: SecurityTaskId;
+  organizationId: OrganizationId;
+  /**
+   * Optional cipherId for tasks that are related to a cipher.
+   */
+  cipherId: CipherId | undefined;
+  type: SecurityTaskType;
+  status: SecurityTaskStatus;
+  creationDate: Date;
+  revisionDate: Date;
+
+  constructor(obj?: SecurityTaskData) {
+    if (obj == null) {
+      return;
+    }
+
+    this.id = obj.id;
+    this.organizationId = obj.organizationId;
+    this.cipherId = obj.cipherId;
+    this.type = obj.type;
+    this.status = obj.status;
+    this.creationDate = obj.creationDate;
+    this.revisionDate = obj.revisionDate;
+  }
+}