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

package/lib/module/iso18013/iso18013-5/error.js

@@ -0,0 +1,25 @@
+"use strict";
+
+import z from 'zod';
+import { GenericModuleErrorSchema } from "../../schema.js";
+
+/**
+ * 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');
+/**
+ * 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
+]);
+/**
+ * Schema which can be used to parse a rejected promise error by the ISO18013_5 module.
+ */
+export const ModuleErrorSchema = GenericModuleErrorSchema(ModuleErrorCodesSchema);
+//# sourceMappingURL=error.js.map

package/lib/module/iso18013/iso18013-5/error.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["z","GenericModuleErrorSchema","OnErrorPayloadSchema","string","catch","ModuleErrorCodesSchema","enum","ModuleErrorSchema"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-5/error.ts"],"mappings":";;AAAA,OAAOA,CAAC,MAAM,KAAK;AACnB,SAASC,wBAAwB,QAAQ,iBAAc;;AAEvD;AACA;AACA;AACA,OAAO,MAAMC,oBAAoB,GAAGF,CAAC,CAACG,MAAM,CAAC,CAAC,CAACC,KAAK,CAAC,eAAe,CAAC;AAIrE;AACA;AACA;AACA,MAAMC,sBAAsB,GAAGL,CAAC,CAACM,IAAI,CAAC,CACpC,iBAAiB;AAAE;AACnB,2BAA2B;AAAE;AAC7B,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACrB,2BAA2B,EAC3B,yBAAyB,EACzB,aAAa;AAAE;AACf,cAAc,CAAE;AAAA,CACjB,CAAC;AAIF;AACA;AACA;AACA,OAAO,MAAMC,iBAAiB,GAAGN,wBAAwB,CACvDI,sBACF,CAAC","ignoreList":[]}

package/lib/module/iso18013/iso18013-5/index.js

@@ -1,5 +1,6 @@
 "use strict";
 
-export { parseEventError, parseVerifierRequest } from "./schema.js";
-export { ErrorCode, addListener, close, generateResponse, getQrCodeString, removeListener, sendErrorResponse, sendResponse, start } from "./proximity.js";
+export { parseVerifierRequest } from "./request.js";
+export { OnErrorPayloadSchema, ModuleErrorSchema } from "./error.js";
+export { ErrorCode, addListener, close, generateResponse, getQrCodeString, sendErrorResponse, sendResponse, start } from "./proximity.js";
 //# sourceMappingURL=index.js.map

package/lib/module/iso18013/iso18013-5/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["parseEventError","parseVerifierRequest","ErrorCode","addListener","close","generateResponse","getQrCodeString","removeListener","sendErrorResponse","sendResponse","start"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-5/index.ts"],"mappings":";;AAAA,SAIEA,eAAe,EACfC,oBAAoB,QACf,aAAU;AAEjB,SACEC,SAAS,EAGTC,WAAW,EACXC,KAAK,EACLC,gBAAgB,EAChBC,eAAe,EACfC,cAAc,EACdC,iBAAiB,EACjBC,YAAY,EACZC,KAAK,QACA,gBAAa","ignoreList":[]}
+{"version":3,"names":["parseVerifierRequest","OnErrorPayloadSchema","ModuleErrorSchema","ErrorCode","addListener","close","generateResponse","getQrCodeString","sendErrorResponse","sendResponse","start"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-5/index.ts"],"mappings":";;AAAA,SAA+BA,oBAAoB,QAAQ,cAAW;AAEtE,SAEEC,oBAAoB,EACpBC,iBAAiB,QAGZ,YAAS;AAEhB,SACEC,SAAS,EAGTC,WAAW,EACXC,KAAK,EACLC,gBAAgB,EAChBC,eAAe,EACfC,iBAAiB,EACjBC,YAAY,EACZC,KAAK,QACA,gBAAa","ignoreList":[]}

package/lib/module/iso18013/iso18013-5/proximity.js

@@ -31,10 +31,12 @@ export let ErrorCode = /*#__PURE__*/function (ErrorCode) {
 
 /**
  * Starts the proximity flow by allocating the necessary resources and initializing the Bluetooth stack.
+ * Resolves to true or rejects in case of error.
  * @param config.peripheralMode (Android only) - Whether the device is in peripheral mode. Defaults to true
  * @param config.centralClientMode (Android only) - Whether the device is in central client mode. Defaults to false
  * @param config.clearBleCache (Android only) - Whether the BLE cache should be cleared. Defaults to true
  * @param config.certificates - Two-dimensional array of base64 strings representing DER encoded X.509 certificate which are used to authenticate the verifier app
+ * @throws {ModuleError} in case of error which can be parsed with {@link ModuleErrorSchema}
  */
 export function start(config = {}) {
   const {
@@ -51,32 +53,41 @@ export function start(config = {}) {
 }
 
 /**
- * Gets the QR code string this method is responsible for initializing the connection and retrieving the QR code string
+ * Creates a QR code to be scanned in order to initialize the presentation.
+ * Resolves with a string containing the QR code or rejects in case of error.
+ * @throws {ModuleError} in case of error which can be parsed with {@link ModuleErrorSchema}
  */
 export function getQrCodeString() {
   return IoReactNativeIso18013.getQrCodeString();
 }
 
 /**
- * Closes the QR engagement
+ * Closes the bluetooth connection and clears any resource.
+ * Resolves to true after closing the connection or rejects in case of error.
+ * @throws {ModuleError} in case of error which can be parsed with {@link ModuleErrorSchema}
  */
 export function close() {
   return IoReactNativeIso18013.close();
 }
 
 /**
- * Sends an error response to the verifier app.
+ * Sends an error response during the presentation according to the SessionData status codes
+ * defined in table 20 of the ISO18013-5 standard.
+ * Resolves to true or rejects in case of error.
  * The error code must be one of the `ErrorCode` enum values.
  * @param code - The error code to be sent to the verifier app.
+ * @throws {ModuleError} in case of error which can be parsed with {@link ModuleErrorSchema}
  */
 export function sendErrorResponse(code) {
   return IoReactNativeIso18013.sendErrorResponse(code);
 }
 
 /**
- * Generates a response that will be sent to the verifier app containing the requested data
- * @param documents - An array of `Document` which contains the requested data received from the `onDocumentRequestReceived` event
+ * Generates a response which can later be sent with {sendResponse} with the provided CBOR documents and the requested attributes.
+ * Resolves with a base64 encoded response or rejects in case of error.
+ * @param documents - An array of `RequestedDocument` which contains the requested data received from the `onDocumentRequestReceived` event
  * @param acceptedFields - The accepted fields which will be presented to the verifier app. See the type definition for more details.
+ * @throws {ModuleError} in case of error which can be parsed with {@link ModuleErrorSchema}
  * @returns A base64 encoded response to be sent to the verifier app via `sendResponse`
  */
 export function generateResponse(documents, acceptedFields) {
@@ -84,9 +95,11 @@ export function generateResponse(documents, acceptedFields) {
 }
 
 /**
- * Sends the response generated through the `generateResponse` method to the verifier app.
+ * Sends a response containing the documents and the fields which the user decided to present generated by {@link generateResponse}.
  * Currently there's not evidence of the verifier app responding to this request, thus we don't handle the response.
+ * Resolves with a true boolean in case of success or rejects in case of error.
  * @param response - The base64 encoded response to be sent to the verifier app.
+ * @throws {ModuleError} in case of failure which can be parsed with {@link ModuleErrorSchema}
  */
 export function sendResponse(response) {
   return IoReactNativeIso18013.sendResponse(response);
@@ -99,14 +112,6 @@ export function sendResponse(response) {
  * @param callback - The callback to be called when the event is emitted. The callback will receive the event payload as an argument.
  */
 export function addListener(event, callback) {
-  eventEmitter.addListener(event, callback);
-}
-
-/**
- * Removes a listener for a `QrEngagementEvents` event.
- * @param event - The event to remove the listener for. The available events are defined in the `QrEngagementEvents` type.
- */
-export function removeListener(event) {
-  eventEmitter.removeAllListeners(event);
+  return eventEmitter.addListener(event, callback);
 }
 //# sourceMappingURL=proximity.js.map

package/lib/module/iso18013/iso18013-5/proximity.js.map

@@ -1 +1 @@
-{"version":3,"names":["NativeEventEmitter","Platform","IoReactNativeIso18013","eventEmitter","ErrorCode","start","config","peripheralMode","centralClientMode","clearBleCache","certificates","OS","getQrCodeString","close","sendErrorResponse","code","generateResponse","documents","acceptedFields","sendResponse","response","addListener","event","callback","removeListener","removeAllListeners"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-5/proximity.ts"],"mappings":";;AAAA,SAASA,kBAAkB,EAAEC,QAAQ,QAAQ,cAAc;AAC3D,SAASC,qBAAqB,QAAQ,aAAI;AAI1C,MAAMC,YAAY,GAAG,IAAIH,kBAAkB,CAACE,qBAAqB,CAAC;;AAElE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA,WAAYE,SAAS,0BAATA,SAAS;EAATA,SAAS,CAATA,SAAS;EAATA,SAAS,CAATA,SAAS;EAATA,SAAS,CAATA,SAAS;EAAA,OAATA,SAAS;AAAA;;AAMrB;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,KAAKA,CACnBC,MAKC,GAAG,CAAC,CAAC,EACY;EAClB,MAAM;IAAEC,cAAc;IAAEC,iBAAiB;IAAEC,aAAa;IAAEC;EAAa,CAAC,GACtEJ,MAAM;EACR,IAAIL,QAAQ,CAACU,EAAE,KAAK,KAAK,EAAE;IACzB,OAAOT,qBAAqB,CAACG,KAAK,CAACK,YAAY,GAAGA,YAAY,GAAG,EAAE,CAAC;EACtE,CAAC,MAAM;IACL,OAAOR,qBAAqB,CAACG,KAAK,CAChCE,cAAc,GAAGA,cAAc,GAAG,IAAI,EACtCC,iBAAiB,GAAGA,iBAAiB,GAAG,KAAK,EAC7CC,aAAa,GAAGA,aAAa,GAAG,IAAI,EACpCC,YAAY,GAAGA,YAAY,GAAG,EAChC,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA,OAAO,SAASE,eAAeA,CAAA,EAAoB;EACjD,OAAOV,qBAAqB,CAACU,eAAe,CAAC,CAAC;AAChD;;AAEA;AACA;AACA;AACA,OAAO,SAASC,KAAKA,CAAA,EAAqB;EACxC,OAAOX,qBAAqB,CAACW,KAAK,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,iBAAiBA,CAACC,IAAe,EAAoB;EACnE,OAAOb,qBAAqB,CAACY,iBAAiB,CAACC,IAAI,CAAC;AACtD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAC9BC,SAAmC,EACnCC,cAA8B,EACb;EACjB,OAAOhB,qBAAqB,CAACc,gBAAgB,CAACC,SAAS,EAAEC,cAAc,CAAC;AAC1E;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACC,QAAgB,EAAoB;EAC/D,OAAOlB,qBAAqB,CAACiB,YAAY,CAACC,QAAQ,CAAC;AACrD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,WAAWA,CACzBC,KAAQ,EACRC,QAA0C,EAC1C;EACApB,YAAY,CAACkB,WAAW,CAACC,KAAK,EAAEC,QAAQ,CAAC;AAC3C;;AAEA;AACA;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAACF,KAAa,EAAE;EAC5CnB,YAAY,CAACsB,kBAAkB,CAACH,KAAK,CAAC;AACxC","ignoreList":[]}
+{"version":3,"names":["NativeEventEmitter","Platform","IoReactNativeIso18013","eventEmitter","ErrorCode","start","config","peripheralMode","centralClientMode","clearBleCache","certificates","OS","getQrCodeString","close","sendErrorResponse","code","generateResponse","documents","acceptedFields","sendResponse","response","addListener","event","callback"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-5/proximity.ts"],"mappings":";;AAAA,SAASA,kBAAkB,EAAEC,QAAQ,QAAQ,cAAc;AAC3D,SAASC,qBAAqB,QAAQ,aAAI;AAG1C,MAAMC,YAAY,GAAG,IAAIH,kBAAkB,CAACE,qBAAqB,CAAC;;AAElE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA,WAAYE,SAAS,0BAATA,SAAS;EAATA,SAAS,CAATA,SAAS;EAATA,SAAS,CAATA,SAAS;EAATA,SAAS,CAATA,SAAS;EAAA,OAATA,SAAS;AAAA;;AAMrB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,KAAKA,CACnBC,MAKC,GAAG,CAAC,CAAC,EACY;EAClB,MAAM;IAAEC,cAAc;IAAEC,iBAAiB;IAAEC,aAAa;IAAEC;EAAa,CAAC,GACtEJ,MAAM;EACR,IAAIL,QAAQ,CAACU,EAAE,KAAK,KAAK,EAAE;IACzB,OAAOT,qBAAqB,CAACG,KAAK,CAACK,YAAY,GAAGA,YAAY,GAAG,EAAE,CAAC;EACtE,CAAC,MAAM;IACL,OAAOR,qBAAqB,CAACG,KAAK,CAChCE,cAAc,GAAGA,cAAc,GAAG,IAAI,EACtCC,iBAAiB,GAAGA,iBAAiB,GAAG,KAAK,EAC7CC,aAAa,GAAGA,aAAa,GAAG,IAAI,EACpCC,YAAY,GAAGA,YAAY,GAAG,EAChC,CAAC;EACH;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASE,eAAeA,CAAA,EAAoB;EACjD,OAAOV,qBAAqB,CAACU,eAAe,CAAC,CAAC;AAChD;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,KAAKA,CAAA,EAAqB;EACxC,OAAOX,qBAAqB,CAACW,KAAK,CAAC,CAAC;AACtC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,iBAAiBA,CAACC,IAAe,EAAoB;EACnE,OAAOb,qBAAqB,CAACY,iBAAiB,CAACC,IAAI,CAAC;AACtD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAC9BC,SAAmC,EACnCC,cAA8B,EACb;EACjB,OAAOhB,qBAAqB,CAACc,gBAAgB,CAACC,SAAS,EAAEC,cAAc,CAAC;AAC1E;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACC,QAAgB,EAAoB;EAC/D,OAAOlB,qBAAqB,CAACiB,YAAY,CAACC,QAAQ,CAAC;AACrD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,WAAWA,CACzBC,KAAQ,EACRC,QAA0C,EAC1C;EACA,OAAOpB,YAAY,CAACkB,WAAW,CAACC,KAAK,EAAEC,QAAQ,CAAC;AAClD","ignoreList":[]}

package/lib/module/iso18013/iso18013-5/{schema.js → request.js}

@@ -40,40 +40,4 @@ const VerifierRequest = z.object({
 export const parseVerifierRequest = input => {
   return VerifierRequest.parse(input);
 };
-
-/**
- * Zod schema for the type returned by the `onError` event in Proximity `Events`.
- */
-const EventError = z.string().catch('Unknown error');
-
-/**
- * Error type returned by the `onError` event in Proximity `Events`.
- */
-
-/**
- * Parses the input to an Error object.
- * This function is used to parse the error received from the verifier app via the `onError` event.
- * @param input - The input to be parsed
- * @returns The parsed Error object or a default error message if parsing fails
- */
-export const parseEventError = input => {
-  return EventError.parse(input);
-};
-
-/**
- * This is the type definition for the accepted fields that will be presented to the verifier app.
- * It contains of a nested object structure, where the outermost key represents the credential doctype.
- * The inner dictionary contains namespaces, and for each namespace, there is another dictionary mapping requested claims to a boolean value,
- * which indicates whether the user is willing to present the corresponding claim. Example:
- * `{
- *    "org.iso.18013.5.1.mDL": {
- *      "org.iso.18013.5.1": {
- *        "hair_colour": true, // Indicates the user is willing to present this claim
- *        "given_name_national_character": true,
- *        "family_name_national_character": true,
- *        "given_name": true,
- *     }
- *    }
- *  }`
- **/
-//# sourceMappingURL=schema.js.map
+//# sourceMappingURL=request.js.map

package/lib/module/iso18013/iso18013-5/request.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["z","booleanFieldGroup","record","boolean","credentialEntrySchema","object","isAuthenticated","catchall","VerifierRequest","request","parseVerifierRequest","input","parse"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-5/request.ts"],"mappings":";;AAAA,SAASA,CAAC,QAAQ,KAAK;;AAEvB;AACA,MAAMC,iBAAiB,GAAGD,CAAC,CAACE,MAAM,CAACF,CAAC,CAACG,OAAO,CAAC,CAAC,CAAC;AAE/C,MAAMC,qBAAqB,GAAGJ,CAAC,CAC5BK,MAAM,CAAC;EACNC,eAAe,EAAEN,CAAC,CAACG,OAAO,CAAC;AAC7B,CAAC,CAAC,CACDI,QAAQ,CAACN,iBAAiB,CAAC;AAE9B,MAAMO,eAAe,GAAGR,CAAC,CAACK,MAAM,CAAC;EAC/BI,OAAO,EAAET,CAAC,CAACE,MAAM,CAACE,qBAAqB;AACzC,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMM,oBAAoB,GAAIC,KAAc,IAAsB;EACvE,OAAOH,eAAe,CAACI,KAAK,CAACD,KAAK,CAAC;AACrC,CAAC","ignoreList":[]}

package/lib/module/iso18013/iso18013-7/README.md

@@ -1,59 +1,84 @@
-## ISO18013-7
+# ISO18013-7
 
-This module provides methods to obtain data structures necessary for the processes defined in the `ISO-18013` 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 remote presentation according to the ISO 18013-7 standard.
 
 ```typescript
-import { ISO18013_7 } from '@pagopa/io-react-native-cbor';
+import { ISO18013_7 } from '@pagopa/io-react-native-iso18013';
 ```
 
-### Methods
+## Methods
 
 #### `generateOID4VPDeviceResponse`
 
-Generates CBOR of the _Device Response_ containing all the claims that have been chosen to be presented during an _OID4VP_ session.
-
-Returns a `Promise` which resolves to a `string` containing the CBOR of the **Device Response** object or rejects with an instance of `CoseFailure` in case of failures.
+Returns a string containing the CBOR of the **Device Response** object.
 
 ```typescript
-try {
-  const result = await ISO18013_7.generateOID4VPDeviceResponse(
-    clientId,
-    responseUri,
-    authorizationRequestNonce,
-    mdocGeneratedNonce,
-    documents,
-    fieldRequestedAndAccepted
-  );
-} catch (error: any) {
-  const { message, userInfo } = e as CoseFailure;
-}
+import { ISO18013_7 } from '@pagopa/io-react-native-iso18013';
+
+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 result = await ISO18013_7.generateOID4VPDeviceResponse(
+  clientId,
+  responseUri,
+  authorizationRequestNonce,
+  mdocGeneratedNonce,
+  documents,
+  acceptedFields
+);
 ```
 
-#### Signature
+## Errors
+
+This table contains the list of error codes that can be thrown by the `ISO18013_7` module which are mapped via the `ModuleErrorCodes` type:
+
+| Type                           | Platform    | Description                                     |
+| ------------------------------ | ----------- | ----------------------------------------------- |
+| GENERATE_OID4VP_RESPONSE_ERROR | Android/iOS | An error occurred while generating the response |
+
+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 RequestedDocument = {
-    issuerSignedContent : string,
-    alias : string,
-    docType : string
+import { ISO18013_7 } from '@pagopa/io-react-native-iso18013';
+try {
+  await ISO18013_7.func();
+} catch (error) {
+  const parsedError = ISO18013_7.ModuleErrorSchema.parse(error); // Or ModuleErrorSchema.safeParse(error) for safe parsing
+  console.log(JSON.stringify(parsedError, null, 2));
 }
-
-export const generateOID4VPDeviceResponse = async (
-  clientId: string,
-  responseUri: string,
-  authorizationRequestNonce: string,
-  mdocGeneratedNonce: string,
-  documents: Array<RequestedDocument>,
-  fieldRequestedAndAccepted: Record<string, any> | string
-) : Promise<string> => {...};
 ```
 
-### Error Codes
+The parsed object will contain properties from both iOS and Android platforms:
 
-| Type                              | Platform    | Description                                                        |
-| --------------------------------- | ----------- | ------------------------------------------------------------------ |
-| UNABLE_TO_GENERATE_RESPONSE       | Android/iOS | Failure during the generation of a response                        |
-| DOC_REQUESTED_PARSING_EXCEPTION   | Android/iOS | The passed documents where in a bad format or contained wrong data |
-| REQUESTED_ITEMS_PARSING_EXCEPTION | iOS         | The passed items where in a bad format                             |
-| UNABLE_TO_GENERATE_TRANSCRIPT     | Android     | There has been an error generating the session transcript          |
-| UNKNOWN_EXCEPTION                 | Android/iOS | Unexpected failure                                                 |
+```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/lib/module/iso18013/iso18013-7/error.js

@@ -0,0 +1,15 @@
+"use strict";
+
+import z from 'zod';
+import { GenericModuleErrorSchema } from "../../schema.js";
+
+/**
+ * Error codes which the ISO18013_7 module uses to reject a promise.
+ */
+const ModuleErrorCodesSchema = z.enum(['GENERATE_OID4VP_RESPONSE_ERROR', 'EUNSPECIFIED' // Android only default when no other error is specified
+]);
+/**
+ * Schema which can be used to parse a rejected promise error by the ISO18013_7 module.
+ */
+export const ModuleErrorSchema = GenericModuleErrorSchema(ModuleErrorCodesSchema);
+//# sourceMappingURL=error.js.map

package/lib/module/iso18013/iso18013-7/error.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["z","GenericModuleErrorSchema","ModuleErrorCodesSchema","enum","ModuleErrorSchema"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-7/error.ts"],"mappings":";;AAAA,OAAOA,CAAC,MAAM,KAAK;AACnB,SAASC,wBAAwB,QAAQ,iBAAc;;AAEvD;AACA;AACA;AACA,MAAMC,sBAAsB,GAAGF,CAAC,CAACG,IAAI,CAAC,CACpC,gCAAgC,EAChC,cAAc,CAAE;AAAA,CACjB,CAAC;AAIF;AACA;AACA;AACA,OAAO,MAAMC,iBAAiB,GAAGH,wBAAwB,CACvDC,sBACF,CAAC","ignoreList":[]}

package/lib/module/iso18013/iso18013-7/index.js

@@ -1,4 +1,5 @@
 "use strict";
 
 export { generateOID4VPDeviceResponse } from "./remote.js";
+export { ModuleErrorSchema } from "./error.js";
 //# sourceMappingURL=index.js.map

package/lib/module/iso18013/iso18013-7/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["generateOID4VPDeviceResponse"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-7/index.ts"],"mappings":";;AAAA,SACEA,4BAA4B,QAGvB,aAAU","ignoreList":[]}
+{"version":3,"names":["generateOID4VPDeviceResponse","ModuleErrorSchema"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-7/index.ts"],"mappings":";;AAAA,SAASA,4BAA4B,QAAQ,aAAU;AACvD,SACEC,iBAAiB,QAGZ,YAAS","ignoreList":[]}

package/lib/module/iso18013/iso18013-7/remote.js

@@ -1,31 +1,18 @@
 "use strict";
 
 import { IoReactNativeIso18013 } from "../index.js";
-
-/**
- * All error codes that the module could return.
- */
-
-/**
- * Error type returned by a rejected promise.
- *
- * If additional error information are available,
- * they are stored in the {@link OID4VPFailure["userInfo"]} field.
- */
-
 /**
- *
- * @param clientId extracted from OID4VP session
- * @param responseUri extracted from OID4VP session
- * @param authorizationRequestNonce extracted from OID4VP session
- * @param mdocGeneratedNonce To be generated
- * @param documents An Array of {@link DocRequested}
- * @param fieldRequestedAndAccepted extracted from OID4VP session, it's a record of claims
- *                                  accepted for disclosure or its stringification
- * @throws {OID4VPFailure} in case of failure
- * @returns the Device Response in CBOR format
+ * Generates a CBOR device response for ISO 18013-7 mDL remote presentation using OID4VP.
+ * @param clientId - the client id extracted from OID4VP session
+ * @param responseUri - the response URI extracted from OID4VP session
+ * @param authorizationRequestNonce - the authorization request nonce extracted from OID4VP session
+ * @param mdocGeneratedNonce - the mdoc generated nonce to be generated
+ * @param documents - an array of {@link RequestedDocument}
+ * @param acceptedFields - a record of claims accepted for disclosure or its stringification extracted from OID4VP session
+ * @throws {ModuleError} in case of failure which can be parsed with {@link ModuleErrorSchema}
+ * @returns a base64 encoded device response
  */
-export const generateOID4VPDeviceResponse = async (clientId, responseUri, authorizationRequestNonce, mdocGeneratedNonce, documents, fieldRequestedAndAccepted) => {
-  return await IoReactNativeIso18013.generateOID4VPDeviceResponse(clientId, responseUri, authorizationRequestNonce, mdocGeneratedNonce, documents, typeof fieldRequestedAndAccepted === 'string' ? fieldRequestedAndAccepted : JSON.stringify(fieldRequestedAndAccepted));
+export const generateOID4VPDeviceResponse = async (clientId, responseUri, authorizationRequestNonce, mdocGeneratedNonce, documents, acceptedFields) => {
+  return await IoReactNativeIso18013.generateOID4VPDeviceResponse(clientId, responseUri, authorizationRequestNonce, mdocGeneratedNonce, documents, acceptedFields);
 };
 //# sourceMappingURL=remote.js.map

package/lib/module/iso18013/iso18013-7/remote.js.map

@@ -1 +1 @@
-{"version":3,"names":["IoReactNativeIso18013","generateOID4VPDeviceResponse","clientId","responseUri","authorizationRequestNonce","mdocGeneratedNonce","documents","fieldRequestedAndAccepted","JSON","stringify"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-7/remote.ts"],"mappings":";;AAAA,SAASA,qBAAqB,QAAQ,aAAI;;AAG1C;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,4BAA4B,GAAG,MAAAA,CAC1CC,QAAgB,EAChBC,WAAmB,EACnBC,yBAAiC,EACjCC,kBAA0B,EAC1BC,SAAmC,EACnCC,yBAAuD,KACnC;EACpB,OAAO,MAAMP,qBAAqB,CAACC,4BAA4B,CAC7DC,QAAQ,EACRC,WAAW,EACXC,yBAAyB,EACzBC,kBAAkB,EAClBC,SAAS,EACT,OAAOC,yBAAyB,KAAK,QAAQ,GACzCA,yBAAyB,GACzBC,IAAI,CAACC,SAAS,CAACF,yBAAyB,CAC9C,CAAC;AACH,CAAC","ignoreList":[]}
+{"version":3,"names":["IoReactNativeIso18013","generateOID4VPDeviceResponse","clientId","responseUri","authorizationRequestNonce","mdocGeneratedNonce","documents","acceptedFields"],"sourceRoot":"../../../../src","sources":["iso18013/iso18013-7/remote.ts"],"mappings":";;AAAA,SAASA,qBAAqB,QAAQ,aAAI;AAI1C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,4BAA4B,GAAG,MAAAA,CAC1CC,QAAgB,EAChBC,WAAmB,EACnBC,yBAAiC,EACjCC,kBAA0B,EAC1BC,SAAmC,EACnCC,cAA8B,KACV;EACpB,OAAO,MAAMP,qBAAqB,CAACC,4BAA4B,CAC7DC,QAAQ,EACRC,WAAW,EACXC,yBAAyB,EACzBC,kBAAkB,EAClBC,SAAS,EACTC,cACF,CAAC;AACH,CAAC","ignoreList":[]}

package/lib/module/schema.js

@@ -0,0 +1,46 @@
+"use strict";
+
+import { z } from 'zod';
+
+/**
+ * Schema for parsing a nativeStackAndroid object of a rejected promise error in an Android native module.
+ */
+const StackTraceElementSchema = z.object({
+  lineNumber: z.number(),
+  file: z.string(),
+  methodName: z.string(),
+  class: z.string()
+});
+
+/**
+ * Schema for parsing specific parameters of a rejected promise error in an Android native module.
+ * It's defined as partial to allow merging with the common schema and it must be checked at runtime.
+ */
+const ModuleErrorAndroidSchema = z.object({
+  nativeStackAndroid: z.array(StackTraceElementSchema)
+}).partial();
+
+/**
+ * Schema for parsing specific parameters of a rejected promise error in an iOS native module.
+ * It's defined as partial to allow merging with the common schema and it must be checked at runtime.
+ */
+const ModuleErrorIosSchema = z.object({
+  domain: z.string(),
+  nativeStackIOS: z.array(z.string())
+}).partial();
+
+/**
+ * Schema for parsing common parameters of a rejected promise error in a native module.
+ * This schema contains the common parameters that are shared across both Android and iOS native modules.
+ * Parameters which are platform specific are defined as optional and must be checked at runtime.
+ * It accepts a generic code schema to allow for different error codes which can be defined in each module.
+ * @param codeSchema - The Zod schema for the error codes used by the module.
+ * @returns A schema for the common parameters of a rejected promise error in a native module.
+ */
+export const GenericModuleErrorSchema = codeSchema => z.object({
+  code: codeSchema,
+  message: z.string(),
+  name: z.string(),
+  userInfo: z.record(z.string(), z.any()).optional().or(z.null())
+}).and(ModuleErrorAndroidSchema).and(ModuleErrorIosSchema);
+//# sourceMappingURL=schema.js.map

package/lib/module/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["z","StackTraceElementSchema","object","lineNumber","number","file","string","methodName","class","ModuleErrorAndroidSchema","nativeStackAndroid","array","partial","ModuleErrorIosSchema","domain","nativeStackIOS","GenericModuleErrorSchema","codeSchema","code","message","name","userInfo","record","any","optional","or","null","and"],"sourceRoot":"../../src","sources":["schema.ts"],"mappings":";;AAAA,SAASA,CAAC,QAAQ,KAAK;;AAEvB;AACA;AACA;AACA,MAAMC,uBAAuB,GAAGD,CAAC,CAACE,MAAM,CAAC;EACvCC,UAAU,EAAEH,CAAC,CAACI,MAAM,CAAC,CAAC;EACtBC,IAAI,EAAEL,CAAC,CAACM,MAAM,CAAC,CAAC;EAChBC,UAAU,EAAEP,CAAC,CAACM,MAAM,CAAC,CAAC;EACtBE,KAAK,EAAER,CAAC,CAACM,MAAM,CAAC;AAClB,CAAC,CAAC;;AAEF;AACA;AACA;AACA;AACA,MAAMG,wBAAwB,GAAGT,CAAC,CAC/BE,MAAM,CAAC;EACNQ,kBAAkB,EAAEV,CAAC,CAACW,KAAK,CAACV,uBAAuB;AACrD,CAAC,CAAC,CACDW,OAAO,CAAC,CAAC;;AAEZ;AACA;AACA;AACA;AACA,MAAMC,oBAAoB,GAAGb,CAAC,CAC3BE,MAAM,CAAC;EACNY,MAAM,EAAEd,CAAC,CAACM,MAAM,CAAC,CAAC;EAClBS,cAAc,EAAEf,CAAC,CAACW,KAAK,CAACX,CAAC,CAACM,MAAM,CAAC,CAAC;AACpC,CAAC,CAAC,CACDM,OAAO,CAAC,CAAC;;AAEZ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMI,wBAAwB,GAGnCC,UAAoB,IAEpBjB,CAAC,CACEE,MAAM,CAAC;EACNgB,IAAI,EAAED,UAAU;EAChBE,OAAO,EAAEnB,CAAC,CAACM,MAAM,CAAC,CAAC;EACnBc,IAAI,EAAEpB,CAAC,CAACM,MAAM,CAAC,CAAC;EAChBe,QAAQ,EAAErB,CAAC,CAACsB,MAAM,CAACtB,CAAC,CAACM,MAAM,CAAC,CAAC,EAAEN,CAAC,CAACuB,GAAG,CAAC,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC,CAACC,EAAE,CAACzB,CAAC,CAAC0B,IAAI,CAAC,CAAC;AAChE,CAAC,CAAC,CACDC,GAAG,CAAClB,wBAAwB,CAAC,CAC7BkB,GAAG,CAACd,oBAAoB,CAAC","ignoreList":[]}

package/lib/typescript/src/cbor/cbor/decoder.d.ts

@@ -1,35 +1,25 @@
 import { Documents, IssuerSigned } from './schema';
 /**
- * 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 declare const decode: (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 declare const decodeDocuments: (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 declare const decodeIssuerSigned: (issuerSigned: string) => Promise<IssuerSigned>;
+export declare const decodeIssuerSigned: (data: string) => Promise<IssuerSigned>;
 //# sourceMappingURL=decoder.d.ts.map

package/lib/typescript/src/cbor/cbor/decoder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decoder.d.ts","sourceRoot":"","sources":["../../../../../src/cbor/cbor/decoder.ts"],"names":[],"mappings":"AACA,OAAO,EACL,SAAS,EAET,YAAY,EAEb,MAAM,UAAU,CAAC;AAGlB;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,MAAM,GAAU,MAAM,MAAM,KAAG,OAAO,CAAC,GAAG,CAGtD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAAU,MAAM,MAAM,KAAG,OAAO,CAAC,SAAS,CAGrE,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,GAC7B,cAAc,MAAM,KACnB,OAAO,CAAC,YAAY,CAItB,CAAC"}
+{"version":3,"file":"decoder.d.ts","sourceRoot":"","sources":["../../../../../src/cbor/cbor/decoder.ts"],"names":[],"mappings":"AACA,OAAO,EACL,SAAS,EAET,YAAY,EAEb,MAAM,UAAU,CAAC;AAGlB;;;;;;;GAOG;AACH,eAAO,MAAM,MAAM,GAAU,MAAM,MAAM,KAAG,OAAO,CAAC,GAAG,CAGtD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAU,MAAM,MAAM,KAAG,OAAO,CAAC,SAAS,CAGrE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAC7B,MAAM,MAAM,KACX,OAAO,CAAC,YAAY,CAItB,CAAC"}

package/lib/typescript/src/cbor/cbor/error.d.ts

@@ -0,0 +1,68 @@
+import z from 'zod';
+/**
+ * Error codes which the CBOR module uses to reject a promise.
+ */
+declare const ModuleErrorCodesSchema: z.ZodEnum<["DECODE_ERROR", "DECODE_DOCUMENTS_ERROR", "DECODE_ISSUER_SIGNED_ERROR", "EUNSPECIFIED"]>;
+export type ModuleErrorCodes = z.infer<typeof ModuleErrorCodesSchema>;
+/**
+ * Schema which can be used to parse a rejected promise error by the CBOR module.
+ */
+export declare const ModuleErrorSchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+    code: z.ZodEnum<["DECODE_ERROR", "DECODE_DOCUMENTS_ERROR", "DECODE_ISSUER_SIGNED_ERROR", "EUNSPECIFIED"]>;
+    message: z.ZodString;
+    name: z.ZodString;
+    userInfo: z.ZodUnion<[z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>;
+}, "strip", z.ZodTypeAny, {
+    code: "DECODE_ERROR" | "DECODE_DOCUMENTS_ERROR" | "DECODE_ISSUER_SIGNED_ERROR" | "EUNSPECIFIED";
+    message: string;
+    name: string;
+    userInfo?: Record<string, any> | null | undefined;
+}, {
+    code: "DECODE_ERROR" | "DECODE_DOCUMENTS_ERROR" | "DECODE_ISSUER_SIGNED_ERROR" | "EUNSPECIFIED";
+    message: string;
+    name: string;
+    userInfo?: Record<string, any> | null | undefined;
+}>, z.ZodObject<{
+    nativeStackAndroid: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        lineNumber: z.ZodNumber;
+        file: z.ZodString;
+        methodName: z.ZodString;
+        class: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        lineNumber: number;
+        file: string;
+        methodName: string;
+        class: string;
+    }, {
+        lineNumber: number;
+        file: string;
+        methodName: string;
+        class: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    nativeStackAndroid?: {
+        lineNumber: number;
+        file: string;
+        methodName: string;
+        class: string;
+    }[] | undefined;
+}, {
+    nativeStackAndroid?: {
+        lineNumber: number;
+        file: string;
+        methodName: string;
+        class: string;
+    }[] | undefined;
+}>>, z.ZodObject<{
+    domain: z.ZodOptional<z.ZodString>;
+    nativeStackIOS: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    domain?: string | undefined;
+    nativeStackIOS?: string[] | undefined;
+}, {
+    domain?: string | undefined;
+    nativeStackIOS?: string[] | undefined;
+}>>;
+export type ModuleError = z.infer<typeof ModuleErrorSchema>;
+export {};
+//# sourceMappingURL=error.d.ts.map

package/lib/typescript/src/cbor/cbor/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../../../src/cbor/cbor/error.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AAGpB;;GAEG;AACH,QAAA,MAAM,sBAAsB,qGAK1B,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAE7B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

package/lib/typescript/src/cbor/cbor/index.d.ts

@@ -1,4 +1,4 @@
 export { decode, decodeDocuments, decodeIssuerSigned } from './decoder';
 export { DocumentValue, Documents, DocumentsFromString, IssuerSigned, MDOC, } from './schema';
-export { type CborFailure, type CborFailureCodes } from './failure';
+export { type ModuleError, type ModuleErrorCodes, ModuleErrorSchema, } from './error';
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/cbor/cbor/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/cbor/cbor/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACxE,OAAO,EACL,aAAa,EACb,SAAS,EACT,mBAAmB,EACnB,YAAY,EACZ,IAAI,GACL,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/cbor/cbor/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACxE,OAAO,EACL,aAAa,EACb,SAAS,EACT,mBAAmB,EACnB,YAAY,EACZ,IAAI,GACL,MAAM,UAAU,CAAC;AAClB,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,gBAAgB,EACrB,iBAAiB,GAClB,MAAM,SAAS,CAAC"}