@snyk/error-catalog-nodejs-public 5.0.0 → 5.0.2

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

@@ -21,6 +21,7 @@ import { ProblemError } from '../problem-error';
  * @summary Service temporarily throttled
  * @category Snyk
  * @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
  * @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
@@ -38,6 +39,7 @@ export declare class TooManyRequestsError extends ProblemError {
  * @summary Server error response
  * @category Snyk
  * @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
  * @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
@@ -52,6 +54,7 @@ export declare class NotImplementedError extends ProblemError {
  * @summary Client request cannot be processed
  * @category Snyk
  * @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
  * @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
@@ -69,6 +72,7 @@ export declare class BadRequestError extends ProblemError {
  * @summary Server communication error
  * @category Snyk
  * @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
  * @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
@@ -83,6 +87,7 @@ export declare class TimeoutError extends ProblemError {
  * @summary Authentication error
  * @category Snyk
  * @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
  * @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
@@ -100,6 +105,7 @@ export declare class UnauthorisedError extends ProblemError {
  * @summary Request not fulfilled due to server error
  * @category Snyk
  * @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
  * @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

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

@@ -16,6 +16,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ServerError = exports.UnauthorisedError = exports.TimeoutError = exports.BadRequestError = exports.NotImplementedError = exports.TooManyRequestsError = void 0;
+const types_1 = require("../types");
 const problem_error_1 = require("../problem-error");
 /**
  * @class
@@ -24,6 +25,7 @@ const problem_error_1 = require("../problem-error");
  * @summary Service temporarily throttled
  * @category Snyk
  * @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
  * @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
@@ -36,6 +38,7 @@ class TooManyRequestsError extends problem_error_1.ProblemError {
             status: 429,
             errorCode: 'SNYK-0001',
             level: 'warn',
+            classification: types_1.Classification.ACTIONABLE,
             instance,
         }, details, Object.assign({ links: [] }, additionalData), cause);
         this.name = this.constructor.name;
@@ -52,6 +55,7 @@ exports.TooManyRequestsError = TooManyRequestsError;
  * @summary Server error response
  * @category Snyk
  * @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
  * @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
@@ -64,6 +68,7 @@ class NotImplementedError extends problem_error_1.ProblemError {
             status: 501,
             errorCode: 'SNYK-0002',
             level: 'error',
+            classification: types_1.Classification.UNSUPPORTED,
             instance,
         }, details, Object.assign({ links: [
                 'https://docs.snyk.io/snyk-api-info',
@@ -79,6 +84,7 @@ exports.NotImplementedError = NotImplementedError;
  * @summary Client request cannot be processed
  * @category Snyk
  * @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
  * @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
@@ -91,6 +97,7 @@ class BadRequestError extends problem_error_1.ProblemError {
             status: 400,
             errorCode: 'SNYK-0003',
             level: 'error',
+            classification: types_1.Classification.ACTIONABLE,
             instance,
         }, details, Object.assign({ links: [] }, additionalData), cause);
         this.name = this.constructor.name;
@@ -107,6 +114,7 @@ exports.BadRequestError = BadRequestError;
  * @summary Server communication error
  * @category Snyk
  * @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
  * @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
@@ -119,6 +127,7 @@ class TimeoutError extends problem_error_1.ProblemError {
             status: 504,
             errorCode: 'SNYK-0004',
             level: 'error',
+            classification: types_1.Classification.UNEXPECTED,
             instance,
         }, details, Object.assign({ links: [
                 'https://status.snyk.io/',
@@ -134,6 +143,7 @@ exports.TimeoutError = TimeoutError;
  * @summary Authentication error
  * @category Snyk
  * @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
  * @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
@@ -146,6 +156,7 @@ class UnauthorisedError extends problem_error_1.ProblemError {
             status: 401,
             errorCode: 'SNYK-0005',
             level: 'error',
+            classification: types_1.Classification.ACTIONABLE,
             instance,
         }, details, Object.assign({ links: [] }, additionalData), cause);
         this.name = this.constructor.name;
@@ -162,6 +173,7 @@ exports.UnauthorisedError = UnauthorisedError;
  * @summary Request not fulfilled due to server error
  * @category Snyk
  * @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
  * @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
@@ -174,6 +186,7 @@ class ServerError extends problem_error_1.ProblemError {
             status: 500,
             errorCode: 'SNYK-9999',
             level: 'error',
+            classification: types_1.Classification.UNEXPECTED,
             instance,
         }, details, Object.assign({ links: [
                 'https://status.snyk.io/',

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

@@ -1 +1 @@
-{"version":3,"file":"Snyk-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/Snyk-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oDAAgD;AAEhD;;;;;;;;;;GAUG;AACH,MAAa,oBAAqB,SAAQ,4BAAY;IACpD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,+BAA+B;YACtC,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,MAAM;YACb,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAzBD,oDAyBC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,uBAAuB;YAC9B,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,oCAAoC;aACnC,IACE,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA3BD,kDA2BC;AAED;;;;;;;;;;GAUG;AACH,MAAa,eAAgB,SAAQ,4BAAY;IAC/C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,oCAAoC;YAC3C,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAzBD,0CAyBC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAa,YAAa,SAAQ,4BAAY;IAC5C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,4BAA4B;YACnC,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,yBAAyB;aACxB,IACE,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA3BD,oCA2BC;AAED;;;;;;;;;;GAUG;AACH,MAAa,iBAAkB,SAAQ,4BAAY;IACjD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,sBAAsB;YAC7B,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AAzBD,8CAyBC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAa,WAAY,SAAQ,4BAAY;IAC3C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,4CAA4C;YACnD,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,yBAAyB;aACxB,IACE,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA3BD,kCA2BC"}
+{"version":3,"file":"Snyk-error-catalog.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/Snyk-error-catalog.ts"],"names":[],"mappings":";;;AAAA,oCAA0C;AAC1C,oDAAgD;AAEhD;;;;;;;;;;;GAWG;AACH,MAAa,oBAAqB,SAAQ,4BAAY;IACpD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,+BAA+B;YACtC,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,MAAM;YACb,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA1BD,oDA0BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,mBAAoB,SAAQ,4BAAY;IACnD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,uBAAuB;YAC9B,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,WAAW;YAC1C,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,oCAAoC;aACnC,IACE,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA5BD,kDA4BC;AAED;;;;;;;;;;;GAWG;AACH,MAAa,eAAgB,SAAQ,4BAAY;IAC/C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,oCAAoC;YAC3C,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA1BD,0CA0BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,YAAa,SAAQ,4BAAY;IAC5C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,4BAA4B;YACnC,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,yBAAyB;aACxB,IACE,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA5BD,oCA4BC;AAED;;;;;;;;;;;GAWG;AACH,MAAa,iBAAkB,SAAQ,4BAAY;IACjD,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,sBAAsB;YAC7B,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE,EAAE,IACN,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA1BD,8CA0BC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAa,WAAY,SAAQ,4BAAY;IAC3C,YACI,OAAe,EACf,cAAoC,EACpC,KAAa,EACb,QAAiB;QAEnB,KAAK,CACH;YACE,KAAK,EAAE,4CAA4C;YACnD,IAAI,EAAE,wDAAwD;YAC9D,MAAM,EAAE,GAAG;YACX,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,cAAc,EAAE,sBAAc,CAAC,UAAU;YACzC,QAAQ;SACT,EACD,OAAO,kBAEL,KAAK,EAAE;gBACP,yBAAyB;aACxB,IACE,cAAc,GAEnB,KAAK,CACN,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,CAAC;CACF;AA5BD,kCA4BC"}

package/src/problem-error.js

@@ -47,7 +47,7 @@ class ProblemError extends Error {
         }
     }
     toProblemJson(instance) {
-        const payload = Object.assign({ type: this.metadata.type, title: this.metadata.title, status: this.metadata.status, errorCode: this.metadata.errorCode, detail: this.detail, instance }, this.additionalData);
+        const payload = Object.assign({ type: this.metadata.type, title: this.metadata.title, status: this.metadata.status, errorCode: this.metadata.errorCode, detail: this.detail, classification: this.metadata.classification, instance }, this.additionalData);
         return new types_1.ProblemJson(payload);
     }
     /**
@@ -72,6 +72,7 @@ class ProblemError extends Error {
             code: this.metadata.errorCode,
             title: this.metadata.title,
             detail: this.detail,
+            classification: this.metadata.classification,
             meta: Object.assign({}, this.additionalData),
         };
         if (source) {

package/src/problem-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"problem-error.js","sourceRoot":"","sources":["../../../../packages/error-catalog-nodejs-public/src/problem-error.ts"],"names":[],"mappings":";;;AAAA,mCAQiB;AACjB,+BAA0B;AAC1B,iCAAiD;AAEjD,MAAa,YAAa,SAAQ,KAAK;IAOrC,YACkB,QAAuB,EACvB,MAAc,EACd,cAAoC,EACpC,KAAa;QAE7B,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QALN,aAAQ,GAAR,QAAQ,CAAe;QACvB,WAAM,GAAN,MAAM,CAAQ;QACd,mBAAc,GAAd,cAAc,CAAsB;QACpC,UAAK,GAAL,KAAK,CAAQ;QAR/B,sLAAsL;QACtL,qJAAqJ;QACrI,wBAAmB,GAAG,IAAI,CAAC;QASzC,IAAI,cAAc,IAAI,cAAc,CAAC,iBAAiB,CAAC,EAAE;YACvD,IAAI,CAAC,EAAE,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;SAC7C;aAAM;YACL,IAAI,CAAC,EAAE,GAAG,IAAA,SAAE,GAAE,CAAC;SAChB;IACH,CAAC;IAED,MAAM,CAAC,QAAgB,EAAE,UAAwB;QAC/C,QAAQ,UAAU,EAAE;YAClB,KAAK,oBAAY,CAAC,OAAO;gBACvB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAClC,KAAK,oBAAY,CAAC,WAAW;gBAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YACtC;gBACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SAC1C;IACH,CAAC;IAED,aAAa,CAAC,QAAgB;QAC5B,MAAM,OAAO,mBACX,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,EACxB,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAC1B,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAC5B,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,EAClC,MAAM,EAAE,IAAI,CAAC,MAAM,EACnB,QAAQ,IACL,IAAI,CAAC,cAAc,CACvB,CAAC;QACF,OAAO,IAAI,mBAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,QAAiB;QACpC,IAAI,MAAsC,CAAC;QAE3C,2DAA2D;QAC3D,MAAM,WAAW,GAAG,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAEvD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;YACnC,MAAM,GAAG,IAAA,8BAAuB,EAAC,WAAW,CAAC,CAAC;SAC/C;QAED,MAAM,kBAAkB,GAAuB;YAC7C,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,KAAK,EAAE;gBACL,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI;aAC1B;YACD,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YACpC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS;YAC7B,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK;YAC1B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,oBACC,IAAI,CAAC,cAAc,CACvB;SACF,CAAC;QACF,IAAI,MAAM,EAAE;YACV,kBAAkB,CAAC,MAAM,GAAG,MAAM,CAAC;SACpC;QACD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,SAAS,CAAC,QAAiB;QACzB,MAAM,OAAO,GAAkB;YAC7B,OAAO,EAAE;gBACP,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;SAC9C,CAAC;QAEF,OAAO,IAAI,eAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;CACF;AA1FD,oCA0FC"}
+{"version":3,"file":"problem-error.js","sourceRoot":"","sources":["../../../../packages/error-catalog-nodejs-public/src/problem-error.ts"],"names":[],"mappings":";;;AAAA,mCAQiB;AACjB,+BAA0B;AAC1B,iCAAiD;AAEjD,MAAa,YAAa,SAAQ,KAAK;IAOrC,YACkB,QAAuB,EACvB,MAAc,EACd,cAAoC,EACpC,KAAa;QAE7B,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QALN,aAAQ,GAAR,QAAQ,CAAe;QACvB,WAAM,GAAN,MAAM,CAAQ;QACd,mBAAc,GAAd,cAAc,CAAsB;QACpC,UAAK,GAAL,KAAK,CAAQ;QAR/B,sLAAsL;QACtL,qJAAqJ;QACrI,wBAAmB,GAAG,IAAI,CAAC;QASzC,IAAI,cAAc,IAAI,cAAc,CAAC,iBAAiB,CAAC,EAAE;YACvD,IAAI,CAAC,EAAE,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;SAC7C;aAAM;YACL,IAAI,CAAC,EAAE,GAAG,IAAA,SAAE,GAAE,CAAC;SAChB;IACH,CAAC;IAED,MAAM,CAAC,QAAgB,EAAE,UAAwB;QAC/C,QAAQ,UAAU,EAAE;YAClB,KAAK,oBAAY,CAAC,OAAO;gBACvB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAClC,KAAK,oBAAY,CAAC,WAAW;gBAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YACtC;gBACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SAC1C;IACH,CAAC;IAED,aAAa,CAAC,QAAgB;QAC5B,MAAM,OAAO,mBACX,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,EACxB,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAC1B,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAC5B,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,EAClC,MAAM,EAAE,IAAI,CAAC,MAAM,EACnB,cAAc,EAAE,IAAI,CAAC,QAAQ,CAAC,cAAc,EAC5C,QAAQ,IACL,IAAI,CAAC,cAAc,CACvB,CAAC;QACF,OAAO,IAAI,mBAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,QAAiB;QACpC,IAAI,MAAsC,CAAC;QAE3C,2DAA2D;QAC3D,MAAM,WAAW,GAAG,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAEvD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;YACnC,MAAM,GAAG,IAAA,8BAAuB,EAAC,WAAW,CAAC,CAAC;SAC/C;QAED,MAAM,kBAAkB,GAAuB;YAC7C,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,KAAK,EAAE;gBACL,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI;aAC1B;YACD,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YACpC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS;YAC7B,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK;YAC1B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,cAAc,EAAE,IAAI,CAAC,QAAQ,CAAC,cAAc;YAC5C,IAAI,oBACC,IAAI,CAAC,cAAc,CACvB;SACF,CAAC;QACF,IAAI,MAAM,EAAE;YACV,kBAAkB,CAAC,MAAM,GAAG,MAAM,CAAC;SACpC;QACD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,SAAS,CAAC,QAAiB;QACzB,MAAM,OAAO,GAAkB;YAC7B,OAAO,EAAE;gBACP,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;SAC9C,CAAC;QAEF,OAAO,IAAI,eAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;CACF;AA5FD,oCA4FC"}

package/src/types.d.ts

@@ -13,6 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export declare enum Classification {
+    UNEXPECTED = "UNEXPECTED",
+    ACTIONABLE = "ACTIONABLE",
+    UNSUPPORTED = "UNSUPPORTED"
+}
 export type Problem = {
     /** A URI reference that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. */
     type: string;
@@ -28,10 +33,12 @@ export type Problem = {
     instance?: string;
     /** The level of this error */
     level?: string;
+    /** Determining whether this error is a failure of Snyk to handle an operation that it was expected to, or if it derives from a requesting service producing something that cannot be handled. */
+    classification: Classification;
     /** Additional properties. */
     [x: string]: any;
 };
-export type ErrorMetadata = Pick<Problem, 'type' | 'title' | 'status' | 'errorCode' | 'level' | 'instance'>;
+export type ErrorMetadata = Pick<Problem, 'type' | 'title' | 'status' | 'errorCode' | 'level' | 'instance' | 'classification'>;
 export declare enum ErrorFormats {
     JsonApi = 0,
     ProblemJson = 1
@@ -62,6 +69,7 @@ export type JsonApiErrorObject = {
     code: string;
     title: string;
     detail: string;
+    classification: Classification;
     source?: JsonApiErrorSource;
     meta?: {
         [x: string]: any;

package/src/types.js

@@ -15,7 +15,13 @@
  */
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JsonApi = exports.ProblemJson = exports.ErrorFormats = void 0;
+exports.JsonApi = exports.ProblemJson = exports.ErrorFormats = exports.Classification = void 0;
+var Classification;
+(function (Classification) {
+    Classification["UNEXPECTED"] = "UNEXPECTED";
+    Classification["ACTIONABLE"] = "ACTIONABLE";
+    Classification["UNSUPPORTED"] = "UNSUPPORTED";
+})(Classification || (exports.Classification = Classification = {}));
 var ErrorFormats;
 (function (ErrorFormats) {
     ErrorFormats[ErrorFormats["JsonApi"] = 0] = "JsonApi";

package/src/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../packages/error-catalog-nodejs-public/src/types.ts"],"names":[],"mappings":";;;AAwBA,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qDAAO,CAAA;IACP,6DAAW,CAAA;AACb,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB;AAQD,MAAa,WAAW;IACtB,YAA6B,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAEjD,OAAO;QACL,OAAO;YACL,cAAc,EAAE,2BAA2B;SAC5C,CAAC;IACJ,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAZD,kCAYC;AA6BD,MAAa,OAAO;IAClB,YAA6B,OAAsB;QAAtB,YAAO,GAAP,OAAO,CAAe;IAAG,CAAC;IAEvD,OAAO;QACL,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AATD,0BASC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../packages/error-catalog-nodejs-public/src/types.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,2CAAyB,CAAA;IACzB,2CAAyB,CAAA;IACzB,6CAA2B,CAAA;AAC7B,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB;AAkCD,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qDAAO,CAAA;IACP,6DAAW,CAAA;AACb,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB;AAQD,MAAa,WAAW;IACtB,YAA6B,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAEjD,OAAO;QACL,OAAO;YACL,cAAc,EAAE,2BAA2B;SAC5C,CAAC;IACJ,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAZD,kCAYC;AA8BD,MAAa,OAAO;IAClB,YAA6B,OAAsB;QAAtB,YAAO,GAAP,OAAO,CAAe;IAAG,CAAC;IAEvD,OAAO;QACL,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAVD,0BAUC"}