Expanded scan text method to support entire API spec

Author: nagarjun

.gitignore

@@ -1,2 +1,3 @@
 /dist
-/node_modules
+/node_modules
+tsconfig.tsbuildinfo

src/nightfall.ts

@@ -9,7 +9,7 @@ export class Nightfall {
   /**
    * Create an instance of the Nightfall client.
    * 
-   * @param {string} apiKey Your Nightfall API key
+   * @param apiKey Your Nightfall API key
    */
   constructor(apiKey: string) {
     this.API_KEY = apiKey
@@ -30,7 +30,7 @@ export class Nightfall {
    * 
    * @param payload An array of strings that you would like to scan
    * @param config The configuration to use to scan the payload
-   * @returns {Promise} A promise object representing the Nightfall response
+   * @returns A promise object representing the Nightfall response
    */
   async scanText(payload: string[], config: ScanText.RequestConfig): Promise<NightfallResponse<ScanText.Response>> {
     try {
@@ -57,8 +57,8 @@ export class Nightfall {
    * A helpder function to determine whether the error is a generic JavaScript error or a
    * Nightfall API error.
    * 
-   * @param {Object} error The error object
-   * @returns {boolean} A boolean that indicates if the error is a Nightfall error
+   * @param error The error object
+   * @returns A boolean that indicates if the error is a Nightfall error
    */
   private isNightfallError(error: any): boolean {
     if (error.hasOwnProperty('isAxiosError') && error.isAxiosError && error.response.data.hasOwnProperty('code')) {

src/types/detectors.ts

@@ -1,5 +1,5 @@
 export namespace Detector {
-  export enum MinConfidence {
+  export enum Confidence {
     VeryUnlikely = 'VERY_UNLIKELY',
     Unlikely = 'UNLIKELY',
     Possible = 'POSSIBLE',
@@ -13,11 +13,66 @@ export namespace Detector {
     WordList = 'WORD_LIST'
   }
 
+  type Regex = {
+    pattern: string
+    isCaseSensitive: boolean
+  }
+
+  type WordList = {
+    values: string[]
+    isCaseSensitive: boolean
+  }
+
+  type ContextRule = {
+    regex: Regex
+    proximity: {
+      windowBefore: number
+      windowAfter: number
+    }
+    confidenceAdjustment: Confidence
+  }
+
+  type ExclusionRule = {
+    matchType: 'PARTIAL' | 'FULL'
+    exclusionType: Type.Regex | Type.WordList
+    regex?: Regex
+    wordList?: WordList
+  }
+
+  export interface RedactionConfig {
+    maskConfig?: MaskConfig;
+    infoTypeSubstitutionConfig?: { [key: string]: string };
+    substitutionConfig?: SubstitutionConfig;
+    cryptoConfig?: CryptoConfig;
+    removeFinding?: boolean;
+  }
+
+  export interface MaskConfig {
+    charsToIgnore: string[];
+    maskingChar: string;
+    numCharsToLeaveUnmasked: number;
+    maskLeftToRight: boolean;
+  }
+
+  export interface SubstitutionConfig {
+    substitutionPhrase: string;
+  }
+
+  export interface CryptoConfig {
+    publicKey: string;
+  }
+
   export interface Properties {
     minNumFindings: number
-    minConfidence: MinConfidence | string
+    minConfidence: Confidence | string
+    detectorUUID?: string,
     displayName: string
     detectorType: Type | string
-    nightfallDetector: string
+    nightfallDetector?: string
+    regex?: Regex
+    wordList?: WordList
+    contextRules?: ContextRule[]
+    exclusionRules?: ExclusionRule[]
+    redactionConfig?: RedactionConfig
   }
 }

src/types/scanText.ts

@@ -4,6 +4,7 @@ export namespace ScanText {
   export interface RequestConfig {
     detectionRuleUUIDs?: string[]
     detectionRules?: DetectionRule[]
+    contextBytes?: number
   }
 
   export interface DetectionRule {
@@ -18,22 +19,29 @@ export namespace ScanText {
   }
 
   export interface Finding {
-    finding: string;
+    finding: string
+    redactedFinding?: string
+    beforeContext?: string
+    afterContext?: string
     detector: {
-      name: string;
-      uuid: string;
+      name: string
+      uuid: string
     };
-    confidence: string;
+    confidence: string
     location: {
-      byteRange: FindingRange;
-      codepointRange: FindingRange;
+      byteRange: FindingRange
+      codepointRange: FindingRange
     };
-    matchedDetectionRuleUUIDs: any[];
-    matchedDetectionRules: string[];
+    redactedLocation?: {
+      byteRange: FindingRange
+      codepointRange: FindingRange
+    }
+    matchedDetectionRuleUUIDs: any[]
+    matchedDetectionRules: string[]
   }
 
   type FindingRange = {
-    start: number;
-    end: number;
+    start: number
+    end: number
   }
 }