@pagopa/io-react-native-cie 1.0.0

package/src/manager/types.ts

@@ -0,0 +1,94 @@
+import { z } from 'zod';
+
+/**
+ * Represent the key of the alert message that can be set during the CIE reading process
+ *
+ * **Note**: Alert messages are only available on iOS
+ */
+export const AlertMessageKey = z.enum([
+  'readingInstructions',
+  'moreTags',
+  'readingInProgress',
+  'readingSuccess',
+  'invalidCard',
+  'tagLost',
+  'cardLocked',
+  'wrongPin1AttemptLeft',
+  'wrongPin2AttemptLeft',
+  'genericError',
+]);
+
+export type AlertMessageKey = z.infer<typeof AlertMessageKey>;
+
+/**
+ * Event emitted during the CIE reading process with the name of the event and the progress of the reading up to that point.
+ * Event names may differ based on the platform.
+ */
+export const NfcEvent = z.object({
+  name: z.string(),
+  progress: z.coerce.number(),
+});
+
+export type NfcEvent = z.infer<typeof NfcEvent>;
+
+/**
+ * Name of the error emitted during the CIE reading process
+ */
+export const NfcErrorName = z.enum([
+  'NOT_A_CIE',
+  'TAG_LOST',
+  'CANCELLED_BY_USER',
+  'APDU_ERROR',
+  'WRONG_PIN',
+  'CARD_BLOCKED',
+  'NO_INTERNET_CONNECTION',
+  'CERTIFICATE_EXPIRED',
+  'CERTIFICATE_REVOKED',
+  'AUTHENTICATION_ERROR',
+  'GENERIC_ERROR',
+]);
+
+export type NfcErrorName = z.infer<typeof NfcErrorName>;
+
+/**
+ * Represent an NFC error emitted during the CIE reading process
+ * It contains the name of the error, the message and the number of attempts
+ */
+export const NfcError = z.union([
+  z.object({
+    name: NfcErrorName,
+    message: z.string().optional(),
+  }),
+  z.object({
+    name: z.literal(NfcErrorName.enum.WRONG_PIN),
+    message: z.string().optional(),
+    attempts: z.number(),
+  }),
+]);
+
+export type NfcError = z.infer<typeof NfcError>;
+
+/**
+ * Represent the CIE attributes containing the CIE type
+ */
+export const CieAttributes = z.object({
+  type: z.string(),
+  base64: z.string(),
+});
+
+export type CieAttributes = z.infer<typeof CieAttributes>;
+
+/**
+ * Event handler that can be used to handle the CIE events during the reading process
+ */
+export type CieEventHandlers = {
+  onEvent: (event: NfcEvent) => void;
+  onError: (error: NfcError) => void;
+  onAttributesSuccess: (attributes: CieAttributes) => void;
+  onSuccess: (uri: string) => void;
+};
+
+/**
+ * Possible events that can be listened to
+ */
+export type CieEvent = keyof CieEventHandlers;

package/src/native.ts

@@ -0,0 +1,18 @@
+import { NativeModules, Platform } from 'react-native';
+
+const LINKING_ERROR =
+  `The package '@pagopa/io-react-native-cie' 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 IoReactNativeCie = NativeModules.IoReactNativeCie
+  ? NativeModules.IoReactNativeCie
+  : new Proxy(
+      {},
+      {
+        get() {
+          throw new Error(LINKING_ERROR);
+        },
+      }
+    );

package/src/utils/index.ts

@@ -0,0 +1,42 @@
+import { IoReactNativeCie } from '../native';
+
+/**
+ * Checks if the device has NFC hardware capabilities.
+ *
+ * On iOS the NFC features is always available.
+ *
+ * @returns A promise that resolves to true if the device supports NFC, false otherwise.
+ * @throws {CieError} If cannot check if NFC is available.
+ */
+export const hasNfcFeature = async () => {
+  return IoReactNativeCie.hasNfcFeature();
+};
+
+/**
+ * Checks if NFC is currently enabled on the device.
+ *
+ * On iOS the NFC features is always enabled.
+ *
+ * @returns A promise that resolves to true if NFC is enabled, false otherwise.
+ * @throws {CieError} If cannot check if NFC is enabled.
+ */
+export const isNfcEnabled = async () => {
+  return IoReactNativeCie.isNfcEnabled();
+};
+
+/**
+ * Verifies if the device supports CIE (Electronic Identity Card) authentication.
+ * @returns A promise that resolves to true if CIE authentication is supported, false otherwise.
+ */
+export const isCieAuthenticationSupported = async () => {
+  return IoReactNativeCie.isCieAuthenticationSupported();
+};
+
+/**
+ * Opens the device's NFC settings page, allowing users to enable or disable NFC.
+ * @returns A promise that resolves when the settings page is opened.
+ * @throws {CieError} If cannot open the settings page.
+ */
+export const openNfcSettings = async () => {
+  return IoReactNativeCie.openNfcSettings();
+};