@pagopa/io-react-native-iso18013 0.4.0 → 0.6.0

package/lib/typescript/src/iso18013/iso18013-5/proximity.d.ts

@@ -1,5 +1,4 @@
-import type { AcceptedFields } from './request';
-import type { RequestedDocument } from '../types';
+import type { AcceptedFields, RequestedDocument } from '../types';
 /**
  * Events emitted by the native module:
  * - `onDeviceConnecting`: (iOS only) Emitted when the device is connecting to the verifier app.
@@ -35,10 +34,12 @@ export declare enum 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 declare function start(config?: {
     peripheralMode?: boolean;
@@ -47,30 +48,41 @@ export declare function start(config?: {
     certificates?: Array<Array<String>>;
 }): Promise<boolean>;
 /**
- * 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 declare function getQrCodeString(): Promise<string>;
 /**
- * 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 declare function close(): Promise<boolean>;
 /**
- * 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 declare function sendErrorResponse(code: ErrorCode): Promise<boolean>;
 /**
- * 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 declare function generateResponse(documents: Array<RequestedDocument>, acceptedFields: AcceptedFields): Promise<string>;
 /**
- * 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 declare function sendResponse(response: string): Promise<boolean>;
 /**

package/lib/typescript/src/iso18013/iso18013-5/proximity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"proximity.d.ts","sourceRoot":"","sources":["../../../../../src/iso18013/iso18013-5/proximity.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAIlD;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,kBAAkB,EAAE,SAAS,CAAC;IAC9B,iBAAiB,EAAE,SAAS,CAAC;IAE7B,yBAAyB,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IACzD,oBAAoB,EAAE,SAAS,CAAC;IAChC,OAAO,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;AAEzC;;;;GAIG;AACH,oBAAY,SAAS;IACnB,kBAAkB,KAAK;IACvB,aAAa,KAAK;IAClB,kBAAkB,KAAK;CACxB;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CACnB,MAAM,GAAE;IACN,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;CAChC,GACL,OAAO,CAAC,OAAO,CAAC,CAalB;AAED;;GAEG;AACH,wBAAgB,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC,CAEjD;AAED;;GAEG;AACH,wBAAgB,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC,CAExC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAEnE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,KAAK,CAAC,iBAAiB,CAAC,EACnC,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAE/D;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAC1C,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,IAAI,8CAG3C"}
+{"version":3,"file":"proximity.d.ts","sourceRoot":"","sources":["../../../../../src/iso18013/iso18013-5/proximity.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAIlE;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,kBAAkB,EAAE,SAAS,CAAC;IAC9B,iBAAiB,EAAE,SAAS,CAAC;IAE7B,yBAAyB,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IACzD,oBAAoB,EAAE,SAAS,CAAC;IAChC,OAAO,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;AAEzC;;;;GAIG;AACH,oBAAY,SAAS;IACnB,kBAAkB,KAAK;IACvB,aAAa,KAAK;IAClB,kBAAkB,KAAK;CACxB;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CACnB,MAAM,GAAE;IACN,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;CAChC,GACL,OAAO,CAAC,OAAO,CAAC,CAalB;AAED;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC,CAEjD;AAED;;;;GAIG;AACH,wBAAgB,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC,CAExC;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAEnE;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,KAAK,CAAC,iBAAiB,CAAC,EACnC,cAAc,EAAE,cAAc,GAC7B,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAE/D;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAC1C,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,IAAI,8CAG3C"}

package/lib/typescript/src/iso18013/iso18013-5/request.d.ts

@@ -43,28 +43,5 @@ export type VerifierRequest = z.infer<typeof VerifierRequest>;
  * @returns The parsed VerifierRequest object
  */
 export declare const parseVerifierRequest: (input: unknown) => VerifierRequest;
-/**
- * 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,
- *     }
- *    }
- *  }`
- **/
-export type AcceptedFields = {
-    [credential: string]: {
-        [namespace: string]: {
-            [field: string]: boolean;
-        };
-    };
-};
 export {};
 //# sourceMappingURL=request.d.ts.map

package/lib/typescript/src/iso18013/iso18013-5/request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../../../src/iso18013/iso18013-5/request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAWxB,QAAA,MAAM,eAAe;;;;;;;;;;;;;;;;EAEnB,CAAC;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAE9D;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,OAAO,OAAO,KAAG,eAErD,CAAC;AAEF;;;;;;;;;;;;;;;IAeI;AACJ,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,UAAU,EAAE,MAAM,GAAG;QACpB,CAAC,SAAS,EAAE,MAAM,GAAG;YAAE,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KACnD,CAAC;CACH,CAAC"}
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../../../src/iso18013/iso18013-5/request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAWxB,QAAA,MAAM,eAAe;;;;;;;;;;;;;;;;EAEnB,CAAC;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAE9D;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,OAAO,OAAO,KAAG,eAErD,CAAC"}

package/lib/typescript/src/iso18013/iso18013-7/index.d.ts

@@ -1,4 +1,4 @@
 export { generateOID4VPDeviceResponse } from './remote';
 export { ModuleErrorSchema, type ModuleError, type ModuleErrorCodes, } from './error';
-export { type RequestedDocument } from '../types';
+export { type RequestedDocument, type AcceptedFields } from '../types';
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/iso18013/iso18013-7/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/iso18013/iso18013-7/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,EACL,iBAAiB,EACjB,KAAK,WAAW,EAChB,KAAK,gBAAgB,GACtB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/iso18013/iso18013-7/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,EACL,iBAAiB,EACjB,KAAK,WAAW,EAChB,KAAK,gBAAgB,GACtB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,cAAc,EAAE,MAAM,UAAU,CAAC"}

package/lib/typescript/src/iso18013/iso18013-7/remote.d.ts

@@ -1,15 +1,15 @@
+import type { AcceptedFields } from '../iso18013-5';
 import type { RequestedDocument } from '../types';
 /**
- *
- * @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 declare const generateOID4VPDeviceResponse: (clientId: string, responseUri: string, authorizationRequestNonce: string, mdocGeneratedNonce: string, documents: Array<RequestedDocument>, fieldRequestedAndAccepted: Record<string, any> | string) => Promise<string>;
+export declare const generateOID4VPDeviceResponse: (clientId: string, responseUri: string, authorizationRequestNonce: string, mdocGeneratedNonce: string, documents: Array<RequestedDocument>, acceptedFields: AcceptedFields) => Promise<string>;
 //# sourceMappingURL=remote.d.ts.map

package/lib/typescript/src/iso18013/iso18013-7/remote.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"remote.d.ts","sourceRoot":"","sources":["../../../../../src/iso18013/iso18013-7/remote.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,4BAA4B,GACvC,UAAU,MAAM,EAChB,aAAa,MAAM,EACnB,2BAA2B,MAAM,EACjC,oBAAoB,MAAM,EAC1B,WAAW,KAAK,CAAC,iBAAiB,CAAC,EACnC,2BAA2B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,KACtD,OAAO,CAAC,MAAM,CAWhB,CAAC"}
+{"version":3,"file":"remote.d.ts","sourceRoot":"","sources":["../../../../../src/iso18013/iso18013-7/remote.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,4BAA4B,GACvC,UAAU,MAAM,EAChB,aAAa,MAAM,EACnB,2BAA2B,MAAM,EACjC,oBAAoB,MAAM,EAC1B,WAAW,KAAK,CAAC,iBAAiB,CAAC,EACnC,gBAAgB,cAAc,KAC7B,OAAO,CAAC,MAAM,CAShB,CAAC"}

package/lib/typescript/src/iso18013/types.d.ts

@@ -13,4 +13,29 @@ export type RequestedDocument = {
     alias: string;
     docType: string;
 };
+/**
+ * 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,
+ *     },
+ *     {...}
+ *    },
+ *    {...}
+ *  }`
+ **/
+export type AcceptedFields = {
+    [credential: string]: {
+        [namespace: string]: {
+            [field: string]: boolean;
+        };
+    };
+};
 //# sourceMappingURL=types.d.ts.map

package/lib/typescript/src/iso18013/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/iso18013/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/iso18013/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;IAiBI;AACJ,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,UAAU,EAAE,MAAM,GAAG;QACpB,CAAC,SAAS,EAAE,MAAM,GAAG;YAAE,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KACnD,CAAC;CACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pagopa/io-react-native-iso18013",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "React Native bridge for iso18013 methods",
   "source": "./src/index.tsx",
   "main": "./lib/module/index.js",

package/src/cbor/cbor/README.md

@@ -1,92 +1,40 @@
-## 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.
-
-```typescript
-try {
-  const decoded = await CBOR.decodeDocuments('...');
-} catch (e) {
-  const { message, userInfo } = e as CborFailure;
-}
-```
-
-### Types
-
-#### `Documents`
-
-```typescript
-type Documents = {
-  status?: number;
-  version?: string;
-  documents?: Array<MDOC>;
-};
-```
-
-#### `MDOC`
+Decodes CBOR data containing MDOC objects.
 
 ```typescript
-type MDOC = {
-  docType?: DocumentType;
-  issuerSigned?: IssuerSigned;
-};
+const decoded = await CBOR.decodeDocuments('...');
 ```
 
-#### `IssuerSigned`
-
-```typescript
-type IssuerSigned = {
-  nameSpaces?: Record<string, Array<DocumentValue>>;
-  issuerAuth?: string;
-};
-```
+#### `decodeIssuerSigned`
 
-#### `DocumentValue`
+Decodes CBOR data containing an Issuer Signed object.
 
 ```typescript
-type DocumentValue = {
-  digestID?: number;
-  random?: string;
-  elementIdentifier?: string;
-  elementValue?: string;
-};
-```
-
-#### `DocumentType`
-
-```typescript
-enum DocumentTypeEnum {
-  MDL = 'org.iso.18013.5.1.mDL',
-  EU_PID = 'eu.europa.ec.eudi.pid.1',
-}
+const decoded = await CBOR.decodeIssuerSigned('...');
 ```
 
-### Error Codes
+## Errors
 
 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 |

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/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

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/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,9 +17,29 @@ 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). |
 
+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
@@ -107,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.
@@ -118,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.
@@ -130,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.
 
@@ -158,20 +194,17 @@ 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.
@@ -183,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
@@ -218,8 +251,15 @@ 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
+    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

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

@@ -1,8 +1,4 @@
-export {
-  type AcceptedFields,
-  type VerifierRequest,
-  parseVerifierRequest,
-} from './request';
+export { type VerifierRequest, parseVerifierRequest } from './request';
 
 export {
   type OnErrorPayload,
@@ -25,4 +21,4 @@ export {
   start,
 } from './proximity';
 
-export { type RequestedDocument } from '../types';
+export { type RequestedDocument, type AcceptedFields } from '../types';