@capgo/capacitor-sim 7.0.0

package/CapgoCapacitorSim.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapgoCapacitorSim'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '14.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+
+let package = Package(
+    name: "CapgoCapacitorSim",
+    platforms: [.iOS(.v14)],
+    products: [
+        .library(
+            name: "CapgoCapacitorSim",
+            targets: ["SimPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0")
+    ],
+    targets: [
+        .target(
+            name: "SimPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/SimPlugin"),
+        .testTarget(
+            name: "SimPluginTests",
+            dependencies: ["SimPlugin"],
+            path: "ios/Tests/SimPluginTests")
+    ]
+)

package/README.md

@@ -0,0 +1,143 @@
+# @capgo/capacitor-sim
+ <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
+
+<div align="center">
+  <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo</a></h2>
+  <h2><a href="https://capgo.app/consulting/?ref=plugin"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
+</div>
+Capacitor plugin to get information from device's sim cards
+
+## Install
+
+```bash
+npm install @capgo/capacitor-sim
+npx cap sync
+```
+
+## Usage
+
+```ts
+import { Sim } from '@capgo/capacitor-sim';
+
+const loadSimCards = async () => {
+  const { simCards } = await Sim.getSimCards();
+
+  return simCards;
+};
+```
+
+The returned `simCards` array contains carrier information for each detected SIM. On Android the list also exposes the `subscriptionId` and `simSlotIndex` values so you can correlate entries across platform APIs.
+
+### iOS 16.4+ limitations
+
+Starting with iOS 16.4 Apple restricts access to several carrier fields returned by CoreTelephony. On devices running iOS 16.4 or newer the plugin may return placeholder values such as `65535`, `--`, or empty strings for `carrierName`, `isoCountryCode`, `mobileCountryCode`, and `mobileNetworkCode`. This behaviour is handled at the OS level and is tracked upstream in [jonz94/capacitor-sim#8](https://github.com/jonz94/capacitor-sim/issues/8); there is currently no known workaround besides relying on Android data or older iOS versions.
+
+## API
+
+<docgen-index>
+
+* [`getSimCards()`](#getsimcards)
+* [`checkPermissions()`](#checkpermissions)
+* [`requestPermissions()`](#requestpermissions)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### getSimCards()
+
+```typescript
+getSimCards() => Promise<GetSimCardsResult>
+```
+
+Get information from the device's SIM cards.
+
+**Returns:** <code>Promise&lt;<a href="#getsimcardsresult">GetSimCardsResult</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### checkPermissions()
+
+```typescript
+checkPermissions() => Promise<PermissionStatus>
+```
+
+Check permission to access SIM card information.
+
+On iOS and Web the status is always granted or denied respectively without prompting.
+
+**Returns:** <code>Promise&lt;<a href="#permissionstatus">PermissionStatus</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### requestPermissions()
+
+```typescript
+requestPermissions() => Promise<PermissionStatus>
+```
+
+Request permission to access SIM card information.
+
+On iOS the status is always granted. On Web the status remains denied.
+
+**Returns:** <code>Promise&lt;<a href="#permissionstatus">PermissionStatus</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### GetSimCardsResult
+
+Result returned by {@link SimPlugin.getSimCards}.
+
+| Prop           | Type                   |
+| -------------- | ---------------------- |
+| **`simCards`** | <code>SimCard[]</code> |
+
+
+#### SimCard
+
+A SIM card description.
+
+| Prop                    | Type                 | Description                                                                                                                                                                                 | Since |
+| ----------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`number`**            | <code>string</code>  | Android only: Phone number for this SIM slot, when available.                                                                                                                               | 1.0.0 |
+| **`subscriptionId`**    | <code>string</code>  | Android only: Unique subscription identifier.                                                                                                                                               | 1.1.0 |
+| **`simSlotIndex`**      | <code>number</code>  | Android only: Physical SIM slot index for this subscription.                                                                                                                                | 1.1.0 |
+| **`allowsVOIP`**        | <code>boolean</code> | iOS only: Indicates whether the carrier supports VoIP.                                                                                                                                      | 1.0.0 |
+| **`carrierName`**       | <code>string</code>  | Display name of the cellular service provider. On iOS 16.4+ the system may return placeholder values such as `--`. See https://github.com/jonz94/capacitor-sim/issues/8 for details.        | 1.0.0 |
+| **`isoCountryCode`**    | <code>string</code>  | ISO 3166-1 alpha-2 country code of the service provider. On iOS 16.4+ the system may return an empty string or `--`. See https://github.com/jonz94/capacitor-sim/issues/8 for details.      | 1.0.0 |
+| **`mobileCountryCode`** | <code>string</code>  | Mobile Country Code (MCC) of the service provider. On iOS 16.4+ the system may return placeholder values such as `65535`. See https://github.com/jonz94/capacitor-sim/issues/8 for details. | 1.0.0 |
+| **`mobileNetworkCode`** | <code>string</code>  | Mobile Network Code (MNC) of the service provider. On iOS 16.4+ the system may return placeholder values such as `65535`. See https://github.com/jonz94/capacitor-sim/issues/8 for details. | 1.0.0 |
+
+
+#### PermissionStatus
+
+Result of a permission check or request.
+
+| Prop              | Type                                                        |
+| ----------------- | ----------------------------------------------------------- |
+| **`readSimCard`** | <code><a href="#permissionstate">PermissionState</a></code> |
+
+
+### Type Aliases
+
+
+#### PermissionState
+
+<code>'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'</code>
+
+</docgen-api>

package/android/build.gradle

@@ -0,0 +1,57 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.7.2'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "app.capgo.plugin.sim"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="android.permission.READ_PHONE_STATE" />
+    <uses-permission android:name="android.permission.READ_PHONE_NUMBERS" />
+</manifest>

package/android/src/main/java/app/capgo/plugin/sim/SimPlugin.java

@@ -0,0 +1,124 @@
+package app.capgo.plugin.sim;
+
+import android.Manifest;
+import android.annotation.SuppressLint;
+import android.content.Context;
+import android.os.Build;
+import android.telephony.SubscriptionInfo;
+import android.telephony.SubscriptionManager;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Logger;
+import com.getcapacitor.PermissionState;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import com.getcapacitor.annotation.Permission;
+import com.getcapacitor.annotation.PermissionCallback;
+import java.util.List;
+
+@SuppressLint("InlinedApi")
+@CapacitorPlugin(
+    name = "Sim",
+    permissions = {
+        @Permission(strings = { Manifest.permission.READ_PHONE_STATE }, alias = SimPlugin.READ_PHONE_STATE),
+        @Permission(strings = { Manifest.permission.READ_PHONE_NUMBERS }, alias = SimPlugin.READ_PHONE_NUMBERS)
+    }
+)
+public class SimPlugin extends Plugin {
+
+    static final String READ_PHONE_STATE = "readPhoneState";
+    static final String READ_PHONE_NUMBERS = "readPhoneNumbers";
+    private static final String PERMISSION_DENIED_ERROR = "Unable to get information from SIM cards, user denied permission request.";
+
+    @PluginMethod
+    public void getSimCards(PluginCall call) {
+        if (!isPermissionGranted()) {
+            requestPhonePermissions(call);
+            return;
+        }
+
+        SubscriptionManager subscriptionManager = (SubscriptionManager) getContext().getSystemService(
+            Context.TELEPHONY_SUBSCRIPTION_SERVICE
+        );
+
+        JSArray carrierInfoCollection = subscriptionManager != null ? collectSubscriptionInfo(subscriptionManager) : new JSArray();
+
+        JSObject result = new JSObject();
+        result.put("simCards", carrierInfoCollection);
+
+        call.resolve(result);
+    }
+
+    @PermissionCallback
+    private void permissionCallback(PluginCall call) {
+        if (!isPermissionGranted()) {
+            Logger.debug(getLogTag(), "User denied SIM read permissions request.");
+            call.reject(PERMISSION_DENIED_ERROR);
+            return;
+        }
+
+        if ("getSimCards".equals(call.getMethodName())) {
+            getSimCards(call);
+        }
+    }
+
+    private void requestPhonePermissions(PluginCall call) {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
+            requestPermissionForAliases(new String[] { READ_PHONE_NUMBERS, READ_PHONE_STATE }, call, "permissionCallback");
+        } else {
+            requestPermissionForAlias(READ_PHONE_STATE, call, "permissionCallback");
+        }
+    }
+
+    private boolean isPermissionGranted() {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
+            return (
+                getPermissionState(READ_PHONE_NUMBERS) == PermissionState.GRANTED &&
+                getPermissionState(READ_PHONE_STATE) == PermissionState.GRANTED
+            );
+        }
+
+        return getPermissionState(READ_PHONE_STATE) == PermissionState.GRANTED;
+    }
+
+    @SuppressLint("MissingPermission")
+    private JSArray collectSubscriptionInfo(SubscriptionManager subscriptionManager) {
+        JSArray results = new JSArray();
+        List<SubscriptionInfo> subscriptionInfoList = subscriptionManager.getActiveSubscriptionInfoList();
+
+        if (subscriptionInfoList == null) {
+            return results;
+        }
+
+        for (SubscriptionInfo subscriptionInfo : subscriptionInfoList) {
+            JSObject carrierInfo = new JSObject();
+
+            String number = null;
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+                number = subscriptionManager.getPhoneNumber(subscriptionInfo.getSubscriptionId());
+            } else {
+                number = subscriptionInfo.getNumber();
+            }
+
+            carrierInfo.put("number", number);
+            carrierInfo.put("subscriptionId", Integer.toString(subscriptionInfo.getSubscriptionId()));
+            carrierInfo.put("simSlotIndex", subscriptionInfo.getSimSlotIndex());
+            carrierInfo.put("carrierName", subscriptionInfo.getCarrierName());
+            carrierInfo.put("isoCountryCode", subscriptionInfo.getCountryIso());
+
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+                carrierInfo.put("mobileCountryCode", subscriptionInfo.getMccString());
+                carrierInfo.put("mobileNetworkCode", subscriptionInfo.getMncString());
+            } else {
+                carrierInfo.put("mobileCountryCode", Integer.toString(subscriptionInfo.getMcc()));
+                carrierInfo.put("mobileNetworkCode", Integer.toString(subscriptionInfo.getMnc()));
+            }
+
+            results.put(carrierInfo);
+        }
+
+        return results;
+    }
+}

package/dist/docs.json

@@ -0,0 +1,247 @@
+{
+  "api": {
+    "name": "SimPlugin",
+    "slug": "simplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "getSimCards",
+        "signature": "() => Promise<GetSimCardsResult>",
+        "parameters": [],
+        "returns": "Promise<GetSimCardsResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Get information from the device's SIM cards.",
+        "complexTypes": [
+          "GetSimCardsResult"
+        ],
+        "slug": "getsimcards"
+      },
+      {
+        "name": "checkPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Check permission to access SIM card information.\n\nOn iOS and Web the status is always granted or denied respectively without prompting.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "checkpermissions"
+      },
+      {
+        "name": "requestPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Request permission to access SIM card information.\n\nOn iOS the status is always granted. On Web the status remains denied.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "requestpermissions"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "GetSimCardsResult",
+      "slug": "getsimcardsresult",
+      "docs": "Result returned by {@link SimPlugin.getSimCards}.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "simCards",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "SimCard"
+          ],
+          "type": "SimCard[]"
+        }
+      ]
+    },
+    {
+      "name": "SimCard",
+      "slug": "simcard",
+      "docs": "A SIM card description.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "number",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Android only: Phone number for this SIM slot, when available.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "subscriptionId",
+          "tags": [
+            {
+              "text": "1.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Android only: Unique subscription identifier.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "simSlotIndex",
+          "tags": [
+            {
+              "text": "1.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Android only: Physical SIM slot index for this subscription.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "allowsVOIP",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "iOS only: Indicates whether the carrier supports VoIP.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "carrierName",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Display name of the cellular service provider.\n\nOn iOS 16.4+ the system may return placeholder values such as `--`.\nSee https://github.com/jonz94/capacitor-sim/issues/8 for details.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "isoCountryCode",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "ISO 3166-1 alpha-2 country code of the service provider.\n\nOn iOS 16.4+ the system may return an empty string or `--`.\nSee https://github.com/jonz94/capacitor-sim/issues/8 for details.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "mobileCountryCode",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Mobile Country Code (MCC) of the service provider.\n\nOn iOS 16.4+ the system may return placeholder values such as `65535`.\nSee https://github.com/jonz94/capacitor-sim/issues/8 for details.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "mobileNetworkCode",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Mobile Network Code (MNC) of the service provider.\n\nOn iOS 16.4+ the system may return placeholder values such as `65535`.\nSee https://github.com/jonz94/capacitor-sim/issues/8 for details.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PermissionStatus",
+      "slug": "permissionstatus",
+      "docs": "Result of a permission check or request.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "readSimCard",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "PermissionState",
+      "slug": "permissionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "'prompt'",
+          "complexTypes": []
+        },
+        {
+          "text": "'prompt-with-rationale'",
+          "complexTypes": []
+        },
+        {
+          "text": "'granted'",
+          "complexTypes": []
+        },
+        {
+          "text": "'denied'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,108 @@
+import type { PermissionState } from '@capacitor/core';
+/**
+ * Result of a permission check or request.
+ *
+ * @since 1.0.0
+ */
+export interface PermissionStatus {
+    readSimCard: PermissionState;
+}
+export interface SimPlugin {
+    /**
+     * Get information from the device's SIM cards.
+     *
+     * @since 1.0.0
+     */
+    getSimCards(): Promise<GetSimCardsResult>;
+    /**
+     * Check permission to access SIM card information.
+     *
+     * On iOS and Web the status is always granted or denied respectively without prompting.
+     *
+     * @since 1.0.0
+     */
+    checkPermissions(): Promise<PermissionStatus>;
+    /**
+     * Request permission to access SIM card information.
+     *
+     * On iOS the status is always granted. On Web the status remains denied.
+     *
+     * @since 1.0.0
+     */
+    requestPermissions(): Promise<PermissionStatus>;
+}
+/**
+ * Result returned by {@link SimPlugin.getSimCards}.
+ *
+ * @since 1.0.0
+ */
+export interface GetSimCardsResult {
+    simCards: SimCard[];
+}
+/**
+ * A SIM card description.
+ *
+ * @since 1.0.0
+ */
+export interface SimCard {
+    /**
+     * Android only: Phone number for this SIM slot, when available.
+     *
+     * @since 1.0.0
+     */
+    number?: string;
+    /**
+     * Android only: Unique subscription identifier.
+     *
+     * @since 1.1.0
+     */
+    subscriptionId?: string;
+    /**
+     * Android only: Physical SIM slot index for this subscription.
+     *
+     * @since 1.1.0
+     */
+    simSlotIndex?: number;
+    /**
+     * iOS only: Indicates whether the carrier supports VoIP.
+     *
+     * @since 1.0.0
+     */
+    allowsVOIP?: boolean;
+    /**
+     * Display name of the cellular service provider.
+     *
+     * On iOS 16.4+ the system may return placeholder values such as `--`.
+     * See https://github.com/jonz94/capacitor-sim/issues/8 for details.
+     *
+     * @since 1.0.0
+     */
+    carrierName: string;
+    /**
+     * ISO 3166-1 alpha-2 country code of the service provider.
+     *
+     * On iOS 16.4+ the system may return an empty string or `--`.
+     * See https://github.com/jonz94/capacitor-sim/issues/8 for details.
+     *
+     * @since 1.0.0
+     */
+    isoCountryCode: string;
+    /**
+     * Mobile Country Code (MCC) of the service provider.
+     *
+     * On iOS 16.4+ the system may return placeholder values such as `65535`.
+     * See https://github.com/jonz94/capacitor-sim/issues/8 for details.
+     *
+     * @since 1.0.0
+     */
+    mobileCountryCode: string;
+    /**
+     * Mobile Network Code (MNC) of the service provider.
+     *
+     * On iOS 16.4+ the system may return placeholder values such as `65535`.
+     * See https://github.com/jonz94/capacitor-sim/issues/8 for details.
+     *
+     * @since 1.0.0
+     */
+    mobileNetworkCode: string;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState } from '@capacitor/core';\n\n/**\n * Result of a permission check or request.\n *\n * @since 1.0.0\n */\nexport interface PermissionStatus {\n  readSimCard: PermissionState;\n}\n\nexport interface SimPlugin {\n  /**\n   * Get information from the device's SIM cards.\n   *\n   * @since 1.0.0\n   */\n  getSimCards(): Promise<GetSimCardsResult>;\n\n  /**\n   * Check permission to access SIM card information.\n   *\n   * On iOS and Web the status is always granted or denied respectively without prompting.\n   *\n   * @since 1.0.0\n   */\n  checkPermissions(): Promise<PermissionStatus>;\n\n  /**\n   * Request permission to access SIM card information.\n   *\n   * On iOS the status is always granted. On Web the status remains denied.\n   *\n   * @since 1.0.0\n   */\n  requestPermissions(): Promise<PermissionStatus>;\n}\n\n/**\n * Result returned by {@link SimPlugin.getSimCards}.\n *\n * @since 1.0.0\n */\nexport interface GetSimCardsResult {\n  simCards: SimCard[];\n}\n\n/**\n * A SIM card description.\n *\n * @since 1.0.0\n */\nexport interface SimCard {\n  /**\n   * Android only: Phone number for this SIM slot, when available.\n   *\n   * @since 1.0.0\n   */\n  number?: string;\n\n  /**\n   * Android only: Unique subscription identifier.\n   *\n   * @since 1.1.0\n   */\n  subscriptionId?: string;\n\n  /**\n   * Android only: Physical SIM slot index for this subscription.\n   *\n   * @since 1.1.0\n   */\n  simSlotIndex?: number;\n\n  /**\n   * iOS only: Indicates whether the carrier supports VoIP.\n   *\n   * @since 1.0.0\n   */\n  allowsVOIP?: boolean;\n\n  /**\n   * Display name of the cellular service provider.\n   *\n   * On iOS 16.4+ the system may return placeholder values such as `--`.\n   * See https://github.com/jonz94/capacitor-sim/issues/8 for details.\n   *\n   * @since 1.0.0\n   */\n  carrierName: string;\n\n  /**\n   * ISO 3166-1 alpha-2 country code of the service provider.\n   *\n   * On iOS 16.4+ the system may return an empty string or `--`.\n   * See https://github.com/jonz94/capacitor-sim/issues/8 for details.\n   *\n   * @since 1.0.0\n   */\n  isoCountryCode: string;\n\n  /**\n   * Mobile Country Code (MCC) of the service provider.\n   *\n   * On iOS 16.4+ the system may return placeholder values such as `65535`.\n   * See https://github.com/jonz94/capacitor-sim/issues/8 for details.\n   *\n   * @since 1.0.0\n   */\n  mobileCountryCode: string;\n\n  /**\n   * Mobile Network Code (MNC) of the service provider.\n   *\n   * On iOS 16.4+ the system may return placeholder values such as `65535`.\n   * See https://github.com/jonz94/capacitor-sim/issues/8 for details.\n   *\n   * @since 1.0.0\n   */\n  mobileNetworkCode: string;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { SimPlugin } from './definitions';
+declare const Sim: SimPlugin;
+export * from './definitions';
+export { Sim };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const Sim = registerPlugin('Sim', {
+    web: () => import('./web').then((m) => new m.SimWeb()),
+});
+export * from './definitions';
+export { Sim };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,GAAG,GAAG,cAAc,CAAY,KAAK,EAAE;IAC3C,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;CACvD,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,GAAG,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { SimPlugin } from './definitions';\n\nconst Sim = registerPlugin<SimPlugin>('Sim', {\n  web: () => import('./web').then((m) => new m.SimWeb()),\n});\n\nexport * from './definitions';\nexport { Sim };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,7 @@
+import { WebPlugin } from '@capacitor/core';
+import type { GetSimCardsResult, PermissionStatus, SimPlugin } from './definitions';
+export declare class SimWeb extends WebPlugin implements SimPlugin {
+    getSimCards(): Promise<GetSimCardsResult>;
+    checkPermissions(): Promise<PermissionStatus>;
+    requestPermissions(): Promise<PermissionStatus>;
+}

package/dist/esm/web.js

@@ -0,0 +1,13 @@
+import { WebPlugin } from '@capacitor/core';
+export class SimWeb extends WebPlugin {
+    async getSimCards() {
+        throw this.unimplemented('Sim.getSimCards is not implemented on web.');
+    }
+    async checkPermissions() {
+        return { readSimCard: 'denied' };
+    }
+    async requestPermissions() {
+        return this.checkPermissions();
+    }
+}
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC,KAAK,CAAC,WAAW;QACf,MAAM,IAAI,CAAC,aAAa,CAAC,4CAA4C,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC;IACjC,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { GetSimCardsResult, PermissionStatus, SimPlugin } from './definitions';\n\nexport class SimWeb extends WebPlugin implements SimPlugin {\n  async getSimCards(): Promise<GetSimCardsResult> {\n    throw this.unimplemented('Sim.getSimCards is not implemented on web.');\n  }\n\n  async checkPermissions(): Promise<PermissionStatus> {\n    return { readSimCard: 'denied' };\n  }\n\n  async requestPermissions(): Promise<PermissionStatus> {\n    return this.checkPermissions();\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,27 @@
+'use strict';
+
+var core = require('@capacitor/core');
+
+const Sim = core.registerPlugin('Sim', {
+    web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.SimWeb()),
+});
+
+class SimWeb extends core.WebPlugin {
+    async getSimCards() {
+        throw this.unimplemented('Sim.getSimCards is not implemented on web.');
+    }
+    async checkPermissions() {
+        return { readSimCard: 'denied' };
+    }
+    async requestPermissions() {
+        return this.checkPermissions();
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    SimWeb: SimWeb
+});
+
+exports.Sim = Sim;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst Sim = registerPlugin('Sim', {\n    web: () => import('./web').then((m) => new m.SimWeb()),\n});\nexport * from './definitions';\nexport { Sim };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class SimWeb extends WebPlugin {\n    async getSimCards() {\n        throw this.unimplemented('Sim.getSimCards is not implemented on web.');\n    }\n    async checkPermissions() {\n        return { readSimCard: 'denied' };\n    }\n    async requestPermissions() {\n        return this.checkPermissions();\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,GAAG,GAAGA,mBAAc,CAAC,KAAK,EAAE;AAClC,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;AAC1D,CAAC;;ACFM,MAAM,MAAM,SAASC,cAAS,CAAC;AACtC,IAAI,MAAM,WAAW,GAAG;AACxB,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,4CAA4C,CAAC;AAC9E,IAAI;AACJ,IAAI,MAAM,gBAAgB,GAAG;AAC7B,QAAQ,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE;AACxC,IAAI;AACJ,IAAI,MAAM,kBAAkB,GAAG;AAC/B,QAAQ,OAAO,IAAI,CAAC,gBAAgB,EAAE;AACtC,IAAI;AACJ;;;;;;;;;"}

package/dist/plugin.js

@@ -0,0 +1,30 @@
+var capacitorSim = (function (exports, core) {
+    'use strict';
+
+    const Sim = core.registerPlugin('Sim', {
+        web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.SimWeb()),
+    });
+
+    class SimWeb extends core.WebPlugin {
+        async getSimCards() {
+            throw this.unimplemented('Sim.getSimCards is not implemented on web.');
+        }
+        async checkPermissions() {
+            return { readSimCard: 'denied' };
+        }
+        async requestPermissions() {
+            return this.checkPermissions();
+        }
+    }
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        SimWeb: SimWeb
+    });
+
+    exports.Sim = Sim;
+
+    return exports;
+
+})({}, capacitorExports);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst Sim = registerPlugin('Sim', {\n    web: () => import('./web').then((m) => new m.SimWeb()),\n});\nexport * from './definitions';\nexport { Sim };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class SimWeb extends WebPlugin {\n    async getSimCards() {\n        throw this.unimplemented('Sim.getSimCards is not implemented on web.');\n    }\n    async checkPermissions() {\n        return { readSimCard: 'denied' };\n    }\n    async requestPermissions() {\n        return this.checkPermissions();\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,GAAG,GAAGA,mBAAc,CAAC,KAAK,EAAE;IAClC,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;IAC1D,CAAC;;ICFM,MAAM,MAAM,SAASC,cAAS,CAAC;IACtC,IAAI,MAAM,WAAW,GAAG;IACxB,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,4CAA4C,CAAC;IAC9E,IAAI;IACJ,IAAI,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE;IACxC,IAAI;IACJ,IAAI,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,OAAO,IAAI,CAAC,gBAAgB,EAAE;IACtC,IAAI;IACJ;;;;;;;;;;;;;;;"}

package/ios/Sources/SimPlugin/SimPlugin.swift

@@ -0,0 +1,53 @@
+import Capacitor
+import CoreTelephony
+import Foundation
+
+@objc(SimPlugin)
+public class SimPlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "SimPlugin"
+    public let jsName = "Sim"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "getSimCards", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "checkPermissions", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "requestPermissions", returnType: CAPPluginReturnPromise)
+    ]
+
+    @objc func getSimCards(_ call: CAPPluginCall) {
+        let telephonyInfo = CTTelephonyNetworkInfo()
+        var result: [[String: Any]] = []
+
+        if let carriers = telephonyInfo.serviceSubscriberCellularProviders?.values, !carriers.isEmpty {
+            for carrier in carriers {
+                result.append(buildCarrierPayload(from: carrier))
+            }
+        } else if let carrier = telephonyInfo.subscriberCellularProvider {
+            result.append(buildCarrierPayload(from: carrier))
+        }
+
+        call.resolve([
+            "simCards": result
+        ])
+    }
+
+    @objc override public func checkPermissions(_ call: CAPPluginCall) {
+        call.resolve([
+            "readSimCard": "granted"
+        ])
+    }
+
+    @objc override public func requestPermissions(_ call: CAPPluginCall) {
+        call.resolve([
+            "readSimCard": "granted"
+        ])
+    }
+
+    private func buildCarrierPayload(from carrier: CTCarrier) -> [String: Any] {
+        return [
+            "allowsVOIP": carrier.allowsVOIP,
+            "carrierName": carrier.carrierName ?? "",
+            "isoCountryCode": carrier.isoCountryCode ?? "",
+            "mobileCountryCode": carrier.mobileCountryCode ?? "",
+            "mobileNetworkCode": carrier.mobileNetworkCode ?? ""
+        ]
+    }
+}

package/ios/Tests/SimPluginTests/SimPluginTests.swift

@@ -0,0 +1,8 @@
+import XCTest
+
+final class SimPluginTests: XCTestCase {
+    func testDummyPasses() {
+        // Placeholder test to keep the test target alive.
+        XCTAssertTrue(true)
+    }
+}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@capgo/capacitor-sim",
+  "version": "7.0.0",
+  "description": "Capacitor plugin to get information from device's sim cards",
+  "main": "dist/plugin.cjs.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "unpkg": "dist/plugin.js",
+  "files": [
+    "android/src/main/",
+    "android/build.gradle",
+    "dist/",
+    "ios/Sources",
+    "ios/Tests",
+    "Package.swift",
+    "CapgoCapacitorSim.podspec"
+  ],
+  "author": "Martin Donadieu <martin@capgo.app>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Cap-go/capacitor-sim.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Cap-go/capacitor-sim/issues"
+  },
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "xcodebuild -scheme CapgoCapacitorSim -destination generic/platform=iOS",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
+    "eslint": "eslint . --ext ts",
+    "prettier": "prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api SimPlugin --output-readme README.md --output-json dist/docs.json",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@capacitor/android": "^7.0.0",
+    "@capacitor/core": "^7.0.0",
+    "@capacitor/docgen": "^0.3.0",
+    "@capacitor/ios": "^7.0.0",
+    "@ionic/eslint-config": "^0.4.0",
+    "@ionic/prettier-config": "^4.0.0",
+    "@ionic/swiftlint-config": "^2.0.0",
+    "eslint": "^8.57.0",
+    "prettier": "^3.4.2",
+    "prettier-plugin-java": "^2.6.6",
+    "rimraf": "^6.0.1",
+    "rollup": "^4.30.1",
+    "swiftlint": "^2.0.0",
+    "typescript": "~4.1.5"
+  },
+  "peerDependencies": {
+    "@capacitor/core": ">=7.0.0"
+  },
+  "prettier": "@ionic/prettier-config",
+  "swiftlint": "@ionic/swiftlint-config",
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  }
+}