react-native-nfc-manager 3.9.0 → 3.11.1

package/README.md

@@ -8,7 +8,7 @@ Bring NFC feature to React Native. Inspired by [phonegap-nfc](https://github.com
 
 Contributions are welcome!
 
-> We also have a slack channel, you're welcome to chat with us for any issue or idea! [join us here](https://join.slack.com/t/reactnativenf-ewh2625/shared_invite/zt-puz9y22v-3rkORO6_zQe4FmaWm6ku_w)
+Made with ❤️ by [whitedogg13](https://github.com/whitedogg13) and [revteltech](https://github.com/revtel)
 
 ## Install
 
@@ -34,22 +34,21 @@ Please see [here](setup.md)
 
 ## Also See
 
-### [Demo App] NfcOpenReWriter 
+### [Demo App] NfcOpenReWriter
 
 We have a full featured NFC utility app available for download.
 
 <a href='https://apps.apple.com/tw/app/nfc-rewriter/id1551243964' target='_blank'>
 <img alt="react-native-nfc-rewriter" src="./images/Apple-App-Store-Icon.png" width="250">
 </a>
-<br/>
 
-It also open sourced in this repo: [React Native NFC ReWriter App](https://github.com/revtel/react-native-nfc-rewriter)
-
-### [Bonus] Reconnect.js
+</br>
 
-Super useful library to help you share states between `sibling` and `nested` React components.
+<a href='https://play.google.com/store/apps/details?id=com.washow.nfcopenrewriter' target='_blank'>
+<img alt="react-native-nfc-rewriter" src="./images/google-play-icon.jpeg" width="250">
+</a>
 
-[Check it out!](https://github.com/revtel/reconnect.js)
+It also open sourced in this repo: [React Native NFC ReWriter App](https://github.com/revtel/react-native-nfc-rewriter)
 
 ## Basic Usage
 
@@ -149,6 +148,65 @@ async function writeNdef({type, value}) {
 }
 ```
 
+## Advanced: Mifare Ultralight usage
+
+Here's an example to read a Mifare Ultralight tag:
+
+```javascript
+import NfcManager, {NfcTech} from 'react-native-nfc-manager';
+
+// Pre-step, call this before any NFC operations
+async function initNfc() {
+  await NfcManager.start();
+}
+
+async function readMifare() {
+  try {
+    // 0. Request Mifare technology
+    let reqMifare = await NfcManager.requestTechnology(
+      NfcTech.MifareUltralight,
+    );
+    if (reqMifare !== 'MifareUltralight') {
+      throw new Error(
+        '[NFC Read] [ERR] Mifare technology could not be requested',
+      );
+    }
+
+    // 1. Get NFC Tag information
+    const nfcTag = await NfcManager.getTag();
+    console.log('[NFC Read] [INFO] Tag: ', nfcTag);
+
+    // 2. Read pages
+    const readLength = 60;
+    let mifarePages = [];
+    const mifarePagesRead = await Promise.all(
+      [...Array(readLength).keys()].map(async (_, i) => {
+        const pageOffset = i * 4; // 4 Pages are read at once, so offset should be in steps with length 4
+        let pages = await NfcManager.mifareUltralightHandlerAndroid.mifareUltralightReadPages(
+          pageOffset,
+        );
+        mifarePages.push(pages);
+        console.log(`[NFC Read] [INFO] Mifare Page: ${pageOffset}`, pages);
+        //await wait(500); // If Mifare Chip is to slow
+      }),
+    );
+
+    // 3. Success
+    console.log('[NFC Read] [INFO] Success reading Mifare');
+
+    // 4. Cleanup
+    _cleanup();
+  } catch (ex) {
+    console.warn('[NFC Read] [ERR] Failed Reading Mifare: ', ex);
+    _cleanup();
+  }
+}
+
+function _cleanup() {
+  NfcManager.cancelTechnologyRequest().catch(() => 0);
+}
+```
+
 To see more examples, please see [React Native NFC ReWriter App](https://github.com/revtel/react-native-nfc-rewriter)
 
 ## API
@@ -179,8 +237,9 @@ Next, rebuild your app as described in the ["Adding custom native code"](https:/
 
 The plugin provides props for extra customization. Every time you change the props or plugins, you'll need to rebuild (and `prebuild`) the native app. If no extra properties are added, defaults will be used.
 
-- `nfcPermission` (_string | false_): Sets the iOS `NFCReaderUsageDescription` permission message to the `Info.plist`. Setting `false` will skip adding the permission. Defaults to `Allow $(PRODUCT_NAME) to interact with nearby NFC devices`.
-- `selectIdentifiers` (_string[]_): Sets the iOS [`com.apple.developer.nfc.readersession.iso7816.select-identifiers`](https://developer.apple.com/documentation/bundleresources/information_property_list/select-identifiers) entitlements to a list of supported application IDs.
+- `nfcPermission` (_string | false_): Sets the iOS `NFCReaderUsageDescription` permission message to the `Info.plist`. Setting `false` will skip adding the permission. Defaults to `Allow $(PRODUCT_NAME) to interact with nearby NFC devices` (Info.plist).
+- `selectIdentifiers` (_string[]_): Sets the iOS [`com.apple.developer.nfc.readersession.iso7816.select-identifiers`](https://developer.apple.com/documentation/bundleresources/information_property_list/select-identifiers) to a list of supported application IDs (Info.plist).
+- `systemCodes` (_string[]_): Sets the iOS [`com.apple.developer.nfc.readersession.felica.systemcodes`](https://developer.apple.com/documentation/bundleresources/information_property_list/systemcodes) to a user provided list of FeliCa™ system codes that the app supports (Info.plist). Each system code must be a discrete value. The wild card value (`0xFF`) isn't allowed.
 
 #### Example
 
@@ -192,10 +251,12 @@ The plugin provides props for extra customization. Every time you change the pro
         "react-native-nfc-manager",
         {
           "nfcPermission": "Custom permission message",
-          "selectIdentifiers": ["A0000002471001"]
+          "selectIdentifiers": ["A0000002471001"],
+          "systemCodes": ["8008"]
         }
       ]
     ]
   }
 }
 ```
+

package/android/src/main/java/community/revteltech/nfc/NfcManager.java

@@ -58,6 +58,7 @@ class NfcManager extends ReactContextBaseJavaModule implements ActivityEventList
     private static final String ERR_NOT_REGISTERED = "you should requestTagEvent first";
     private static final String ERR_MULTI_REQ = "You can only issue one request at a time";
     private static final String ERR_NO_TECH_REQ = "no tech request available";
+    private static final String ERR_NO_REFERENCE = "no reference available";
     private static final String ERR_TRANSCEIVE_FAIL = "transceive fail";
     private static final String ERR_API_NOT_SUPPORT = "unsupported tag api";
     private static final String ERR_GET_ACTIVITY_FAIL = "fail to get current activity";
@@ -160,19 +161,22 @@ class NfcManager extends ReactContextBaseJavaModule implements ActivityEventList
 
     @ReactMethod
     public void getTag(Callback callback) {
-        synchronized(this) {
+        synchronized (this) {
             if (techRequest != null) {
                 Tag tag = techRequest.getTagHandle();
-                WritableMap parsed = tag2React(tag);
-                if (Arrays.asList(tag.getTechList()).contains(Ndef.class.getName())) {
-                    try {
-                        Ndef ndef = Ndef.get(tag);
-                        parsed = ndef2React(ndef, new NdefMessage[] { ndef.getCachedNdefMessage() });
-                    } catch (Exception ex) {
-                        // bypass
+                if (tag != null) {
+                    WritableMap parsed = tag2React(tag);
+                    if (Arrays.asList(tag.getTechList()).contains(Ndef.class.getName())) {
+                        try {
+                            Ndef ndef = Ndef.get(tag);
+                            parsed = ndef2React(ndef, new NdefMessage[]{ndef.getCachedNdefMessage()});
+                        } catch (Exception ex) {
+                        }
                     }
+                    callback.invoke(null, parsed);
+                } else {
+                    callback.invoke(ERR_NO_REFERENCE);
                 }
-                callback.invoke(null, parsed);
             } else {
                 callback.invoke(ERR_NO_TECH_REQ);
             }
@@ -1060,7 +1064,12 @@ class NfcManager extends ReactContextBaseJavaModule implements ActivityEventList
         Activity activity = getCurrentActivity();
         Intent intent = new Intent(activity, activity.getClass());
         intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP | Intent.FLAG_ACTIVITY_CLEAR_TOP);
-        return PendingIntent.getActivity(activity, 0, intent, 0);
+
+        int flag = 0;
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+          flag = PendingIntent.FLAG_MUTABLE;
+        }
+        return PendingIntent.getActivity(activity, 0, intent, flag);
     }
 
     private IntentFilter[] getIntentFilters() {
@@ -1135,6 +1144,10 @@ class NfcManager extends ReactContextBaseJavaModule implements ActivityEventList
         WritableMap nfcTag = parseNfcIntent(intent);
         if (nfcTag != null) {
             if (isForegroundEnabled) {
+                Tag tagFromIntent = intent.getParcelableExtra(NfcAdapter.EXTRA_TAG);
+                Intent intentNew=new Intent("TagFound");
+                intentNew.putExtra("tag",tagFromIntent);
+                context.sendBroadcast(intentNew);
                 sendEvent("NfcManagerDiscoverTag", nfcTag);
             } else {
                 sendEvent("NfcManagerDiscoverBackgroundTag", nfcTag);

package/app.plugin.js

@@ -4,7 +4,7 @@ const {
   withEntitlementsPlist,
 } = require('@expo/config-plugins');
 
-const NFC_READER = 'Allow $(PRODUCT_NAME) to interact with nearby NFC devices';
+const NFC_READER = 'Interact with nearby NFC devices';
 
 function withIosPermission(c, props = {}) {
   const {nfcPermission} = props;
@@ -18,44 +18,73 @@ function withIosPermission(c, props = {}) {
   });
 }
 
-function addValuesToEntitlementsArray(entitlements, key, values) {
+function addValuesToArray(obj, key, values) {
   if (!Array.isArray(values) || !values.length) {
-    return entitlements;
+    return obj;
   }
-  if (!Array.isArray(entitlements[key])) {
-    entitlements[key] = [];
+  if (!Array.isArray(obj[key])) {
+    obj[key] = [];
   }
   // Add the required values
-  entitlements[key].push(...values);
+  obj[key].push(...values);
 
   // Remove duplicates
-  entitlements[key] = [...new Set(entitlements[key])];
+  obj[key] = [...new Set(obj[key])];
 
-  return entitlements;
+  // Prevent adding empty arrays to Info.plist or *.entitlements
+  if (!obj[key].length) {
+    delete obj[key];
+  }
+
+  return obj;
 }
 
-function withIosNFCEntitlement(c, {selectIdentifiers}) {
+function withIosNfcEntitlement(c) {
   return withEntitlementsPlist(c, (config) => {
     // Add the required formats
-    config.modResults = addValuesToEntitlementsArray(
+    config.modResults = addValuesToArray(
       config.modResults,
       'com.apple.developer.nfc.readersession.formats',
       ['NDEF', 'TAG'],
     );
+
+    return config;
+  });
+}
+
+function withIosNfcSelectIdentifiers(c, {selectIdentifiers}) {
+  return withInfoPlist(c, (config) => {
     // Add the user defined identifiers
-    config.modResults = addValuesToEntitlementsArray(
+    config.modResults = addValuesToArray(
       config.modResults,
       // https://developer.apple.com/documentation/bundleresources/information_property_list/select-identifiers
       'com.apple.developer.nfc.readersession.iso7816.select-identifiers',
       selectIdentifiers || [],
     );
+
+    return config;
+  });
+}
+
+function withIosNfcSystemCodes(c, {systemCodes}) {
+  return withInfoPlist(c, (config) => {
+    // Add the user defined identifiers
+    config.modResults = addValuesToArray(
+      config.modResults,
+      // https://developer.apple.com/documentation/bundleresources/information_property_list/systemcodes
+      'com.apple.developer.nfc.readersession.felica.systemcodes',
+      systemCodes || [],
+    );
+
     return config;
   });
 }
 
-function withNFC(config, props = {}) {
-  const {nfcPermission, selectIdentifiers} = props;
-  config = withIosNFCEntitlement(config, {selectIdentifiers});
+function withNfc(config, props = {}) {
+  const {nfcPermission, selectIdentifiers, systemCodes} = props;
+  config = withIosNfcEntitlement(config);
+  config = withIosNfcSelectIdentifiers(config, {selectIdentifiers});
+  config = withIosNfcSystemCodes(config, {systemCodes});
   if (nfcPermission !== false) {
     config = withIosPermission(config, props);
     config = AndroidConfig.Permissions.withPermissions(config, [
@@ -65,4 +94,4 @@ function withNFC(config, props = {}) {
   return config;
 }
 
-module.exports = withNFC;
+module.exports = withNfc;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-nfc-manager",
-  "version": "3.9.0",
+  "version": "3.11.1",
   "description": "A NFC module for react native.",
   "main": "src/index.js",
   "repository": {
@@ -51,6 +51,7 @@
     "@babel/preset-react": "^7.12.10",
     "@react-native-community/eslint-config": "^2.0.0",
     "@release-it/conventional-changelog": "^2.0.1",
+    "dotenv-cli": "^4.0.0",
     "eslint": "^7.19.0",
     "jest": "^26.6.3",
     "jest-cli": "^26.6.3",
@@ -61,12 +62,12 @@
     "typescript": "^4.1.3"
   },
   "dependencies": {
-    "@expo/config-plugins": "^2.0.0"
+    "@expo/config-plugins": "^3.0.6"
   },
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "jest -i",
-    "release": "release-it"
+    "release": "dotenv release-it --"
   }
 }

package/src/NativeNfcManager.js

@@ -8,7 +8,7 @@ function callNative(name, params = []) {
   const nativeMethod = NativeNfcManager[name];
 
   if (!nativeMethod) {
-    throw new Error(`no sucm native method: "${name}"`);
+    throw new Error(`no such native method: "${name}"`);
   }
 
   if (!Array.isArray(params)) {