@nodesecure/rc 1.4.0 → 2.0.0

package/dist/projects/report.d.ts

@@ -1,69 +1,69 @@
-/**
- * Configuration dedicated for NodeSecure Report
- * @see https://github.com/NodeSecure/report
- */
-export interface ReportConfiguration {
-    /**
-     * @default `light`
-     */
-    theme?: "light" | "dark";
-    title: string;
-    /**
-     * URL to a logo to show on the final HTML/PDF Report
-     */
-    logoUrl: string;
-    /**
-     * Show/categorize internal dependencies as transitive
-     * @default false
-     */
-    includeTransitiveInternal?: boolean;
-    npm?: {
-        /**
-         * NPM organization prefix starting with @
-         * @example `@nodesecure`
-         */
-        organizationPrefix: string;
-        packages: string[];
-    };
-    git?: {
-        /**
-         * GitHub organization URL
-         * @example `https://github.com/NodeSecure`
-         */
-        organizationUrl: string;
-        /**
-         * List of repositories (name are enough, no need to provide .git url or any equivalent)
-         */
-        repositories: string[];
-    };
-    /**
-     * @default html,pdf
-     */
-    reporters?: ("html" | "pdf")[];
-    charts?: ReportChart[];
-}
-export interface ReportChart {
-    /**
-     * List of available charts.
-     */
-    name: "Extensions" | "Licenses" | "Warnings" | "Flags";
-    /**
-     * @default true
-     */
-    display?: boolean;
-    /**
-     * Chart.js chart type.
-     *
-     * @see https://www.chartjs.org/docs/latest/charts
-     * @default `bar`
-     */
-    type?: "bar" | "horizontalBar" | "polarArea" | "doughnut";
-    /**
-     * D3 Interpolation color. Will be picked randomly by default if not provided.
-     * @see https://github.com/d3/d3-scale-chromatic/blob/main/README.md
-     */
-    interpolation?: string;
-}
-export declare function generateReportConfiguration(): {
-    report: Partial<ReportConfiguration>;
-};
+/**
+ * Configuration dedicated for NodeSecure Report
+ * @see https://github.com/NodeSecure/report
+ */
+export interface ReportConfiguration {
+    /**
+     * @default `light`
+     */
+    theme?: "light" | "dark";
+    title: string;
+    /**
+     * URL to a logo to show on the final HTML/PDF Report
+     */
+    logoUrl?: string;
+    /**
+     * Show/categorize internal dependencies as transitive
+     * @default false
+     */
+    includeTransitiveInternal?: boolean;
+    npm?: {
+        /**
+         * NPM organization prefix starting with @
+         * @example `@nodesecure`
+         */
+        organizationPrefix: string;
+        packages: string[];
+    };
+    git?: {
+        /**
+         * GitHub organization URL
+         * @example `https://github.com/NodeSecure`
+         */
+        organizationUrl: string;
+        /**
+         * List of repositories (name are enough, no need to provide .git url or any equivalent)
+         */
+        repositories: string[];
+    };
+    /**
+     * @default html,pdf
+     */
+    reporters?: ("html" | "pdf")[];
+    charts?: ReportChart[];
+}
+export interface ReportChart {
+    /**
+     * List of available charts.
+     */
+    name: "Extensions" | "Licenses" | "Warnings" | "Flags";
+    /**
+     * @default true
+     */
+    display?: boolean;
+    /**
+     * Chart.js chart type.
+     *
+     * @see https://www.chartjs.org/docs/latest/charts
+     * @default `bar`
+     */
+    type?: "bar" | "horizontalBar" | "polarArea" | "doughnut";
+    /**
+     * D3 Interpolation color. Will be picked randomly by default if not provided.
+     * @see https://github.com/d3/d3-scale-chromatic/blob/main/README.md
+     */
+    interpolation?: string;
+}
+export declare function generateReportConfiguration(): {
+    report: Partial<ReportConfiguration>;
+};

package/dist/projects/report.js

@@ -1,33 +1,33 @@
-export function generateReportConfiguration() {
-    const report = {
-        theme: "light",
-        includeTransitiveInternal: false,
-        reporters: ["html", "pdf"],
-        charts: [
-            {
-                name: "Extensions",
-                display: true,
-                interpolation: "d3.interpolateRainbow"
-            },
-            {
-                name: "Licenses",
-                display: true,
-                interpolation: "d3.interpolateCool"
-            },
-            {
-                name: "Warnings",
-                display: true,
-                type: "horizontalBar",
-                interpolation: "d3.interpolateInferno"
-            },
-            {
-                name: "Flags",
-                display: true,
-                type: "horizontalBar",
-                interpolation: "d3.interpolateSinebow"
-            }
-        ]
-    };
-    return { report };
-}
+export function generateReportConfiguration() {
+    const report = {
+        theme: "light",
+        includeTransitiveInternal: false,
+        reporters: ["html", "pdf"],
+        charts: [
+            {
+                name: "Extensions",
+                display: true,
+                interpolation: "d3.interpolateRainbow"
+            },
+            {
+                name: "Licenses",
+                display: true,
+                interpolation: "d3.interpolateCool"
+            },
+            {
+                name: "Warnings",
+                display: true,
+                type: "horizontalBar",
+                interpolation: "d3.interpolateInferno"
+            },
+            {
+                name: "Flags",
+                display: true,
+                type: "horizontalBar",
+                interpolation: "d3.interpolateSinebow"
+            }
+        ]
+    };
+    return { report };
+}
 //# sourceMappingURL=report.js.map

package/dist/projects/scanner.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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;
+};
+export declare function generateScannerConfiguration(): {
+    scanner: ScannerConfiguration;
+};

package/dist/projects/scanner.js

@@ -0,0 +1,7 @@
+export function generateScannerConfiguration() {
+    const scanner = {
+        flaggedAuthors: []
+    };
+    return { scanner };
+}
+//# sourceMappingURL=scanner.js.map

package/dist/projects/scanner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanner.js","sourceRoot":"","sources":["../../src/projects/scanner.ts"],"names":[],"mappings":"AAgBA,MAAM,UAAU,4BAA4B;IAC1C,MAAM,OAAO,GAAyB;QACpC,cAAc,EAAE,EAAE;KACnB,CAAC;IAEF,OAAO,EAAE,OAAO,EAAE,CAAC;AACrB,CAAC"}

package/dist/rc.d.ts

@@ -1,40 +1,48 @@
-import i18n from "@nodesecure/i18n";
-import * as vuln from "@nodesecure/vuln";
-import { generateCIConfiguration, CiConfiguration, CiWarnings } from "./projects/ci.js";
-import { generateReportConfiguration, ReportConfiguration, ReportChart } from "./projects/report.js";
-export declare const JSONSchema: any;
-export interface RC {
-    /** version of the rc package used to generate the nodesecurerc file */
-    version: string;
-    /**
-     * Language to use for i18n (translation in NodeSecure tools).
-     * @see https://developer.mozilla.org/en-US/docs/Glossary/I18N
-     * @see https://github.com/NodeSecure/i18n
-     *
-     * @default `english`
-     */
-    i18n?: i18n.languages;
-    /**
-     * Vulnerability strategy to use. Can be disabled by using `none` as value.
-     * @see https://github.com/NodeSecure/vuln#available-strategy
-     *
-     * @default `npm`
-     */
-    strategy?: vuln.Strategy.Kind;
-    /** NodeSecure ci Object configuration */
-    ci?: CiConfiguration;
-    /** NodeSecure report Object configuration */
-    report?: ReportConfiguration;
-}
-export type RCGenerationMode = "minimal" | "ci" | "report" | "complete";
-/**
- * @example
- * generateDefaultRC("complete");
- * generateDefaultRC(["ci", "report"]); // minimal + ci + report
- */
-export declare function generateDefaultRC(mode?: RCGenerationMode | RCGenerationMode[]): RC;
-/**
- * Dedicated directory for NodeSecure to store the configuration in the os HOME directory.
- */
-export declare function homedir(): string;
-export { generateCIConfiguration, CiConfiguration, CiWarnings, generateReportConfiguration, ReportConfiguration, ReportChart };
+import i18n from "@nodesecure/i18n";
+import * as vuln from "@nodesecure/vuln";
+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";
+export declare const JSONSchema: any;
+export interface RC {
+    /** version of the rc package used to generate the nodesecurerc file */
+    version: string;
+    /**
+     * Language to use for i18n (translation in NodeSecure tools).
+     * @see https://developer.mozilla.org/en-US/docs/Glossary/I18N
+     * @see https://github.com/NodeSecure/i18n
+     *
+     * @default `english`
+     */
+    i18n?: i18n.languages;
+    /**
+     * Vulnerability strategy to use. Can be disabled by using `none` as value.
+     * @see https://github.com/NodeSecure/vuln#available-strategy
+     *
+     * @default `npm`
+     */
+    strategy?: vuln.Strategy.Kind;
+    /**
+     * Package Registry (default to NPM public registry)
+     * @default `https://registry.npmjs.org`
+     */
+    registry?: string;
+    /** NodeSecure scanner Object configuration */
+    scanner?: ScannerConfiguration;
+    /** NodeSecure ci Object configuration */
+    ci?: CiConfiguration;
+    /** NodeSecure report Object configuration */
+    report?: ReportConfiguration;
+}
+export type RCGenerationMode = "minimal" | "ci" | "report" | "scanner" | "complete";
+/**
+ * @example
+ * generateDefaultRC("complete");
+ * generateDefaultRC(["ci", "report"]); // minimal + ci + report
+ */
+export declare function generateDefaultRC(mode?: RCGenerationMode | RCGenerationMode[]): RC;
+/**
+ * Dedicated directory for NodeSecure to store the configuration in the os HOME directory.
+ */
+export declare function homedir(): string;
+export { generateCIConfiguration, CiConfiguration, CiWarnings, generateReportConfiguration, ReportConfiguration, ReportChart, generateScannerConfiguration, ScannerConfiguration, Author };

package/dist/rc.js

@@ -1,33 +1,35 @@
-// Import Node.js Dependencies
-import os from "node:os";
-import path from "node:path";
-// Import Internal Dependencies
-import { GLOBAL_CONFIGURATION_DIRECTORY } from "./constants.js";
-import { loadJSONSchemaSync } from "./schema/loader.js";
-import { generateCIConfiguration } from "./projects/ci.js";
-import { generateReportConfiguration } from "./projects/report.js";
-// CONSTANTS
-export const JSONSchema = loadJSONSchemaSync();
-/**
- * @example
- * generateDefaultRC("complete");
- * generateDefaultRC(["ci", "report"]); // minimal + ci + report
- */
-export function generateDefaultRC(mode = "minimal") {
-    const modes = new Set(typeof mode === "string" ? [mode] : mode);
-    const minimalRC = {
-        version: "1.0.0",
-        i18n: "english",
-        strategy: "npm"
-    };
-    const complete = modes.has("complete");
-    return Object.assign(minimalRC, complete || modes.has("ci") ? generateCIConfiguration() : {}, complete || modes.has("report") ? generateReportConfiguration() : {});
-}
-/**
- * Dedicated directory for NodeSecure to store the configuration in the os HOME directory.
- */
-export function homedir() {
-    return path.join(os.homedir(), GLOBAL_CONFIGURATION_DIRECTORY);
-}
-export { generateCIConfiguration, generateReportConfiguration };
+// Import Node.js Dependencies
+import os from "node:os";
+import path from "node:path";
+// Import Internal Dependencies
+import { GLOBAL_CONFIGURATION_DIRECTORY } from "./constants.js";
+import { loadJSONSchemaSync } from "./schema/loader.js";
+import { generateCIConfiguration } from "./projects/ci.js";
+import { generateReportConfiguration } from "./projects/report.js";
+import { generateScannerConfiguration } from "./projects/scanner.js";
+// CONSTANTS
+export const JSONSchema = loadJSONSchemaSync();
+/**
+ * @example
+ * generateDefaultRC("complete");
+ * generateDefaultRC(["ci", "report"]); // minimal + ci + report
+ */
+export function generateDefaultRC(mode = "minimal") {
+    const modes = new Set(typeof mode === "string" ? [mode] : mode);
+    const minimalRC = {
+        version: "1.0.0",
+        i18n: "english",
+        strategy: "npm",
+        registry: "https://registry.npmjs.org"
+    };
+    const complete = modes.has("complete");
+    return Object.assign(minimalRC, complete || modes.has("ci") ? generateCIConfiguration() : {}, complete || modes.has("report") ? generateReportConfiguration() : {}, complete || modes.has("scanner") ? generateScannerConfiguration() : {});
+}
+/**
+ * Dedicated directory for NodeSecure to store the configuration in the os HOME directory.
+ */
+export function homedir() {
+    return path.join(os.homedir(), GLOBAL_CONFIGURATION_DIRECTORY);
+}
+export { generateCIConfiguration, generateReportConfiguration, generateScannerConfiguration };
 //# sourceMappingURL=rc.js.map

package/dist/rc.js.map

@@ -1 +1 @@
-{"version":3,"file":"rc.js","sourceRoot":"","sources":["../src/rc.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAM7B,+BAA+B;AAC/B,OAAO,EAAE,8BAA8B,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAA+B,MAAM,kBAAkB,CAAC;AACxF,OAAO,EAAE,2BAA2B,EAAoC,MAAM,sBAAsB,CAAC;AAErG,YAAY;AACZ,MAAM,CAAC,MAAM,UAAU,GAAG,kBAAkB,EAAE,CAAC;AA4B/C;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAA8C,SAAS;IACvF,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAEhE,MAAM,SAAS,GAAG;QAChB,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,SAAkB;QACxB,QAAQ,EAAE,KAAc;KACzB,CAAC;IACF,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEvC,OAAO,MAAM,CAAC,MAAM,CAClB,SAAS,EACT,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC,EAAE,EAC5D,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,2BAA2B,EAAE,CAAC,CAAC,CAAC,EAAE,CACrE,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,OAAO;IACrB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,8BAA8B,CAAC,CAAC;AACjE,CAAC;AAED,OAAO,EACL,uBAAuB,EAIvB,2BAA2B,EAG5B,CAAC"}
+{"version":3,"file":"rc.js","sourceRoot":"","sources":["../src/rc.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAM7B,+BAA+B;AAC/B,OAAO,EAAE,8BAA8B,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,OAAO,EAAE,uBAAuB,EAAyC,MAAM,kBAAkB,CAAC;AAClG,OAAO,EAAE,2BAA2B,EAA8C,MAAM,sBAAsB,CAAC;AAC/G,OAAO,EAAE,4BAA4B,EAA0C,MAAM,uBAAuB,CAAC;AAE7G,YAAY;AACZ,MAAM,CAAC,MAAM,UAAU,GAAG,kBAAkB,EAAE,CAAC;AAmC/C;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAA8C,SAAS;IACvF,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAEhE,MAAM,SAAS,GAAG;QAChB,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,SAAkB;QACxB,QAAQ,EAAE,KAAc;QACxB,QAAQ,EAAE,4BAA4B;KACvC,CAAC;IACF,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEvC,OAAO,MAAM,CAAC,MAAM,CAClB,SAAS,EACT,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC,EAAE,EAC5D,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,2BAA2B,EAAE,CAAC,CAAC,CAAC,EAAE,EACpE,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,4BAA4B,EAAE,CAAC,CAAC,CAAC,EAAE,CACvE,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,OAAO;IACrB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,8BAA8B,CAAC,CAAC;AACjE,CAAC;AAED,OAAO,EACL,uBAAuB,EAIvB,2BAA2B,EAI3B,4BAA4B,EAG7B,CAAC"}

package/dist/schema/defs/author.json

@@ -0,0 +1,13 @@
+{
+    "type": "object",
+    "properties": {
+        "name": {
+            "type": "string"
+        },
+        "email": {
+            "type": "string"
+        }
+    },
+    "required": ["name", "email"],
+    "additionalProperties": false
+}

package/dist/schema/defs/ci.json

@@ -1,58 +1,58 @@
-{
-    "type": "object",
-    "properties": {
-        "reporters": {
-            "type": "array",
-            "uniqueItems": true,
-            "items": {
-                "type": "string",
-                "enum": [
-                    "html",
-                    "console"
-                ]
-            },
-            "default": [
-                "console"
-            ]
-        },
-        "vulnerabilities": {
-            "type": "object",
-            "properties": {
-                "severity": {
-                    "type": "string",
-                    "enum": [
-                        "medium",
-                        "high",
-                        "critical",
-                        "all"
-                    ],
-                    "default": "all"
-                }
-            },
-            "additionalProperties": false
-        },
-        "warnings": {
-            "default": "off",
-            "description": "JS-X-Ray warnings configuration",
-            "oneOf": [
-                {
-                    "$ref": "#/$defs/ciWarnings"
-                },
-                {
-                    "type": "object",
-                    "minProperties": 1,
-                    "patternProperties": {
-                        "^[A-Za-z-]+$": {
-                            "$ref": "#/$defs/ciWarnings"
-                        }
-                    }
-                }
-            ]
-        }
-    },
-    "required": [
-        "reporters",
-        "warnings"
-    ],
-    "additionalProperties": false
-}
+{
+    "type": "object",
+    "properties": {
+        "reporters": {
+            "type": "array",
+            "uniqueItems": true,
+            "items": {
+                "type": "string",
+                "enum": [
+                    "html",
+                    "console"
+                ]
+            },
+            "default": [
+                "console"
+            ]
+        },
+        "vulnerabilities": {
+            "type": "object",
+            "properties": {
+                "severity": {
+                    "type": "string",
+                    "enum": [
+                        "medium",
+                        "high",
+                        "critical",
+                        "all"
+                    ],
+                    "default": "all"
+                }
+            },
+            "additionalProperties": false
+        },
+        "warnings": {
+            "default": "off",
+            "description": "JS-X-Ray warnings configuration",
+            "oneOf": [
+                {
+                    "$ref": "#/$defs/ciWarnings"
+                },
+                {
+                    "type": "object",
+                    "minProperties": 1,
+                    "patternProperties": {
+                        "^[A-Za-z-]+$": {
+                            "$ref": "#/$defs/ciWarnings"
+                        }
+                    }
+                }
+            ]
+        }
+    },
+    "required": [
+        "reporters",
+        "warnings"
+    ],
+    "additionalProperties": false
+}

package/dist/schema/defs/ciWarnings.json

@@ -1,8 +1,8 @@
-{
-    "type": "string",
-    "enum": [
-        "off",
-        "error",
-        "warning"
-    ]
-}
+{
+    "type": "string",
+    "enum": [
+        "off",
+        "error",
+        "warning"
+    ]
+}