expo-cellular 3.0.0 → 4.1.0

package/CHANGELOG.md

@@ -8,6 +8,61 @@
 
 ### 🐛 Bug fixes
 
+### 💡 Others
+
+## 4.1.0 — 2021-12-03
+
+### 💡 Others
+
+- Removed legacy Objective-C implementation and changed the pod name to `ExpoCellular`. ([#15082](https://github.com/expo/expo/pull/15082) by [@tsapeta](https://github.com/tsapeta))
+
+## 4.0.0 — 2021-09-28
+
+### 🛠 Breaking changes
+
+- Deprecated module's constants in favor of new methods returning up-to-date data. ([#13729](https://github.com/expo/expo/pull/13729) by [@m1st4ke](https://github.com/m1st4ke))
+- Dropped support for iOS 11.0 ([#14383](https://github.com/expo/expo/pull/14383) by [@cruzach](https://github.com/cruzach))
+
+### 🎉 New features
+
+- Added 5G cellular support ([#13713](https://github.com/expo/expo/pull/13713) by [@m1st4ke](https://github.com/m1st4ke))
+- Added methods returning up-to-date data. ([#13729](https://github.com/expo/expo/pull/13729) by [@m1st4ke](https://github.com/m1st4ke))
+
+### 🐛 Bug fixes
+
+- Fix building errors from use_frameworks! in Podfile. ([#14523](https://github.com/expo/expo/pull/14523) by [@kudo](https://github.com/kudo))
+
+### 💡 Others
+
+- Added experimental opt-in implementation in Swift ([#13523](https://github.com/expo/expo/pull/13523) by [@tsapeta](https://github.com/tsapeta))
+- Rewrote Android part from Java to Kotlin ([#13694](https://github.com/expo/expo/pull/13694) by [@m1st4ke](https://github.com/m1st4ke))
+
+## 3.2.0 — 2021-06-16
+
+### 🎉 New features
+
+- [plugin] Created config plugin for applying permissions on Android ([#13175](https://github.com/expo/expo/pull/13175) by [@EvanBacon](https://github.com/EvanBacon))
+
+### 🐛 Bug fixes
+
+- Fix null cellular information on iOS. ([#12710](https://github.com/expo/expo/pull/12710) by [@randomhajile](https://github.com/randomhajile))
+- Enable kotlin in all modules. ([#12716](https://github.com/expo/expo/pull/12716) by [@wschurman](https://github.com/wschurman))
+- Add TypeScript types to the exported constants: `allowsVoip`, `carrier`, `isoCountryCode`, `mobileCountryCode` and `mobileNetworkCode`. ([#12838](https://github.com/expo/expo/pull/12838) by [@simek](https://github.com/simek))
+
+### 💡 Others
+
+- Build Android code using Java 8 to fix Android instrumented test build error. ([#12939](https://github.com/expo/expo/pull/12939) by [@kudo](https://github.com/kudo))
+
+## 3.1.0 — 2021-03-10
+
+### 🎉 New features
+
+- Updated Android build configuration to target Android 11 (added support for Android SDK 30). ([#11647](https://github.com/expo/expo/pull/11647) by [@bbarthec](https://github.com/bbarthec))
+
+### 🐛 Bug fixes
+
+- Remove peerDependencies and unimodulePeerDependencies from Expo modules. ([#11980](https://github.com/expo/expo/pull/11980) by [@brentvatne](https://github.com/brentvatne))
+
 ## 3.0.0 — 2021-01-15
 
 ### 🛠 Breaking changes

package/README.md

@@ -13,7 +13,7 @@ For managed [managed](https://docs.expo.io/versions/latest/introduction/managed-
 
 # Installation in bare React Native projects
 
-For bare React Native projects, you must ensure that you have [installed and configured the `react-native-unimodules` package](https://github.com/expo/expo/tree/master/packages/react-native-unimodules) before continuing.
+For bare React Native projects, you must ensure that you have [installed and configured the `expo` package](https://docs.expo.dev/bare/installing-expo-modules/) before continuing.
 
 ### Add the package to your npm dependencies
 
@@ -21,6 +21,15 @@ For bare React Native projects, you must ensure that you have [installed and con
 expo install expo-cellular
 ```
 
+### Configure for Android
+
+This package requires the `android.permission.READ_PHONE_STATE` be added to your `AndroidManifest.xml`, this is used for `TelephonyManager` on Android. We **do not** require the more risky `READ_PRIVILEGED_PHONE_STATE` permission.
+
+```xml
+<!-- Added permissions -->
+<uses-permission android:name="android.permission.READ_PHONE_STATE" />
+```
+
 # Contributing
 
 Contributions are very welcome! Please refer to guidelines described in the [contributing guide](https://github.com/expo/expo#contributing).

package/android/build.gradle

@@ -1,12 +1,23 @@
 apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
 apply plugin: 'maven'
 
 group = 'host.exp.exponent'
-version = '3.0.0'
+version = '4.1.0'
 
-// Simple helper that allows the root project to override versions declared by this library.
-def safeExtGet(prop, fallback) {
-  rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+buildscript {
+  // Simple helper that allows the root project to override versions declared by this library.
+  ext.safeExtGet = { prop, fallback ->
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+  }
+
+  repositories {
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${safeExtGet('kotlinVersion', '1.4.21')}")
+  }
 }
 
 // Upload android library to maven with javadoc and android sources
@@ -35,27 +46,30 @@ uploadArchives {
 }
 
 android {
-  compileSdkVersion safeExtGet("compileSdkVersion", 29)
+  compileSdkVersion safeExtGet("compileSdkVersion", 30)
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+  kotlinOptions {
+    jvmTarget = JavaVersion.VERSION_1_8
+  }
 
   defaultConfig {
     minSdkVersion safeExtGet("minSdkVersion", 21)
-    targetSdkVersion safeExtGet("targetSdkVersion", 29)
+    targetSdkVersion safeExtGet("targetSdkVersion", 30)
     versionCode 11
-    versionName '3.0.0'
+    versionName '4.1.0'
   }
   lintOptions {
     abortOnError false
   }
 }
 
-if (new File(rootProject.projectDir.parentFile, 'package.json').exists()) {
-  apply from: project(":unimodules-core").file("../unimodules-core.gradle")
-} else {
-  throw new GradleException(
-      '\'unimodules-core.gradle\' was not found in the usual React Native dependency location. ' +
-          'This package can only be used in such projects. Are you sure you\'ve installed the dependencies properly?')
-}
-
 dependencies {
-  unimodule 'unimodules-core'
+  implementation project(':expo-modules-core')
+
+  implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${safeExtGet('kotlinVersion', '1.4.21')}"
 }

package/android/src/main/java/expo/modules/cellular/CellularGeneration.kt

@@ -0,0 +1,9 @@
+package expo.modules.cellular
+
+enum class CellularGeneration(val value: Int) {
+  UNKNOWN(0),
+  CG_2G(1),
+  CG_3G(2),
+  CG_4G(3),
+  CG_5G(4),
+}

package/android/src/main/java/expo/modules/cellular/CellularModule.kt

@@ -0,0 +1,102 @@
+package expo.modules.cellular
+
+import android.annotation.SuppressLint
+import android.content.Context
+import android.net.sip.SipManager
+import android.os.Build
+import android.telephony.TelephonyManager
+import android.util.Log
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+
+const val moduleName = "ExpoCellular"
+
+class CellularModule : Module() {
+  override fun definition() = ModuleDefinition {
+    name(moduleName)
+    constants {
+      val telephonyManager = telephonyManager()
+      mapOf(
+        "allowsVoip" to SipManager.isVoipSupported(context),
+        "isoCountryCode" to telephonyManager?.simCountryIso,
+        "carrier" to telephonyManager?.simOperatorName,
+        "mobileCountryCode" to telephonyManager?.simOperator?.substring(0, 3),
+        "mobileNetworkCode" to telephonyManager?.simOperator?.substring(3)
+      )
+    }
+
+    function("getCellularGenerationAsync") {
+      try {
+        getCurrentGeneration()
+      } catch (e: SecurityException) {
+        Log.w(moduleName, "READ_PHONE_STATE permission is required to acquire network type", e)
+        CellularGeneration.UNKNOWN.value
+      }
+    }
+
+    function("allowsVoipAsync") {
+      SipManager.isVoipSupported(context)
+    }
+
+    function("getIsoCountryCodeAsync") {
+      telephonyManager()?.simCountryIso
+    }
+
+    function("getCarrierNameAsync") {
+      telephonyManager()?.simOperatorName
+    }
+
+    function("getMobileCountryCodeAsync") {
+      telephonyManager()?.simOperator?.substring(0, 3)
+    }
+
+    function("getMobileNetworkCodeAsync") {
+      telephonyManager()?.simOperator?.substring(3)
+    }
+  }
+
+  private fun telephonyManager() =
+    (context.getSystemService(Context.TELEPHONY_SERVICE) as? TelephonyManager).takeIf {
+      it?.simState == TelephonyManager.SIM_STATE_READY
+    }
+
+  private val context
+    get() = requireNotNull(appContext.reactContext)
+
+  @SuppressLint("MissingPermission")
+  private fun getCurrentGeneration(): Int {
+    val telephonyManager = telephonyManager()
+      ?: return CellularGeneration.UNKNOWN.value
+    val networkType = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
+      telephonyManager.dataNetworkType
+    } else {
+      telephonyManager.networkType
+    }
+    return when (networkType) {
+      TelephonyManager.NETWORK_TYPE_GPRS,
+      TelephonyManager.NETWORK_TYPE_EDGE,
+      TelephonyManager.NETWORK_TYPE_CDMA,
+      TelephonyManager.NETWORK_TYPE_1xRTT,
+      TelephonyManager.NETWORK_TYPE_IDEN -> {
+        CellularGeneration.CG_2G.value
+      }
+      TelephonyManager.NETWORK_TYPE_UMTS,
+      TelephonyManager.NETWORK_TYPE_EVDO_0,
+      TelephonyManager.NETWORK_TYPE_EVDO_A,
+      TelephonyManager.NETWORK_TYPE_HSDPA,
+      TelephonyManager.NETWORK_TYPE_HSUPA,
+      TelephonyManager.NETWORK_TYPE_HSPA,
+      TelephonyManager.NETWORK_TYPE_EVDO_B,
+      TelephonyManager.NETWORK_TYPE_EHRPD,
+      TelephonyManager.NETWORK_TYPE_HSPAP -> {
+        CellularGeneration.CG_3G.value
+      }
+      TelephonyManager.NETWORK_TYPE_LTE -> {
+        CellularGeneration.CG_4G.value
+      }
+      else -> {
+        CellularGeneration.UNKNOWN.value
+      }
+    }
+  }
+}

package/app.plugin.js

@@ -0,0 +1 @@
+module.exports = require('./plugin/build/withCellular');

package/build/Cellular.d.ts

@@ -1,8 +1,198 @@
 import { CellularGeneration } from './Cellular.types';
 export { CellularGeneration };
-export declare const allowsVoip: any;
-export declare const carrier: any;
-export declare const isoCountryCode: any;
-export declare const mobileCountryCode: any;
-export declare const mobileNetworkCode: any;
+/**
+ * Indicates if the carrier allows making VoIP calls on its network. On Android, this checks whether
+ * the system supports SIP-based VoIP API. See [here](https://developer.android.com/reference/android/net/sip/SipManager.html#isVoipSupported(android.content.Context))
+ * to view more information.
+ *
+ * On iOS, if you configure a device for a carrier and then remove the SIM card, this property
+ * retains the `boolean` value indicating the carrier’s policy regarding VoIP. If you then install
+ * a new SIM card, its VoIP policy `boolean` replaces the previous value of this property.
+ *
+ * On web, this returns `null`.
+ *
+ * @example
+ * ```ts
+ * Cellular.allowsVoip; // true or false
+ * ```
+ * @deprecated Deprecated field, use [`allowsVoipAsync()`](#allowsvoipasync) instead.
+ *
+ */
+export declare const allowsVoip: boolean | null;
+/**
+ * The name of the user’s home cellular service provider. If the device has dual SIM cards, only the
+ * carrier for the currently active SIM card will be returned. On Android, this value is only
+ * available when the SIM state is [`SIM_STATE_READY`](https://developer.android.com/reference/android/telephony/TelephonyManager.html#SIM_STATE_READY).
+ * Otherwise, this returns `null`.
+ *
+ * On iOS, if you configure a device for a carrier and then remove the SIM card, this property
+ * retains the name of the carrier. If you then install a new SIM card, its carrier name replaces
+ * the previous value of this property. The value for this property is `null` if the user never
+ * configured a carrier for the device.
+ *
+ * On web, this returns `null`.
+ *
+ * @example
+ * ```ts
+ * Cellular.carrier; // "T-Mobile" or "Verizon"
+ * ```
+ * @deprecated Deprecated field, use [`getCarrierNameAsync()`](#getcarriernameasync) instead.
+ *
+ */
+export declare const carrier: string | null;
+/**
+ * The ISO country code for the user’s cellular service provider. On iOS, the value is `null` if any
+ * of the following apply:
+ * - The device is in airplane mode.
+ * - There is no SIM card in the device.
+ * - The device is outside of cellular service range.
+ *
+ * On web, this returns `null`.
+ *
+ * @example
+ * ```ts
+ * Cellular.isoCountryCode; // "us" or "au"
+ * ```
+ * @deprecated Deprecated field, use [`getIsoCountryCodeAsync()`](#getisocountrycodeAsync) instead.
+ *
+ */
+export declare const isoCountryCode: string | null;
+/**
+ * The mobile country code (MCC) for the user’s current registered cellular service provider.
+ * On Android, this value is only available when SIM state is [`SIM_STATE_READY`](https://developer.android.com/reference/android/telephony/TelephonyManager.html#SIM_STATE_READY). Otherwise, this
+ * returns `null`. On iOS, the value may be null on hardware prior to iPhone 4S when in airplane mode.
+ * Furthermore, the value for this property is `null` if any of the following apply:
+ * - There is no SIM card in the device.
+ * - The device is outside of cellular service range.
+ *
+ * On web, this returns `null`.
+ *
+ * @example
+ * ```ts
+ * Cellular.mobileCountryCode; // "310"
+ * ```
+ * @deprecated Deprecated field, use [`getMobileCountryCodeAsync()`](#getmobilecountrycodeasync) instead.
+ *
+ */
+export declare const mobileCountryCode: string | null;
+/**
+ * The ISO country code for the user’s cellular service provider. On iOS, the value is `null` if
+ * any of the following apply:
+ * - The device is in airplane mode.
+ * - There is no SIM card in the device.
+ * - The device is outside of cellular service range.
+ *
+ * On web, this returns `null`.
+ *
+ * @example
+ * ```ts
+ * Cellular.mobileNetworkCode; // "260"
+ * ```
+ * @deprecated Deprecated field, use [`getMobileNetworkCodeAsync()`](#getmobilenetworkcodeasync) instead.
+ *
+ */
+export declare const mobileNetworkCode: string | null;
+/**
+ * @return Returns a promise which fulfils with a [`Cellular.CellularGeneration`](#cellulargeneration)
+ * enum value that represents the current cellular-generation type.
+ *
+ * On web, this method uses [`navigator.connection.effectiveType`](https://developer.mozilla.org/en-US/docs/Web/API/NetworkInformation/effectiveType)
+ * to detect the effective type of the connection using a combination of recently observed
+ * round-trip time and downlink values. See [here](https://developer.mozilla.org/en-US/docs/Web/API/Network_Information_API)
+ * to view browser compatibility.
+ *
+ * @example
+ * ```ts
+ * await Cellular.getCellularGenerationAsync();
+ * // CellularGeneration.CELLULAR_4G
+ * ```
+ */
 export declare function getCellularGenerationAsync(): Promise<CellularGeneration>;
+/**
+ * @return Returns if the carrier allows making VoIP calls on its network. On Android, this checks whether
+ * the system supports SIP-based VoIP API. See [here](https://developer.android.com/reference/android/net/sip/SipManager.html#isVoipSupported(android.content.Context))
+ * to view more information.
+ *
+ * On iOS, if you configure a device for a carrier and then remove the SIM card, this property
+ * retains the `boolean` value indicating the carrier’s policy regarding VoIP. If you then install
+ * a new SIM card, its VoIP policy `boolean` replaces the previous value of this property.
+ *
+ * On web, this returns `null`.
+ *
+ * @example
+ * ```ts
+ * await Cellular.allowsVoipAsync(); // true or false
+ * ```
+ */
+export declare function allowsVoipAsync(): Promise<boolean | null>;
+/**
+ * @return Returns the ISO country code for the user’s cellular service provider.
+ *
+ * On iOS, the value is `null` if any of the following apply:
+ * - The device is in airplane mode.
+ * - There is no SIM card in the device.
+ * - The device is outside of cellular service range.
+ *
+ * On web, this returns `null`.
+ *
+ * @example
+ * ```ts
+ * await Cellular.getIsoCountryCodeAsync(); // "us" or "au"
+ * ```
+ *
+ */
+export declare function getIsoCountryCodeAsync(): Promise<string | null>;
+/**
+ * @return Returns name of the user’s home cellular service provider. If the device has dual SIM cards, only the
+ * carrier for the currently active SIM card will be returned.
+ *
+ * On Android, this value is only available when the SIM state is [`SIM_STATE_READY`](https://developer.android.com/reference/android/telephony/TelephonyManager.html#SIM_STATE_READY).
+ * Otherwise, this returns `null`.
+ *
+ * On iOS, if you configure a device for a carrier and then remove the SIM card, this property
+ * retains the name of the carrier. If you then install a new SIM card, its carrier name replaces
+ * the previous value of this property. The value for this property is `null` if the user never
+ * configured a carrier for the device.
+ *
+ * On web, this returns `null`.
+ *
+ * @example
+ * ```ts
+ * await Cellular.getCarrierNameAsync(); // "T-Mobile" or "Verizon"
+ * ```
+ */
+export declare function getCarrierNameAsync(): Promise<string | null>;
+/**
+ * @return Returns mobile country code (MCC) for the user’s current registered cellular service provider.
+ *
+ * On Android, this value is only available when SIM state is [`SIM_STATE_READY`](https://developer.android.com/reference/android/telephony/TelephonyManager.html#SIM_STATE_READY). Otherwise, this
+ * returns `null`. On iOS, the value may be null on hardware prior to iPhone 4S when in airplane mode.
+ * Furthermore, the value for this property is `null` if any of the following apply:
+ * - There is no SIM card in the device.
+ * - The device is outside of cellular service range.
+ *
+ * On web, this returns `null`.
+ *
+ * @example
+ * ```ts
+ * await Cellular.getMobileCountryCodeAsync(); // "310"
+ * ```
+ */
+export declare function getMobileCountryCodeAsync(): Promise<string | null>;
+/**
+ * @return Returns the mobile network code (MNC) for the user’s current registered cellular service provider.
+ *
+ * On Android, this value is only available when SIM state is [`SIM_STATE_READY`](https://developer.android.com/reference/android/telephony/TelephonyManager.html#SIM_STATE_READY). Otherwise, this
+ * returns `null`. On iOS, the value may be null on hardware prior to iPhone 4S when in airplane mode.
+ * Furthermore, the value for this property is `null` if any of the following apply:
+ * - There is no SIM card in the device.
+ * - The device is outside of cellular service range.
+ *
+ * On web, this returns `null`.
+ *
+ * @example
+ * ```ts
+ * await Cellular.getMobileNetworkCodeAsync(); // "310"
+ * ```
+ */
+export declare function getMobileNetworkCodeAsync(): Promise<string | null>;