@candidpartners/snitch-types - npm Package Compare versions

Comparing version 2.9.6 to 2.9.7

CHANGELOG.md

@@ -7,2 +7,7 @@ # Changelog
 
+## [2.9.7] - 2021-05-25
+### Added:
+- ISnitchFormatterMetadata - Formatter metadata used to output summary level results and statistics.
+- installed typedoc devDependency and created docs npm script to generate library JavaScript API documentation.
+
 ## [2.9.6] - 2021-05-21
@@ -9,0 +14,0 @@ ### Added:

lib/types/snitch-config.d.ts

@@ -48,4 +48,31 @@ import { IAwsConfigEvent } from "./aws-config-event";
 };
+/**
+ * Formatter metadata used to output summary level results and statistics.
+ */
+export interface ISnitchFormatterMetadata {
+    /**
+     * Compliance Engine aggregate rule result.
+     */
+    ruleStatistics?: IStatistics[];
+    /**
+     * Compliance Engine scanned rules result.
+     */
+    scanResult?: IResult;
+    /**
+     * Compliance Engine aggregate scanned rules results.
+     */
+    scanStatistics?: IStatistics;
+    /**
+     * Compliance Engine CLI messages to report.
+     */
+    messages?: IMessages;
+}
+/**
+ * Configure Matter Compliance Engine reporter, used to report formatted output.
+ */
 export interface ISnitchReporter {
-    reportResults: (snitchResult: ISnitchRuleResult[], config: ISnitchConfig, ruleStatistics?: IStatistics[], scanResult?: IResult, scanStatistics?: IStatistics, messages?: IMessages) => Promise<any>;
+    /**
+     * Compliance Engine results to report.
+     */
+    reportResults: (snitchResult: ISnitchRuleResult[], config: ISnitchConfig, metadata?: ISnitchFormatterMetadata) => Promise<any>;
 }
@@ -52,0 +79,0 @@ export interface ISnitchRetriever {

package.json

@@ -23,3 +23,3 @@ {
   "types": "./lib/types/index.d.ts",
-  "version": "2.9.6",
+  "version": "2.9.7",
   "scripts": {
@@ -32,2 +32,3 @@ "prebuild": "rm -rf ./lib",
     "build:watch": "node --max-old-space-size=2048 node_modules/typescript/bin/tsc --watch -p tsconfig.json",
+    "docs": "typedoc --out lib/docs src/",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
@@ -73,4 +74,5 @@ "lint:fix": "eslint . --ext .js,.jsx,.ts,.tsx --fix",
     "ts-node": "^9.0.0",
+    "typedoc": "^0.20.36",
     "typescript": "^4.0.3"
   }
 }

No alert changes

Improved metrics

Total package byte prevSize

80776

increased by1.15%

Lines of code

1363

increased by2.02%

Worsened metrics

Dev dependency count

33

increased by3.13%

No dependency changes