Skip to content

Latest commit

 

History

History
238 lines (159 loc) · 6.57 KB

README.md

File metadata and controls

238 lines (159 loc) · 6.57 KB
Raw

react-native-sim-cards-manager

A new library that merge multiple sim cards libraries into a single one:

Bridges have been adapted, so you will have to adapt your code if you come from one of those libraries.

Bugs fixed and some improvements have been made.

Installation

npm install react-native-sim-cards-manager

Permissions

Android

Minimum API Level is 22

TelephonyManager require Android permission READ_PHONE_STATE:

Add in your Android Manifest:

<uses-permission
          android:name="android.permission.READ_PHONE_STATE" />

To use eSIM features, for regular apps, please follow this

To use eSIM features, for system apps, add in your Android Manifest:

<uses-permission
          android:name="android.permission.WRITE_EMBEDDED_SUBSCRIPTIONS" />

More info here

iOS

This API won't work without eSIM entitlement. You can read more about it here

Minimum API Level is 12 for eSIM methods

Note: At the moment (iOS 14.2) there might a bug in iOS SDK which returns uknown result before eSIM setup completion. More about it here

Usage

Get sim cards

The list can be empty (no simcards detected) or one/many element(s) Two methods are availabe :

Method getSimCards

This handle the permission request and takes an optionnal rationale Parameter

import SimCardsManagerModule from 'react-native-sim-cards-manager';

SimCardsManagerModule.getSimCards({
  title: 'App Permission',
  message: 'Custom message',
  buttonNeutral: 'Not now',
  buttonNegative: 'Not OK',
  buttonPositive: 'OK',
})
  .then((array: Array<any>) => {
    //
  })
  .catch((error) => {
    //
  });

Method getSimCardsNative

This is the method used internally by getSimCards. It does not handle the permission request and leaves the user of this lib.

import SimCardsManagerModule from 'react-native-sim-cards-manager';

SimCardsManagerModule.getSimCardsNative()
  .then((array: Array<any>) => {
    //
  })
  .catch((error) => {
    //
  });

Available set of data per platform:

Platform iOS Android
carrierName ✅ ✅
displayName ❌ ✅
isoCountryCode ✅ ✅
mobileCountryCode ✅ ✅
mobileNetworkCode ✅ ✅
isNetworkRoaming ❌ ✅
isDataRoaming ❌ ✅
simSlotIndex ❌ ✅
phoneNumber ❌ ✅
simSerialNumber ❌ ✅
subscriptionId ❌ ✅
allowsVOIP ✅ ❌

Esim is supported

Return true/false is the device support eSim feature

import SimCardsManagerModule from 'react-native-sim-cards-manager';

SimCardsManagerModule.isEsimSupported()
  .then((isSupported: boolean) => {
    //
  })
  .catch((error) => {
    //
  });

Setup eSim with an activation code

Entry parameters for the bridge:

Entry parameters Mandatory Description
address N/A The address of the carrier network’s eSIM server
confirmationCode N/A The provisioning request’s confirmation code, provided by the network operator when initiating an eSIM download
iccid N/A The provisioning request’s eUICC identifier
address N/A The provisioning request’s Integrated Circuit Card Identifier
matchingId N/A The provisioning request’s matching identifier
oid N/A The provisioning request’s Object Identifier

Error code that can be returned by the bridge:

Error code Description
0 Feature not available for that OS / device
1 The device doesn't support a cellular plan
2 The OS failed to add the new plan
3 (iOS) The OS has returned an unknow error
3 (Android) The OS has returned an error or something goes wrong with the Intent/Activity 
import SimCardsManagerModule from 'react-native-sim-cards-manager';

SimCardsManagerModule.setupEsim({
  confirmationCode,
  address: '',
})
  .then((isPlanAdded: boolean) => {
    //
  })
  .catch((error) => {
    //
  });

Changelog

1.0.11

  • Fix Android - get phone number on API 33
  • Android - sendPhoneCall with phone number and sim slot index

1.0.10

  • Fix Fix issue when the OS requires user action

1.0.9

  • Improve package generation and add types declaration (one more time !)

1.0.8

  • Improve package generation and add types declaration

1.0.7

  • Upgrade packages (detected CVE)

1.0.6

  • Added an extra check on eSim method for Android (hasCarrierPrivileges())

1.0.5

  • Fix bug with missing MUTABLE flag on intent for Android
  • Remove some useless logs

1.0.4

  • Improve esim resolvable error

1.0.3

  • Fix bug with EMBEDDED_SUBSCRIPTION_RESULT_ERROR #12

1.0.2

  • Remove 'deviceID' on Android because it require high privilege
  • Adding permission management on Android (READ_PHONE_STATE)

1.0.1

  • Android bug fixes

1.0.0

  • First stable release

0.9.9

  • iOS implementation
  • Android implementation
  • RN implementation
  • Documentation & sample project

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT