@pagopa/io-react-native-iso18013 0.3.0 → 0.5.0

package/src/cbor/cbor/README.md

@@ -1,95 +1,75 @@
-## CBOR
+# CBOR
 
 This module provides methods to decode CBOR data into readable objects.
 
 ```typescript
-import { CBOR } from '@pagopa/io-react-native-cbor';
+import { CBOR } from '@pagopa/io-react-native-iso18013';
 ```
 
-### Methods
+## Methods
 
 #### `decode`
 
-This method allows to decode CBOR data into readable JSON objects.
-Returns a `Promise` which resolves to a JSON object, or rejects with an instance of `CborFailure` in case of failure.
+Decodes CBOR data into readable JSON objects.
 
 **Note**: this method does not decode nested CBOR objects and therefore complex objects needs additional manual decoding
 
 ```typescript
-try {
-  const decoded = await CBOR.decode('...');
-} catch (e) {
-  const { message, userInfo } = e as CborFailure;
-}
+const decoded = await CBOR.decode('...');
 ```
 
 #### `decodeDocuments`
 
-This metod allows the decoding of CBOR data which contains MDOC objects.
-Returns a promise wich resolves to a [Documents](#documents) object, or rejects with an instance of `CborFailure` in case of failure.
+Decodes CBOR data containing MDOC objects.
 
 ```typescript
-try {
-  const decoded = await CBOR.decodeDocuments('...');
-} catch (e) {
-  const { message, userInfo } = e as CborFailure;
-}
+const decoded = await CBOR.decodeDocuments('...');
 ```
 
-### Types
+#### `decodeIssuerSigned`
 
-#### `Documents`
+Decodes CBOR data containing an Issuer Signed object.
 
 ```typescript
-type Documents = {
-  status?: number;
-  version?: string;
-  documents?: Array<MDOC>;
-};
+const decoded = await CBOR.decodeIssuerSigned('...');
 ```
 
-#### `MDOC`
+## Errors
 
-```typescript
-type MDOC = {
-  docType?: DocumentType;
-  issuerSigned?: IssuerSigned;
-};
-```
+This table contains the list of error codes that can be thrown by the `CBOR` module which are mapped via the `ModuleErrorCodes` type:
+| Type | Platform | Description |
+| -------------------------- | ----------- | ------------------------------------------------------------ |
+| DECODE_ERROR | Android/iOS | An error occurred while decoding the CBOR |
+| DECODE_DOCUMENTS_ERROR | Android/iOS | An error occurred while decoding a CBOR mDOC |
+| DECODE_ISSUER_SIGNED_ERROR | Android/iOS | An error occurred while decoding a CBOR Issuer Signed object |
 
-#### `IssuerSigned`
+An error can be parsed using the `ModuleErrorSchema` with type `ModuleErrorCodes` exposed by the `ISO18013_5` module. The error can be parsed as follows:
 
 ```typescript
-type IssuerSigned = {
-  nameSpaces?: Record<string, Array<DocumentValue>>;
-  issuerAuth?: string;
-};
+import { CBOR } from '@pagopa/io-react-native-iso18013';
+try {
+  await CBOR.func();
+} catch (error) {
+  const parsedError = CBOR.ModuleErrorSchema.parse(error); // Or ModuleErrorSchema.safeParse(error) for safe parsing
+  console.log(JSON.stringify(parsedError, null, 2));
+}
 ```
 
-#### `DocumentValue`
+The parsed object will contain properties from both iOS and Android platforms:
 
 ```typescript
-type DocumentValue = {
-  digestID?: number;
-  random?: string;
-  elementIdentifier?: string;
-  elementValue?: string;
+{
+  code: string; // Defined in ModuleErrorCodes
+  message: string;
+  name: string;
+  userInfo?: Record<string, any> | null;
+  nativeStackAndroid?: Array<{
+    lineNumber: number;
+    file: string;
+    methodName: string;
+    class: string;
+  }>;
+  domain?: string;
+  nativeStackIOS?: Array<string>;
 };
 ```
-
-#### `DocumentType`
-
-```typescript
-enum DocumentTypeEnum {
-  MDL = 'org.iso.18013.5.1.mDL',
-  EU_PID = 'eu.europa.ec.eudi.pid.1',
-}
-```
-
-### Error Codes
-
-| Type              | Platform    | Description                                   |
-| ----------------- | ----------- | --------------------------------------------- |
-| INVALID_ENCODING  | Android/iOS | Provided payload has incorrect encoding       |
-| UNABLE_TO_DECODE  | Android/iOS | The data does not contain a valid CBOR object |
-| UNKNOWN_EXCEPTION | Android/iOS | Unexpected failure                            |

package/src/cbor/cbor/decoder.ts

@@ -8,15 +8,11 @@ import {
 import { coerceToJSON } from './schema.utils';
 
 /**
- * Decode base64 encoded CBOR data to JSON object.
+ * Decode base64 or base64url encoded CBOR data to JSON object.
+ * This method does not handle nested CBOR data, which will need additional parsing.
  *
- * If it is not possibile to decode the provided data, the promise will be rejected with
- * an instance of {@link CborFailure}.
- *
- * **NOTE**: this method does not handle nested CBOR data, which will need additional
- * parsing.
- *
- * @param data - The base64 or base64url encoded CBOR data
+ * @param data - The base64 or base64url encoded CBOR string
+ * @throws {ModuleError} in case of failure which can be parsed with {@link ModuleErrorSchema}
  * @returns The decoded data as JSON object
  */
 export const decode = async (data: string): Promise<any> => {
@@ -25,12 +21,9 @@ export const decode = async (data: string): Promise<any> => {
 };
 
 /**
- * Decode base64 or base64url encoded CBOR data to mDOC object
- *
- * If it is not possibile to decode the provided data, the promise will be rejected with
- * an instance of {@link CborFailure}.
- *
- * @param data - The base64 encoded MDOC data
+ * Decode base64 or base64url encoded mDOC-CBOR data to a JSON object
+ * @param data - The base64 or base64url encoded mDOC-CBOR string
+ * @throws {ModuleError} in case of failure which can be parsed with {@link ModuleErrorSchema}
  * @returns The decoded data as mDOC object
  */
 export const decodeDocuments = async (data: string): Promise<Documents> => {
@@ -39,18 +32,15 @@ export const decodeDocuments = async (data: string): Promise<Documents> => {
 };
 
 /**
- * Extract and decode the {@link IssuerSigned} with the {@link IssuerAuth} decoded from base64 encoded CBOR
- *
- * If it is not possibile to decode the provided data, the promise will be rejected with
- * an instance of {@link CborFailure}.
- *
- * @param issuerSigned - The base64 or base64url encoded MDOC data
- * @returns The decoded {@link IssuerSigned} contained in the mDOC object
+ * Decode base64 or base64url encoded issuerSigned attribute part of an mDOC-CBOR.
+ * @param data - The base64 or base64url encoded mDOC-CBOR containing the issuerSigned
+ * @throws {ModuleError} in case of failure which can be parsed with {@link ModuleErrorSchema}
+ * @returns The decoded {@link IssuerSigned}
  */
 export const decodeIssuerSigned = async (
-  issuerSigned: string
+  data: string
 ): Promise<IssuerSigned> => {
   const decodedIssuerSignedString =
-    await IoReactNativeCbor.decodeIssuerSigned(issuerSigned);
+    await IoReactNativeCbor.decodeIssuerSigned(data);
   return await IssuerSignedFromString.parseAsync(decodedIssuerSignedString);
 };

package/src/cbor/cbor/error.ts

@@ -0,0 +1,23 @@
+import z from 'zod';
+import { GenericModuleErrorSchema } from '../../schema';
+
+/**
+ * Error codes which the CBOR module uses to reject a promise.
+ */
+const ModuleErrorCodesSchema = z.enum([
+  'DECODE_ERROR',
+  'DECODE_DOCUMENTS_ERROR',
+  'DECODE_ISSUER_SIGNED_ERROR',
+  'EUNSPECIFIED', // Android only default when no other error is specified
+]);
+
+export type ModuleErrorCodes = z.infer<typeof ModuleErrorCodesSchema>;
+
+/**
+ * Schema which can be used to parse a rejected promise error by the CBOR module.
+ */
+export const ModuleErrorSchema = GenericModuleErrorSchema(
+  ModuleErrorCodesSchema
+);
+
+export type ModuleError = z.infer<typeof ModuleErrorSchema>;

package/src/cbor/cbor/index.ts

@@ -6,4 +6,8 @@ export {
   IssuerSigned,
   MDOC,
 } from './schema';
-export { type CborFailure, type CborFailureCodes } from './failure';
+export {
+  type ModuleError,
+  type ModuleErrorCodes,
+  ModuleErrorSchema,
+} from './error';

package/src/cbor/cose/README.md

@@ -3,7 +3,7 @@
 This module provides methods to sign and verify data with COSE.
 
 ```typescript
-import { COSE } from '@pagopa/io-react-native-cbor';
+import { COSE } from '@pagopa/io-react-native-iso18013';
 ```
 
 ### Methods
@@ -42,12 +42,42 @@ try {
 }
 ```
 
-### Error Codes
+### Error
 
-| Type                 | Platform    | Description                                        |
-| -------------------- | ----------- | -------------------------------------------------- |
-| PUBLIC_KEY_NOT_FOUND | Android/iOS | The public key is missing for the specified keyTag |
-| INVALID_ENCODING     | Android/iOS | Provided payload has incorrect encoding            |
-| UNABLE_TO_SIGN       | Android/iOS | It was not possible to sign the given string       |
-| THREADING_ERROR      | iOS         | Unexpected failure                                 |
-| UNKNOWN_EXCEPTION    | Android/iOS | Unexpected failure                                 |
+This table contains the list of error codes that can be thrown by the `COSE` module which are mapped via the `ModuleErrorCodes` type:
+| Type | Platform | Description |
+| -------------------------- | ----------- | ------------------------------------------------------------ |
+| SIGN_ERROR | Android/iOS | An error occurred while signing the data |
+| VERIFY_ERROR | Android/iOS | An error occurred while verifying the signature |
+| THREADING_ERROR | iOS | An error occurred while performing the sign operation in background |
+
+An error can be parsed using the `ModuleErrorSchema` with type `ModuleErrorCodes` exposed by the `COSE` module. The error can be parsed as follows:
+
+```typescript
+import { COSE } from '@pagopa/io-react-native-iso18013';
+try {
+  await COSE.func();
+} catch (error) {
+  const parsedError = COSE.ModuleErrorSchema.parse(error); // Or ModuleErrorSchema.safeParse(error) for safe parsing
+  console.log(JSON.stringify(parsedError, null, 2));
+}
+```
+
+The parsed object will contain properties from both iOS and Android platforms:
+
+```typescript
+{
+  code: string; // Defined in ModuleErrorCodes
+  message: string;
+  name: string;
+  userInfo?: Record<string, any> | null;
+  nativeStackAndroid?: Array<{
+    lineNumber: number;
+    file: string;
+    methodName: string;
+    class: string;
+  }>;
+  domain?: string;
+  nativeStackIOS?: Array<string>;
+};
+```

package/src/cbor/cose/error.ts

@@ -0,0 +1,23 @@
+import z from 'zod';
+import { GenericModuleErrorSchema } from '../../schema';
+
+/**
+ * Error codes which the COSE module uses to reject a promise.
+ */
+const ModuleErrorCodesSchema = z.enum([
+  'SIGN_ERROR',
+  'VERIFY_ERROR',
+  'THREADING_ERROR', // iOS only
+  'EUNSPECIFIED', // Android only default when no other error is specified
+]);
+
+export type ModuleErrorCodes = z.infer<typeof ModuleErrorCodesSchema>;
+
+/**
+ * Schema which can be used to parse a rejected promise error by the COSE module.
+ */
+export const ModuleErrorSchema = GenericModuleErrorSchema(
+  ModuleErrorCodesSchema
+);
+
+export type ModuleError = z.infer<typeof ModuleErrorSchema>;

package/src/cbor/cose/index.ts

@@ -1,2 +1,6 @@
 export { sign, verify } from './sign';
-export { type CoseFailure, type CoseFailureCodes } from './failure';
+export {
+  type ModuleErrorCodes,
+  type ModuleError,
+  ModuleErrorSchema,
+} from './error';

package/src/cbor/cose/sign.ts

@@ -4,19 +4,20 @@ import { IoReactNativeCbor } from '..';
 /**
  * Sign base64 encoded data with COSE and return the COSE-Sign1 object in base64 encoding
  *
- * @param payload - The base64 or base64url encoded payload to sign
+ * @param data - The base64 or base64url encoded payload to sign
  * @param keyTag - The alias of the key to use for signing.
- * @throws {CoseFailure} If the key does not exist
+ * @throws {ModuleError} in case of failure which can be parsed with {@link ModuleErrorSchema}
  * @returns The COSE-Sign1 object in base64 encoding
  */
-export const sign = async (payload: string, keyTag: string): Promise<string> =>
-  await IoReactNativeCbor.sign(payload, keyTag);
+export const sign = async (data: string, keyTag: string): Promise<string> =>
+  await IoReactNativeCbor.sign(data, keyTag);
 
 /**
  * Verifies a COSE-Sign1 object with the provided public key
  *
  * @param data - The COSE-Sign1 object in base64 or base64url encoding
  * @param publicKey - The public key in JWK format
+ * @throws {ModuleError} in case of failure which can be parsed with {@link ModuleErrorSchema}
  * @returns true if the signature is valid, false otherwise
  */
 export const verify = async (

package/src/iso18013/index.ts

@@ -1,11 +1,4 @@
 import { NativeModules, Platform } from 'react-native';
-export {
-  type AcceptedFields,
-  type EventError,
-  type VerifierRequest,
-  parseEventError,
-  parseVerifierRequest,
-} from './iso18013-5/schema';
 
 const LINKING_ERROR =
   `The package '@pagopa/io-react-native-iso18013' (IoReactNativeIso18013) doesn't seem to be linked. Make sure: \n\n` +

package/src/iso18013/iso18013-5/README.md

@@ -1,13 +1,15 @@
 # ISO18013-5
 
-This library provides a React Native module based on [iso18013-android](https://github.com/pagopa/iso18013-android) and [iso18013-ios](https://github.com/pagopa/iso18013-ios) which allows mDL proximity presentation according to the
-ISO 18013-5 standard and remote presentation according to the ISO 18013-7 standard.
+This library provides a React Native module based on [iso18013-android](https://github.com/pagopa/iso18013-android) and [iso18013-ios](https://github.com/pagopa/iso18013-ios) which allows mDL proximity presentation according to the ISO 18013-5 standard.
 
 ## Installation
 
-## Usage
+```
+yarn add @pagopa/io-react-native-iso18013
+cd ios && bundle exec pod install && cd ..
+```
 
-### `events`
+## Events
 
 This library emits the following events:
 | Event | Payload | Description |
@@ -15,17 +17,39 @@ This library emits the following events:
 | onDeviceConnecting (iOS only) | `undefined` | Event dispatched when the verifier app is connecting |
 | onDeviceConnected | `undefined` | Event dispatched when the verifier app is connected. |
 | onDocumentRequestReceived | `{ data: string } \| undefined` | Event dispatched when the consumer app receives a new request, contained in the data payload. It can be parsed via the `parseVerifierRequest` provided [here](src/schema.ts). |
-| onDeviceDisconnected | `undefined` | Event dispatched when the verifier app disconnects. |
+| onDeviceDisconnected | `undefined` | Event dispatched when the verifier app disconnects by sending the END (0x02) flag. |
 | onError | `{ error: string } \| undefined` | Event dispatched when an error occurs which is contained in the error payload. It can be parsed via the `parseError` provided [here](src/schema.ts). |
 
-Listeners can be added using the `addListener` method and removed using the `removeListener` method.
+The events flow is described in the following diagram:
+
+```mermaid
+flowchart LR
+    onDeviceConnecting["onDeviceConnecting *(iOS only)*"]
+    onDeviceConnected["onDeviceConnected"]
+    onDocumentRequestReceived["onDocumentRequestReceived"]
+    onDeviceDisconnected["onDeviceDisconnected"]
+    onError["onError"]
+
+    onDeviceConnecting -- "Verifier app connects" --> onDeviceConnected
+
+    onDeviceConnected -- "Verifier app sends request" --> onDocumentRequestReceived
+    onDeviceConnected -- "Verifier sends END (0x02)" --> onDeviceDisconnected
+    onDeviceConnected -- "Error status or abrupt disconnection" --> onError
+
+    onDocumentRequestReceived -- "Verifier sends END (0x02)" --> onDeviceDisconnected
+    onDocumentRequestReceived -- "Error status or abrupt disconnection" --> onError
+```
+
+Listeners can be added using the `addListener` method and removed by using the returned reference by calling the `remove` method.
 
 ```typescript
 import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
 
-ISO18013_5.addListener('event', () => console.log('event occurred'));
+const listener = ISO18013_5.addListener('event', () =>
+  console.log('event occurred')
+);
 
-ISO18013_5.removeListener('event');
+listener.remove();
 ```
 
 #### `onDeviceConnecting`
@@ -105,7 +129,9 @@ ISO18013_5.addListener(
 );
 ```
 
-### `start`
+## Methods
+
+#### `start`
 
 Starts the proximity flow and starts the bluetooth service. This method also accepts optional parameters to configure the initialization on Android, along with the possibility
 to specify a certificates of array to verify the reader app.
@@ -116,7 +142,7 @@ import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
 await ISO18013_5.start();
 ```
 
-### `getQrCodeString`
+#### `getQrCodeString`
 
 Returns the QR code string which contains a base64url encoded CBOR object which encodes the bluetooth engagement data.
 It can be used to display the QR code in the UI which will be scanned by the verifier app.
@@ -128,25 +154,37 @@ const qrCodeString = await ISO18013_5.getQrCodeString();
 console.log(qrCodeString);
 ```
 
-### `generateResponse`
+#### `generateResponse`
 
 Generates a response that will be sent to the verifier app containing the requested documents.
 
 ```typescript
 import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
 
-const response = await ISO18013_5.generateResponse({
-  documents: [
-    {
-      type: 'mDL',
-      data: 'base64url-encoded-data',
+const documents = [
+  {
+    issuerSignedContent: 'base64url-or-base64-encoded-content',
+    alias: 'key-alias',
+    docType: 'docType',
+  },
+];
+
+const acceptedFields = {
+  'org.iso.18013.5.1.mDL': {
+    'org.iso.18013.5.1': {
+      hair_colour: true,
+      given_name_national_character: true,
+      family_name_national_character: true,
+      given_name: true,
     },
-  ],
-});
+  },
+};
+
+const response = await ISO18013_5.generateResponse(documents, acceptedFields);
 console.log(response);
 ```
 
-### `sendResponse`
+#### `sendResponse`
 
 Sends the response generate by `generateResponse` to the verifier app.
 
@@ -156,24 +194,21 @@ import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
 await ISO18013_5.sendResponse(response);
 ```
 
-### `sendErrorResponse`
+#### `sendErrorResponse`
 
 Sends an error response to the verifier app. The supported error codes are defined in the Table 20 of the ISO 18013-5 standard and are coded in the `ErrorCode` enum.
 
 ```typescript
 import { ISO18013_5, ErrorCode } from '@pagopa/io-react-native-iso18013';
 
-await ISO18013_5.sendErrorResponse({
-  errorCode: ErrorCode.SESSION_ENCRYPTION,
-  errorMessage: 'An error occurred while encrypting the session',
-});
+await ISO18013_5.sendErrorResponse(ErrorCode.SESSION_ENCRYPTION);
 ```
 
-### `close`
+#### `close`
 
 Closes the QR engagement by releasing the resources allocated during the `start` method.
 Before starting a new flow, it is necessary to call this method to ensure that the previous flow is properly closed.
-The listeners can be removed using the `removeListener` method.
+Listeners can be added using the `addListener` method and removed using the `removeListener` method.
 
 ```typescript
 import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
@@ -181,9 +216,9 @@ import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
 await ISO18013_5.close();
 ```
 
-## Proximity Flow Schema
+## Proximity Sequence Diagram
 
-This section describes a high level overview of the interactions between an app implementing the `io-react-native-proximity` library and a verifier app.
+This section describes a high level overview of the happy flow interactions between an app implementing the `io-react-native-proximity` library and a verifier app.
 
 ```mermaid
 sequenceDiagram
@@ -216,19 +251,60 @@ sequenceDiagram
         proximity->>+verifier: Sends the error response code
         verifier->>+verifier: Shows the received error response code
     end
-    verifier->>+app: Closes the connection
-    proximity->>+app: Calls the onDeviceDisconnected callback
-```
-
-## Error Codes
-
-| Type                            | Platform    | Description                                                                  |
-| ------------------------------- | ----------- | ---------------------------------------------------------------------------- |
-| DRH_NOT_DEFINED                 | Android     | The device retrieval helper hasn't been initialized, call the `start` method |
-| QR_ENGAGEMENT_NOT_DEFINED_ERROR | Android     | The QR engagement hasn't been initialized, call the `start` method           |
-| START_ERROR                     | Android/iOS | An error occurred while initializing the required resources                  |
-| GET_QR_CODE_ERROR               | Android/iOS | An error occurred while generating the engagement QR code                    |
-| GENERATE_RESPONSE_ERROR         | Android/iOS | An error occurred while generating the response for the verifier app         |
-| SEND_RESPONSE_ERROR             | Android/iOS | An error occurred while sending the response to the verifier app             |
-| SEND_ERROR_RESPONSE_ERROR       | Android/iOS | An error occurred while sending the error response to the verifier app       |
-| CLOSE_ERROR                     | Android     | An error occured while closing the required resources                        |
+    alt The verifier sends the END (0x02) termination flag
+      verifier->>+app: Closes the connection
+      proximity->>+app: Calls the onDeviceDisconnected callback
+      app->>+proximity: Calls close()
+    else The verifier app closes the connection without the END (0x02) termination flag
+      verifier->>+app: Closes the connection
+      proximity->>+app: Calls the onError callback
+      app->>+proximity: Calls close()
+    end
+```
+
+## Errors
+
+This table contains the list of error codes that can be thrown by the `ISO18013_5` module which are mapped via the `ModuleErrorCodes` type:
+
+| Type                      | Platform    | Description                                                                  |
+| ------------------------- | ----------- | ---------------------------------------------------------------------------- |
+| DRH_NOT_DEFINED           | Android     | The device retrieval helper hasn't been initialized, call the `start` method |
+| QR_ENGAGEMENT_NOT_DEFINED | Android     | The QR engagement hasn't been initialized, call the `start` method           |
+| START_ERROR               | Android/iOS | An error occurred while initializing the required resources                  |
+| GET_QR_CODE_ERROR         | Android/iOS | An error occurred while generating the engagement QR code                    |
+| SEND_RESPONSE_ERROR       | Android/iOS | An error occurred while sending the response for the verifier app            |
+| SEND_ERROR_RESPONSE_ERROR | Android/iOS | An error occurred while sending the error response to the verifier app       |
+| GENERATE_RESPONSE_ERROR   | Android/iOS | An error occurred while generating the response for the verifier app         |
+| CLOSE_ERROR               | Android     | An error occured while closing the required resources                        |
+| EUNSPECIFIED              | Android     | Default error when no other error is specified                               |
+
+An error can be parsed using the `ModuleErrorSchema` with type `ModuleErrorCodes` exposed by the `ISO18013_5` module. The error can be parsed as follows:
+
+```typescript
+import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
+try {
+  await ISO18013_5.func();
+} catch (error) {
+  const parsedError = ISO18013_5.ModuleErrorSchema.parse(error); // Or ModuleErrorSchema.safeParse(error) for safe parsing
+  console.log(JSON.stringify(parsedError, null, 2));
+}
+```
+
+The parsed object will contain properties from both iOS and Android platforms:
+
+```typescript
+{
+  code: string; // Defined in ModuleErrorCodes
+  message: string;
+  name: string;
+  userInfo?: Record<string, any> | null;
+  nativeStackAndroid?: Array<{
+    lineNumber: number;
+    file: string;
+    methodName: string;
+    class: string;
+  }>;
+  domain?: string;
+  nativeStackIOS?: Array<string>;
+};
+```

package/src/iso18013/iso18013-5/error.ts

@@ -0,0 +1,35 @@
+import z from 'zod';
+import { GenericModuleErrorSchema } from '../../schema';
+
+/**
+ * Schema for parsing the payload returned by the `onError` event in Proximity `Events`, along with its type definition.
+ */
+export const OnErrorPayloadSchema = z.string().catch('Unknown error');
+
+export type OnErrorPayload = z.infer<typeof OnErrorPayloadSchema>;
+
+/**
+ * Error codes which the ISO18013_5 module uses to reject a promise.
+ */
+const ModuleErrorCodesSchema = z.enum([
+  'DRH_NOT_DEFINED', // Android only
+  'QR_ENGAGEMENT_NOT_DEFINED', // Android only
+  'START_ERROR',
+  'GET_QR_CODE_ERROR',
+  'SEND_RESPONSE_ERROR',
+  'SEND_ERROR_RESPONSE_ERROR',
+  'GENERATE_RESPONSE_ERROR',
+  'CLOSE_ERROR', // Android only
+  'EUNSPECIFIED', // Android only default when no other error is specified
+]);
+
+export type ModuleErrorCodes = z.infer<typeof ModuleErrorCodesSchema>;
+
+/**
+ * Schema which can be used to parse a rejected promise error by the ISO18013_5 module.
+ */
+export const ModuleErrorSchema = GenericModuleErrorSchema(
+  ModuleErrorCodesSchema
+);
+
+export type ModuleError = z.infer<typeof ModuleErrorSchema>;