@pagopa/io-react-native-wallet 0.24.1 → 0.25.0

package/lib/commonjs/utils/errors.js

@@ -3,9 +3,25 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.WalletProviderResponseError = exports.WalletInstanceRevokedError = exports.WalletInstanceNotFoundError = exports.WalletInstanceIntegrityFailedError = exports.WalletInstanceCreationIntegrityError = exports.WalletInstanceCreationError = exports.WalletInstanceAttestationIssuingError = exports.ValidationFailed = exports.UnexpectedStatusCodeError = exports.StatusAttestationError = exports.PidMetadataError = exports.PidIssuingError = exports.OperationAbortedError = exports.NoSuitableKeysFoundInEntityConfiguration = exports.IoWalletError = exports.CredentialRequestError = exports.CredentialIssuingNotSynchronousError = exports.CredentialInvalidStatusError = exports.ClaimsNotFoundInToken = exports.ClaimsNotFoundBetweenDislosures = exports.AuthorizationIdpError = exports.AuthorizationError = exports.AuthRequestDecodeError = void 0;
+exports.IssuerResponseError = exports.IoWalletError = void 0;
+Object.defineProperty(exports, "IssuerResponseErrorCodes", {
+  enumerable: true,
+  get: function () {
+    return _errorCodes.IssuerResponseErrorCodes;
+  }
+});
+exports.WalletProviderResponseError = exports.ValidationFailed = exports.UnexpectedStatusCodeError = exports.ResponseErrorBuilder = void 0;
+Object.defineProperty(exports, "WalletProviderResponseErrorCodes", {
+  enumerable: true,
+  get: function () {
+    return _errorCodes.WalletProviderResponseErrorCodes;
+  }
+});
 exports.extractErrorMessageFromIssuerConf = extractErrorMessageFromIssuerConf;
-exports.serializeAttrs = void 0;
+exports.serializeAttrs = exports.isWalletProviderResponseError = exports.isIssuerResponseError = void 0;
+var _errorCodes = require("./error-codes");
+// An error reason that supports both a string and a generic JSON object
+
 /**
  * utility to format a set of attributes into an error message string
  *
@@ -16,9 +32,14 @@ exports.serializeAttrs = void 0;
  * @param attrs A key value record set
  * @returns a human-readable serialization of the set
  */
-const serializeAttrs = attrs => Object.entries(attrs).map(_ref => {
-  let [k, v] = _ref;
-  return [k, Array.isArray(v) ? `(${v.join(", ")})` : v];
+const serializeAttrs = attrs => Object.entries(attrs).filter(_ref => {
+  let [, v] = _ref;
+  return v !== undefined;
+}).map(_ref2 => {
+  let [k, v] = _ref2;
+  if (Array.isArray(v)) return [k, `(${v.join(", ")})`];
+  if (typeof v !== "string") return [k, JSON.stringify(v)];
+  return [k, v];
 }).map(_ => _.join("=")).join(" ");
 
 /**
@@ -34,119 +55,32 @@ const serializeAttrs = attrs => Object.entries(attrs).map(_ref => {
  */
 exports.serializeAttrs = serializeAttrs;
 class IoWalletError extends Error {
-  /** A unique error code for the particular error subclass. */
-  static get code() {
-    return "ERR_IO_WALLET_GENERIC";
-  }
-
   /** A unique error code for the particular error subclass. */
   code = "ERR_IO_WALLET_GENERIC";
   constructor(message) {
-    var _Error$captureStackTr;
     super(message);
     this.name = this.constructor.name;
-    // @ts-ignore
-    (_Error$captureStackTr = Error.captureStackTrace) === null || _Error$captureStackTr === void 0 ? void 0 : _Error$captureStackTr.call(Error, this, this.constructor);
   }
 }
 
-/**
- * An error subclass thrown when a Wallet Provider http request has a status code different from the one expected.
- */
-exports.IoWalletError = IoWalletError;
-class UnexpectedStatusCodeError extends IoWalletError {
-  static get code() {
-    return "ERR_UNEXPECTED_STATUS_CODE";
-  }
-  code = "ERR_UNEXPECTED_STATUS_CODE";
-
-  /** HTTP status code */
-
-  /** The stringified response body, useful to process the error response */
-
-  constructor(message, statusCode, responseBody) {
-    super(serializeAttrs({
-      message,
-      statusCode: statusCode.toString()
-    }));
-    this.statusCode = statusCode;
-    this.responseBody = responseBody;
-  }
-}
 /**
  * An error subclass thrown when validation fail
  *
  */
-exports.UnexpectedStatusCodeError = UnexpectedStatusCodeError;
+exports.IoWalletError = IoWalletError;
 class ValidationFailed extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_VALIDATION_FAILED";
-  }
   code = "ERR_IO_WALLET_VALIDATION_FAILED";
 
   /** The Claim for which the validation failed. */
 
   /** Reason code for the validation failure. */
 
-  constructor(message) {
-    let claim = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "unspecified";
-    let reason = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "unspecified";
-    super(serializeAttrs({
-      message,
-      claim,
-      reason
-    }));
-    this.claim = claim;
-    this.reason = reason;
-  }
-}
-
-/**
- * An error subclass thrown when validation fail
- *
- */
-exports.ValidationFailed = ValidationFailed;
-class WalletInstanceAttestationIssuingError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_INSTANCE_ATTESTATION_ISSUING_FAILED";
-  }
-  code = "ERR_IO_WALLET_INSTANCE_ATTESTATION_ISSUING_FAILED";
-
-  /** The Claim for which the validation failed. */
-
-  /** Reason code for the validation failure. */
-
-  constructor(message) {
-    let claim = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "unspecified";
-    let reason = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "unspecified";
-    super(serializeAttrs({
+  constructor(_ref3) {
+    let {
       message,
-      claim,
-      reason
-    }));
-    this.claim = claim;
-    this.reason = reason;
-  }
-}
-
-/**
- * An error subclass thrown when auth request decode fail
- *
- */
-exports.WalletInstanceAttestationIssuingError = WalletInstanceAttestationIssuingError;
-class AuthRequestDecodeError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_AUTHENTICATION_REQUEST_DECODE_FAILED";
-  }
-  code = "ERR_IO_WALLET_AUTHENTICATION_REQUEST_DECODE_FAILED";
-
-  /** The Claim for which the validation failed. */
-
-  /** Reason code for the validation failure. */
-
-  constructor(message) {
-    let claim = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "unspecified";
-    let reason = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "unspecified";
+      claim = "unspecified",
+      reason = "unspecified"
+    } = _ref3;
     super(serializeAttrs({
       message,
       claim,
@@ -158,399 +92,70 @@ class AuthRequestDecodeError extends IoWalletError {
 }
 
 /**
- * An error subclass thrown when validation fail
- *
+ * An error subclass thrown when an HTTP request has a status code different from the one expected.
  */
-exports.AuthRequestDecodeError = AuthRequestDecodeError;
-class PidIssuingError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_PID_ISSUING_FAILED";
-  }
-  code = "ERR_IO_WALLET_PID_ISSUING_FAILED";
-
-  /** The Claim for which the validation failed. */
-
-  /** Reason code for the validation failure. */
-
-  constructor(message) {
-    let claim = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "unspecified";
-    let reason = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "unspecified";
-    super(serializeAttrs({
+exports.ValidationFailed = ValidationFailed;
+class UnexpectedStatusCodeError extends IoWalletError {
+  code = "ERR_UNEXPECTED_STATUS_CODE";
+  constructor(_ref4) {
+    let {
       message,
-      claim,
-      reason
-    }));
-    this.claim = claim;
-    this.reason = reason;
-  }
-}
-
-/**
- * When claims are requested but not found in the credential
- *
- */
-exports.PidIssuingError = PidIssuingError;
-class ClaimsNotFoundBetweenDislosures extends Error {
-  static get code() {
-    return "ERR_CLAIMS_NOT_FOUND";
-  }
-  code = "ERR_CLAIMS_NOT_FOUND";
-
-  /** The Claims not found */
-
-  constructor(claims) {
-    const c = Array.isArray(claims) ? claims : [claims];
-    const message = `Some requested claims are not present in the disclosurable values, claims: ${c.join(", ")}`;
-    super(message);
-    this.claims = c;
-  }
-}
-
-/**
- * When the SD-JWT does not contain an hashed reference to a given set of claims
- */
-exports.ClaimsNotFoundBetweenDislosures = ClaimsNotFoundBetweenDislosures;
-class ClaimsNotFoundInToken extends Error {
-  static get code() {
-    return "ERR_CLAIMS_NOT_FOUND_IN_TOKEN";
-  }
-  code = "ERR_CLAIMS_NOT_FOUND_IN_TOKEN";
-
-  /** The Claims not found */
-
-  constructor(claims) {
-    const c = Array.isArray(claims) ? claims : [claims];
-    const message = `Some claims are not found in the given token, claims: ${c.join(", ")}`;
-    super(message);
-    this.claims = c;
-  }
-}
-
-/**
- * When selecting a public key from an entity configuration, and no one meets the requirements for the scenario
- *
- */
-exports.ClaimsNotFoundInToken = ClaimsNotFoundInToken;
-class NoSuitableKeysFoundInEntityConfiguration extends Error {
-  static get code() {
-    return "ERR_NO_SUITABLE_KEYS_NOT_FOUND";
-  }
-  code = "ERR_NO_SUITABLE_KEYS_NOT_FOUND";
-
-  /**
-   * @param scenario describe the scenario in which the error arise
-   */
-  constructor(scenario) {
-    const message = `Entity configuration do not provide any suitable keys (${scenario}).`;
-    super(message);
-  }
-}
-
-/**
- * When selecting a public key from an entity configuration, and no one meets the requirements for the scenario
- *
- */
-exports.NoSuitableKeysFoundInEntityConfiguration = NoSuitableKeysFoundInEntityConfiguration;
-class PidMetadataError extends Error {
-  static get code() {
-    return "PID_METADATA_ERROR";
-  }
-  constructor(message) {
-    super(message);
-  }
-}
-
-/**
- * An error subclass thrown when a Wallet Provider http request fail
- *
- */
-exports.PidMetadataError = PidMetadataError;
-class WalletProviderResponseError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_PROVIDER_RESPONSE_FAILED";
-  }
-  code = "ERR_IO_WALLET_PROVIDER_RESPONSE_FAILED";
-
-  /** The Claim for which the validation failed. */
-
-  /** Reason code for the validation failure. */
-
-  /** HTTP status code */
-
-  constructor(message) {
-    let claim = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "unspecified";
-    let reason = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "unspecified";
-    let statusCode = arguments.length > 3 ? arguments[3] : undefined;
+      reason,
+      statusCode
+    } = _ref4;
     super(serializeAttrs({
       message,
-      claim,
       reason,
-      statusCode: statusCode.toString()
+      statusCode
     }));
-    this.claim = claim;
     this.reason = reason;
     this.statusCode = statusCode;
   }
 }
-exports.WalletProviderResponseError = WalletProviderResponseError;
-class WalletInstanceRevokedError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_INSTANCE_REVOKED";
-  }
-  code = "ERR_IO_WALLET_INSTANCE_REVOKED";
-  constructor(message, claim) {
-    let reason = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "unspecified";
-    super(serializeAttrs({
-      message,
-      claim,
-      reason
-    }));
-    this.reason = reason;
-    this.claim = claim;
-  }
-}
-exports.WalletInstanceRevokedError = WalletInstanceRevokedError;
-class WalletInstanceNotFoundError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_INSTANCE_NOT_FOUND";
-  }
-  code = "ERR_IO_WALLET_INSTANCE_NOT_FOUND";
-  constructor(message, claim) {
-    let reason = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "unspecified";
-    super(serializeAttrs({
-      message,
-      claim,
-      reason
-    }));
-    this.reason = reason;
-    this.claim = claim;
-  }
-}
-
-/**
- * An error subclass thrown when obtaining a wallet instance attestation which fails due to the integrity.
- */
-exports.WalletInstanceNotFoundError = WalletInstanceNotFoundError;
-class WalletInstanceIntegrityFailedError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_INSTANCE_INTEGRITY_FAILED";
-  }
-  code = "ERR_IO_WALLET_INSTANCE_INTEGRITY_FAILED";
-  constructor(message, claim) {
-    let reason = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "unspecified";
-    super(serializeAttrs({
-      message,
-      claim,
-      reason
-    }));
-    this.reason = reason;
-    this.claim = claim;
-  }
-}
-
-/**
- * An error subclass thrown when an error occurs during the wallet instance creation process.
- */
-exports.WalletInstanceIntegrityFailedError = WalletInstanceIntegrityFailedError;
-class WalletInstanceCreationError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_INSTANCE_CREATION_ERROR";
-  }
-  code = "ERR_IO_WALLET_INSTANCE_CREATION_ERROR";
-
-  /** The Claim for which the validation failed. */
-
-  /** Reason code for the validation failure. */
-
-  constructor(message) {
-    let claim = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "unspecified";
-    let reason = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "unspecified";
-    super(serializeAttrs({
-      message,
-      claim,
-      reason
-    }));
-    this.claim = claim;
-    this.reason = reason;
-  }
-}
-
-/**
- * An error subclass thrown when obtaining a wallet instance attestation which fails due to the integrity.
- */
-exports.WalletInstanceCreationError = WalletInstanceCreationError;
-class WalletInstanceCreationIntegrityError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_INSTANCE_CREATION_INTEGRITY_ERROR";
-  }
-  code = "ERR_IO_WALLET_INSTANCE_CREATION_INTEGRITY_ERROR";
-  constructor(message, claim) {
-    let reason = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "unspecified";
-    super(serializeAttrs({
-      message,
-      claim,
-      reason
-    }));
-    this.reason = reason;
-    this.claim = claim;
-  }
-}
-
-/**
- * An error subclass thrown when an error occurs during the authorization process.
- */
-exports.WalletInstanceCreationIntegrityError = WalletInstanceCreationIntegrityError;
-class AuthorizationError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_AUTHORIZATION_ERROR";
-  }
-  code = "ERR_IO_WALLET_AUTHORIZATION_ERROR";
-  constructor(message) {
-    super(message);
-  }
-}
-
-/**
- * An error subclass thrown when an error occurs during the authorization process with the IDP.
- * It contains the error and error description returned by the IDP.
- */
-exports.AuthorizationError = AuthorizationError;
-class AuthorizationIdpError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_IDENTIFICATION_RESPONSE_ERROR";
-  }
-  code = "ERR_IO_WALLET_IDENTIFICATION_RESPONSE_PARSING_FAILED";
-  constructor(error, errorDescription) {
-    super(serializeAttrs(errorDescription ? {
-      error,
-      errorDescription
-    } : {
-      error
-    }));
-    this.error = error;
-    this.errorDescription = errorDescription;
-  }
-}
 
 /**
- * Error subclass thrown when an operation has been aborted.
- */
-exports.AuthorizationIdpError = AuthorizationIdpError;
-class OperationAbortedError extends IoWalletError {
-  static get code() {
-    return "ERR_IO_WALLET_OPERATION_ABORTED";
-  }
-  code = "ERR_IO_WALLET_OPERATION_ABORTED";
-
-  /** The aborted operation */
-
-  constructor(operation) {
-    super(serializeAttrs({
-      operation
-    }));
-    this.operation = operation;
-  }
-}
-
-/**
- * Error subclass thrown when a credential status is invalid, either during issuance or when requesting a status attestation.
- */
-exports.OperationAbortedError = OperationAbortedError;
-class CredentialInvalidStatusError extends IoWalletError {
-  static get code() {
-    return "ERR_CREDENTIAL_INVALID_STATUS";
-  }
-  code = "ERR_CREDENTIAL_INVALID_STATUS";
-
-  /**
-   * The error code that should be mapped with one of the `issuance_errors_supported` in the EC.
-   */
-
-  constructor(message, errorCode) {
-    let reason = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : "unspecified";
-    super(serializeAttrs({
-      message,
-      errorCode,
-      reason
-    }));
-    this.errorCode = errorCode;
-    this.reason = reason;
-  }
-}
-
-/**
- * Error subclass thrown when an error occurs while obtaining a status attestation for a credential.
- */
-exports.CredentialInvalidStatusError = CredentialInvalidStatusError;
-class StatusAttestationError extends IoWalletError {
-  static get code() {
-    return "ERR_STATUS_ATTESTATION_ERROR";
-  }
-  code = "ERR_STATUS_ATTESTATION_ERROR";
-  constructor(message) {
-    let reason = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "unspecified";
-    super(serializeAttrs({
-      message,
-      reason
-    }));
-    this.reason = reason;
-  }
-}
-
-/**
- * Error subclass thrown when an error occurs while requesting a credential.
+ * An error subclass thrown when an Issuer HTTP request fails.
+ * The specific error can be found in the `code` property.
+ *
+ * The class is generic over the error code to narrow down the reason.
  */
-exports.StatusAttestationError = StatusAttestationError;
-class CredentialRequestError extends IoWalletError {
-  static get code() {
-    return "CREDENTIAL_REQUEST_ERROR";
-  }
-  code = "CREDENTIAL_REQUEST_ERROR";
-  constructor(message) {
-    let reason = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "unspecified";
-    super(serializeAttrs({
-      message,
-      reason
-    }));
-    this.reason = reason;
+exports.UnexpectedStatusCodeError = UnexpectedStatusCodeError;
+class IssuerResponseError extends UnexpectedStatusCodeError {
+  constructor(params) {
+    super(params);
+    this.code = params.code ?? _errorCodes.IssuerResponseErrorCodes.IssuerGenericError;
   }
 }
 
 /**
- * Error subclass thrown when a credential cannot be issued immediately because it follows the async flow.
+ * An error subclass thrown when a Wallet Provider HTTP request fails.
+ * The specific error can be found in the `code` property.
  */
-exports.CredentialRequestError = CredentialRequestError;
-class CredentialIssuingNotSynchronousError extends IoWalletError {
-  static get code() {
-    return "CREDENTIAL_ISSUING_NOT_SYNCHRONOUS_ERROR";
-  }
-  code = "CREDENTIAL_ISSUING_NOT_SYNCHRONOUS_ERROR";
-  constructor(message) {
-    let reason = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : "unspecified";
-    super(serializeAttrs({
-      message,
-      reason
-    }));
-    this.reason = reason;
+exports.IssuerResponseError = IssuerResponseError;
+class WalletProviderResponseError extends UnexpectedStatusCodeError {
+  constructor(params) {
+    super(params);
+    this.reason = params.reason;
+    this.code = params.code ?? _errorCodes.WalletProviderResponseErrorCodes.WalletProviderGenericError;
   }
 }
-exports.CredentialIssuingNotSynchronousError = CredentialIssuingNotSynchronousError;
+exports.WalletProviderResponseError = WalletProviderResponseError;
 /**
  * Function to extract the error message from the Entity Configuration's supported error codes.
  * @param errorCode The error code to map to a meaningful message
- * @param params.issuerConf The entity configuration for credentials
- * @param params.credentialType The type of credential the error belongs to
+ * @param issuerConf The entity configuration for credentials
+ * @param credentialType The type of credential the error belongs to
  * @returns A localized error {@link LocalizedIssuanceError} or undefined
- * @throws {Error} When no credential config is found
+ * @throws {IoWalletError} When no credential config is found
  */
-function extractErrorMessageFromIssuerConf(errorCode, _ref2) {
+function extractErrorMessageFromIssuerConf(errorCode, _ref5) {
   let {
     issuerConf,
     credentialType
-  } = _ref2;
+  } = _ref5;
   const credentialConfiguration = issuerConf.openid_credential_issuer.credential_configurations_supported[credentialType];
   if (!credentialConfiguration) {
-    throw new Error(`No configuration found for ${credentialType} in the provided EC`);
+    throw new IoWalletError(`No configuration found for ${credentialType} in the provided EC`);
   }
   const {
     issuance_errors_supported
@@ -559,15 +164,66 @@ function extractErrorMessageFromIssuerConf(errorCode, _ref2) {
     return undefined;
   }
   const localesList = issuance_errors_supported[errorCode].display;
-  return localesList.reduce((acc, _ref3) => {
+  return localesList.reduce((acc, _ref6) => {
     let {
       locale,
       ...rest
-    } = _ref3;
+    } = _ref6;
     return {
       ...acc,
       [locale]: rest
     };
   }, {});
 }
+
+/**
+ * Type guard for issuer errors.
+ * @param error The error to check
+ * @param code Optional code to narrow down the issuer error
+ */
+const isIssuerResponseError = (error, code) => error instanceof IssuerResponseError && error.code === (code ?? error.code);
+
+/**
+ * Type guard for wallet provider errors.
+ * @param error The error to check
+ * @param code Optional code to narrow down the wallet provider error
+ */
+exports.isIssuerResponseError = isIssuerResponseError;
+const isWalletProviderResponseError = (error, code) => error instanceof WalletProviderResponseError && error.code === (code ?? error.code);
+exports.isWalletProviderResponseError = isWalletProviderResponseError;
+/**
+ * Builder class used to create specialized errors from type {@link UnexpectedStatusCodeError} that handles multiple status codes.
+ *
+ * Chain multiple `handle` to add cases that depend on the status code, then call `buildFrom` when done.
+ *
+ * For example:
+ * ```
+ * new ResponseErrorBuilder(IssuerResponseError)
+ *   .handle(403, { code: "ERROR_CODE_1", message: "Forbidden" })
+ *   .handle(500, { code: "ERROR_CODE_2", message: "Unexpected error" })
+ *   .handle("*", { code: "ERROR_CODE_3", message: "Fallback" })
+ *   .buildFrom(baseError)
+ * ```
+ */
+class ResponseErrorBuilder {
+  errorCases = {};
+  constructor(ErrorClass) {
+    this.ErrorClass = ErrorClass;
+  }
+  handle(status, params) {
+    this.errorCases[status] = params;
+    return this;
+  }
+  buildFrom(originalError) {
+    const params = this.errorCases[originalError.statusCode] ?? this.errorCases["*"];
+    if (params) {
+      return new this.ErrorClass({
+        ...originalError,
+        ...params
+      });
+    }
+    return originalError;
+  }
+}
+exports.ResponseErrorBuilder = ResponseErrorBuilder;
 //# sourceMappingURL=errors.js.map