types(notifications): add types to onClick, onReceive, actions

Author: hayemaxi

packages/core/src/notifications/panelNode.ts

@@ -8,7 +8,7 @@ import { ResourceTreeDataProvider, TreeNode } from '../shared/treeview/resourceT
 import { Command, Commands } from '../shared/vscode/commands2'
 import { Icon, IconPath, getIcon } from '../shared/icons'
 import { contextKey, setContext } from '../shared/vscode/setContext'
-import { NotificationType, ToolkitNotification, getNotificationTelemetryId } from './types'
+import { NotificationType, OnReceiveType, ToolkitNotification, getNotificationTelemetryId } from './types'
 import { ToolkitError } from '../shared/errors'
 import { isAmazonQ } from '../shared/extensionUtilities'
 import { getLogger } from '../shared/logger/logger'
@@ -165,7 +165,11 @@ export class NotificationsNode implements TreeNode {
      * Can be either a blocking modal or a bottom-right corner toast
      * Handles the button click actions based on the button type.
      */
-    private showInformationWindow(notification: ToolkitNotification, type: string = 'toast', passive: boolean = false) {
+    private showInformationWindow(
+        notification: ToolkitNotification,
+        type: OnReceiveType = 'toast',
+        passive: boolean = false
+    ) {
         const isModal = type === 'modal'
 
         // modal has to have defined actions (buttons)

packages/core/src/notifications/types.ts

@@ -38,6 +38,10 @@ export interface ExactMatch {
 
 export type ConditionalClause = Range | ExactMatch | OR
 
+export type OnReceiveType = 'toast' | 'modal'
+export type OnClickType = 'modal' | 'openTextDocument' | 'openUrl'
+export type ActionType = 'openUrl' | 'updateAndReload' | 'openTxt'
+
 /** How to display the notification. */
 export interface UIRenderInstructions {
     content: {
@@ -47,13 +51,13 @@ export interface UIRenderInstructions {
             toastPreview?: string // optional property for toast
         }
     }
-    onRecieve: string
+    onRecieve: OnReceiveType // TODO: typo
     onClick: {
-        type: string
+        type: OnClickType
         url?: string // optional property for 'openUrl'
     }
     actions?: Array<{
-        type: string
+        type: ActionType
         displayText: {
             [`en-US`]: string
         }

packages/core/src/test/notifications/controller.test.ts

@@ -534,7 +534,7 @@ describe('RemoteFetcher', function () {
     })
 })
 
-function getValidTestNotification(id: string) {
+function getValidTestNotification(id: string): ToolkitNotification {
     return {
         id,
         displayIf: {
@@ -556,7 +556,7 @@ function getValidTestNotification(id: string) {
     }
 }
 
-function getInvalidTestNotification(id: string) {
+function getInvalidTestNotification(id: string): ToolkitNotification {
     return {
         id,
         displayIf: {
@@ -570,6 +570,8 @@ function getInvalidTestNotification(id: string) {
                     description: 'test',
                 },
             },
+            onRecieve: 'toast',
+            onClick: { type: 'modal' },
         },
     }
 }