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

package/src/utils/misc.ts

@@ -2,25 +2,36 @@ import { IoWalletError, UnexpectedStatusCodeError } from "./errors";
 import { sha256 } from "js-sha256";
 
 /**
- * Check if a response is in the expected status, other
+ * Check if a response is in the expected status, otherwise throw an error
  * @param status - The expected status
- * @throws {@link UnexpectedStatusCodeError} if the status is different from the one expected
+ * @param customError - A custom error compatible with {@link UnexpectedStatusCodeError}
+ * @throws UnexpectedStatusCodeError if the status is different from the one expected
  * @returns The given response object
  */
-export const hasStatus =
-  (status: number) =>
+export const hasStatusOrThrow =
+  (status: number, customError?: typeof UnexpectedStatusCodeError) =>
   async (res: Response): Promise<Response> => {
     if (res.status !== status) {
-      const responseBody = await res.text();
-      throw new UnexpectedStatusCodeError(
-        `Http request failed. Expected ${status}, got ${res.status}, url: ${res.url} with response: ${responseBody}`,
-        res.status,
-        responseBody
-      );
+      const ErrorClass = customError ?? UnexpectedStatusCodeError;
+      throw new ErrorClass({
+        message: `Http request failed. Expected ${status}, got ${res.status}, url: ${res.url}`,
+        statusCode: res.status,
+        reason: await parseRawHttpResponse(res), // Pass the response body as reason so the original error can surface
+      });
     }
     return res;
   };
 
+/**
+ * Utility function to parse a raw HTTP response as JSON if supported, otherwise as text.
+ */
+export const parseRawHttpResponse = <T extends Record<string, unknown>>(
+  response: Response
+) =>
+  response.headers.get("content-type")?.includes("application/json")
+    ? (response.json() as Promise<T>)
+    : response.text();
+
 // extract a type from an async function output
 // helpful to bind the input of a function to the output of another
 export type Out<FN> = FN extends (...args: any[]) => Promise<any>
@@ -39,39 +50,6 @@ export const generateRandomAlphaNumericString = (size: number) =>
     Math.floor(Math.random() * 36).toString(36)
   ).join("");
 
-/**
- * Repeatedly checks a condition function until it returns true,
- * then resolves the returned promise. If the condition function does not return true
- * within the specified timeout, the promise is rejected.
- *
- * @param conditionFunction - A function that returns a boolean value.
- *                            The promise resolves when this function returns true.
- * @param timeout - An optional timeout in seconds. The promise is rejected if the
- *                  condition function does not return true within this time.
- * @returns A promise that resolves once the conditionFunction returns true or rejects if timed out.
- */
-export const until = (
-  conditionFunction: () => boolean,
-  timeoutSeconds?: number
-): Promise<void> =>
-  new Promise<void>((resolve, reject) => {
-    const start = Date.now();
-    const poll = () => {
-      if (conditionFunction()) {
-        resolve();
-      } else if (
-        timeoutSeconds !== undefined &&
-        Date.now() - start >= timeoutSeconds * 1000
-      ) {
-        reject(new Error("Timeout exceeded"));
-      } else {
-        setTimeout(poll, 400);
-      }
-    };
-
-    poll();
-  });
-
 /**
  * Get the hash of a credential without discloures.
  * A credential is a string like `header.body.sign~sd1~sd2....` where `~` is the separator between the credential and the discloures.
@@ -88,28 +66,6 @@ export const getCredentialHashWithouDiscloures = async (
   return sha256(credential.slice(0, tildeIndex));
 };
 
-/**
- * Creates a promise that waits until the provided signal is aborted.
- * @returns {Object} An object with `listen` and `remove` methods to handle subscribing and unsubscribing.
- */
-export const createAbortPromiseFromSignal = (signal: AbortSignal) => {
-  let listener: () => void;
-  return {
-    listen: () =>
-      new Promise<"OPERATION_ABORTED">((resolve) => {
-        if (signal.aborted) {
-          return resolve("OPERATION_ABORTED");
-        }
-        listener = () => resolve("OPERATION_ABORTED");
-        signal.addEventListener("abort", listener);
-      }),
-    remove: () => signal.removeEventListener("abort", listener),
-  };
-};
-
-export const isDefined = <T>(x: T | undefined | null | ""): x is T =>
-  Boolean(x);
-
 export const safeJsonParse = <T>(text: string, withDefault?: T): T | null => {
   try {
     return JSON.parse(text);

package/src/utils/par.ts

@@ -6,8 +6,9 @@ import {
 import uuid from "react-native-uuid";
 import * as z from "zod";
 import * as WalletInstanceAttestation from "../wallet-instance-attestation";
-import { generateRandomAlphaNumericString, hasStatus } from "./misc";
+import { generateRandomAlphaNumericString, hasStatusOrThrow } from "./misc";
 import { createPopToken } from "./pop";
+import { IssuerResponseError } from "./errors";
 
 export type AuthorizationDetail = z.infer<typeof AuthorizationDetail>;
 export const AuthorizationDetail = z.object({
@@ -109,7 +110,7 @@ export const makeParRequest =
       },
       body: formBody.toString(),
     })
-      .then(hasStatus(201))
+      .then(hasStatusOrThrow(201, IssuerResponseError))
       .then((res) => res.json())
       .then((result) => result.request_uri);
   };

package/src/wallet-instance/README.md

@@ -6,7 +6,8 @@ The suggested way to implement this service is to use [io-react-native-integrity
 
 The following methods are available:
 - `createWalletInstance` creates a new wallet instance;
-- `revokeCurrentWalletInstance` revokes the currently valid wallet instance of the user who made the request.
+- `revokeWalletInstance` revokes a wallet instance by ID;
+- `getWalletInstanceStatus` fetches the status of a wallet instance by ID without the need to require an attestation.
 
 Examples are provided as follows:
 
@@ -35,12 +36,29 @@ return integrityKeyTag;
 
 The returned `integrityKeyTag` is supposed to be stored and used to verify the integrity of the device in the future when using an `IntegrityContext` object. It must be regenerated if another wallet instance is created.
 
-### Wallet instance revocation
+### Wallet Instance revocation
+
+Revoke a Wallet Instance by ID. The ID matches the hardware/integrity key tag used for creation.
+
+```ts
+const { WALLET_PROVIDER_BASE_URL } = env;
+
+await WalletInstance.revokeWalletInstance({
+  id: "495e5bec-b93f-4fd7-952a-94b27233abdb"
+  walletProviderBaseUrl: WALLET_PROVIDER_BASE_URL,
+  appFetch,
+});
+
+```
+### Wallet Instance status
+
+Get the status of a Wallet Instance by ID. The ID matches the hardware/integrity key tag used for creation.
 
 ```ts
 const { WALLET_PROVIDER_BASE_URL } = env;
 
-await WalletInstance.revokeCurrentWalletInstance({
+const status = await WalletInstance.getWalletInstanceStatus({
+  id: "495e5bec-b93f-4fd7-952a-94b27233abdb"
   walletProviderBaseUrl: WALLET_PROVIDER_BASE_URL,
   appFetch,
 });
@@ -48,6 +66,9 @@ await WalletInstance.revokeCurrentWalletInstance({
 
 ## Mapped results
 
-### 409 Conflict (WalletInstanceCreationIntegrityError)
+The following errors are mapped to a `WalletProviderResponseError` with specific codes.
 
-A `409 Conflict` response is returned by the wallet provider when an integrity check fails.
+|HTTP Status|Error Code|Description|
+|-----------|----------|-----------|
+|`409 Conflict`|`ERR_IO_WALLET_INSTANCE_INTEGRITY_FAILED`|This response is returned by the wallet provider when an integrity check fails.|
+|`*`|`ERR_IO_WALLET_PROVIDER_GENERIC_ERROR`|This is a generic error code to map unexpected errors that occurred when interacting with the Wallet Provider.|

package/src/wallet-instance/index.ts

@@ -1,10 +1,11 @@
 import { getWalletProviderClient } from "../client";
-import type { IntegrityContext } from "..";
 import {
-  WalletInstanceCreationError,
-  WalletInstanceCreationIntegrityError,
+  ResponseErrorBuilder,
   WalletProviderResponseError,
+  WalletProviderResponseErrorCodes,
 } from "../utils/errors";
+import type { WalletInstanceData } from "../client/generated/wallet-provider";
+import type { IntegrityContext } from "..";
 
 export async function createWalletInstance(context: {
   integrityContext: IntegrityContext;
@@ -40,28 +41,49 @@ const handleCreateWalletInstanceError = (e: unknown) => {
     throw e;
   }
 
-  if (e.statusCode === 409) {
-    throw new WalletInstanceCreationIntegrityError(
-      "Unable to get an attestation for a Wallet Instance that failed the integrity check",
-      e.claim,
-      e.reason
-    );
-  }
-
-  throw new WalletInstanceCreationError(
-    `Unable to obtain wallet instance attestation [response status code: ${e.statusCode}]`,
-    e.claim,
-    e.reason
-  );
+  throw new ResponseErrorBuilder(WalletProviderResponseError)
+    .handle(409, {
+      code: WalletProviderResponseErrorCodes.WalletInstanceIntegrityFailed,
+      message:
+        "Unable to create a wallet instance with a device that failed the integrity check",
+    })
+    .handle("*", {
+      code: WalletProviderResponseErrorCodes.WalletInstanceCreationFailed,
+      message: "Unable to create wallet instance",
+    })
+    .buildFrom(e);
 };
 
-export async function revokeCurrentWalletInstance(context: {
+/**
+ * Revoke a Wallet Instance by ID.
+ * @param context.id The Wallet Instance ID. It matches the hardware key tag used for creation.
+ */
+export async function revokeWalletInstance(context: {
+  id: string;
   walletProviderBaseUrl: string;
   appFetch?: GlobalFetch["fetch"];
 }): Promise<void> {
   const api = getWalletProviderClient(context);
 
-  await api.put("/wallet-instances/current/status", {
+  await api.put("/wallet-instances/{id}/status", {
+    path: { id: context.id },
     body: { status: "REVOKED" },
   });
 }
+
+/**
+ * Get the status of a Wallet Instance by ID.
+ * @param context.id The Wallet Instance ID. It matches the hardware key tag used for creation.
+ * @returns Details on the status of the Wallet Instance
+ */
+export async function getWalletInstanceStatus(context: {
+  id: string;
+  walletProviderBaseUrl: string;
+  appFetch?: GlobalFetch["fetch"];
+}): Promise<WalletInstanceData> {
+  const api = getWalletProviderClient(context);
+
+  return api.get("/wallet-instances/{id}/status", {
+    path: { id: context.id },
+  });
+}

package/src/wallet-instance-attestation/README.md

@@ -36,6 +36,12 @@ The returned `issuedAttestation` is supposed to be stored and used for any futur
 
 ## Mapped results
 
-### 409 Conflict (WalletInstanceIntegrityFailedError)
+The following errors are mapped to a `WalletProviderResponseError` with specific codes.
+
+|HTTP Status|Error Code|Description|
+|-----------|----------|-----------|
+|`403 Forbidden`|`ERR_IO_WALLET_INSTANCE_REVOKED`|This response is returned by the wallet provider when the wallet instance has been revoked.|
+|`404 Not Found`|`ERR_IO_WALLET_INSTANCE_NOT_FOUND`|This response is returned by the wallet provider when the wallet instance does not exist.|
+|`409 Conflict`|`ERR_IO_WALLET_INSTANCE_INTEGRITY_FAILED`|This response is returned by the wallet provider when an integrity check fails.|
+|`*`|`ERR_IO_WALLET_PROVIDER_GENERIC_ERROR`|This is a generic error code to map unexpected errors that occurred when interacting with the Wallet Provider.|
 
-A `409 Conflict` response is returned by the wallet provider when an integrity check fails.

package/src/wallet-instance-attestation/issuing.ts

@@ -1,14 +1,15 @@
-import { type CryptoContext } from "@pagopa/io-react-native-jwt";
-import { SignJWT, thumbprint } from "@pagopa/io-react-native-jwt";
-import { JWK, fixBase64EncodingOnKey } from "../utils/jwk";
+import {
+  type CryptoContext,
+  SignJWT,
+  thumbprint,
+} from "@pagopa/io-react-native-jwt";
+import { fixBase64EncodingOnKey, JWK } from "../utils/jwk";
 import { getWalletProviderClient } from "../client";
 import type { IntegrityContext } from "..";
 import {
+  ResponseErrorBuilder,
   WalletProviderResponseError,
-  WalletInstanceRevokedError,
-  WalletInstanceNotFoundError,
-  WalletInstanceAttestationIssuingError,
-  WalletInstanceIntegrityFailedError,
+  WalletProviderResponseErrorCodes,
 } from "../utils/errors";
 import { TokenResponse } from "./types";
 
@@ -120,33 +121,24 @@ const handleAttestationCreationError = (e: unknown) => {
     throw e;
   }
 
-  if (e.statusCode === 403) {
-    throw new WalletInstanceRevokedError(
-      "Unable to get an attestation for a revoked Wallet Instance",
-      e.claim,
-      e.reason
-    );
-  }
-
-  if (e.statusCode === 404) {
-    throw new WalletInstanceNotFoundError(
-      "Unable to get an attestation for a Wallet Instance that does not exist",
-      e.claim,
-      e.reason
-    );
-  }
-
-  if (e.statusCode === 409) {
-    throw new WalletInstanceIntegrityFailedError(
-      "Unable to get an attestation for a Wallet Instance that failed the integrity check",
-      e.claim,
-      e.reason
-    );
-  }
-
-  throw new WalletInstanceAttestationIssuingError(
-    `Unable to obtain wallet instance attestation [response status code: ${e.statusCode}]`,
-    e.claim,
-    e.reason
-  );
+  throw new ResponseErrorBuilder(WalletProviderResponseError)
+    .handle(403, {
+      code: WalletProviderResponseErrorCodes.WalletInstanceRevoked,
+      message: "Unable to get an attestation for a revoked Wallet Instance",
+    })
+    .handle(404, {
+      code: WalletProviderResponseErrorCodes.WalletInstanceNotFound,
+      message:
+        "Unable to get an attestation for a Wallet Instance that does not exist",
+    })
+    .handle(409, {
+      code: WalletProviderResponseErrorCodes.WalletInstanceIntegrityFailed,
+      message:
+        "Unable to get an attestation for a Wallet Instance that failed the integrity check",
+    })
+    .handle("*", {
+      code: WalletProviderResponseErrorCodes.WalletInstanceAttestationIssuingFailed,
+      message: "Unable to obtain wallet instance attestation",
+    })
+    .buildFrom(e);
 };