@pagopa/io-react-native-cie 1.0.0

package/IoReactNativeCie.podspec

@@ -0,0 +1,28 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "IoReactNativeCie"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => min_ios_version_supported }
+  s.source       = { :git => "https://github.com/pagopa/io-react-native-cie.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm,swift}"
+
+  # CieSDK dependency
+  s.dependency "CieSDK", "~> 0.1.11"
+
+# Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.
+# See https://github.com/facebook/react-native/blob/febf6b7f33fdb4904669f99d795eba4c0f95d7bf/scripts/cocoapods/new_architecture.rb#L79.
+if respond_to?(:install_modules_dependencies, true)
+  install_modules_dependencies(s)
+else
+  s.dependency "React-Core"
+end
+end

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,406 @@
+[![npm version](https://img.shields.io/npm/v/@pagopa/io-react-native-cie.svg)](https://www.npmjs.com/package/@pagopa/io-react-native-cie) [![MIT License](https://img.shields.io/github/license/pagopa/io-react-native-cie)](LICENSE)
+
+# @pagopa/io-react-native-cie
+
+Module to handle CIE (Electronic Identity Card) operations natively in React Native apps.
+
+> [!CAUTION]
+> If you are migrating from `io-cie-sdk` please read the [migration guide](/docs/migrate-from-io-cie-sdk.md) carefully
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Setup](#setup)
+- [Example App](#example-app)
+- [API](#api)
+- [Usage](#usage)
+  - [Check NFC Status](#check-nfc-status)
+  - [Reading CIE Data](#reading-cie-data)
+    - [Reading Attributes](#reading-attributes)
+    - [Authentication](#authentication)
+  - [Event System](#event-system)
+    - [Event Listeners](#event-listeners)
+    - [Example Usage](#example-usage)
+    - [NFC read events](#nfc-read-events)
+    - [NFC error events](#nfc-error-events)
+  - [Alert Messages](#alert-messages)
+    - [Available Alert Messages](#available-alert-messages)
+- [NFC Events](#nfc-events)
+  - [iOS](#ios)
+  - [Android](#android)
+- [NFC Errors](#nfc-errors)
+  - [iOS](#ios-1)
+  - [Android](#android-1)
+- [Types](#types)
+- [Errors](#errors)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+```sh
+npm install @pagopa/io-react-native-cie
+# or
+yarn add @pagopa/io-react-native-cie
+```
+
+### iOS
+
+```sh
+cd ios && bundle exec pod install && cd ..
+```
+
+## Setup
+
+### Android
+
+On Android you need to declare the following permission into your `AndroidManifest.xml`.
+More info in the [official Android documentation](https://developer.android.com/develop/connectivity/nfc/nfc):
+
+```xml
+  <!-- Required to access NFC hardware -->
+  <uses-permission android:name="android.permission.NFC" />
+  <!-- Required for authentication process -->
+  <uses-permission android:name="android.permission.INTERNET" />
+```
+
+### iOS
+
+1. In Apple developer site, enable capability for NFC.
+2. Add `NFCReaderUsageDescription` into your `info.plist`, for example:
+   ```xml
+   <key>NFCReaderUsageDescription</key>
+   <string>We need to use NFC</string>
+   ```
+   [More info on Apple's doc](https://developer.apple.com/documentation/bundleresources/information-property-list/nfcreaderusagedescription?language=objc)
+3. Add the required ISO7816 identifiers into your `info.plist`
+   ```xml
+   <key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
+   <array>
+     <string>A0000000308000000009816001</string>
+     <string>A00000000039</string>
+     <string>A0000002471001</string>
+     <string>00000000000000</string>
+   </array>
+   ```
+   [More info on Apple's doc](https://developer.apple.com/documentation/corenfc/nfciso7816tag).
+4. In Xcode's **Signing & Capabilities** tab, make sure **Near Field Communication Tag Reading** capability had been added.
+   [More info on Apple's doc](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_nfc_readersession_formats?language=objc).
+
+## Example App
+
+A fully working example app demonstrating how to use this package is available in the [example](./example) directory.
+
+To run the example app, follow the instructions in [example/README.md](./example/README.md).
+
+## API
+
+List of available functions
+
+| Function                                                                      | Return             | Descrizione                                                   |
+| :---------------------------------------------------------------------------- | :----------------- | :------------------------------------------------------------ |
+| `hasNFCFeature()`                                                             | `Promise<boolean>` | (Android) Checks if the device supports NFC feature           |
+| `isNfcEnabled()`                                                              | `Promise<boolean>` | (Android) Checks if the NFC is currently enabled              |
+| `isCieAuthenticationSupported()`                                              | `Promise<boolean>` | (Android) Checks if the device supports CIE autentication     |
+| `openNfcSettings()`                                                           | `Promise<void>`    | (Android) Opens NFC system settings page                      |
+| `addListener(event: CieEvent, listener: CieEventHandlers)`                       | `() => void`       | Adds a NFC event listener and returns a function to unsubscribe from the event                                    |
+| `removeListener(event: CieEvent)`                       | `void`       | Removes all listeners for the specified event                                     |
+| `removeAllListeners()`                                                        | `void`             | Removes all registered listeners                              |
+| `setCustomIdpUrl(url: string)`                                                | `void`             | Updates IDP url                                               |
+| `setAlertMessage(key: AlertMessageKey, value: string)`                        | `void`             | (iOS) Updates iOS NFC modal alert message                     |
+| `setCurrentAlertMessage(value: string)`                                       | `void`             | (iOS) Updates currently displayed iOS NFC modal alert message |
+| `startReadingAttributes(timeout: number)`                                     | `Promise<void`     | Start the CIE attributes reading process                      |
+| `startReading(pin: string, authenticationUrl: string, timeout: number)`       | `Promise<void`     | Start the CIE reading process fro authentication              |
+| `stopReading()`                                                               | `Promise<void`     | (Android) Stops all reading process                           |
+
+## Usage
+
+The package is split into two modules:
+
+- [CieUtils](/src/utils): Provides functions to check the NFC status of the device.
+- [CieManager](/src/manager): Provides CIE read and authentication capabilities.
+
+### Check NFC Status
+
+**Note:** These methods are applicable only for Android devices, as iOS devices always have NFC available.
+
+```typescript
+import { CieUtils } from '@pagopa/io-react-native-cie';
+
+// Check if the device has NFC
+await CieUtils.hasNfcFeature();
+// Check if NFC is enabled
+await CieUtils.isNfcEnabled();
+// Convenient method to check if CIE authentication is supported
+await CieUtils.isCieAuthenticationSupported();
+```
+
+### Reading CIE Data
+
+#### Reading Attributes
+
+Read CIE attributes (card type and base64-encoded data) with optional timeout (Android only)
+
+```typescript
+import { CieManager } from '@pagopa/io-react-native-cie';
+
+CieManager.startReadingAttributes()
+  .then(() => console.log('Reading started'))
+  .catch((error) => console.error('Error:', error));
+```
+
+#### Authentication
+
+Start the CIE authentication process:
+
+```typescript
+CieManager.startReading('12345678', 'https//auth-url.it')
+  .then(() => console.log('Authentication started'))
+  .catch((error) => console.error('Error:', error));
+```
+
+### Event System
+
+The library uses an event-driven approach for NFC operations and read results. Events are emitted to notify your application about progress, success, or failure. Each listener method returns a cleanup function that should be called when the operation is complete or when your component unmounts.
+
+#### Available events
+
+| Listener Type        | Description                                                                           |
+| -------------------- | ------------------------------------------------------------------------------------- |
+| `onEvent`            | NFC events emitted during the reading process which indicates the reading progression |
+| `onError`            | NFC error events emitted if the reading process fails                                 |
+| `onSuccess`          | Authentication success event                                                          |
+| `onAttributeSuccess` | Successful attribute reads                                                            |
+
+#### Listening for events
+
+You can register an event listiner with CieManager.addListener and remove it with the returned unregister function or by using CieManager.removeListener
+
+```typescript
+const unsubscribe = CieManager.addListener('onEvent', (event) => {
+  console.log(event);
+});
+
+// remove the listener with
+unsubscribe()
+// or
+CieManager.removeListener("onEvent);
+```
+
+#### Example Usage
+
+```typescript
+import { CieManager } from '@pagopa/io-react-native-cie';
+import { useEffect } from 'react';
+
+// ...
+
+useEffect(() => {
+  // Register all event listeners
+  const cleanup = [
+    CieManager.addListener('onEvent', (event) => {
+      console.info('NFC Event', event);
+    }),
+    CieManager.addListener('onError', (error) => {
+      console.error('NFC Error', error);
+    }),
+    CieManager.addListener('onSuccess', (url) => {
+      console.log('Auth url:', url);
+    }),
+  ];
+
+  // Cleanup all listeners on unmount
+  return () => cleanup.forEach((remove) => remove());
+}, []);
+```
+
+To remove all listeners at once:
+
+```typescript
+CieManager.removeAllListeners();
+```
+
+#### NFC read events
+
+List of events that are emitted during CIE reading process. Event names may differs based on the platform
+
+<details>
+  <summary>iOS</summary>
+
+| Event                       | Description                                                |
+| --------------------------- | ---------------------------------------------------------- |
+| ON_TAG_DISCOVERED           | Tag has been discovered                                    |
+| ON_TAG_DISCOVERED_NOT_CIE   | Discovered tag is not a CIE                                |
+| CONNECTED                   | Connected to tag                                           |
+| GET_SERVICE_ID              | Get CIE serviceId                                          |
+| SELECT_IAS                  | Select IAS Application                                     |
+| SELECT_CIE                  | Select CIE Application                                     |
+| DH_INIT_GET_G               | Get DiffieHellman G parameter                              |
+| DH_INIT_GET_P               | Get DiffieHellman P parameter                              |
+| DH_INIT_GET_Q               | Get DiffieHellman Q parameter                              |
+| READ_CHIP_PUBLIC_KEY        | Retrive internal authentication key                        |
+| SELECT_FOR_READ_FILE        | Select file                                                |
+| READ_FILE                   | Read file                                                  |
+| GET_D_H_EXTERNAL_PARAMETERS | Retrive Diffie Hellman external authenticationl parameters |
+| SET_D_H_PUBLIC_KEY          | Set Diffie Hellman internal key                            |
+| GET_ICC_PUBLIC_KEY          | Retrive ICC Public Key                                     |
+| CHIP_SET_KEY                | Select key for certificate validation                      |
+| CHIP_VERIFY_CERTIFICATE     | Certificate validation                                     |
+| CHIP_SET_CAR                | Select key for external authentication                     |
+| CHIP_GET_CHALLENGE          | Get challenge for external authentication                  |
+| CHIP_ANSWER_CHALLENGE       | Responds to challenge for external authentication          |
+| SELECT_KEY                  | Select key                                                 |
+| VERIFY_PIN                  | Verify CIE Pin                                             |
+| SIGN                        | Sign data                                                  |
+| READ_CERTIFICATE            | Read CIE User Certificate                                  |
+| SELECT_ROOT                 | Select Root Application                                    |
+
+</details>
+
+<details>
+
+  <summary>Android</summary>
+
+| Event                         | Description                                            |
+| ----------------------------- | ------------------------------------------------------ |
+| ON_TAG_DISCOVERED             | Tag has been discovered                                |
+| ON_TAG_DISCOVERED_NOT_CIE     | Discovered tag is not a CIE                            |
+| CONNECTED                     | Connected to tag                                       |
+| SELECT_IAS_SERVICE_ID         | Selects internal authentication service for service ID |
+| SELECT_CIE_SERVICE_ID         | Selects CIE service ID                                 |
+| SELECT_READ_FILE_SERVICE_ID   | Selects read file service ID                           |
+| READ_FILE_SERVICE_ID_RESPONSE | Reads file service ID response                         |
+| SELECT_IAS                    | Selects internal authentication service                |
+| SELECT_CIE                    | Selects CIE application                                |
+| DH_INIT_GET_G                 | Gets G for Diffie-Hellman initialization               |
+| DH_INIT_GET_P                 | Gets P for Diffie-Hellman initialization               |
+| DH_INIT_GET_Q                 | Gets Q for Diffie-Hellman initialization               |
+| SELECT_FOR_READ_FILE          | Selects for reading a file                             |
+| READ_FILE                     | Reads a file                                           |
+| INIT_EXTERNAL_AUTHENTICATION  | Initializes external authentication                    |
+| SET_MSE                       | Sets MSE                                               |
+| D_H_KEY_EXCHANGE_GET_DATA     | Exchanges Diffie-Hellman data                          |
+| SIGN1_SELECT                  | Selects SIGN1 message                                  |
+| SIGN1_VERIFY_CERT             | Verifies SIGN1 certificate                             |
+| SET_CHALLENGE_RESPONSE        | Sets challenge response                                |
+| GET_CHALLENGE_RESPONSE        | Gets challenge response                                |
+| EXTERNAL_AUTHENTICATION       | Performs external authentication                       |
+| INTERNAL_AUTHENTICATION       | Performs internal authentication                       |
+| GIVE_RANDOM                   | Provides random data                                   |
+| VERIFY_PIN                    | Verifies PIN                                           |
+| READ_FILE_SM                  | Reads file with secure messaging                       |
+| SIGN                          | Signs data                                             |
+| SIGN_WITH_CIPHER              | Signs with cipher                                      |
+| SELECT_ROOT                   | Selects root                                           |
+
+</details>
+
+#### NFC error events
+
+List of error event that may be emitted during CIE reading process
+
+| Error                  | Description                            |
+| ---------------------- | -------------------------------------- |
+| NOT_A_CIE              | Discovered tag is not a CIE            |
+| TAG_LOST               | Tag was lost during read operation     |
+| CANCELLED_BY_USER      | (iOS only) Read was cancelled by user  |
+| APDU_ERROR             | Protocol error or not supported        |
+| CARD_BLOCKED           | Too many PIN attempts, card is blocked |
+| WRONG_PIN              | Wrong PIN                              |
+| NO_INTERNET_CONNECTION | Missing internet connection            |
+| CERTIFICATE_EXPIRED    | CIE expired                            |
+| CERTIFICATE_REVOKED    | CIE revoked                            |
+| AUTHENTICATION_ERROR   | unable to complete authentication      |
+| GENERIC_ERROR          | Unmapped or unexpected error           |
+
+### Alert Messages
+
+**Note:** This feature is iOS-only; Android does not support alert messages.
+
+<img src="https://github.com/user-attachments/assets/eaebf481-f5db-476e-977e-25653606ab8f" width="200" />
+<img src="https://github.com/user-attachments/assets/dc7c5a81-954e-43dc-a468-6a2c17620eb1" width="200" />
+<img src="https://github.com/user-attachments/assets/f473b67f-c5a5-4954-9e85-f2b414db53f2" width="200" />
+
+Customize the NFC dialog messages using `CieManager.setAlertMessage(key, value)`:
+
+```typescript
+CieManager.setAlertMessage(
+  'readingInstructions',
+  'Hold your iPhone near your CIE card to begin scanning.'
+);
+```
+
+You can update the currently displayed alert message (for example, during the reading process) using `CieManager.setCurrentAlertMessage(value)`:
+
+```typescript
+CieManager.setCurrentAlertMessage('Reading in progress, 80% completed');
+```
+
+#### Available Alert Messages
+
+| Key                    | Description              | Default Message                                                                                   |
+| ---------------------- | ------------------------ | ------------------------------------------------------------------------------------------------- |
+| `readingInstructions`  | Pre-scan instructions    | "Tieni la tua carta d'identità elettronica sul retro dell'iPhone, nella parte in alto."           |
+| `moreTags`             | Multiple tags detected   | "Sono stati individuate più carte NFC. Per favore avvicina una carta alla volta."                 |
+| `readingInProgress`    | Reading status           | "Lettura in corso, tieni ferma la carta ancora per qualche secondo..."                            |
+| `readingSuccess`       | Success message          | "Lettura avvenuta con successo. Puoi rimuovere la carta mentre completiamo la verifica dei dati." |
+| `invalidCard`          | Invalid card error       | "La carta utilizzata non sembra essere una Carta di Identità Elettronica (CIE)."                  |
+| `tagLost`              | Card removed error       | "Hai rimosso la carta troppo presto."                                                             |
+| `cardLocked`           | Card locked error        | "Carta CIE bloccata"                                                                              |
+| `wrongPin1AttemptLeft` | PIN warning (1 attempt)  | "PIN errato, hai ancora 1 tentativo"                                                              |
+| `wrongPin2AttemptLeft` | PIN warning (2 attempts) | "PIN errato, hai ancora 2 tentativi"                                                              |
+| `genericError`         | Generic error            | "Qualcosa è andato storto"                                                                        |
+
+## Types
+
+```typescript
+type CieAttributes = {
+  type: string;
+  base64: string;
+};
+```
+
+Contains the CIE type (NFC manufacturer) and the attributres in base64 encoded string format.
+CIE type can be one of the following: `NXP`, `GEMALTO`, `GEMALTO_2`, `ACTALIS`, `ST`, `UNKNOWN`
+
+```typescript
+type NfcEvent = {
+  name: string;
+  progress: number;
+};
+```
+
+Event sent during the CIE reading process. Contains the name of the event and the progress associated. Event names and order may vary based on the platform.
+
+```typescript
+type NfcError = {
+  name: NfcErrorName;
+  message?: string;
+};
+```
+
+Error event that may be sent during the CIE reading process. Contains the name of the error and an optional message. Error names and order may vary based on the platform.
+
+## Errors
+
+The CIE reading function may throw exceptions if the reading process cannot be initiated. These exceptions indicate issues with input validation or system compatibility.
+Below is a comprehensive list of possible exceptions that may be thrown during initialization:
+
+| Error Code            | Platform    | Description             |
+| --------------------- | ----------- | ----------------------- |
+| `PIN_REGEX_NOT_VALID` | ios/Android | Invalid PIN format      |
+| `INVALID_AUTH_URL`    | ios/Android | Invalid auth url format |
+| `THREADING_ERROR`     | iOS         | Unexpected error        |
+| `UNKNOWN_EXCEPTION`   | iOS/Android | Unexpected error        |
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+
+## License
+
+MIT
+
+---
+
+Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)