Add support for AlertConfig

Callers may provide an alertConfig object as part of either a synchronous plaintext scan, or an asynchronous file scan to fan alerts out to any of { slack, email, and webhook}.

Author: evanfuller

src/types/alerts.ts

@@ -0,0 +1,19 @@
+export namespace Alerts {
+  export interface Config {
+    slack?: Slack;
+    email?: Email;
+    url?: Webhook;
+  }
+
+  export interface Slack {
+    target: string;
+  }
+
+  export interface Email {
+    address: string;
+  }
+
+  export interface Webhook {
+    address: string;
+  }
+}

src/types/index.ts

@@ -1,3 +1,4 @@
+export * from './alerts'
 export * from './detectors'
 export * from './global'
 export * from './scanFile'

src/types/scanFile.ts

@@ -1,4 +1,4 @@
-import { Detector, NightfallError } from ".";
+import { Alerts, Detector, NightfallError } from ".";
 
 export namespace ScanFile {
   export interface ScanRequest {
@@ -9,7 +9,8 @@ export namespace ScanFile {
   export interface ScanPolicy {
     detectionRuleUUIDs?: string[]
     detectionRules?: Detector.Rule[]
-    webhookURL: string
+    webhookURL?: string // Deprecated, use alertConfig instead
+    alertConfig?: Alerts.Config
   }
 
   export interface InitializeResponse {

src/types/scanText.ts

@@ -1,11 +1,12 @@
-import { Detector } from ".";
+import { Alerts, Detector } from ".";
 
 export namespace ScanText {
   export interface RequestConfig {
     detectionRuleUUIDs?: string[]
     detectionRules?: Detector.Rule[]
     contextBytes?: number
     defaultRedactionConfig?: Detector.RedactionConfig
+    alertConfig?: Alerts.Config
   }
 
   export interface Response {