@snyk/error-catalog-nodejs-public 5.32.2 → 5.34.0

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

@@ -36,6 +36,7 @@ const problem_error_1 = require("../problem-error");
  * @summary Error reading manifest
  * @category PRChecks
  * @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
@@ -47,6 +48,15 @@ class FailedToReadManifestError extends problem_error_1.ProblemError {
             title: 'Error reading manifest',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-pr-check-0001',
             status: 500,
+            description: `Snyk failed to read 1 or more manifest files.
+Sometimes things go wrong: a flaky connection, 3rd party services go down and Snyk is unable to read the files needed in order to test your project. 
+
+If this happens, you could try:
+
+- Opening and re-opening your Pull Request / Merge Request, to kick off a new test
+- Removing and re-adding the repo to Snyk
+
+Ultimately, you should contact support@snyk.io if the issue persists`,
             errorCode: 'SNYK-PR-CHECK-0001',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -75,6 +85,7 @@ exports.FailedToReadManifestError = FailedToReadManifestError;
  * @summary Manifest not found
  * @category PRChecks
  * @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
@@ -86,6 +97,14 @@ class ManifestNotFoundError extends problem_error_1.ProblemError {
             title: 'Manifest not found',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-pr-check-0002',
             status: 404,
+            description: `Snyk uses your project manifest file to analyze your projects for vulnerabilities. When you import a project for monitoring, Snyk scans the project to locate the manifest file and then remembers where that file is. 
+When a project manifest file is moved or deleted, we still try to look for in it in the last known location in order to run tests on commit statuses. If we can't find the file, this error can occur.
+
+If this happens, you could try the following:
+1. Delete the matching project from your account in the Snyk app (UI or CLI).
+2. Now import the same project from scratch.
+
+As during the original import, Snyk scans the project and locates the manifest file.`,
             errorCode: 'SNYK-PR-CHECK-0002',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -106,6 +125,7 @@ exports.ManifestNotFoundError = ManifestNotFoundError;
  * @summary Rate limit hit while testing project
  * @category PRChecks
  * @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
@@ -117,6 +137,9 @@ class ThirdPartyRateLimitError extends problem_error_1.ProblemError {
             title: 'Rate limit hit while testing project',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-pr-check-0003',
             status: 429,
+            description: `Snyk makes requests to your SCM when testing a project, in order to analyze your projects for vulnerabilities. If we need to make a lot of requests in a short time period, we may encounter third party rate limits, and this error can occur.
+
+If you receive any of these errors, try re-running the tests, by closing and reopening the pull request.`,
             errorCode: 'SNYK-PR-CHECK-0003',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -140,6 +163,7 @@ exports.ThirdPartyRateLimitError = ThirdPartyRateLimitError;
  * @summary Out of Sync Error
  * @category PRChecks
  * @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
@@ -151,6 +175,11 @@ class OutOfSyncError extends problem_error_1.ProblemError {
             title: 'Out of Sync Error',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-pr-check-0004',
             status: 422,
+            description: `Sometimes a project may become out of sync between the lockfile and the manifest file. This might happen if the package.json is modified or updated but the lockfile is not. 
+
+This can be resolved by ensuring the lockfile and manifest file are correctly synced, by executing npm install or yarn install.
+
+In some cases, it may be necessary to delete the node_modules folder and the package-lock.json and run npm install again to force a full reinstall. `,
             errorCode: 'SNYK-PR-CHECK-0004',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -173,6 +202,7 @@ exports.OutOfSyncError = OutOfSyncError;
  * @summary Failed determining project target
  * @category PRChecks
  * @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
@@ -184,6 +214,11 @@ class FailedDeterminingProjectTargetError extends problem_error_1.ProblemError {
             title: 'Failed determining project target',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-pr-check-0005',
             status: 500,
+            description: `An internal error occurred, whereby Snyk was unable to determine the correct target for a given project in your PR Check.
+
+If you receive this error, try re-running the tests, by closing and reopening the pull request.
+
+Ultimately, you should contact support@snyk.io if the issue persists.`,
             errorCode: 'SNYK-PR-CHECK-0005',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -207,6 +242,7 @@ exports.FailedDeterminingProjectTargetError = FailedDeterminingProjectTargetErro
  * @summary Failed to complete the test
  * @category PRChecks
  * @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
@@ -218,6 +254,11 @@ class FailedToCompleteTestError extends problem_error_1.ProblemError {
             title: 'Failed to complete the test',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-pr-check-0006',
             status: 500,
+            description: `A "Failed to complete testing check status" appears in your commit checks when an unknown error occurs while Snyk was trying to test your projects for vulnerabilities or license issues.
+
+If you receive this error, try re-running the tests, by closing and reopening the pull request.
+
+Ultimately, you should contact support@snyk.io if the issue persists.`,
             errorCode: 'SNYK-PR-CHECK-0006',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -241,6 +282,7 @@ exports.FailedToCompleteTestError = FailedToCompleteTestError;
  * @summary Failed to fetch merge commit SHA
  * @category PRChecks
  * @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
@@ -252,6 +294,9 @@ class FailedToFetchMergeCommitShaError extends problem_error_1.ProblemError {
             title: 'Failed to fetch merge commit SHA',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-pr-check-0007',
             status: 500,
+            description: `In order for snyk test to run, we need the merge commit SHA from the GitHub. For some reason, we couldn’t get it.
+
+Try closing and then reopening the pull request, or you can Skip the Pull Request Check if it is consistent.`,
             errorCode: 'SNYK-PR-CHECK-0007',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -275,6 +320,7 @@ exports.FailedToFetchMergeCommitShaError = FailedToFetchMergeCommitShaError;
  * @summary Merge conflict error
  * @category PRChecks
  * @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
@@ -286,6 +332,9 @@ class MergeConflictError extends problem_error_1.ProblemError {
             title: 'Merge conflict error',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-pr-check-0008',
             status: 422,
+            description: `Merge Conflict Error is not a Snyk specific issue but rather some issues on your SCM environment. As an example, merge conflicts could happen when people make different changes to the same line of the same file, or when one person edits a file and another person deletes the same file.
+
+To resolve this, you might need to figure out all the merge conflicts on your SCM environment and resolve them to fully remediate these types of errors on Snyk. As a note, this cannot be modified/changed on Snyk's side.`,
             errorCode: 'SNYK-PR-CHECK-0008',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -309,6 +358,7 @@ exports.MergeConflictError = MergeConflictError;
  * @summary Failed to detect issues
  * @category PRChecks
  * @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
@@ -320,6 +370,9 @@ class FailedToDetectIssuesError extends problem_error_1.ProblemError {
             title: 'Failed to detect issues',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-pr-check-0009',
             status: 500,
+            description: `Snyk is always trying to check for new issues and vulnerabilities to keep you safe. We do so by testing on your code on webhook Pull Request events and Push events.
+
+Occasionally you might see a "Failed to detect issues" commit status which may block your PR. This means that we tried to run a test against your changes but unfortunately something went wrong / we encountered an internal problem. If this happens to you try recreating the pull request and if it still occurs reach out and let us know which user, organization and project and commit sha you experienced the issue with on support@snyk.io`,
             errorCode: 'SNYK-PR-CHECK-0009',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,
@@ -340,6 +393,7 @@ exports.FailedToDetectIssuesError = FailedToDetectIssuesError;
  * @summary No valid credentials to process PR check
  * @category PRChecks
  * @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
@@ -351,6 +405,9 @@ class InvalidThirdPartyCredentialsError extends problem_error_1.ProblemError {
             title: 'No valid credentials to process PR check',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-pr-check-0010',
             status: 401,
+            description: `Snyk uses credentials configured on your integration to test your code and to update your PR Check.
+
+If this error occurs, please ensure your integration and credentials are correctly set up, by following the instructions for your SCM here: https://docs.snyk.io/integrate-with-snyk/git-repository-scm-integrations`,
             errorCode: 'SNYK-PR-CHECK-0010',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,
@@ -369,6 +426,7 @@ exports.InvalidThirdPartyCredentialsError = InvalidThirdPartyCredentialsError;
  * @summary Failed to generate a commit status
  * @category PRChecks
  * @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
@@ -380,6 +438,9 @@ class FailedToGenerateCommitStatusError extends problem_error_1.ProblemError {
             title: 'Failed to generate a commit status',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-pr-check-0011',
             status: 500,
+            description: `Snyk is always trying to check for new issues and vulnerabilities to keep you safe. We do so by testing on your code on webhook Pull Request events and Push events.
+
+Occasionally you might see a "Failed to generate a commit status" which may block your PR. This means that we tried to run a test against your changes but unfortunately something went wrong / we encountered an internal problem. If this happens to you try recreating the pull request and if it still occurs reach out and let us know which user, organization and project and commit sha you experienced the issue with on support@snyk.io`,
             errorCode: 'SNYK-PR-CHECK-0011',
             level: 'error',
             classification: types_1.Classification.UNEXPECTED,

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

@@ -1 +1 @@
-{"version":3,"file":"PRChecks-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/PRChecks-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,yBAA0B,SAAQ,4BAAY;IACzD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,qFAAqF;aACpF,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,8DA8BC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,2EAA2E;aAC1E,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,sDA8BC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAa,wBAAyB,SAAQ,4BAAY;IACxD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,sCAAsC;YAC7C,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,oBAAoB;YAC/B,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,4DA4BC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,cAAe,SAAQ,4BAAY;IAC9C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,mBAAmB;YAC1B,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,qGAAqG;aACpG,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,wCA8BC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAa,mCAAoC,SAAQ,4BAAY;IACnE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,mCAAmC;YAC1C,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,oBAAoB;YAC/B,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,kFA4BC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,yBAA0B,SAAQ,4BAAY;IACzD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,6BAA6B;YACpC,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,8EAA8E;aAC7E,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,8DA8BC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,gCAAiC,SAAQ,4BAAY;IAChE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,kCAAkC;YACzC,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,wDAAwD;aACvD,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,4EA8BC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,kBAAmB,SAAQ,4BAAY;IAClD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,sBAAsB;YAC7B,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,wDAAwD;aACvD,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,gDA8BC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,yBAA0B,SAAQ,4BAAY;IACzD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,yBAAyB;YAChC,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,gFAAgF;aAC/E,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,8DA8BC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAa,iCAAkC,SAAQ,4BAAY;IACjE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,0CAA0C;YACjD,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,oBAAoB;YAC/B,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,8EA4BC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAa,iCAAkC,SAAQ,4BAAY;IACjE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,oCAAoC;YAC3C,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,oBAAoB;YAC/B,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,8EA4BC"}
+{"version":3,"file":"PRChecks-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/PRChecks-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAa,yBAA0B,SAAQ,4BAAY;IACzD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;;;;;;;qEAQgD;YAC7D,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,qFAAqF;aACpF,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAvCD,8DAuCC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,qBAAsB,SAAQ,4BAAY;IACrD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,oBAAoB;YAC3B,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;;;;;;qFAOgE;YAC7E,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,2EAA2E;aAC1E,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAtCD,sDAsCC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,wBAAyB,SAAQ,4BAAY;IACxD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,sCAAsC;YAC7C,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;yGAEoF;YACjG,SAAS,EAAE,oBAAoB;YAC/B,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;AA/BD,4DA+BC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,cAAe,SAAQ,4BAAY;IAC9C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,mBAAmB;YAC1B,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;;;qJAIgI;YAC7I,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,qGAAqG;aACpG,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAnCD,wCAmCC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,mCAAoC,SAAQ,4BAAY;IACnE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,mCAAmC;YAC1C,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;;;sEAIiD;YAC9D,SAAS,EAAE,oBAAoB;YAC/B,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;AAjCD,kFAiCC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,yBAA0B,SAAQ,4BAAY;IACzD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,6BAA6B;YACpC,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;;;sEAIiD;YAC9D,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,8EAA8E;aAC7E,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAnCD,8DAmCC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,gCAAiC,SAAQ,4BAAY;IAChE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,kCAAkC;YACzC,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;6GAEwF;YACrG,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,wDAAwD;aACvD,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAjCD,4EAiCC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,kBAAmB,SAAQ,4BAAY;IAClD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,sBAAsB;YAC7B,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;4NAEuM;YACpN,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,wDAAwD;aACvD,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAjCD,gDAiCC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,yBAA0B,SAAQ,4BAAY;IACzD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,yBAAyB;YAChC,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;qbAEga;YAC7a,SAAS,EAAE,oBAAoB;YAC/B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,gFAAgF;aAC/E,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAjCD,8DAiCC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,iCAAkC,SAAQ,4BAAY;IACjE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,0CAA0C;YACjD,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;qNAEgM;YAC7M,SAAS,EAAE,oBAAoB;YAC/B,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;AA/BD,8EA+BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,iCAAkC,SAAQ,4BAAY;IACjE,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,oCAAoC;YAC3C,IAAI,EAAE,sEAAsE;YAC5E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;;kbAE6Z;YAC1a,SAAS,EAAE,oBAAoB;YAC/B,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;AA/BD,8EA+BC"}

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

@@ -25,6 +25,7 @@ import { ProblemError } from '../problem-error';
  * @summary Unable to apply a policy with an invalid configuration
  * @category Policies
  * @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

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

@@ -29,6 +29,7 @@ const problem_error_1 = require("../problem-error");
  * @summary Unable to apply a policy with an invalid configuration
  * @category Policies
  * @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
@@ -40,6 +41,8 @@ class InvalidPolicyApplyError extends problem_error_1.ProblemError {
             title: 'Unable to apply a policy with an invalid configuration',
             type: 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-policy-0001',
             status: 422,
+            description: `Snyk could not apply a policy whilst executing a test because the configuration for the policy was invalid.
+You may be able to fix the policy and try again.`,
             errorCode: 'SNYK-POLICY-0001',
             level: 'error',
             classification: types_1.Classification.ACTIONABLE,

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

@@ -1 +1 @@
-{"version":3,"file":"Policies-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/Policies-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;;;;GAeG;AACH,MAAa,uBAAwB,SAAQ,4BAAY;IACvD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,wDAAwD;YAC/D,IAAI,EAAE,oEAAoE;YAC1E,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,kBAAkB;YAC7B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,2CAA2C;aAC1C,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA9BD,0DA8BC"}
+{"version":3,"file":"Policies-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/Policies-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,uBAAwB,SAAQ,4BAAY;IACvD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB,EACjB,IAAe;QAEjB,KAAK,CACH;YACE,KAAK,EAAE,wDAAwD;YAC/D,IAAI,EAAE,oEAAoE;YAC1E,MAAM,EAAE,GAAG;YACX,WAAW,EAAE;iDAC4B;YACzC,SAAS,EAAE,kBAAkB;YAC7B,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,2CAA2C;aAC1C,IACE,cAAc,GAEnB,KAAK,EACL,IAAI,CACL,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAhCD,0DAgCC"}

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

@@ -21,6 +21,7 @@ import { ProblemError } from '../problem-error';
  * @summary Your Organisation is not authorized to perform this action
  * @category PurlVulnerabilityFetching
  * @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
@@ -36,6 +37,7 @@ export declare class OrganizationNotWhitelistedError extends ProblemError {
  * @summary Authorization request failure
  * @category PurlVulnerabilityFetching
  * @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
@@ -54,6 +56,7 @@ export declare class AuthorizationRequestFailureError extends ProblemError {
  * @summary Invalid purl
  * @category PurlVulnerabilityFetching
  * @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
@@ -72,6 +75,7 @@ export declare class InvalidPurlError extends ProblemError {
  * @summary Namespace not specified
  * @category PurlVulnerabilityFetching
  * @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
@@ -87,6 +91,7 @@ export declare class NamespaceNotProvidedError extends ProblemError {
  * @summary Unsupported ecosystem
  * @category PurlVulnerabilityFetching
  * @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
@@ -102,6 +107,7 @@ export declare class UnsupportedEcosystemError extends ProblemError {
  * @summary Purl components required
  * @category PurlVulnerabilityFetching
  * @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
@@ -117,6 +123,7 @@ export declare class MissingComponentError extends ProblemError {
  * @summary Unsupported purl components
  * @category PurlVulnerabilityFetching
  * @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
@@ -132,6 +139,7 @@ export declare class ComponentNotSupportedError extends ProblemError {
  * @summary Requested package not found
  * @category PurlVulnerabilityFetching
  * @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
@@ -147,6 +155,7 @@ export declare class PackageNotFoundError extends ProblemError {
  * @summary Vulnerability service not available
  * @category PurlVulnerabilityFetching
  * @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
@@ -162,6 +171,7 @@ export declare class VulnerabilityServiceUnavailableError extends ProblemError {
  * @summary This issue is unexpected and the service should recover quickly if not please contact support
  * @category PurlVulnerabilityFetching
  * @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
@@ -177,6 +187,7 @@ export declare class VulnDBInvalidResponseError extends ProblemError {
  * @summary This issue is unexpected and the service should recover quickly if not please contact support
  * @category PurlVulnerabilityFetching
  * @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
@@ -192,6 +203,7 @@ export declare class VulndbNextError extends ProblemError {
  * @summary Request not processed due to unexpected error
  * @category PurlVulnerabilityFetching
  * @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
@@ -207,6 +219,7 @@ export declare class InternalServerError extends ProblemError {
  * @summary Invalid pagination parameters
  * @category PurlVulnerabilityFetching
  * @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
@@ -222,6 +235,7 @@ export declare class InvalidPaginationParametersError extends ProblemError {
  * @summary purls exceed limit
  * @category PurlVulnerabilityFetching
  * @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
@@ -237,6 +251,7 @@ export declare class TooManyPurlsError extends ProblemError {
  * @summary Number of issues exceeds limit
  * @category PurlVulnerabilityFetching
  * @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
@@ -255,6 +270,7 @@ export declare class TooManyIssuesError extends ProblemError {
  * @summary Expected distro to be present
  * @category PurlVulnerabilityFetching
  * @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
@@ -270,6 +286,7 @@ export declare class UndefinedContainerDistroError extends ProblemError {
  * @summary Unsupported Debian distro
  * @category PurlVulnerabilityFetching
  * @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
@@ -285,6 +302,7 @@ export declare class UnsupportedDebianDistroError extends ProblemError {
  * @summary Expected namespace to be present
  * @category PurlVulnerabilityFetching
  * @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
@@ -300,6 +318,7 @@ export declare class UndefinedContainerVendorError extends ProblemError {
  * @summary Unsupported vendor
  * @category PurlVulnerabilityFetching
  * @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
@@ -315,6 +334,7 @@ export declare class UnsupportedContainerVendorError extends ProblemError {
  * @summary Unsupported Alpine distro
  * @category PurlVulnerabilityFetching
  * @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