@snyk/error-catalog-nodejs-public - npm Package Compare versions

Comparing version 5.41.0 to 5.42.0

package.json

 {
   "name": "@snyk/error-catalog-nodejs-public",
-  "version": "5.41.0",
+  "version": "5.42.0",
   "type": "commonjs",
@@ -5,0 +5,0 @@ "author": "snyk.io",

src/catalogs/CLI-error-catalog.d.ts

@@ -79,3 +79,3 @@ /*
  * @class
- * @name EmptyFlagOptionIssueError
+ * @name EmptyFlagOptionError
  * @description A specified flag is missing an option value. Provide a correct option value and try again.
@@ -94,3 +94,3 @@ *
  */
-export declare class EmptyFlagOptionIssueError extends ProblemError {
+export declare class EmptyFlagOptionError extends ProblemError {
     constructor(details: string, additionalData?: Record<string, any>, cause?: Error, instance?: string, logs?: string[]);
@@ -100,3 +100,3 @@ }
  * @class
- * @name InvalidFlagOptionIssueError
+ * @name InvalidFlagOptionError
  * @description A specified flag option or combination is invalid. Provide a valid flag option or combination and try again.
@@ -115,3 +115,3 @@ *
  */
-export declare class InvalidFlagOptionIssueError extends ProblemError {
+export declare class InvalidFlagOptionError extends ProblemError {
     constructor(details: string, additionalData?: Record<string, any>, cause?: Error, instance?: string, logs?: string[]);
@@ -137,3 +137,3 @@ }
  * @class
- * @name AuthConfigIssueError
+ * @name AuthConfigError
  * @description When running your command, Snyk requires an authenticated account. You must include your API token as an environment value, or use `snyk auth` to authenticate.
@@ -153,3 +153,3 @@ *
  */
-export declare class AuthConfigIssueError extends ProblemError {
+export declare class AuthConfigError extends ProblemError {
     constructor(details: string, additionalData?: Record<string, any>, cause?: Error, instance?: string, logs?: string[]);
@@ -159,3 +159,3 @@ }
  * @class
- * @name CommandArgsIssueError
+ * @name CommandArgsError
  * @description The specified CLI command includes missing or misconfigured arguments. Provide the correct arguments and try again.
@@ -174,3 +174,3 @@ *
  */
-export declare class CommandArgsIssueError extends ProblemError {
+export declare class CommandArgsError extends ProblemError {
     constructor(details: string, additionalData?: Record<string, any>, cause?: Error, instance?: string, logs?: string[]);
@@ -180,3 +180,3 @@ }
  * @class
- * @name NoSupportedFilesFoundFailureError
+ * @name NoSupportedFilesFoundError
  * @description Snyk could not detect any supported target files. Ensure the files you are importing are supported, that you are in the right directory, and try again.
@@ -195,3 +195,3 @@ *
  */
-export declare class NoSupportedFilesFoundFailureError extends ProblemError {
+export declare class NoSupportedFilesFoundError extends ProblemError {
     constructor(details: string, additionalData?: Record<string, any>, cause?: Error, instance?: string, logs?: string[]);
@@ -201,3 +201,3 @@ }
  * @class
- * @name TooManyVulnerablePathsFailureError
+ * @name TooManyVulnerablePathsError
  * @description There are too many vulnerable paths to process the project. If your command supports it, consider the following:pruning repeated subdependencies (`snyk test -p`); excluding directories (`snyk test --all-projects --exclude=dir1,file2`); setting a detection depth (`snyk test --all-projects --detection-depth=3`). If the error still occurs, consider debugging or contact Snyk Support.
@@ -219,3 +219,3 @@ *
  */
-export declare class TooManyVulnerablePathsFailureError extends ProblemError {
+export declare class TooManyVulnerablePathsError extends ProblemError {
     constructor(details: string, additionalData?: Record<string, any>, cause?: Error, instance?: string, logs?: string[]);
@@ -241,2 +241,59 @@ }
  * @class
+ * @name GeneralSCAFailureError
+ * @description CLI was unable to execute your SCA command, please take a look at the given details.If they do not help to resolve the issue, consider debugging or consulting support.
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-cli/commands/test](https://docs.snyk.io/snyk-cli/commands/test)
+ * @summary SCA failure
+ * @category CLI
+ * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
+ * @param {Classification} classification          the error classification determining if the error is user-actionable or not
+ * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
+ * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+export declare class GeneralSCAFailureError extends ProblemError {
+    constructor(details: string, additionalData?: Record<string, any>, cause?: Error, instance?: string, logs?: string[]);
+}
+/**
+ * @class
+ * @name GeneralIACFailureError
+ * @description CLI was unable to execute your IAC command, please take a look at the given details.If they do not help to resolve the issue, consider debugging or consulting support.
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-cli/commands/iac](https://docs.snyk.io/snyk-cli/commands/iac)
+ * @summary IAC failue
+ * @category CLI
+ * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
+ * @param {Classification} classification          the error classification determining if the error is user-actionable or not
+ * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
+ * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+export declare class GeneralIACFailureError extends ProblemError {
+    constructor(details: string, additionalData?: Record<string, any>, cause?: Error, instance?: string, logs?: string[]);
+}
+/**
+ * @class
+ * @name GeneralSASTFailureError
+ * @description CLI was unable to execute your SAST command, please take a look at the given details.If they do not help to resolve the issue, consider debugging or consulting support.
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-cli/commands/code](https://docs.snyk.io/snyk-cli/commands/code)
+ * @summary SAST failure
+ * @category CLI
+ * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
+ * @param {Classification} classification          the error classification determining if the error is user-actionable or not
+ * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
+ * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+export declare class GeneralSASTFailureError extends ProblemError {
+    constructor(details: string, additionalData?: Record<string, any>, cause?: Error, instance?: string, logs?: string[]);
+}
+/**
+ * @class
  * @name ConnectionTimeoutError
@@ -243,0 +300,0 @@ * @description A request to the Snyk API has unexpectedly timeout. Check Snyk status, then try again.

src/catalogs/CLI-error-catalog.js

@@ -18,3 +18,3 @@ /*
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConnectionTimeoutError = exports.ValidationFailureError = exports.TooManyVulnerablePathsFailureError = exports.NoSupportedFilesFoundFailureError = exports.CommandArgsIssueError = exports.AuthConfigIssueError = exports.GetVulnsFromResourceFailedError = exports.InvalidFlagOptionIssueError = exports.EmptyFlagOptionIssueError = exports.ConfigEnvironmentConsistencyIssueError = exports.ConfigEnvironmentFailedError = exports.GeneralCLIFailureError = void 0;
+exports.ConnectionTimeoutError = exports.GeneralSASTFailureError = exports.GeneralIACFailureError = exports.GeneralSCAFailureError = exports.ValidationFailureError = exports.TooManyVulnerablePathsError = exports.NoSupportedFilesFoundError = exports.CommandArgsError = exports.AuthConfigError = exports.GetVulnsFromResourceFailedError = exports.InvalidFlagOptionError = exports.EmptyFlagOptionError = exports.ConfigEnvironmentConsistencyIssueError = exports.ConfigEnvironmentFailedError = exports.GeneralCLIFailureError = void 0;
 const types_1 = require("../types");
@@ -132,3 +132,3 @@ const problem_error_1 = require("../problem-error");
  * @class
- * @name EmptyFlagOptionIssueError
+ * @name EmptyFlagOptionError
  * @description A specified flag is missing an option value. Provide a correct option value and try again.
@@ -147,3 +147,3 @@ *
  */
-class EmptyFlagOptionIssueError extends problem_error_1.ProblemError {
+class EmptyFlagOptionError extends problem_error_1.ProblemError {
     constructor(details, additionalData, cause, instance, logs) {
@@ -165,6 +165,6 @@ super({
 }
-exports.EmptyFlagOptionIssueError = EmptyFlagOptionIssueError;
+exports.EmptyFlagOptionError = EmptyFlagOptionError;
 /**
  * @class
- * @name InvalidFlagOptionIssueError
+ * @name InvalidFlagOptionError
  * @description A specified flag option or combination is invalid. Provide a valid flag option or combination and try again.
@@ -183,3 +183,3 @@ *
  */
-class InvalidFlagOptionIssueError extends problem_error_1.ProblemError {
+class InvalidFlagOptionError extends problem_error_1.ProblemError {
     constructor(details, additionalData, cause, instance, logs) {
@@ -201,3 +201,3 @@ super({
 }
-exports.InvalidFlagOptionIssueError = InvalidFlagOptionIssueError;
+exports.InvalidFlagOptionError = InvalidFlagOptionError;
 /**
@@ -234,3 +234,3 @@ * @class
  * @class
- * @name AuthConfigIssueError
+ * @name AuthConfigError
  * @description When running your command, Snyk requires an authenticated account. You must include your API token as an environment value, or use `snyk auth` to authenticate.
@@ -250,3 +250,3 @@ *
  */
-class AuthConfigIssueError extends problem_error_1.ProblemError {
+class AuthConfigError extends problem_error_1.ProblemError {
     constructor(details, additionalData, cause, instance, logs) {
@@ -269,6 +269,6 @@ super({
 }
-exports.AuthConfigIssueError = AuthConfigIssueError;
+exports.AuthConfigError = AuthConfigError;
 /**
  * @class
- * @name CommandArgsIssueError
+ * @name CommandArgsError
  * @description The specified CLI command includes missing or misconfigured arguments. Provide the correct arguments and try again.
@@ -287,3 +287,3 @@ *
  */
-class CommandArgsIssueError extends problem_error_1.ProblemError {
+class CommandArgsError extends problem_error_1.ProblemError {
     constructor(details, additionalData, cause, instance, logs) {
@@ -305,6 +305,6 @@ super({
 }
-exports.CommandArgsIssueError = CommandArgsIssueError;
+exports.CommandArgsError = CommandArgsError;
 /**
  * @class
- * @name NoSupportedFilesFoundFailureError
+ * @name NoSupportedFilesFoundError
  * @description Snyk could not detect any supported target files. Ensure the files you are importing are supported, that you are in the right directory, and try again.
@@ -323,3 +323,3 @@ *
  */
-class NoSupportedFilesFoundFailureError extends problem_error_1.ProblemError {
+class NoSupportedFilesFoundError extends problem_error_1.ProblemError {
     constructor(details, additionalData, cause, instance, logs) {
@@ -341,6 +341,6 @@ super({
 }
-exports.NoSupportedFilesFoundFailureError = NoSupportedFilesFoundFailureError;
+exports.NoSupportedFilesFoundError = NoSupportedFilesFoundError;
 /**
  * @class
- * @name TooManyVulnerablePathsFailureError
+ * @name TooManyVulnerablePathsError
  * @description There are too many vulnerable paths to process the project. If your command supports it, consider the following:pruning repeated subdependencies (`snyk test -p`); excluding directories (`snyk test --all-projects --exclude=dir1,file2`); setting a detection depth (`snyk test --all-projects --detection-depth=3`). If the error still occurs, consider debugging or contact Snyk Support.
@@ -362,3 +362,3 @@ *
  */
-class TooManyVulnerablePathsFailureError extends problem_error_1.ProblemError {
+class TooManyVulnerablePathsError extends problem_error_1.ProblemError {
     constructor(details, additionalData, cause, instance, logs) {
@@ -383,3 +383,3 @@ super({
 }
-exports.TooManyVulnerablePathsFailureError = TooManyVulnerablePathsFailureError;
+exports.TooManyVulnerablePathsError = TooManyVulnerablePathsError;
 /**
@@ -416,2 +416,104 @@ * @class
  * @class
+ * @name GeneralSCAFailureError
+ * @description CLI was unable to execute your SCA command, please take a look at the given details.If they do not help to resolve the issue, consider debugging or consulting support.
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-cli/commands/test](https://docs.snyk.io/snyk-cli/commands/test)
+ * @summary SCA failure
+ * @category CLI
+ * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
+ * @param {Classification} classification          the error classification determining if the error is user-actionable or not
+ * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
+ * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+class GeneralSCAFailureError extends problem_error_1.ProblemError {
+    constructor(details, additionalData, cause, instance, logs) {
+        super({
+            title: 'SCA failure',
+            type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-cli-0011',
+            status: 200,
+            description: `CLI was unable to execute your SCA command, please take a look at the given details.If they do not help to resolve the issue, consider debugging or consulting support.`,
+            errorCode: 'SNYK-CLI-0011',
+            level: 'error',
+            classification: types_1.Classification.UNEXPECTED,
+            instance,
+        }, details, Object.assign({ links: [
+                'https://docs.snyk.io/snyk-cli/commands/test',
+            ] }, additionalData), cause, logs);
+        this.name = this.constructor.name;
+    }
+}
+exports.GeneralSCAFailureError = GeneralSCAFailureError;
+/**
+ * @class
+ * @name GeneralIACFailureError
+ * @description CLI was unable to execute your IAC command, please take a look at the given details.If they do not help to resolve the issue, consider debugging or consulting support.
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-cli/commands/iac](https://docs.snyk.io/snyk-cli/commands/iac)
+ * @summary IAC failue
+ * @category CLI
+ * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
+ * @param {Classification} classification          the error classification determining if the error is user-actionable or not
+ * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
+ * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+class GeneralIACFailureError extends problem_error_1.ProblemError {
+    constructor(details, additionalData, cause, instance, logs) {
+        super({
+            title: 'IAC failue',
+            type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-cli-0012',
+            status: 200,
+            description: `CLI was unable to execute your IAC command, please take a look at the given details.If they do not help to resolve the issue, consider debugging or consulting support.`,
+            errorCode: 'SNYK-CLI-0012',
+            level: 'error',
+            classification: types_1.Classification.UNEXPECTED,
+            instance,
+        }, details, Object.assign({ links: [
+                'https://docs.snyk.io/snyk-cli/commands/iac',
+            ] }, additionalData), cause, logs);
+        this.name = this.constructor.name;
+    }
+}
+exports.GeneralIACFailureError = GeneralIACFailureError;
+/**
+ * @class
+ * @name GeneralSASTFailureError
+ * @description CLI was unable to execute your SAST command, please take a look at the given details.If they do not help to resolve the issue, consider debugging or consulting support.
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-cli/commands/code](https://docs.snyk.io/snyk-cli/commands/code)
+ * @summary SAST failure
+ * @category CLI
+ * @param {string} details                         the specific details that causes this error
+ * @param {string} description                     the general description for this error
+ * @param {Classification} classification          the error classification determining if the error is user-actionable or not
+ * @param {Record<string, any>} [additionalData]   a collection of relevant data specific to this error
+ * @param {Error} [cause]                          the `Error` type that caused this error to be thrown
+ * @param {string} [instance]                      the instance to use for this error. Overrides 'instance' metadata
+ */
+class GeneralSASTFailureError extends problem_error_1.ProblemError {
+    constructor(details, additionalData, cause, instance, logs) {
+        super({
+            title: 'SAST failure',
+            type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-cli-0013',
+            status: 200,
+            description: `CLI was unable to execute your SAST command, please take a look at the given details.If they do not help to resolve the issue, consider debugging or consulting support.`,
+            errorCode: 'SNYK-CLI-0013',
+            level: 'error',
+            classification: types_1.Classification.UNEXPECTED,
+            instance,
+        }, details, Object.assign({ links: [
+                'https://docs.snyk.io/snyk-cli/commands/code',
+            ] }, additionalData), cause, logs);
+        this.name = this.constructor.name;
+    }
+}
+exports.GeneralSASTFailureError = GeneralSASTFailureError;
+/**
+ * @class
  * @name ConnectionTimeoutError
@@ -418,0 +520,0 @@ * @description A request to the Snyk API has unexpectedly timeout. Check Snyk status, then try again.

src/catalogs/error-codes.d.ts

@@ -246,10 +246,13 @@ /*
         ConfigEnvironmentConsistencyIssue: string;
-        EmptyFlagOptionIssue: string;
-        InvalidFlagOptionIssue: string;
+        EmptyFlagOption: string;
+        InvalidFlagOption: string;
         GetVulnsFromResourceFailed: string;
-        AuthConfigIssue: string;
-        CommandArgsIssue: string;
-        NoSupportedFilesFoundFailure: string;
-        TooManyVulnerablePathsFailure: string;
+        AuthConfig: string;
+        CommandArgs: string;
+        NoSupportedFilesFound: string;
+        TooManyVulnerablePaths: string;
         ValidationFailure: string;
+        GeneralSCAFailure: string;
+        GeneralIACFailure: string;
+        GeneralSASTFailure: string;
         ConnectionTimeout: string;
@@ -256,0 +259,0 @@ };

src/catalogs/error-codes.js

@@ -248,10 +248,13 @@ /*
         ConfigEnvironmentConsistencyIssue: 'SNYK-CLI-0002',
-        EmptyFlagOptionIssue: 'SNYK-CLI-0003',
-        InvalidFlagOptionIssue: 'SNYK-CLI-0004',
+        EmptyFlagOption: 'SNYK-CLI-0003',
+        InvalidFlagOption: 'SNYK-CLI-0004',
         GetVulnsFromResourceFailed: 'SNYK-CLI-0005',
-        AuthConfigIssue: 'SNYK-CLI-0006',
-        CommandArgsIssue: 'SNYK-CLI-0007',
-        NoSupportedFilesFoundFailure: 'SNYK-CLI-0008',
-        TooManyVulnerablePathsFailure: 'SNYK-CLI-0009',
+        AuthConfig: 'SNYK-CLI-0006',
+        CommandArgs: 'SNYK-CLI-0007',
+        NoSupportedFilesFound: 'SNYK-CLI-0008',
+        TooManyVulnerablePaths: 'SNYK-CLI-0009',
         ValidationFailure: 'SNYK-CLI-0010',
+        GeneralSCAFailure: 'SNYK-CLI-0011',
+        GeneralIACFailure: 'SNYK-CLI-0012',
+        GeneralSASTFailure: 'SNYK-CLI-0013',
         ConnectionTimeout: 'SNYK-OS-7001',
@@ -258,0 +261,0 @@ },

No alert changes

Improved metrics

Total package byte prevSize

1000207

increased by1.11%

Lines of code

14535

increased by1.15%

No dependency changes