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

package/src/credential/presentation/03-get-request-object.ts

@@ -7,9 +7,9 @@ import {
 } from "@pagopa/io-react-native-jwt";
 
 import { createDPopToken } from "../../utils/dpop";
-import { NoSuitableKeysFoundInEntityConfiguration } from "../../utils/errors";
+import { NoSuitableKeysFoundInEntityConfiguration } from "./errors";
 import type { EvaluateRelyingPartyTrust } from "./02-evaluate-rp-trust";
-import { hasStatus, type Out } from "../../utils/misc";
+import { hasStatusOrThrow, type Out } from "../../utils/misc";
 import type { StartFlow } from "./01-start-flow";
 import { RequestObject } from "./types";
 
@@ -56,7 +56,7 @@ export const getRequestObject: GetRequestObject = async (
       DPoP: signedWalletInstanceDPoP,
     },
   })
-    .then(hasStatus(200))
+    .then(hasStatusOrThrow(200))
     .then((res) => res.json())
     .then((responseJson) => responseJson.response);
 

package/src/credential/presentation/04-send-authorization-response.ts

@@ -2,8 +2,8 @@ import { EncryptJwe, SignJWT } from "@pagopa/io-react-native-jwt";
 import uuid from "react-native-uuid";
 import * as WalletInstanceAttestation from "../../wallet-instance-attestation";
 import type { JWK } from "@pagopa/io-react-native-jwt/lib/typescript/types";
-import { NoSuitableKeysFoundInEntityConfiguration } from "../../utils/errors";
-import { hasStatus, type Out } from "../../utils/misc";
+import { NoSuitableKeysFoundInEntityConfiguration } from "./errors";
+import { hasStatusOrThrow, type Out } from "../../utils/misc";
 import type { GetRequestObject } from "./03-get-request-object";
 import { disclose } from "../../sd-jwt";
 import type { EvaluateRelyingPartyTrust } from "./02-evaluate-rp-trust";
@@ -162,7 +162,7 @@ export const sendAuthorizationResponse: SendAuthorizationResponse = async (
     },
     body,
   })
-    .then(hasStatus(200))
+    .then(hasStatusOrThrow(200))
     .then((res) => res.json())
     .then(AuthorizationResponse.parse);
 };

package/src/credential/presentation/errors.ts

@@ -0,0 +1,41 @@
+import { IoWalletError, serializeAttrs } from "../../utils/errors";
+
+/**
+ * An error subclass thrown when auth request decode fail
+ *
+ */
+export class AuthRequestDecodeError extends IoWalletError {
+  code = "ERR_IO_WALLET_AUTHENTICATION_REQUEST_DECODE_FAILED";
+
+  /** The Claim for which the validation failed. */
+  claim: string;
+
+  /** Reason code for the validation failure. */
+  reason: string;
+
+  constructor(
+    message: string,
+    claim: string = "unspecified",
+    reason: string = "unspecified"
+  ) {
+    super(serializeAttrs({ message, claim, reason }));
+    this.claim = claim;
+    this.reason = reason;
+  }
+}
+
+/**
+ * When selecting a public key from an entity configuration, and no one meets the requirements for the scenario
+ *
+ */
+export class NoSuitableKeysFoundInEntityConfiguration extends IoWalletError {
+  code = "ERR_NO_SUITABLE_KEYS_NOT_FOUND";
+
+  /**
+   * @param scenario describe the scenario in which the error arise
+   */
+  constructor(scenario: string) {
+    const message = `Entity configuration do not provide any suitable keys (${scenario}).`;
+    super(message);
+  }
+}

package/src/credential/presentation/index.ts

@@ -11,12 +11,14 @@ import {
   sendAuthorizationResponse,
   type SendAuthorizationResponse,
 } from "./04-send-authorization-response";
+import * as Errors from "./errors";
 
 export {
   startFlowFromQR,
   evaluateRelyingPartyTrust,
   getRequestObject,
   sendAuthorizationResponse,
+  Errors,
 };
 export type {
   StartFlow,

package/src/credential/status/02-status-attestation.ts

@@ -1,19 +1,16 @@
 import {
   getCredentialHashWithouDiscloures,
-  hasStatus,
-  safeJsonParse,
+  hasStatusOrThrow,
   type Out,
 } from "../../utils/misc";
 import type { EvaluateIssuerTrust, ObtainCredential } from "../issuance";
-import { SignJWT, type CryptoContext } from "@pagopa/io-react-native-jwt";
+import { type CryptoContext, SignJWT } from "@pagopa/io-react-native-jwt";
 import uuid from "react-native-uuid";
+import { StatusAttestationResponse } from "./types";
 import {
-  InvalidStatusAttestationResponse,
-  StatusAttestationResponse,
-} from "./types";
-import {
-  StatusAttestationError,
-  CredentialInvalidStatusError,
+  IssuerResponseError,
+  IssuerResponseErrorCodes,
+  ResponseErrorBuilder,
   UnexpectedStatusCodeError,
 } from "../../utils/errors";
 
@@ -74,7 +71,7 @@ export const statusAttestation: StatusAttestation = async (
     },
     body: JSON.stringify(body),
   })
-    .then(hasStatus(201))
+    .then(hasStatusOrThrow(201))
     .then((raw) => raw.json())
     .then((json) => StatusAttestationResponse.parse(json))
     .catch(handleStatusAttestationError);
@@ -94,19 +91,14 @@ const handleStatusAttestationError = (e: unknown) => {
     throw e;
   }
 
-  if (e.statusCode === 404) {
-    const maybeError = InvalidStatusAttestationResponse.safeParse(
-      safeJsonParse(e.responseBody)
-    );
-    throw new CredentialInvalidStatusError(
-      "Invalid status found for the given credential",
-      maybeError.success ? maybeError.data.error : "unknown",
-      e.message
-    );
-  }
-
-  throw new StatusAttestationError(
-    `Unable to obtain the status attestation for the given credential [response status code: ${e.statusCode}]`,
-    e.message
-  );
+  throw new ResponseErrorBuilder(IssuerResponseError)
+    .handle(404, {
+      code: IssuerResponseErrorCodes.CredentialInvalidStatus,
+      message: "Invalid status found for the given credential",
+    })
+    .handle("*", {
+      code: IssuerResponseErrorCodes.StatusAttestationRequestFailed,
+      message: `Unable to obtain the status attestation for the given credential`,
+    })
+    .buildFrom(e);
 };

package/src/credential/status/README.md

@@ -16,11 +16,14 @@ graph TD;
     1 --> 2
 ```
 
+
 ## Mapped results
 
-### 404 Not Found (CredentialInvalidStatusError)
+The following errors are mapped to a `IssuerResponseError` with specific codes.
 
-A `404 Not Found` response is returned by the credential issuer when the status attestation is invalid.
+|HTTP Status|Error Code|Description|
+|-----------|----------|-----------|
+|`404 Not Found`|`ERR_CREDENTIAL_INVALID_STATUS`|This response is returned by the credential issuer when the status attestation is invalid. It might contain more details in the `reason` property.|
 
 ## Example
 

package/src/credential/status/types.ts

@@ -41,18 +41,3 @@ export const ParsedStatusAttestation = z.object({
     iat: UnixTime,
   }),
 });
-
-/**
- * Shape from parsing a status attestation response in case of error.
- */
-export const InvalidStatusAttestationResponse = z.object({
-  error: z.string(),
-});
-
-/**
- * Type from parsing a status attestation response in case of error.
- * Inferred from {@link InvalidStatusAttestationResponse}.
- */
-export type InvalidStatusAttestationResponse = z.infer<
-  typeof InvalidStatusAttestationResponse
->;

package/src/sd-jwt/errors.ts

@@ -0,0 +1,39 @@
+/**
+ * When claims are requested but not found in the credential
+ *
+ */
+export class ClaimsNotFoundBetweenDisclosures extends Error {
+  code = "ERR_CLAIMS_NOT_FOUND";
+
+  /** The Claims not found */
+  claims: string[];
+
+  constructor(claims: string | string[]) {
+    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
+ */
+export class ClaimsNotFoundInToken extends Error {
+  code = "ERR_CLAIMS_NOT_FOUND_IN_TOKEN";
+
+  /** The Claims not found */
+  claims: string[];
+
+  constructor(claims: string | string[]) {
+    const claimsArray = Array.isArray(claims) ? claims : [claims];
+    super(
+      `Some requested claims are not present in the disclosurable values: ${claimsArray.join(
+        ", "
+      )}`
+    );
+    this.claims = claimsArray;
+  }
+}

package/src/sd-jwt/index.ts

@@ -6,10 +6,7 @@ import { sha256ToBase64 } from "@pagopa/io-react-native-jwt";
 import { Disclosure, SdJwt4VC, type DisclosureWithEncoded } from "./types";
 import { verifyDisclosure } from "./verifier";
 import type { JWK } from "../utils/jwk";
-import {
-  ClaimsNotFoundBetweenDislosures,
-  ClaimsNotFoundInToken,
-} from "../utils/errors";
+import * as Errors from "./errors";
 import { Base64 } from "js-base64";
 
 const decodeDisclosure = (encoded: string): DisclosureWithEncoded => {
@@ -73,7 +70,7 @@ export const decode = <S extends z.ZodType<SdJwt4VC>>(
  * @param token The encoded token that represents a valid sd-jwt for verifiable credentials
  * @param claims The list of claims to be disclosed
  *
- * @throws {ClaimsNotFoundBetweenDislosures} When one or more claims does not relate to any discloure.
+ * @throws {ClaimsNotFoundBetweenDisclosures} When one or more claims does not relate to any discloure.
  * @throws {ClaimsNotFoundInToken} When one or more claims are not contained in the SD-JWT token.
  * @returns The encoded token with only the requested disclosures, along with the path each claim can be found on the SD-JWT token
  *
@@ -94,7 +91,7 @@ export const disclose = async (
 
       // check every claim represents a known disclosure
       if (!disclosure) {
-        throw new ClaimsNotFoundBetweenDislosures(claim);
+        throw new Errors.ClaimsNotFoundBetweenDisclosures(claim);
       }
 
       const hash = await sha256ToBase64(disclosure.encoded);
@@ -106,7 +103,7 @@ export const disclose = async (
         return { claim, path: `verified_claims.claims._sd[${index}]` };
       }
 
-      throw new ClaimsNotFoundInToken(claim);
+      throw new Errors.ClaimsNotFoundInToken(claim);
     })
   );
 
@@ -166,4 +163,4 @@ export const verify = async <S extends z.ZodType<SdJwt4VC>>(
   };
 };
 
-export { SdJwt4VC };
+export { SdJwt4VC, Errors };

package/src/sd-jwt/verifier.ts

@@ -9,10 +9,10 @@ export const verifyDisclosure = async (
 ) => {
   let hash = await sha256ToBase64(encoded);
   if (!claims.includes(hash)) {
-    throw new ValidationFailed(
-      "Validation of disclosure failed",
-      `${decoded}`,
-      "Disclosure hash not found in claims"
-    );
+    throw new ValidationFailed({
+      message: "Validation of disclosure failed",
+      claim: `${decoded}`,
+      reason: "Disclosure hash not found in claims",
+    });
   }
 };

package/src/trust/index.ts

@@ -8,7 +8,7 @@ import {
   EntityStatement,
 } from "./types";
 import { validateTrustChain, renewTrustChain } from "./chain";
-import { hasStatus } from "../utils/misc";
+import { hasStatusOrThrow } from "../utils/misc";
 
 export type {
   WalletProviderEntityConfiguration,
@@ -70,7 +70,7 @@ export async function getSignedEntityConfiguration(
   return await appFetch(wellKnownUrl, {
     method: "GET",
   })
-    .then(hasStatus(200))
+    .then(hasStatusOrThrow(200))
     .then((res) => res.text());
 }
 
@@ -256,6 +256,6 @@ export async function getSignedEntityStatement(
   return await appFetch(url, {
     method: "GET",
   })
-    .then(hasStatus(200))
+    .then(hasStatusOrThrow(200))
     .then((res) => res.text());
 }

package/src/utils/decoder.ts

@@ -47,7 +47,7 @@ export const getJwtFromFormPost = async (
     }
   }
 
-  throw new ValidationFailed(
-    `Unable to obtain JWT from form_post.jwt. Form data: ${formData}`
-  );
+  throw new ValidationFailed({
+    message: `Unable to obtain JWT from form_post.jwt. Form data: ${formData}`,
+  });
 };

package/src/utils/error-codes.ts

@@ -0,0 +1,50 @@
+export const IssuerResponseErrorCodes = {
+  IssuerGenericError: "ERR_ISSUER_GENERIC_ERROR",
+  /**
+   * Error code thrown when a credential cannot be issued immediately because it follows the async flow.
+   */
+  CredentialIssuingNotSynchronous: "ERR_CREDENTIAL_ISSUING_NOT_SYNCHRONOUS",
+  /**
+   * Error code thrown when an error occurs while requesting a credential.
+   */
+  CredentialRequestFailed: "ERR_CREDENTIAL_REQUEST_FAILED",
+  /**
+   * Error code thrown when a credential status is invalid, either during issuance or when requesting a status attestation.
+   */
+  CredentialInvalidStatus: "ERR_CREDENTIAL_INVALID_STATUS",
+  /**
+   * Error code thrown when an error occurs while obtaining a status attestation for a credential.
+   */
+  StatusAttestationRequestFailed: "ERR_STATUS_ATTESTATION_REQUEST_FAILED",
+} as const;
+
+export const WalletProviderResponseErrorCodes = {
+  WalletProviderGenericError: "ERR_IO_WALLET_PROVIDER_GENERIC_ERROR",
+  /**
+   * An error code thrown when an error occurs during the wallet instance creation process.
+   */
+  WalletInstanceCreationFailed: "ERR_IO_WALLET_INSTANCE_CREATION_FAILED",
+  /**
+   * An error code thrown when validation fail
+   */
+  WalletInstanceAttestationIssuingFailed:
+    "ERR_IO_WALLET_INSTANCE_ATTESTATION_ISSUING_FAILED",
+  /**
+   * An error code thrown when the requester does not pass the integrity checks when interacting with the Wallet Provider.
+   */
+  WalletInstanceIntegrityFailed: "ERR_IO_WALLET_INSTANCE_INTEGRITY_FAILED",
+  /**
+   * An error code thrown when obtaining a wallet instance attestation but the wallet instance is revoked.
+   */
+  WalletInstanceRevoked: "ERR_IO_WALLET_INSTANCE_REVOKED",
+  /**
+   * An error code thrown when obtaining a wallet instance attestation but the wallet instance is not found.
+   */
+  WalletInstanceNotFound: "ERR_IO_WALLET_INSTANCE_NOT_FOUND",
+} as const;
+
+export type IssuerResponseErrorCode =
+  (typeof IssuerResponseErrorCodes)[keyof typeof IssuerResponseErrorCodes];
+
+export type WalletProviderResponseErrorCode =
+  (typeof WalletProviderResponseErrorCodes)[keyof typeof WalletProviderResponseErrorCodes];