@pagopa/io-react-native-iso18013 0.1.0

package/lib/module/cbor/cbor/schema.js

@@ -0,0 +1,117 @@
+"use strict";
+
+import { z } from 'zod';
+import { coerceToJSON } from "./schema.utils.js";
+export let DocumentTypeEnum = /*#__PURE__*/function (DocumentTypeEnum) {
+  DocumentTypeEnum["MDL"] = "org.iso.18013.5.1.mDL";
+  DocumentTypeEnum["EU_PID"] = "eu.europa.ec.eudi.pid.1";
+  return DocumentTypeEnum;
+}({});
+export const DocumentType = z.nativeEnum(DocumentTypeEnum);
+/**
+ * Value contained in a document
+ */
+export const DocumentValue = z.object({
+  digestID: z.coerce.number().optional(),
+  random: z.string().optional(),
+  elementIdentifier: z.string(),
+  elementValue: z.any()
+});
+/**
+ * Issuer Auth Unprotected Header Entry
+ */
+export const IssuerAuthUnprotectedHeader = z.object({
+  algorithm: z.coerce.string().optional(),
+  keyId: z.string().optional(),
+  x5chain: z.array(z.string()).optional()
+});
+/**
+ * Issuer Auth Payload Validity Info
+ */
+export const IssuerAuthPayloadValidityInfo = z.object({
+  signed: z.coerce.date(),
+  validUntil: z.coerce.date(),
+  validFrom: z.coerce.date(),
+  expectedUpdate: z.coerce.date().optional()
+});
+/**
+ * EC KEY
+ */
+const ECKey = z.object({
+  kty: z.enum(['EC']),
+  crv: z.enum(['P-256', 'P-384', 'P-521']),
+  x: z.string(),
+  y: z.string()
+});
+
+/**
+ * RSA KEY
+ */
+const RSAKEY = z.object({
+  kty: z.enum(['RSA']),
+  alg: z.string(),
+  e: z.string(),
+  n: z.string()
+});
+const PublicKey = z.union([RSAKEY, ECKey]);
+
+/**
+ * Issuer Auth Payload Device Key Info
+ */
+export const IssuerAuthPayloadDeviceKeyInfo = z.object({
+  deviceKey: PublicKey
+});
+/**
+ * Issuer Auth Payload Object
+ */
+export const IssuerAuthPayload = z.object({
+  docType: z.string().optional(),
+  version: z.string().optional(),
+  validityInfo: IssuerAuthPayloadValidityInfo,
+  digestAlgorithm: z.string().optional(),
+  deviceKeyInfo: IssuerAuthPayloadDeviceKeyInfo,
+  valueDigests: z.record(z.any())
+});
+/**
+ * Issuer Auth Object
+ */
+export const IssuerAuth = z.object({
+  rawValue: z.string().optional(),
+  protectedHeader: z.string().optional(),
+  unprotectedHeader: IssuerAuthUnprotectedHeader,
+  payload: IssuerAuthPayload,
+  signature: z.string().optional()
+});
+/**
+ * Issuer signed object
+ */
+export const IssuerSigned = z.object({
+  nameSpaces: z.record(z.string(), coerceToJSON.pipe(z.array(DocumentValue))),
+  issuerAuth: IssuerAuth
+});
+/**
+ * mDOC object
+ */
+export const MDOC = z.object({
+  docType: DocumentType,
+  issuerSigned: IssuerSigned
+});
+/**
+ * CBOR decoded data containing the status, version and the list of documents
+ */
+export const Documents = z.object({
+  status: z.number().optional(),
+  version: z.string().optional(),
+  documents: coerceToJSON.pipe(z.array(MDOC))
+});
+
+/**
+ * Documents object from string
+ */
+export const DocumentsFromString = coerceToJSON.pipe(Documents);
+
+/**
+ * IssuerSigned object from string
+ */
+export const IssuerSignedFromString = coerceToJSON.pipe(IssuerSigned);
+//# sourceMappingURL=schema.js.map

package/lib/module/cbor/cbor/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["z","coerceToJSON","DocumentTypeEnum","DocumentType","nativeEnum","DocumentValue","object","digestID","coerce","number","optional","random","string","elementIdentifier","elementValue","any","IssuerAuthUnprotectedHeader","algorithm","keyId","x5chain","array","IssuerAuthPayloadValidityInfo","signed","date","validUntil","validFrom","expectedUpdate","ECKey","kty","enum","crv","x","y","RSAKEY","alg","e","n","PublicKey","union","IssuerAuthPayloadDeviceKeyInfo","deviceKey","IssuerAuthPayload","docType","version","validityInfo","digestAlgorithm","deviceKeyInfo","valueDigests","record","IssuerAuth","rawValue","protectedHeader","unprotectedHeader","payload","signature","IssuerSigned","nameSpaces","pipe","issuerAuth","MDOC","issuerSigned","Documents","status","documents","DocumentsFromString","IssuerSignedFromString"],"sourceRoot":"../../../../src","sources":["cbor/cbor/schema.ts"],"mappings":";;AAAA,SAASA,CAAC,QAAQ,KAAK;AACvB,SAASC,YAAY,QAAQ,mBAAgB;AAE7C,WAAYC,gBAAgB,0BAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAA,OAAhBA,gBAAgB;AAAA;AAK5B,OAAO,MAAMC,YAAY,GAAGH,CAAC,CAACI,UAAU,CAACF,gBAAgB,CAAC;AAG1D;AACA;AACA;AACA,OAAO,MAAMG,aAAa,GAAGL,CAAC,CAACM,MAAM,CAAC;EACpCC,QAAQ,EAAEP,CAAC,CAACQ,MAAM,CAACC,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EACtCC,MAAM,EAAEX,CAAC,CAACY,MAAM,CAAC,CAAC,CAACF,QAAQ,CAAC,CAAC;EAC7BG,iBAAiB,EAAEb,CAAC,CAACY,MAAM,CAAC,CAAC;EAC7BE,YAAY,EAAEd,CAAC,CAACe,GAAG,CAAC;AACtB,CAAC,CAAC;AAIF;AACA;AACA;AACA,OAAO,MAAMC,2BAA2B,GAAGhB,CAAC,CAACM,MAAM,CAAC;EAClDW,SAAS,EAAEjB,CAAC,CAACQ,MAAM,CAACI,MAAM,CAAC,CAAC,CAACF,QAAQ,CAAC,CAAC;EACvCQ,KAAK,EAAElB,CAAC,CAACY,MAAM,CAAC,CAAC,CAACF,QAAQ,CAAC,CAAC;EAC5BS,OAAO,EAAEnB,CAAC,CAACoB,KAAK,CAACpB,CAAC,CAACY,MAAM,CAAC,CAAC,CAAC,CAACF,QAAQ,CAAC;AACxC,CAAC,CAAC;AAMF;AACA;AACA;AACA,OAAO,MAAMW,6BAA6B,GAAGrB,CAAC,CAACM,MAAM,CAAC;EACpDgB,MAAM,EAAEtB,CAAC,CAACQ,MAAM,CAACe,IAAI,CAAC,CAAC;EACvBC,UAAU,EAAExB,CAAC,CAACQ,MAAM,CAACe,IAAI,CAAC,CAAC;EAC3BE,SAAS,EAAEzB,CAAC,CAACQ,MAAM,CAACe,IAAI,CAAC,CAAC;EAC1BG,cAAc,EAAE1B,CAAC,CAACQ,MAAM,CAACe,IAAI,CAAC,CAAC,CAACb,QAAQ,CAAC;AAC3C,CAAC,CAAC;AAMF;AACA;AACA;AACA,MAAMiB,KAAK,GAAG3B,CAAC,CAACM,MAAM,CAAC;EACrBsB,GAAG,EAAE5B,CAAC,CAAC6B,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;EACnBC,GAAG,EAAE9B,CAAC,CAAC6B,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;EACxCE,CAAC,EAAE/B,CAAC,CAACY,MAAM,CAAC,CAAC;EACboB,CAAC,EAAEhC,CAAC,CAACY,MAAM,CAAC;AACd,CAAC,CAAC;;AAEF;AACA;AACA;AACA,MAAMqB,MAAM,GAAGjC,CAAC,CAACM,MAAM,CAAC;EACtBsB,GAAG,EAAE5B,CAAC,CAAC6B,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;EACpBK,GAAG,EAAElC,CAAC,CAACY,MAAM,CAAC,CAAC;EACfuB,CAAC,EAAEnC,CAAC,CAACY,MAAM,CAAC,CAAC;EACbwB,CAAC,EAAEpC,CAAC,CAACY,MAAM,CAAC;AACd,CAAC,CAAC;AAEF,MAAMyB,SAAS,GAAGrC,CAAC,CAACsC,KAAK,CAAC,CAACL,MAAM,EAAEN,KAAK,CAAC,CAAC;;AAE1C;AACA;AACA;AACA,OAAO,MAAMY,8BAA8B,GAAGvC,CAAC,CAACM,MAAM,CAAC;EACrDkC,SAAS,EAAEH;AACb,CAAC,CAAC;AAMF;AACA;AACA;AACA,OAAO,MAAMI,iBAAiB,GAAGzC,CAAC,CAACM,MAAM,CAAC;EACxCoC,OAAO,EAAE1C,CAAC,CAACY,MAAM,CAAC,CAAC,CAACF,QAAQ,CAAC,CAAC;EAC9BiC,OAAO,EAAE3C,CAAC,CAACY,MAAM,CAAC,CAAC,CAACF,QAAQ,CAAC,CAAC;EAC9BkC,YAAY,EAAEvB,6BAA6B;EAC3CwB,eAAe,EAAE7C,CAAC,CAACY,MAAM,CAAC,CAAC,CAACF,QAAQ,CAAC,CAAC;EACtCoC,aAAa,EAAEP,8BAA8B;EAC7CQ,YAAY,EAAE/C,CAAC,CAACgD,MAAM,CAAChD,CAAC,CAACe,GAAG,CAAC,CAAC;AAChC,CAAC,CAAC;AAIF;AACA;AACA;AACA,OAAO,MAAMkC,UAAU,GAAGjD,CAAC,CAACM,MAAM,CAAC;EACjC4C,QAAQ,EAAElD,CAAC,CAACY,MAAM,CAAC,CAAC,CAACF,QAAQ,CAAC,CAAC;EAC/ByC,eAAe,EAAEnD,CAAC,CAACY,MAAM,CAAC,CAAC,CAACF,QAAQ,CAAC,CAAC;EACtC0C,iBAAiB,EAAEpC,2BAA2B;EAC9CqC,OAAO,EAAEZ,iBAAiB;EAC1Ba,SAAS,EAAEtD,CAAC,CAACY,MAAM,CAAC,CAAC,CAACF,QAAQ,CAAC;AACjC,CAAC,CAAC;AAIF;AACA;AACA;AACA,OAAO,MAAM6C,YAAY,GAAGvD,CAAC,CAACM,MAAM,CAAC;EACnCkD,UAAU,EAAExD,CAAC,CAACgD,MAAM,CAAChD,CAAC,CAACY,MAAM,CAAC,CAAC,EAAEX,YAAY,CAACwD,IAAI,CAACzD,CAAC,CAACoB,KAAK,CAACf,aAAa,CAAC,CAAC,CAAC;EAC3EqD,UAAU,EAAET;AACd,CAAC,CAAC;AAIF;AACA;AACA;AACA,OAAO,MAAMU,IAAI,GAAG3D,CAAC,CAACM,MAAM,CAAC;EAC3BoC,OAAO,EAAEvC,YAAY;EACrByD,YAAY,EAAEL;AAChB,CAAC,CAAC;AAIF;AACA;AACA;AACA,OAAO,MAAMM,SAAS,GAAG7D,CAAC,CAACM,MAAM,CAAC;EAChCwD,MAAM,EAAE9D,CAAC,CAACS,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,CAAC;EAC7BiC,OAAO,EAAE3C,CAAC,CAACY,MAAM,CAAC,CAAC,CAACF,QAAQ,CAAC,CAAC;EAC9BqD,SAAS,EAAE9D,YAAY,CAACwD,IAAI,CAACzD,CAAC,CAACoB,KAAK,CAACuC,IAAI,CAAC;AAC5C,CAAC,CAAC;;AAEF;AACA;AACA;AACA,OAAO,MAAMK,mBAAmB,GAAG/D,YAAY,CAACwD,IAAI,CAACI,SAAS,CAAC;;AAE/D;AACA;AACA;AACA,OAAO,MAAMI,sBAAsB,GAAGhE,YAAY,CAACwD,IAAI,CAACF,YAAY,CAAC","ignoreList":[]}

package/lib/module/cbor/cbor/schema.utils.js

@@ -0,0 +1,16 @@
+"use strict";
+
+import { z } from 'zod';
+
+/**
+ * If the value is a string, parse it as JSON.
+ * Otherwise, return the value as is.
+ * Useful for unescaping stringified JSON content
+ */
+export const coerceToJSON = z.any().transform(any => {
+  if (typeof any === 'object') {
+    return any;
+  }
+  return JSON.parse(any);
+});
+//# sourceMappingURL=schema.utils.js.map

package/lib/module/cbor/cbor/schema.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["z","coerceToJSON","any","transform","JSON","parse"],"sourceRoot":"../../../../src","sources":["cbor/cbor/schema.utils.ts"],"mappings":";;AAAA,SAASA,CAAC,QAAQ,KAAK;;AAEvB;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,YAAY,GAAGD,CAAC,CAACE,GAAG,CAAC,CAAC,CAACC,SAAS,CAAED,GAAG,IAAK;EACrD,IAAI,OAAOA,GAAG,KAAK,QAAQ,EAAE;IAC3B,OAAOA,GAAG;EACZ;EACA,OAAOE,IAAI,CAACC,KAAK,CAACH,GAAG,CAAC;AACxB,CAAC,CAAC","ignoreList":[]}

package/lib/module/cbor/cose/README.md

@@ -0,0 +1,53 @@
+## COSE
+
+This module provides methods to sign and verify data with COSE.
+
+```typescript
+import { COSE } from '@pagopa/io-react-native-cbor';
+```
+
+### Methods
+
+#### `sign`
+
+Signs base64 encoded data using COSE (CBOR Object Signing and Encryption).
+Returns a `Promise` which resolves to a `string` containing the COSE-Sign1 object in base64 encoding or rejects with an instance of `CoseFailure` in case of failures.
+
+```typescript
+try {
+  const coseSign1 = await COSE.sign('base64EncodedData', 'keyTag');
+} catch (e) {
+  const { message, userInfo } = e as CoseFailure;
+}
+```
+
+#### `verify`
+
+Verifies a COSE-Sign1 object using the provided public key.
+Returns a `Promise` which resolves to a `boolean` indicating if the signature is valid or rejects with an instance of `CoseFailure` in case of failures.
+
+```typescript
+// public key in JWK format
+const publicKey = {
+  kty: 'EC',
+  crv: 'P-256',
+  x: '...',
+  y: '...',
+};
+
+try {
+  const isValid = await COSE.verify('coseSign1Base64Data', publicKey);
+} catch (e) {
+  const { message, userInfo } = e as CoseFailure;
+}
+```
+
+### Error Codes
+
+| 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                                 |

package/lib/module/cbor/cose/failure.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=failure.js.map

package/lib/module/cbor/cose/failure.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sourceRoot":"../../../../src","sources":["cbor/cose/failure.ts"],"mappings":"","ignoreList":[]}

package/lib/module/cbor/cose/index.js

@@ -0,0 +1,4 @@
+"use strict";
+
+export { sign, verify } from "./sign.js";
+//# sourceMappingURL=index.js.map

package/lib/module/cbor/cose/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["sign","verify"],"sourceRoot":"../../../../src","sources":["cbor/cose/index.ts"],"mappings":";;AAAA,SAASA,IAAI,EAAEC,MAAM,QAAQ,WAAQ","ignoreList":[]}

package/lib/module/cbor/cose/sign.js

@@ -0,0 +1,23 @@
+"use strict";
+
+import { IoReactNativeCbor } from "../index.js";
+
+/**
+ * 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 keyTag - The alias of the key to use for signing.
+ * @throws {CoseFailure} If the key does not exist
+ * @returns The COSE-Sign1 object in base64 encoding
+ */
+export const sign = async (payload, keyTag) => await IoReactNativeCbor.sign(payload, 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
+ * @returns true if the signature is valid, false otherwise
+ */
+export const verify = async (data, publicKey) => await IoReactNativeCbor.verify(data, publicKey);
+//# sourceMappingURL=sign.js.map

package/lib/module/cbor/cose/sign.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["IoReactNativeCbor","sign","payload","keyTag","verify","data","publicKey"],"sourceRoot":"../../../../src","sources":["cbor/cose/sign.ts"],"mappings":";;AACA,SAASA,iBAAiB,QAAQ,aAAI;;AAEtC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,IAAI,GAAG,MAAAA,CAAOC,OAAe,EAAEC,MAAc,KACxD,MAAMH,iBAAiB,CAACC,IAAI,CAACC,OAAO,EAAEC,MAAM,CAAC;;AAE/C;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,MAAM,GAAG,MAAAA,CACpBC,IAAY,EACZC,SAAoB,KACC,MAAMN,iBAAiB,CAACI,MAAM,CAACC,IAAI,EAAEC,SAAS,CAAC","ignoreList":[]}

package/lib/module/cbor/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+import { NativeModules, Platform } from 'react-native';
+const LINKING_ERROR = `The package '@pagopa/io-react-native-cbor' doesn't seem to be linked. Make sure: \n\n` + Platform.select({
+  ios: "- You have run 'pod install'\n",
+  default: ''
+}) + '- You rebuilt the app after installing the package\n' + '- You are not using Expo Go\n';
+export const IoReactNativeCbor = NativeModules.IoReactNativeCbor ? NativeModules.IoReactNativeCbor : new Proxy({}, {
+  get() {
+    throw new Error(LINKING_ERROR);
+  }
+});
+//# sourceMappingURL=index.js.map

package/lib/module/cbor/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","select","ios","default","IoReactNativeCbor","Proxy","get","Error"],"sourceRoot":"../../../src","sources":["cbor/index.ts"],"mappings":";;AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAEtD,MAAMC,aAAa,GACjB,uFAAuF,GACvFD,QAAQ,CAACE,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,OAAO,MAAMC,iBAAiB,GAAGN,aAAa,CAACM,iBAAiB,GAC5DN,aAAa,CAACM,iBAAiB,GAC/B,IAAIC,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACP,aAAa,CAAC;EAChC;AACF,CACF,CAAC","ignoreList":[]}

package/lib/module/index.js

@@ -0,0 +1,8 @@
+"use strict";
+
+import * as CBOR from "./cbor/cbor/index.js";
+import * as COSE from "./cbor/cose/index.js";
+import * as ISO18013_5 from "./iso18013/iso18013-5/index.js";
+import * as ISO18013_7 from "./iso18013/iso18013-7/index.js";
+export { CBOR, COSE, ISO18013_5, ISO18013_7 };
+//# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["CBOR","COSE","ISO18013_5","ISO18013_7"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,OAAO,KAAKA,IAAI,MAAM,sBAAa;AACnC,OAAO,KAAKC,IAAI,MAAM,sBAAa;AACnC,OAAO,KAAKC,UAAU,MAAM,gCAAuB;AACnD,OAAO,KAAKC,UAAU,MAAM,gCAAuB;AACnD,SAASH,IAAI,EAAEC,IAAI,EAAEC,UAAU,EAAEC,UAAU","ignoreList":[]}

package/lib/module/iso18013/index.js

@@ -0,0 +1,14 @@
+"use strict";
+
+import { NativeModules, Platform } from 'react-native';
+export { parseEventError, parseVerifierRequest } from "./iso18013-5/schema.js";
+const LINKING_ERROR = `The package '@pagopa/io-react-native-proximity' doesn't seem to be linked. Make sure: \n\n` + Platform.select({
+  ios: "- You have run 'pod install'\n",
+  default: ''
+}) + '- You rebuilt the app after installing the package\n' + '- You are not using Expo Go\n';
+export const IoReactNativeProximity = NativeModules.IoReactNativeIso18013 ? NativeModules.IoReactNativeIso18013 : new Proxy({}, {
+  get() {
+    throw new Error(LINKING_ERROR);
+  }
+});
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"names":["NativeModules","Platform","parseEventError","parseVerifierRequest","LINKING_ERROR","select","ios","default","IoReactNativeProximity","IoReactNativeIso18013","Proxy","get","Error"],"sourceRoot":"../../../src","sources":["iso18013/index.ts"],"mappings":";;AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AACtD,SAIEC,eAAe,EACfC,oBAAoB,QACf,wBAAqB;AAE5B,MAAMC,aAAa,GACjB,4FAA4F,GAC5FH,QAAQ,CAACI,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,OAAO,MAAMC,sBAAsB,GAAGR,aAAa,CAACS,qBAAqB,GACrET,aAAa,CAACS,qBAAqB,GACnC,IAAIC,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACR,aAAa,CAAC;EAChC;AACF,CACF,CAAC","ignoreList":[]}

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

@@ -0,0 +1,234 @@
+# 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.
+
+## Installation
+
+## Usage
+
+### `events`
+
+This library emits the following events:
+| Event | Payload | Description |
+|---------------------------|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
+| 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. |
+| 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.
+
+```typescript
+import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
+
+ISO18013_5.addListener('event', () => console.log('event occurred'));
+
+ISO18013_5.removeListener('event');
+```
+
+#### `onDeviceConnecting`
+
+```typescript
+import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
+
+ISO18013_5.addListener('onDeviceConnecting', () => {
+  console.log('Device is connecting');
+});
+```
+
+#### `onDeviceConnected`
+
+```typescript
+import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
+
+ISO18013_5.addListener('onDeviceConnected', () => {
+  console.log('Device is connected');
+});
+```
+
+#### `onDocumentRequestReceived`
+
+```typescript
+import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
+
+ISO18013_5.addListener(
+  'onDocumentRequestReceived',
+  (payload: ISO18013_5.EventsPayload['onDocumentRequestReceived']) => {
+    console.log('onDocumentRequestReceived', payload);
+    if (!payload || !payload.data) {
+      console.warn('Request does not contain a message.');
+      return;
+    }
+
+    // Parse and verify the received request with the exposed function
+    const parsedJson = JSON.parse(payload.data);
+    console.log('Parsed JSON:', parsedJson);
+    const parsedResponse = parseVerifierRequest(parsedJson);
+    console.log('Parsed response:', JSON.stringify(parsedResponse));
+  }
+);
+```
+
+#### `onDeviceDisconnected`
+
+```typescript
+import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
+
+ISO18013_5.addListener('onDeviceDisconnected', () => {
+  console.log('Device is disconnected');
+});
+```
+
+#### `onError`
+
+```typescript
+import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
+
+ISO18013_5.addListener(
+  'onError',
+  async (data: ISO18013_5.EventsPayload['onError']) => {
+    try {
+      if (!data || !data.error) {
+        throw new Error('No error data received');
+      }
+      const parsedError = parseError(data.error);
+      console.error(`onError: ${parsedError}`);
+    } catch (e) {
+      console.error('Error parsing onError data:', e);
+    } finally {
+      // Close the flow on error
+      await closeFlow();
+    }
+  }
+);
+```
+
+### `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.
+
+```typescript
+import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
+
+await ISO18013_5.start();
+```
+
+### `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.
+
+```typescript
+import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
+
+const qrCodeString = await ISO18013_5.getQrCodeString();
+console.log(qrCodeString);
+```
+
+### `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',
+    },
+  ],
+});
+console.log(response);
+```
+
+### `sendResponse`
+
+Sends the response generate by `generateResponse` to the verifier app.
+
+```typescript
+import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
+
+await ISO18013_5.sendResponse(response);
+```
+
+### `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',
+});
+```
+
+### `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.
+
+```typescript
+import { ISO18013_5 } from '@pagopa/io-react-native-iso18013';
+
+await ISO18013_5.close();
+```
+
+## Proximity Flow Schema
+
+This section describes a high level overview of the interactions between an app implementing the `io-react-native-proximity` library and a verifier app.
+
+```mermaid
+sequenceDiagram
+    participant app as Consumer App
+    participant proximity as io-react-native-iso18013
+    participant verifier as Verifier App
+
+    Note over proximity, verifier: If an error occurs during the flow, the onError callback is triggered
+    app->>+proximity: Calls start()
+    app->>+proximity: Calls getQrCode()
+    proximity-->>+app: QR code string
+    app->>+app: Renders the QR code string
+    verifier->>+app: Scans the QR code
+    proximity->>+app: Triggers the onDeviceConnecting callback
+    verifier->>+app: Connects to the verifier app
+    proximity->>+app: Triggers the onDeviceConnected callback
+    verifier->>+app: Requests the credential(s)
+    proximity->>+app: Triggers the onDocumentRequestReceived() callback
+    app->>+proximity: Parses the request by calling parseVerifierRequest()
+    proximity-->>+app: Returns a VerifierRequest
+    app->>+app: Shows the requested data and asks for user consent
+    alt The user accepts
+        app->>+proximity: Calls generateResponse()
+        proximity-->>+app: Returns the response
+        app->>+proximity: Calls sendResponse()
+        proximity->>+verifier: Sends the response
+        verifier->>+verifier: Shows the received credential(s) and the verification result
+    else The user rejects
+        app->>+proximity: Calls sendErrorResponse()
+        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                        |

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

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

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

@@ -0,0 +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":[]}

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

@@ -0,0 +1,112 @@
+"use strict";
+
+import { NativeEventEmitter, Platform } from 'react-native';
+import { IoReactNativeProximity } from "../index.js";
+const eventEmitter = new NativeEventEmitter(IoReactNativeProximity);
+
+/**
+ * Events emitted by the native module:
+ * - `onDeviceConnecting`: (iOS only) Emitted when the device is connecting to the verifier app.
+ * - `onDeviceConnected`: Emitted when the device is connected to the verifier app.
+ * - `onDocumentRequestReceived`: Emitted when a document request is received from the verifier app. Carries a payload containing the request data.
+ * - `onDeviceDisconnected`: Emitted when the device is disconnected from the verifier app.
+ * - `onError`: Emitted when an error occurs. Carries a payload containing the error data.
+ */
+
+/**
+ * Events emitted by the native module.
+ */
+
+/**
+ * Error codes that can be used with the `sendErrorResponse` method.
+ * These are defined based on the SessionData status code defined in the table 20 of the ISO 18013-5 standard
+ * and mirror codes defined in the native module.
+ */
+export let ErrorCode = /*#__PURE__*/function (ErrorCode) {
+  ErrorCode[ErrorCode["SESSION_ENCRYPTION"] = 10] = "SESSION_ENCRYPTION";
+  ErrorCode[ErrorCode["CBOR_DECODING"] = 11] = "CBOR_DECODING";
+  ErrorCode[ErrorCode["SESSION_TERMINATED"] = 20] = "SESSION_TERMINATED";
+  return ErrorCode;
+}({});
+
+/**
+ * Starts the proximity flow by allocating the necessary resources and initializing the Bluetooth stack.
+ * @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 - Array of base64 representing DER encoded X.509 certificate which are used to authenticate the verifier app
+ */
+export function start(config = {}) {
+  const {
+    peripheralMode,
+    centralClientMode,
+    clearBleCache,
+    certificates
+  } = config;
+  if (Platform.OS === 'ios') {
+    return IoReactNativeProximity.start(certificates ? certificates : []);
+  } else {
+    return IoReactNativeProximity.start(peripheralMode ? peripheralMode : true, centralClientMode ? centralClientMode : false, clearBleCache ? clearBleCache : true, certificates ? certificates : []);
+  }
+}
+
+/**
+ * Gets the QR code string this method is responsible for initializing the connection and retrieving the QR code string
+ */
+export function getQrCodeString() {
+  return IoReactNativeProximity.getQrCodeString();
+}
+
+/**
+ * Closes the QR engagement
+ */
+export function close() {
+  return IoReactNativeProximity.close();
+}
+
+/**
+ * Sends an error response to the verifier app.
+ * The error code must be one of the `ErrorCode` enum values.
+ * @param code - The error code to be sent to the verifier app.
+ */
+export function sendErrorResponse(code) {
+  return IoReactNativeProximity.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
+ * @param acceptedFields - The accepted fields which will be presented to the verifier app. See the type definition for more details.
+ * @returns A base64 encoded response to be sent to the verifier app via `sendResponse`
+ */
+export function generateResponse(documents, acceptedFields) {
+  return IoReactNativeProximity.generateResponse(documents, acceptedFields);
+}
+
+/**
+ * Sends the response generated through the `generateResponse` method to the verifier app.
+ * Currently there's not evidence of the verifier app responding to this request, thus we don't handle the response.
+ * @param response - The base64 encoded response to be sent to the verifier app.
+ */
+export function sendResponse(response) {
+  return IoReactNativeProximity.sendResponse(response);
+}
+
+/**
+ * Adds a listener for a `QrEngagementEvents` event which will be emitted by the native module.
+ * The callback will be called with the event payload when the event is emitted.
+ * @param event - The event to listen for. The available events are defined in the `QrEngagementEvents` type.
+ * @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);
+}
+//# sourceMappingURL=proximity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"names":["NativeEventEmitter","Platform","IoReactNativeProximity","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,sBAAsB,QAAQ,aAAI;AAI3C,MAAMC,YAAY,GAAG,IAAIH,kBAAkB,CAACE,sBAAsB,CAAC;;AAEnE;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,sBAAsB,CAACG,KAAK,CAACK,YAAY,GAAGA,YAAY,GAAG,EAAE,CAAC;EACvE,CAAC,MAAM;IACL,OAAOR,sBAAsB,CAACG,KAAK,CACjCE,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,sBAAsB,CAACU,eAAe,CAAC,CAAC;AACjD;;AAEA;AACA;AACA;AACA,OAAO,SAASC,KAAKA,CAAA,EAAqB;EACxC,OAAOX,sBAAsB,CAACW,KAAK,CAAC,CAAC;AACvC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,iBAAiBA,CAACC,IAAe,EAAoB;EACnE,OAAOb,sBAAsB,CAACY,iBAAiB,CAACC,IAAI,CAAC;AACvD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAC9BC,SAAmC,EACnCC,cAA8B,EACb;EACjB,OAAOhB,sBAAsB,CAACc,gBAAgB,CAACC,SAAS,EAAEC,cAAc,CAAC;AAC3E;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACC,QAAgB,EAAoB;EAC/D,OAAOlB,sBAAsB,CAACiB,YAAY,CAACC,QAAQ,CAAC;AACtD;;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":[]}