Type Notifications to Users

web-api/src/business/useCaseHelper/generateChangeOfAddressHelper.ts

@@ -47,7 +47,7 @@ export const generateChangeOfAddressHelper = async ({
   jobId: string;
   user: RawPractitioner;
   requestUserId?: string;
-  websocketMessagePrefix: string;
+  websocketMessagePrefix: 'user' | 'admin';
 }) => {
   try {
     const newData = contactInfo;
@@ -107,10 +107,15 @@ export const generateChangeOfAddressHelper = async ({
     applicationContext.logger.error(error);
   }
 
+  const NOTIFICATION_ACTION:
+    | 'user_contact_update_progress'
+    | 'admin_contact_update_progress' =
+    `${websocketMessagePrefix}_contact_update_progress`;
+
   await applicationContext.getNotificationGateway().sendNotificationToUser({
     applicationContext,
     message: {
-      action: `${websocketMessagePrefix}_contact_update_progress`,
+      action: NOTIFICATION_ACTION,
     },
     userId: requestUserId || user.userId,
   });
@@ -138,10 +143,15 @@ export const generateChangeOfAddressHelper = async ({
       });
     }
 
+    const CONTACT_UPDATE_COMPLETE_ACTION:
+      | 'user_contact_full_update_complete'
+      | 'admin_contact_full_update_complete' =
+      `${websocketMessagePrefix}_contact_full_update_complete`;
+
     await applicationContext.getNotificationGateway().sendNotificationToUser({
       applicationContext,
       message: {
-        action: `${websocketMessagePrefix}_contact_full_update_complete`,
+        action: CONTACT_UPDATE_COMPLETE_ACTION,
         user,
       },
       userId: requestUserId || user.userId,

web-api/src/business/useCases/courtIssuedDocument/fileAndServeCourtIssuedDocumentInteractor.ts

@@ -61,7 +61,7 @@ export const fileAndServeCourtIssuedDocument = async (
     docketEntryId,
   });
 
-  let error;
+  let error: Error | undefined;
   if (!docketEntryToServe) {
     error = new NotFoundError(`Docket entry ${docketEntryId} was not found.`);
   } else if (docketEntryToServe.servedAt) {
@@ -285,7 +285,7 @@ export const determineEntitiesToLock = (
 });
 
 export const handleLockError = async (
-  applicationContext,
+  applicationContext: ServerApplicationContext,
   originalRequest,
   authorizedUser: UnknownAuthUser,
 ) => {

web-api/src/business/useCases/courtIssuedDocument/serveCourtIssuedDocumentInteractor.ts

@@ -214,7 +214,7 @@ export const determineEntitiesToLock = (
 });
 
 export const handleLockError = async (
-  applicationContext,
+  applicationContext: ServerApplicationContext,
   originalRequest,
   authorizedUser: UnknownAuthUser,
 ) => {

web-api/src/business/useCases/customCaseReport/createCsvCustomCaseReportFileInteractor.ts

@@ -118,7 +118,7 @@ export const createCsvCustomCaseReportFileInteractor = async (
   const csvBuffer = Buffer.from(csvString);
 
   const today = formatNow(FORMATS.MMDDYYYY_UNDERSCORED);
-  const fileName = 'Custom Case Report - ' + today;
+  const fileName: string = 'Custom Case Report - ' + today;
 
   const fileInfo = await saveFileAndGenerateUrl({
     applicationContext,

web-api/src/business/useCases/docketEntry/addPaperFilingInteractor.ts

@@ -287,7 +287,7 @@ export const determineEntitiesToLock = (
 });
 
 export const handleLockError = async (
-  applicationContext,
+  applicationContext: ServerApplicationContext,
   originalRequest,
   authorizedUser: UnknownAuthUser,
 ) => {

web-api/src/business/useCases/docketEntry/editPaperFilingInteractor.ts

@@ -538,7 +538,7 @@ export const determineEntitiesToLock = (
 });
 
 export const handleLockError = async (
-  applicationContext,
+  applicationContext: ServerApplicationContext,
   originalRequest,
   authorizedUser: UnknownAuthUser,
 ) => {

web-api/src/business/useCases/user/generateChangeOfAddress.ts

@@ -50,7 +50,7 @@ const generateChangeOfAddressForPractitioner = async ({
   updatedEmail?: string;
   updatedName?: string;
   user: any;
-  websocketMessagePrefix?: string;
+  websocketMessagePrefix?: 'user' | 'admin';
   authorizedUser: AuthUser;
 }): Promise<any[] | undefined> => {
   const associatedUserCases = await applicationContext
@@ -65,10 +65,15 @@ const generateChangeOfAddressForPractitioner = async ({
   }
 
   let completedCases = 0;
+  const NOTIFICATION_ACTION:
+    | 'user_contact_update_progress'
+    | 'admin_contact_update_progress' =
+    `${websocketMessagePrefix}_contact_update_progress`;
+
   await applicationContext.getNotificationGateway().sendNotificationToUser({
     applicationContext,
     message: {
-      action: `${websocketMessagePrefix}_contact_update_progress`,
+      action: NOTIFICATION_ACTION,
       completedCases,
       totalCases: associatedUserCases.length,
     },

web-api/src/notifications/sendNotificationToUser.test.ts

@@ -1,3 +1,4 @@
+import { NotificationMessage } from '@web-api/notifications/sendNotificationToUserTypes';
 import { applicationContext } from '../../../shared/src/business/test/createTestApplicationContext';
 import { sendNotificationToUser } from './sendNotificationToUser';
 
@@ -28,7 +29,13 @@ describe('sendNotificationToUser', () => {
       sk: 'sk-04',
     },
   ];
-  const mockMessage = 'hello, computer';
+  const mockMessage: NotificationMessage = {
+    action: 'download_csv_file',
+    csvInfo: {
+      fileName: 'TEST NAME',
+      url: 'SOME URL',
+    },
+  };
 
   const send = jest.fn().mockResolvedValue('ok');
 

web-api/src/notifications/sendNotificationToUser.ts

@@ -1,3 +1,4 @@
+import { NotificationMessage } from '@web-api/notifications/sendNotificationToUserTypes';
 import { ServerApplicationContext } from '@web-api/applicationContext';
 
 export const sendNotificationToUser = async ({
@@ -8,7 +9,7 @@ export const sendNotificationToUser = async ({
 }: {
   applicationContext: ServerApplicationContext;
   clientConnectionId?: string;
-  message: any;
+  message: NotificationMessage;
   userId: string;
 }) => {
   let connections = await applicationContext

web-api/src/notifications/sendNotificationToUserTypes.ts

@@ -0,0 +1,226 @@
+import { RawPractitioner } from '@shared/business/entities/Practitioner';
+import { UserRecord } from '@web-api/persistence/dynamo/dynamoTypes';
+
+type MessageCompletionErrorNotification = {
+  action: 'message_completion_error';
+  alertError: {
+    message: string;
+    title: string;
+  };
+};
+
+type ContactUpdateProgressNotification = {
+  action: 'user_contact_update_progress' | 'admin_contact_update_progress';
+  completedCases?: number;
+  totalCases?: number;
+};
+
+type ContactUpdateCompleteNotification = {
+  action:
+    | 'user_contact_full_update_complete'
+    | 'admin_contact_full_update_complete';
+  user?: RawPractitioner | UserRecord;
+};
+
+type ServeDocumentErrorNotification = {
+  action: 'serve_document_error';
+  error: string;
+};
+
+type ServeDocumentCompleteNotification = {
+  action: 'serve_document_complete';
+  alertSuccess: {
+    message: string;
+    overwritable: boolean;
+  };
+  generateCoversheet?: boolean;
+  docketEntryId?: string;
+  pdfUrl?: string;
+};
+
+type RetryAsyncRequestNotification = {
+  action: 'retry_async_request';
+  originalRequest: any;
+  requestToRetry: string;
+};
+
+type BatchDownloadCsvDataNotification = {
+  action: 'batch_download_csv_data';
+  filesCompleted: number;
+  totalFiles: number;
+};
+
+type DownloadCsvFileNotification = {
+  action: 'download_csv_file';
+  csvInfo: {
+    fileName: string;
+    url: string;
+  };
+};
+
+type SaveDocketEntryForLaterCompleteNotification = {
+  action: 'save_docket_entry_for_later_complete';
+  alertSuccess: {
+    message: string;
+    overwritable: boolean;
+  };
+  docketEntryId: string;
+};
+
+type BatchDownloadErrorNotification = {
+  action: 'batch_download_error';
+  error: any;
+};
+
+type BatchDownloadProgressNotification = {
+  action: 'batch_download_progress';
+  filesCompleted: number;
+  totalFiles: number;
+};
+
+type BatchDownloadReadyNotification = {
+  action: 'batch_download_ready';
+  url: string;
+};
+
+type AwsBatchDownloadProgressNotification = {
+  action: 'aws_batch_download_progress';
+  filesCompleted: number;
+  totalFiles: number;
+};
+
+type MessageCompletionSucessNotification = {
+  action: 'message_completion_success';
+  completedMessageIds: string[];
+};
+
+type AdminContactInitialUpdateCompleteNotification = {
+  action: 'admin_contact_initial_update_complete';
+};
+
+type ServeToIrsCompleteNotification = {
+  action: 'serve_to_irs_complete';
+  pdfUrl: string;
+};
+
+type ServeToIrsErrorNotification = {
+  action: 'serve_to_irs_error';
+};
+
+type BatchDownloadDocketGeneratedNotification = {
+  action: 'batch_download_docket_generated';
+  filesCompleted: number;
+  totalFiles: number;
+};
+
+type NoticeGenerationUpdatedNotification = {
+  action: 'notice_generation_updated';
+};
+
+type PaperServiceStartedNotification = {
+  action: 'paper_service_started';
+  totalPdfs: number;
+};
+
+type PaperServiceUpdatedNotification = {
+  action: 'paper_service_updated';
+  pdfsAppended: number;
+};
+
+type SetTrialCalendarPaperServiceCompleteNotification = {
+  action: 'set_trial_calendar_paper_service_complete';
+  fileId: string;
+  hasPaper: boolean;
+  pdfUrl: string;
+};
+
+type ThirtyDayNoticePaperServiceCompleteNotification = {
+  action: 'thirty_day_notice_paper_service_complete';
+  pdfUrl?: string;
+  fileId?: string;
+  hasPaper?: boolean;
+};
+
+type NoticeGenerationCompleteNotification = {
+  action: 'notice_generation_complete';
+  hasPaper?: boolean;
+  trialNoticePdfsKeys: string[];
+  trialSessionId?: string;
+};
+
+type NoticeGenerationStartNotification = {
+  action: 'notice_generation_start';
+  totalCases: number;
+};
+
+type SetTrialSessionCalendarCompleteNotification = {
+  action: 'set_trial_session_calendar_complete';
+  trialSessionId: string;
+};
+
+type SetTrialSessionCalendarErrorNotification = {
+  action: 'set_trial_session_calendar_error';
+  message: string;
+};
+
+type UpdateTrialSessionCompleteNotification = {
+  action: 'update_trial_session_complete';
+  fileId?: string;
+  hasPaper?: boolean;
+  pdfUrl?: string;
+  trialSessionId?: string;
+};
+
+type UserContactInitialUpdateCompleteNotification = {
+  action: 'user_contact_initial_update_complete';
+};
+
+type UserContactUpdateErrorNotification = {
+  action: 'user_contact_update_error';
+  error: string;
+};
+
+export type NotificationMessage =
+  | MessageCompletionErrorNotification
+  | ContactUpdateProgressNotification
+  | ContactUpdateCompleteNotification
+  | ServeDocumentErrorNotification
+  | ServeDocumentCompleteNotification
+  | RetryAsyncRequestNotification
+  | BatchDownloadCsvDataNotification
+  | DownloadCsvFileNotification
+  | SaveDocketEntryForLaterCompleteNotification
+  | BatchDownloadErrorNotification
+  | BatchDownloadProgressNotification
+  | BatchDownloadReadyNotification
+  | AwsBatchDownloadProgressNotification
+  | MessageCompletionSucessNotification
+  | AdminContactInitialUpdateCompleteNotification
+  | ServeToIrsCompleteNotification
+  | ServeToIrsErrorNotification
+  | BatchDownloadDocketGeneratedNotification
+  | NoticeGenerationUpdatedNotification
+  | PaperServiceStartedNotification
+  | PaperServiceUpdatedNotification
+  | SetTrialCalendarPaperServiceCompleteNotification
+  | ThirtyDayNoticePaperServiceCompleteNotification
+  | NoticeGenerationCompleteNotification
+  | NoticeGenerationStartNotification
+  | SetTrialSessionCalendarCompleteNotification
+  | SetTrialSessionCalendarErrorNotification
+  | UpdateTrialSessionCompleteNotification
+  | UserContactInitialUpdateCompleteNotification
+  | UserContactUpdateErrorNotification;
+
+type MaintenanceModeEngaged = {
+  action: 'maintenance_mode_engaged';
+};
+
+type MaintenanceModeDisengaged = {
+  action: 'maintenance_mode_disengaged';
+};
+
+export type SocketRouterNotificationMessage =
+  | NotificationMessage
+  | MaintenanceModeEngaged
+  | MaintenanceModeDisengaged;

web-client/src/providers/socketRouter.ts

@@ -1,10 +1,12 @@
+import { SocketRouterNotificationMessage } from '@web-api/notifications/sendNotificationToUserTypes';
+
 /* eslint-disable complexity */
 const noop = () => {};
 
 export const socketRouter = (app, onMessageCallbackFn?) => {
   return async event => {
     const message = JSON.parse(event.data);
-    const { action } = message;
+    const { action } = message as SocketRouterNotificationMessage;
 
     switch (action) {
       case 'paper_service_started':