@candidpartners/snitch-types - npm Package Compare versions

Comparing version 2.9.10 to 2.9.11

CHANGELOG.md

@@ -7,2 +7,15 @@ # Changelog
 
+## [2.9.11] - 2021-06-15
+### Added:
+- ProviderType - Cloud provider type.
+- SnitchScanType - Matter Compliance Engine scan type.
+
+### Changed:
+- TSnitchConfigMetadata
+  - id - updated to readonly.
+  - saveOutput - true/false flag, when true persist Terraform plan and directed graph output to file.
+  - scanType type updated to SnitchScanType.
+  - provider type updated to ProviderType.
+  - version - updated to readonly.
+
 ## [2.9.10] - 2021-06-07
@@ -9,0 +22,0 @@ ### Added:

lib/types/snitch-config.d.ts

@@ -6,4 +6,6 @@ import { IAwsConfigEvent } from "./aws-config-event";
 import { IStatistics, IResult } from "./rule-result";
+export declare type ProviderType = "aws" | "azure" | "gcp";
 export declare type SnitchRuleSeverity = "off" | "info" | "warn" | "error";
 export declare type SnitchRuleProtection = "read-only" | "amend" | "replace" | "remove";
+export declare type SnitchScanType = "static" | "livecheck";
 export interface ISnitchConfigError {
@@ -36,14 +38,54 @@ type: "MISSING_RULE" | "INVALID CONFIG" | "PROTECTED RULE";
 };
+/**
+ * Matter Compliance Engine configuration metadata.
+ */
 export declare type TSnitchConfigMetadata = {
-    id: string;
-    version: string;
+    /**
+     * Label the cloud provider account name/id for the check.
+     */
+    account?: string;
+    /**
+     * Date time the Compliance Engine check completed.
+     */
+    endTime: Date | null;
+    /**
+     * Unique identifier for the Matter Compliance Engine check.
+     */
+    readonly id: string;
+    /**
+     * Label the provider for the check (aws, azure, gcp).
+     */
+    provider?: ProviderType;
+    /**
+     * Label the region for the check.
+     */
+    region?: string;
+    /**
+     * When true, persist Terraform plan and directed graph output to files.
+     */
+    saveOutput: boolean;
+    /**
+     * Silence console log output except the reporter.
+     */
+    silent: boolean;
+    /**
+     * Type of Compliance Engine check being performed.
+     */
+    scanType: SnitchScanType | null;
+    /**
+     * Date time the Compliance Engine check began.
+     */
     startTime: Date;
-    endTime?: Date;
-    scanType?: "static" | "livecheck";
+    /**
+     * Label the trigger/source for the check (git, awsConfig, etc).
+     */
     trigger?: string;
+    /**
+     * Provide additional trigger source details as a JSON encoded string.
+     */
     triggerDetails?: any;
-    provider?: "aws" | "azure" | "gcp";
-    region?: string;
-    account?: string;
-    silent?: boolean;
+    /**
+     * Matter Compliance Engine `snitch-core` version.
+     */
+    readonly version: string;
 };
@@ -50,0 +92,0 @@ /**

package.json

@@ -23,3 +23,3 @@ {
   "types": "./lib/types/index.d.ts",
-  "version": "2.9.10",
+  "version": "2.9.11",
   "scripts": {
@@ -26,0 +26,0 @@ "prebuild": "rm -rf ./lib",

No alert changes

Improved metrics

Total package byte prevSize

133055

increased by1.18%

Lines of code

2388

increased by1.79%

No dependency changes