@capgo/capacitor-sim 7.0.8 → 7.1.0

package/README.md

@@ -123,6 +123,10 @@ A SIM card description.
 | **`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 |
 
+| Method               | Signature                                    | Description                             |
+| -------------------- | -------------------------------------------- | --------------------------------------- |
+| **getPluginVersion** | () =&gt; Promise&lt;{ version: string; }&gt; | Get the native Capacitor plugin version |
+
 
 #### PermissionStatus
 

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

@@ -28,6 +28,8 @@ import java.util.List;
 )
 public class SimPlugin extends Plugin {
 
+    private final String PLUGIN_VERSION = "7.1.0";
+
     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.";
@@ -121,4 +123,15 @@ public class SimPlugin extends Plugin {
 
         return results;
     }
+
+    @PluginMethod
+    public void getPluginVersion(final PluginCall call) {
+        try {
+            final JSObject ret = new JSObject();
+            ret.put("version", this.PLUGIN_VERSION);
+            call.resolve(ret);
+        } catch (final Exception e) {
+            call.reject("Could not get plugin version", e);
+        }
+    }
 }

package/dist/docs.json

@@ -93,7 +93,27 @@
           "name": "since"
         }
       ],
-      "methods": [],
+      "methods": [
+        {
+          "name": "getPluginVersion",
+          "signature": "() => Promise<{ version: string; }>",
+          "parameters": [],
+          "returns": "Promise<{ version: string; }>",
+          "tags": [
+            {
+              "name": "returns",
+              "text": "an Promise with version for this device"
+            },
+            {
+              "name": "throws",
+              "text": "An error if the something went wrong"
+            }
+          ],
+          "docs": "Get the native Capacitor plugin version",
+          "complexTypes": [],
+          "slug": "getpluginversion"
+        }
+      ],
       "properties": [
         {
           "name": "number",

package/dist/esm/definitions.d.ts

@@ -105,4 +105,13 @@ export interface SimCard {
      * @since 1.0.0
      */
     mobileNetworkCode: string;
+    /**
+     * Get the native Capacitor plugin version
+     *
+     * @returns {Promise<{ id: string }>} an Promise with version for this device
+     * @throws An error if the something went wrong
+     */
+    getPluginVersion(): Promise<{
+        version: string;
+    }>;
 }

package/dist/esm/definitions.js.map

@@ -1 +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"]}
+{"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  /**\n   * Get the native Capacitor plugin version\n   *\n   * @returns {Promise<{ id: string }>} an Promise with version for this device\n   * @throws An error if the something went wrong\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\n"]}

package/dist/esm/web.d.ts

@@ -4,4 +4,7 @@ export declare class SimWeb extends WebPlugin implements SimPlugin {
     getSimCards(): Promise<GetSimCardsResult>;
     checkPermissions(): Promise<PermissionStatus>;
     requestPermissions(): Promise<PermissionStatus>;
+    getPluginVersion(): Promise<{
+        version: string;
+    }>;
 }

package/dist/esm/web.js

@@ -9,5 +9,8 @@ export class SimWeb extends WebPlugin {
     async requestPermissions() {
         return this.checkPermissions();
     }
+    async getPluginVersion() {
+        return { version: 'web' };
+    }
 }
 //# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -1 +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"]}
+{"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;IAED,KAAK,CAAC,gBAAgB;QACpB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC5B,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  async getPluginVersion(): Promise<{ version: string }> {\n    return { version: 'web' };\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -16,6 +16,9 @@ class SimWeb extends core.WebPlugin {
     async requestPermissions() {
         return this.checkPermissions();
     }
+    async getPluginVersion() {
+        return { version: 'web' };
+    }
 }
 
 var web = /*#__PURE__*/Object.freeze({

package/dist/plugin.cjs.js.map

@@ -1 +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;;;;;;;;;"}
+{"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    async getPluginVersion() {\n        return { version: 'web' };\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,IAAI,MAAM,gBAAgB,GAAG;AAC7B,QAAQ,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE;AACjC,IAAI;AACJ;;;;;;;;;"}

package/dist/plugin.js

@@ -15,6 +15,9 @@ var capacitorSim = (function (exports, core) {
         async requestPermissions() {
             return this.checkPermissions();
         }
+        async getPluginVersion() {
+            return { version: 'web' };
+        }
     }
 
     var web = /*#__PURE__*/Object.freeze({

package/dist/plugin.js.map

@@ -1 +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;;;;;;;;;;;;;;;"}
+{"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    async getPluginVersion() {\n        return { version: 'web' };\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,IAAI,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE;IACjC,IAAI;IACJ;;;;;;;;;;;;;;;"}

package/ios/Sources/SimPlugin/SimPlugin.swift

@@ -4,12 +4,14 @@ import Foundation
 
 @objc(SimPlugin)
 public class SimPlugin: CAPPlugin, CAPBridgedPlugin {
+    private let PLUGIN_VERSION: String = "7.1.0"
     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)
+        CAPPluginMethod(name: "requestPermissions", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getPluginVersion", returnType: CAPPluginReturnPromise)
     ]
 
     @objc func getSimCards(_ call: CAPPluginCall) {
@@ -50,4 +52,9 @@ public class SimPlugin: CAPPlugin, CAPBridgedPlugin {
             "mobileNetworkCode": carrier.mobileNetworkCode ?? ""
         ]
     }
+
+    @objc func getPluginVersion(_ call: CAPPluginCall) {
+        call.resolve(["version": self.PLUGIN_VERSION])
+    }
+
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-sim",
-  "version": "7.0.8",
+  "version": "7.1.0",
   "description": "Capacitor plugin to get information from device's sim cards",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",