@snyk/error-catalog-nodejs-public 5.30.0 → 5.30.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snyk/error-catalog-nodejs-public",
-  "version": "5.30.0",
+  "version": "5.30.2",
   "type": "commonjs",
   "author": "snyk.io",
   "license": "Apache-2.0",
@@ -12,5 +12,6 @@
     "uuid": "^9.0.0",
     "tslib": "^2.6.2"
   },
-  "main": "./src/index.js"
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts"
 }

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

@@ -18,6 +18,9 @@ import { ProblemError } from '../problem-error';
  * @class
  * @name ConfigEnvironmentFailedError
  * @description The specified environment cannot be used. As a result, the configuration remains unchanged.Provide the correct specifications for the environment and try again.
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-cli/commands/config-environment](https://docs.snyk.io/snyk-cli/commands/config-environment)
  * @summary Unable to set environment
  * @category CLI
  * @param {string} details                         the specific details that causes this error
@@ -32,10 +35,13 @@ export declare class ConfigEnvironmentFailedError extends ProblemError {
 /**
  * @class
  * @name ConfigEnvironmentConsistencyIssueError
- * @description There are different ways of configuring the CLI, for example via Environment Variables or configuration file.
+ * @description You can configure the CLI in different ways, for example via Environment Variables or configuration file.
  * If one parameter is configured multiple times, it is probably unintentional and might cause unexpected behaviour.
  * Review configured environment variables and ensure that everything is intentional. If so, you can skip this check by using --no-check.
- * @summary Possible inconsistent configuration detected
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-cli/commands/config-environment](https://docs.snyk.io/snyk-cli/commands/config-environment)
+ * @summary Possible inconsistent configuration
  * @category CLI
  * @param {string} details                         the specific details that causes this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not

package/src/catalogs/CLI-error-catalog.js

@@ -22,6 +22,9 @@ const problem_error_1 = require("../problem-error");
  * @class
  * @name ConfigEnvironmentFailedError
  * @description The specified environment cannot be used. As a result, the configuration remains unchanged.Provide the correct specifications for the environment and try again.
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-cli/commands/config-environment](https://docs.snyk.io/snyk-cli/commands/config-environment)
  * @summary Unable to set environment
  * @category CLI
  * @param {string} details                         the specific details that causes this error
@@ -40,7 +43,9 @@ class ConfigEnvironmentFailedError extends problem_error_1.ProblemError {
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
             instance,
-        }, details, Object.assign({ links: [] }, additionalData), cause, logs);
+        }, details, Object.assign({ links: [
+                'https://docs.snyk.io/snyk-cli/commands/config-environment',
+            ] }, additionalData), cause, logs);
         this.name = this.constructor.name;
     }
 }
@@ -48,10 +53,13 @@ exports.ConfigEnvironmentFailedError = ConfigEnvironmentFailedError;
 /**
  * @class
  * @name ConfigEnvironmentConsistencyIssueError
- * @description There are different ways of configuring the CLI, for example via Environment Variables or configuration file.
+ * @description You can configure the CLI in different ways, for example via Environment Variables or configuration file.
  * If one parameter is configured multiple times, it is probably unintentional and might cause unexpected behaviour.
  * Review configured environment variables and ensure that everything is intentional. If so, you can skip this check by using --no-check.
- * @summary Possible inconsistent configuration detected
+ *
+ * See more:
+ * - [https://docs.snyk.io/snyk-cli/commands/config-environment](https://docs.snyk.io/snyk-cli/commands/config-environment)
+ * @summary Possible inconsistent configuration
  * @category CLI
  * @param {string} details                         the specific details that causes this error
  * @param {Classification} classification          the error classification determining if the error is user-actionable or not
@@ -62,14 +70,16 @@ exports.ConfigEnvironmentFailedError = ConfigEnvironmentFailedError;
 class ConfigEnvironmentConsistencyIssueError extends problem_error_1.ProblemError {
     constructor(details, additionalData, cause, instance, logs) {
         super({
-            title: 'Possible inconsistent configuration detected',
+            title: 'Possible inconsistent configuration',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-cli-0002',
             status: 200,
             errorCode: 'SNYK-CLI-0002',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
             instance,
-        }, details, Object.assign({ links: [] }, additionalData), cause, logs);
+        }, details, Object.assign({ links: [
+                'https://docs.snyk.io/snyk-cli/commands/config-environment',
+            ] }, additionalData), cause, logs);
         this.name = this.constructor.name;
     }
 }

package/src/catalogs/CLI-error-catalog.js.map

@@ -1 +1 @@
-{"version":3,"file":"CLI-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/CLI-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;GAWG;AACH,MAAa,4BAA6B,SAAQ,4BAAY;IAC5D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,2BAA2B;YAClC,IAAI,EAAE,iEAAiE;YACvE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,eAAe;YAC1B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA5BD,oEA4BC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAa,sCAAuC,SAAQ,4BAAY;IACtE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,8CAA8C;YACrD,IAAI,EAAE,iEAAiE;YACvE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,eAAe;YAC1B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA5BD,wFA4BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,sBAAuB,SAAQ,4BAAY;IACtD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,6BAA6B;YACpC,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,yBAAyB;aACxB,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,wDA8BC"}
+{"version":3,"file":"CLI-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/CLI-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;;;GAcG;AACH,MAAa,4BAA6B,SAAQ,4BAAY;IAC5D,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,2BAA2B;YAClC,IAAI,EAAE,iEAAiE;YACvE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,eAAe;YAC1B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,2DAA2D;aAC1D,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,oEA8BC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,sCAAuC,SAAQ,4BAAY;IACtE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,qCAAqC;YAC5C,IAAI,EAAE,iEAAiE;YACvE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,eAAe;YAC1B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,2DAA2D;aAC1D,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,wFA8BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,sBAAuB,SAAQ,4BAAY;IACtD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,6BAA6B;YACpC,IAAI,EAAE,gEAAgE;YACtE,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,cAAc;YACzB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,yBAAyB;aACxB,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,wDA8BC"}

package/src/catalogs/OpenSourceEcosystems-error-catalog.d.ts

@@ -159,7 +159,7 @@ export declare class BrokeredConnectionNotSupportedError extends ProblemError {
  *
  * * Your provided credentials are correct or not scoped too narrowly.
  * * The branch you've asked us to clone exists.
- * * The repository you've provided is accessible from the internet is you are not connected through a broker.
+ * * The repository you've provided is accessible from the internet and you are not connected through a broker.
  *
  * And try the operation again.
  * @summary Snyk failed to clone your repository

package/src/catalogs/OpenSourceEcosystems-error-catalog.js

@@ -274,7 +274,7 @@ exports.BrokeredConnectionNotSupportedError = BrokeredConnectionNotSupportedErro
  *
  * * Your provided credentials are correct or not scoped too narrowly.
  * * The branch you've asked us to clone exists.
- * * The repository you've provided is accessible from the internet is you are not connected through a broker.
+ * * The repository you've provided is accessible from the internet and you are not connected through a broker.
  *
  * And try the operation again.
  * @summary Snyk failed to clone your repository