refactor(scanner): add new highlight + contacts property (#233)

package.json

@@ -51,6 +51,7 @@
   "dependencies": {
     "@nodesecure/i18n": "^4.0.0",
     "@nodesecure/js-x-ray": "^7.0.0",
+    "@nodesecure/npm-types": "^1.0.0",
     "@nodesecure/vuln": "^1.7.0",
     "@openally/result": "^1.2.1",
     "@slimio/config": "^1.2.0",

src/index.ts

@@ -3,4 +3,4 @@ export * from "./functions/write.js";
 export * from "./functions/memoize.js";
 export * as CONSTANTS from "./constants.js";
 
-export { type RC, type Author, JSONSchema, homedir } from "./rc.js";
+export { type RC, JSONSchema, homedir } from "./rc.js";

src/projects/scanner.ts

@@ -1,22 +1,21 @@
+// Import Third-party Dependencies
+import type { Contact } from "@nodesecure/npm-types";
+
 /**
  * Configuration dedicated for NodeSecure scanner
  * @see https://github.com/NodeSecure/scanner
  */
 export interface ScannerConfiguration {
-  /**
-   * List of NPM users/authors flagged
-   * @see https://github.com/NodeSecure/authors
-   */
-  flaggedAuthors: Author[];
-}
-export type Author = {
-  name: string,
-  email: string,
+  highlight?: {
+    contacts: Contact[];
+  }
 }
 
 export function generateScannerConfiguration(): { scanner: ScannerConfiguration } {
   const scanner: ScannerConfiguration = {
-    flaggedAuthors: []
+    highlight: {
+      contacts: []
+    }
   };
 
   return { scanner };

src/rc.ts

@@ -10,9 +10,20 @@ import * as vuln from "@nodesecure/vuln";
 import { GLOBAL_CONFIGURATION_DIRECTORY } from "./constants.js";
 import { loadJSONSchemaSync } from "./schema/loader.js";
 
-import { generateCIConfiguration, type CiConfiguration, type CiWarnings } from "./projects/ci.js";
-import { generateReportConfiguration, type ReportConfiguration, type ReportChart } from "./projects/report.js";
-import { generateScannerConfiguration, type ScannerConfiguration, type Author } from "./projects/scanner.js";
+import {
+  generateCIConfiguration,
+  type CiConfiguration,
+  type CiWarnings
+} from "./projects/ci.js";
+import {
+  generateReportConfiguration,
+  type ReportConfiguration,
+  type ReportChart
+} from "./projects/report.js";
+import {
+  generateScannerConfiguration,
+  type ScannerConfiguration
+} from "./projects/scanner.js";
 
 // CONSTANTS
 export const JSONSchema = loadJSONSchemaSync();
@@ -91,6 +102,5 @@ export {
   ReportChart,
 
   generateScannerConfiguration,
-  ScannerConfiguration,
-  Author
+  ScannerConfiguration
 };

src/schema/defs/author.json → src/schema/defs/contact.json

@@ -6,8 +6,11 @@
     },
     "email": {
       "type": "string"
+    },
+    "url": {
+      "type": "string"
     }
   },
-  "required": ["name", "email"],
+  "required": ["name"],
   "additionalProperties": false
 }

src/schema/defs/scanner.json

@@ -1,11 +1,18 @@
 {
   "type": "object",
   "properties": {
-    "flaggedAuthors": {
-      "type": "array",
-      "items": {
-        "$ref": "#/$defs/author"
-      }
+    "highlight": {
+      "type": "object",
+      "properties": {
+        "contacts": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/contact"
+          }
+        }
+      },
+      "required": ["contacts"],
+      "additionalProperties": false
     }
   },
   "additionalProperties": false