sms-read-plugin-android 0.0.1

package/Package.swift

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

package/README.md

@@ -0,0 +1,173 @@
+# sms-read-plugin-android
+
+A plugin used to read sms for android apps
+
+## Install
+
+To use npm
+
+```bash
+npm install sms-read-plugin-android
+````
+
+To use yarn
+
+```bash
+yarn add sms-read-plugin-android
+```
+
+Sync native files
+
+```bash
+npx cap sync
+```
+
+## API
+
+<docgen-index>
+
+* [`startListening(...)`](#startlistening)
+* [`stopListening()`](#stoplistening)
+* [`addListener('smsReceived', ...)`](#addlistenersmsreceived-)
+* [`addListener('smsError', ...)`](#addlistenersmserror-)
+* [`removeAllListeners()`](#removealllisteners)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### startListening(...)
+
+```typescript
+startListening(options?: StartListeningOptions | undefined) => Promise<SmsReceivedResult>
+```
+
+Start the SMS User Consent flow.
+
+Registers with Google Play Services (`SmsRetrieverClient.startSmsUserConsent`)
+and waits for a single incoming SMS. When a matching message arrives the
+system shows a one-tap consent dialog; if the user allows it, the promise
+resolves with the full message body and (best-effort) the extracted OTP.
+
+This is a one-shot operation: it resolves/rejects exactly once and then
+stops listening. Call it again to listen for the next message. Internally
+it times out after ~5 minutes (enforced by Play Services).
+
+Requires NO SMS permissions and NO app hash.
+
+| Param         | Type                                                                    |
+| ------------- | ----------------------------------------------------------------------- |
+| **`options`** | <code><a href="#startlisteningoptions">StartListeningOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#smsreceivedresult">SmsReceivedResult</a>&gt;</code>
+
+--------------------
+
+
+### stopListening()
+
+```typescript
+stopListening() => Promise<void>
+```
+
+Stop an in-progress `startListening` call early.
+
+Unregisters the broadcast receiver and rejects any pending
+`startListening` promise with code `CANCELLED`.
+
+--------------------
+
+
+### addListener('smsReceived', ...)
+
+```typescript
+addListener(eventName: 'smsReceived', listenerFunc: (event: SmsReceivedResult) => void) => Promise<PluginListenerHandle>
+```
+
+Listen for a received SMS. Fires in addition to the `startListening`
+promise resolving, for consumers that prefer an event-based API.
+
+| Param              | Type                                                                                |
+| ------------------ | ----------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'smsReceived'</code>                                                          |
+| **`listenerFunc`** | <code>(event: <a href="#smsreceivedresult">SmsReceivedResult</a>) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### addListener('smsError', ...)
+
+```typescript
+addListener(eventName: 'smsError', listenerFunc: (event: SmsErrorEvent) => void) => Promise<PluginListenerHandle>
+```
+
+Listen for errors during the consent flow (timeout, denied consent, etc.).
+
+| Param              | Type                                                                        |
+| ------------------ | --------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'smsError'</code>                                                     |
+| **`listenerFunc`** | <code>(event: <a href="#smserrorevent">SmsErrorEvent</a>) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => Promise<void>
+```
+
+Remove all registered listeners for this plugin.
+
+--------------------
+
+
+### Interfaces
+
+
+#### SmsReceivedResult
+
+| Prop          | Type                | Description                                                            |
+| ------------- | ------------------- | ---------------------------------------------------------------------- |
+| **`message`** | <code>string</code> | The full text of the SMS the user consented to share.                  |
+| **`otp`**     | <code>string</code> | The OTP extracted from `message` using `otpPattern`, if one was found. |
+
+
+#### StartListeningOptions
+
+| Prop                    | Type                | Description                                                                                                                                                                                                |
+| ----------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`senderPhoneNumber`** | <code>string</code> | If set, only messages originating from this phone number trigger the consent prompt. Leave undefined to accept a message from any sender.                                                                  |
+| **`otpPattern`**        | <code>string</code> | Custom regular expression (as a string) used to extract the OTP from the message body. The first capturing group is preferred; otherwise the whole match is used. Defaults to `\d{4,8}` (a 4–8 digit run). |
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+#### SmsErrorEvent
+
+| Prop          | Type                                                  | Description                                    |
+| ------------- | ----------------------------------------------------- | ---------------------------------------------- |
+| **`code`**    | <code><a href="#smserrorcode">SmsErrorCode</a></code> | Stable machine-readable error code.            |
+| **`message`** | <code>string</code>                                   | Human-readable description of what went wrong. |
+
+
+### Type Aliases
+
+
+#### SmsErrorCode
+
+<code>'TIMEOUT' | 'CONSENT_DENIED' | 'NO_MESSAGE' | 'CANCELLED' | 'API_ERROR'</code>
+
+</docgen-api>

package/SmsReadPluginAndroid.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'SmsReadPluginAndroid'
+  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 = '15.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/android/build.gradle

@@ -0,0 +1,61 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.3.0'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.7.0'
+    playServicesAuthApiPhoneVersion = project.hasProperty('playServicesAuthApiPhoneVersion') ? rootProject.ext.playServicesAuthApiPhoneVersion : '18.2.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.13.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace = "com.gokulnaryanan.voltpath.sms"
+    compileSdk = project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 36
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 24
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 36
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.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"
+    implementation "com.google.android.gms:play-services-auth-api-phone:$playServicesAuthApiPhoneVersion"
+    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,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>

package/android/src/main/java/com/gokulnaryanan/voltpath/sms/SmsReadPlugin.java

@@ -0,0 +1,50 @@
+package com.gokulnaryanan.voltpath.sms;
+
+import androidx.annotation.Nullable;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * Pure, framework-free logic for the SMS Read plugin.
+ *
+ * Kept separate from {@link SmsReadPluginPlugin} (the Capacitor bridge) so it
+ * can be unit-tested without an Android runtime or the Play Services SDK.
+ */
+public class SmsReadPlugin {
+
+    /** Matches a run of 4 to 8 digits, the typical shape of an OTP. */
+    static final String DEFAULT_OTP_PATTERN = "\\d{4,8}";
+
+    /**
+     * Extract an OTP from an SMS body.
+     *
+     * @param message the full SMS text
+     * @param pattern a regular expression; when it contains a capturing group,
+     *                group 1 is returned, otherwise the whole match is. Falls
+     *                back to {@link #DEFAULT_OTP_PATTERN} when null/blank.
+     * @return the extracted OTP, or {@code null} if nothing matched or the
+     *         pattern was invalid.
+     */
+    @Nullable
+    public String extractOtp(@Nullable String message, @Nullable String pattern) {
+        if (message == null || message.isEmpty()) {
+            return null;
+        }
+
+        String effectivePattern = (pattern == null || pattern.trim().isEmpty()) ? DEFAULT_OTP_PATTERN : pattern;
+
+        try {
+            Matcher matcher = Pattern.compile(effectivePattern).matcher(message);
+            if (!matcher.find()) {
+                return null;
+            }
+            if (matcher.groupCount() >= 1 && matcher.group(1) != null) {
+                return matcher.group(1);
+            }
+            return matcher.group();
+        } catch (RuntimeException ex) {
+            // Invalid regex supplied by the caller — treat as "no OTP found".
+            return null;
+        }
+    }
+}

package/android/src/main/java/com/gokulnaryanan/voltpath/sms/SmsReadPluginPlugin.java

@@ -0,0 +1,227 @@
+package com.gokulnaryanan.voltpath.sms;
+
+import android.app.Activity;
+import android.content.BroadcastReceiver;
+import android.content.Context;
+import android.content.Intent;
+import android.content.IntentFilter;
+import android.os.Bundle;
+import androidx.activity.result.ActivityResult;
+import androidx.core.content.ContextCompat;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.ActivityCallback;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import com.google.android.gms.auth.api.phone.SmsRetriever;
+import com.google.android.gms.auth.api.phone.SmsRetrieverClient;
+import com.google.android.gms.common.api.CommonStatusCodes;
+import com.google.android.gms.common.api.Status;
+
+/**
+ * Capacitor bridge over the Google Play Services SMS User Consent API.
+ *
+ * Flow:
+ *   1. JS calls {@code startListening()} -> we call
+ *      {@link SmsRetrieverClient#startSmsUserConsent(String)} and register a
+ *      broadcast receiver for {@link SmsRetriever#SMS_RETRIEVED_ACTION}.
+ *   2. When a matching SMS arrives, Play Services broadcasts a consent intent.
+ *      We launch it with {@code startActivityForResult}, which shows the
+ *      one-tap consent dialog.
+ *   3. On "Allow", the result carries the full message body. We extract the
+ *      OTP and resolve the pending call (and emit a {@code smsReceived} event).
+ *
+ * Requires NO SMS permissions and NO app hash — that is the whole point of the
+ * User Consent variant.
+ */
+@CapacitorPlugin(name = "SmsReadPlugin")
+public class SmsReadPluginPlugin extends Plugin {
+
+    private static final String TAG = "SmsReadPlugin";
+
+    private final SmsReadPlugin implementation = new SmsReadPlugin();
+
+    /** The in-flight {@code startListening} call, kept alive until a result. */
+    private PluginCall pendingCall;
+
+    /** Regex used to extract the OTP from the consented message. */
+    private String otpPattern;
+
+    /** Receiver for {@link SmsRetriever#SMS_RETRIEVED_ACTION}; null when idle. */
+    private BroadcastReceiver smsReceiver;
+
+    @PluginMethod
+    public void startListening(PluginCall call) {
+        // Only one listen at a time — cancel any previous attempt cleanly.
+        cancelPending("Superseded by a new startListening call");
+        teardownReceiver();
+
+        otpPattern = call.getString("otpPattern");
+        String senderPhoneNumber = call.getString("senderPhoneNumber");
+
+        Context context = getContext();
+        SmsRetrieverClient client = SmsRetriever.getClient(context);
+
+        registerReceiver(context);
+
+        // null sender => accept a message from any number.
+        client
+            .startSmsUserConsent(senderPhoneNumber)
+            .addOnSuccessListener((unused) -> {
+                Logger.debug(TAG, "SMS User Consent listener started");
+                call.setKeepAlive(true);
+                pendingCall = call;
+            })
+            .addOnFailureListener((error) -> {
+                Logger.error(TAG, "Failed to start SMS User Consent", error);
+                teardownReceiver();
+                call.reject("Failed to start SMS User Consent: " + error.getMessage(), "API_ERROR");
+            });
+    }
+
+    @PluginMethod
+    public void stopListening(PluginCall call) {
+        teardownReceiver();
+        cancelPending("Listening cancelled by stopListening");
+        call.resolve();
+    }
+
+    @Override
+    protected void handleOnDestroy() {
+        teardownReceiver();
+        cancelPending("Plugin destroyed");
+        super.handleOnDestroy();
+    }
+
+    private void registerReceiver(Context context) {
+        smsReceiver = new BroadcastReceiver() {
+            @Override
+            public void onReceive(Context ctx, Intent intent) {
+                if (!SmsRetriever.SMS_RETRIEVED_ACTION.equals(intent.getAction())) {
+                    return;
+                }
+                Bundle extras = intent.getExtras();
+                if (extras == null) {
+                    return;
+                }
+                Status status = (Status) extras.get(SmsRetriever.EXTRA_STATUS);
+                if (status == null) {
+                    return;
+                }
+                switch (status.getStatusCode()) {
+                    case CommonStatusCodes.SUCCESS:
+                        Intent consentIntent = extras.getParcelable(SmsRetriever.EXTRA_CONSENT_INTENT);
+                        launchConsent(consentIntent);
+                        break;
+                    case CommonStatusCodes.TIMEOUT:
+                        teardownReceiver();
+                        emitError("TIMEOUT", "Timed out waiting for an SMS (5 minute limit)");
+                        rejectPending("Timed out waiting for an SMS", "TIMEOUT");
+                        break;
+                    default:
+                        // Other status codes are not expected for this action.
+                        break;
+                }
+            }
+        };
+
+        IntentFilter filter = new IntentFilter(SmsRetriever.SMS_RETRIEVED_ACTION);
+        // The broadcast originates from Play Services (an external process), so
+        // the receiver must be exported; it is gated by SEND_PERMISSION, which
+        // only Play Services holds. ContextCompat handles the Android 13+ flag.
+        ContextCompat.registerReceiver(context, smsReceiver, filter, SmsRetriever.SEND_PERMISSION, null, ContextCompat.RECEIVER_EXPORTED);
+    }
+
+    private void launchConsent(Intent consentIntent) {
+        if (consentIntent == null) {
+            teardownReceiver();
+            emitError("NO_MESSAGE", "Consent intent was missing from the broadcast");
+            rejectPending("Consent intent was missing", "NO_MESSAGE");
+            return;
+        }
+        if (pendingCall == null) {
+            // Nothing is awaiting a result (e.g. already cancelled).
+            teardownReceiver();
+            return;
+        }
+        // Hands the consent dialog to Capacitor; the result returns to
+        // handleConsentResult below, tied to pendingCall.
+        startActivityForResult(pendingCall, consentIntent, "handleConsentResult");
+    }
+
+    @ActivityCallback
+    private void handleConsentResult(PluginCall call, ActivityResult result) {
+        teardownReceiver();
+
+        if (call == null) {
+            return;
+        }
+        if (result.getResultCode() != Activity.RESULT_OK || result.getData() == null) {
+            emitError("CONSENT_DENIED", "User denied SMS consent");
+            call.reject("User denied SMS consent", "CONSENT_DENIED");
+            clearPending(call);
+            return;
+        }
+
+        String message = result.getData().getStringExtra(SmsRetriever.EXTRA_SMS_MESSAGE);
+        if (message == null) {
+            emitError("NO_MESSAGE", "Consent granted but no message body was returned");
+            call.reject("No message body returned", "NO_MESSAGE");
+            clearPending(call);
+            return;
+        }
+
+        String otp = implementation.extractOtp(message, otpPattern);
+
+        JSObject payload = new JSObject();
+        payload.put("message", message);
+        if (otp != null) {
+            payload.put("otp", otp);
+        }
+
+        notifyListeners("smsReceived", payload);
+        call.resolve(payload);
+        clearPending(call);
+    }
+
+    private void teardownReceiver() {
+        if (smsReceiver != null) {
+            try {
+                getContext().unregisterReceiver(smsReceiver);
+            } catch (IllegalArgumentException ignored) {
+                // Already unregistered — safe to ignore.
+            }
+            smsReceiver = null;
+        }
+    }
+
+    /** Reject + release the pending call (used for cancellations). */
+    private void cancelPending(String reason) {
+        rejectPending(reason, "CANCELLED");
+    }
+
+    private void rejectPending(String reason, String code) {
+        if (pendingCall != null) {
+            pendingCall.reject(reason, code);
+            pendingCall.setKeepAlive(false);
+            pendingCall = null;
+        }
+    }
+
+    /** Release the pending reference after a terminal resolve/reject. */
+    private void clearPending(PluginCall call) {
+        call.setKeepAlive(false);
+        if (pendingCall == call) {
+            pendingCall = null;
+        }
+    }
+
+    private void emitError(String code, String message) {
+        JSObject payload = new JSObject();
+        payload.put("code", code);
+        payload.put("message", message);
+        notifyListeners("smsError", payload);
+    }
+}

package/dist/docs.json

@@ -0,0 +1,238 @@
+{
+  "api": {
+    "name": "SmsReadPluginPlugin",
+    "slug": "smsreadpluginplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "startListening",
+        "signature": "(options?: StartListeningOptions | undefined) => Promise<SmsReceivedResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartListeningOptions | undefined"
+          }
+        ],
+        "returns": "Promise<SmsReceivedResult>",
+        "tags": [
+          {
+            "name": "platform",
+            "text": "android"
+          }
+        ],
+        "docs": "Start the SMS User Consent flow.\n\nRegisters with Google Play Services (`SmsRetrieverClient.startSmsUserConsent`)\nand waits for a single incoming SMS. When a matching message arrives the\nsystem shows a one-tap consent dialog; if the user allows it, the promise\nresolves with the full message body and (best-effort) the extracted OTP.\n\nThis is a one-shot operation: it resolves/rejects exactly once and then\nstops listening. Call it again to listen for the next message. Internally\nit times out after ~5 minutes (enforced by Play Services).\n\nRequires NO SMS permissions and NO app hash.",
+        "complexTypes": [
+          "SmsReceivedResult",
+          "StartListeningOptions"
+        ],
+        "slug": "startlistening"
+      },
+      {
+        "name": "stopListening",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "platform",
+            "text": "android"
+          }
+        ],
+        "docs": "Stop an in-progress `startListening` call early.\n\nUnregisters the broadcast receiver and rejects any pending\n`startListening` promise with code `CANCELLED`.",
+        "complexTypes": [],
+        "slug": "stoplistening"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'smsReceived', listenerFunc: (event: SmsReceivedResult) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'smsReceived'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: SmsReceivedResult) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "platform",
+            "text": "android"
+          }
+        ],
+        "docs": "Listen for a received SMS. Fires in addition to the `startListening`\npromise resolving, for consumers that prefer an event-based API.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "SmsReceivedResult"
+        ],
+        "slug": "addlistenersmsreceived-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'smsError', listenerFunc: (event: SmsErrorEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'smsError'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: SmsErrorEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "platform",
+            "text": "android"
+          }
+        ],
+        "docs": "Listen for errors during the consent flow (timeout, denied consent, etc.).",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "SmsErrorEvent"
+        ],
+        "slug": "addlistenersmserror-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Remove all registered listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "SmsReceivedResult",
+      "slug": "smsreceivedresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "The full text of the SMS the user consented to share.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "otp",
+          "tags": [],
+          "docs": "The OTP extracted from `message` using `otpPattern`, if one was found.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "StartListeningOptions",
+      "slug": "startlisteningoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "senderPhoneNumber",
+          "tags": [],
+          "docs": "If set, only messages originating from this phone number trigger the\nconsent prompt. Leave undefined to accept a message from any sender.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "otpPattern",
+          "tags": [],
+          "docs": "Custom regular expression (as a string) used to extract the OTP from the\nmessage body. The first capturing group is preferred; otherwise the whole\nmatch is used. Defaults to `\\d{4,8}` (a 4–8 digit run).",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "SmsErrorEvent",
+      "slug": "smserrorevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "code",
+          "tags": [],
+          "docs": "Stable machine-readable error code.",
+          "complexTypes": [
+            "SmsErrorCode"
+          ],
+          "type": "SmsErrorCode"
+        },
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "Human-readable description of what went wrong.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "SmsErrorCode",
+      "slug": "smserrorcode",
+      "docs": "",
+      "types": [
+        {
+          "text": "'TIMEOUT'",
+          "complexTypes": []
+        },
+        {
+          "text": "'CONSENT_DENIED'",
+          "complexTypes": []
+        },
+        {
+          "text": "'NO_MESSAGE'",
+          "complexTypes": []
+        },
+        {
+          "text": "'CANCELLED'",
+          "complexTypes": []
+        },
+        {
+          "text": "'API_ERROR'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,80 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+export interface SmsReadPluginPlugin {
+    /**
+     * Start the SMS User Consent flow.
+     *
+     * Registers with Google Play Services (`SmsRetrieverClient.startSmsUserConsent`)
+     * and waits for a single incoming SMS. When a matching message arrives the
+     * system shows a one-tap consent dialog; if the user allows it, the promise
+     * resolves with the full message body and (best-effort) the extracted OTP.
+     *
+     * This is a one-shot operation: it resolves/rejects exactly once and then
+     * stops listening. Call it again to listen for the next message. Internally
+     * it times out after ~5 minutes (enforced by Play Services).
+     *
+     * Requires NO SMS permissions and NO app hash.
+     *
+     * @platform android
+     */
+    startListening(options?: StartListeningOptions): Promise<SmsReceivedResult>;
+    /**
+     * Stop an in-progress `startListening` call early.
+     *
+     * Unregisters the broadcast receiver and rejects any pending
+     * `startListening` promise with code `CANCELLED`.
+     *
+     * @platform android
+     */
+    stopListening(): Promise<void>;
+    /**
+     * Listen for a received SMS. Fires in addition to the `startListening`
+     * promise resolving, for consumers that prefer an event-based API.
+     *
+     * @platform android
+     */
+    addListener(eventName: 'smsReceived', listenerFunc: (event: SmsReceivedResult) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listen for errors during the consent flow (timeout, denied consent, etc.).
+     *
+     * @platform android
+     */
+    addListener(eventName: 'smsError', listenerFunc: (event: SmsErrorEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all registered listeners for this plugin.
+     */
+    removeAllListeners(): Promise<void>;
+}
+export interface StartListeningOptions {
+    /**
+     * If set, only messages originating from this phone number trigger the
+     * consent prompt. Leave undefined to accept a message from any sender.
+     */
+    senderPhoneNumber?: string;
+    /**
+     * Custom regular expression (as a string) used to extract the OTP from the
+     * message body. The first capturing group is preferred; otherwise the whole
+     * match is used. Defaults to `\d{4,8}` (a 4–8 digit run).
+     */
+    otpPattern?: string;
+}
+export interface SmsReceivedResult {
+    /**
+     * The full text of the SMS the user consented to share.
+     */
+    message: string;
+    /**
+     * The OTP extracted from `message` using `otpPattern`, if one was found.
+     */
+    otp?: string;
+}
+export type SmsErrorCode = 'TIMEOUT' | 'CONSENT_DENIED' | 'NO_MESSAGE' | 'CANCELLED' | 'API_ERROR';
+export interface SmsErrorEvent {
+    /**
+     * Stable machine-readable error code.
+     */
+    code: SmsErrorCode;
+    /**
+     * Human-readable description of what went wrong.
+     */
+    message: 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 { PluginListenerHandle } from '@capacitor/core';\n\nexport interface SmsReadPluginPlugin {\n  /**\n   * Start the SMS User Consent flow.\n   *\n   * Registers with Google Play Services (`SmsRetrieverClient.startSmsUserConsent`)\n   * and waits for a single incoming SMS. When a matching message arrives the\n   * system shows a one-tap consent dialog; if the user allows it, the promise\n   * resolves with the full message body and (best-effort) the extracted OTP.\n   *\n   * This is a one-shot operation: it resolves/rejects exactly once and then\n   * stops listening. Call it again to listen for the next message. Internally\n   * it times out after ~5 minutes (enforced by Play Services).\n   *\n   * Requires NO SMS permissions and NO app hash.\n   *\n   * @platform android\n   */\n  startListening(options?: StartListeningOptions): Promise<SmsReceivedResult>;\n\n  /**\n   * Stop an in-progress `startListening` call early.\n   *\n   * Unregisters the broadcast receiver and rejects any pending\n   * `startListening` promise with code `CANCELLED`.\n   *\n   * @platform android\n   */\n  stopListening(): Promise<void>;\n\n  /**\n   * Listen for a received SMS. Fires in addition to the `startListening`\n   * promise resolving, for consumers that prefer an event-based API.\n   *\n   * @platform android\n   */\n  addListener(\n    eventName: 'smsReceived',\n    listenerFunc: (event: SmsReceivedResult) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Listen for errors during the consent flow (timeout, denied consent, etc.).\n   *\n   * @platform android\n   */\n  addListener(eventName: 'smsError', listenerFunc: (event: SmsErrorEvent) => void): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all registered listeners for this plugin.\n   */\n  removeAllListeners(): Promise<void>;\n}\n\nexport interface StartListeningOptions {\n  /**\n   * If set, only messages originating from this phone number trigger the\n   * consent prompt. Leave undefined to accept a message from any sender.\n   */\n  senderPhoneNumber?: string;\n\n  /**\n   * Custom regular expression (as a string) used to extract the OTP from the\n   * message body. The first capturing group is preferred; otherwise the whole\n   * match is used. Defaults to `\\d{4,8}` (a 4–8 digit run).\n   */\n  otpPattern?: string;\n}\n\nexport interface SmsReceivedResult {\n  /**\n   * The full text of the SMS the user consented to share.\n   */\n  message: string;\n\n  /**\n   * The OTP extracted from `message` using `otpPattern`, if one was found.\n   */\n  otp?: string;\n}\n\nexport type SmsErrorCode = 'TIMEOUT' | 'CONSENT_DENIED' | 'NO_MESSAGE' | 'CANCELLED' | 'API_ERROR';\n\nexport interface SmsErrorEvent {\n  /**\n   * Stable machine-readable error code.\n   */\n  code: SmsErrorCode;\n\n  /**\n   * Human-readable description of what went wrong.\n   */\n  message: string;\n}\n"]}

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const SmsReadPlugin = registerPlugin('SmsReadPlugin', {
+    web: () => import('./web').then((m) => new m.SmsReadPluginWeb()),
+});
+export * from './definitions';
+export { SmsReadPlugin };
+//# 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,aAAa,GAAG,cAAc,CAAsB,eAAe,EAAE;IACzE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;CACjE,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { SmsReadPluginPlugin } from './definitions';\n\nconst SmsReadPlugin = registerPlugin<SmsReadPluginPlugin>('SmsReadPlugin', {\n  web: () => import('./web').then((m) => new m.SmsReadPluginWeb()),\n});\n\nexport * from './definitions';\nexport { SmsReadPlugin };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,6 @@
+import { WebPlugin } from '@capacitor/core';
+import type { SmsReadPluginPlugin, StartListeningOptions, SmsReceivedResult } from './definitions';
+export declare class SmsReadPluginWeb extends WebPlugin implements SmsReadPluginPlugin {
+    startListening(_options?: StartListeningOptions): Promise<SmsReceivedResult>;
+    stopListening(): Promise<void>;
+}

package/dist/esm/web.js

@@ -0,0 +1,10 @@
+import { WebPlugin } from '@capacitor/core';
+export class SmsReadPluginWeb extends WebPlugin {
+    async startListening(_options) {
+        throw this.unavailable('SMS User Consent is only available on Android.');
+    }
+    async stopListening() {
+        throw this.unavailable('SMS User Consent is only available on Android.');
+    }
+}
+//# 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,gBAAiB,SAAQ,SAAS;IAC7C,KAAK,CAAC,cAAc,CAAC,QAAgC;QACnD,MAAM,IAAI,CAAC,WAAW,CAAC,gDAAgD,CAAC,CAAC;IAC3E,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,MAAM,IAAI,CAAC,WAAW,CAAC,gDAAgD,CAAC,CAAC;IAC3E,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { SmsReadPluginPlugin, StartListeningOptions, SmsReceivedResult } from './definitions';\n\nexport class SmsReadPluginWeb extends WebPlugin implements SmsReadPluginPlugin {\n  async startListening(_options?: StartListeningOptions): Promise<SmsReceivedResult> {\n    throw this.unavailable('SMS User Consent is only available on Android.');\n  }\n\n  async stopListening(): Promise<void> {\n    throw this.unavailable('SMS User Consent is only available on Android.');\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+var core = require('@capacitor/core');
+
+const SmsReadPlugin = core.registerPlugin('SmsReadPlugin', {
+    web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.SmsReadPluginWeb()),
+});
+
+class SmsReadPluginWeb extends core.WebPlugin {
+    async startListening(_options) {
+        throw this.unavailable('SMS User Consent is only available on Android.');
+    }
+    async stopListening() {
+        throw this.unavailable('SMS User Consent is only available on Android.');
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    SmsReadPluginWeb: SmsReadPluginWeb
+});
+
+exports.SmsReadPlugin = SmsReadPlugin;
+//# 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 SmsReadPlugin = registerPlugin('SmsReadPlugin', {\n    web: () => import('./web').then((m) => new m.SmsReadPluginWeb()),\n});\nexport * from './definitions';\nexport { SmsReadPlugin };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class SmsReadPluginWeb extends WebPlugin {\n    async startListening(_options) {\n        throw this.unavailable('SMS User Consent is only available on Android.');\n    }\n    async stopListening() {\n        throw this.unavailable('SMS User Consent is only available on Android.');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,aAAa,GAAGA,mBAAc,CAAC,eAAe,EAAE;AACtD,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;AACpE,CAAC;;ACFM,MAAM,gBAAgB,SAASC,cAAS,CAAC;AAChD,IAAI,MAAM,cAAc,CAAC,QAAQ,EAAE;AACnC,QAAQ,MAAM,IAAI,CAAC,WAAW,CAAC,gDAAgD,CAAC;AAChF,IAAI;AACJ,IAAI,MAAM,aAAa,GAAG;AAC1B,QAAQ,MAAM,IAAI,CAAC,WAAW,CAAC,gDAAgD,CAAC;AAChF,IAAI;AACJ;;;;;;;;;"}

package/dist/plugin.js

@@ -0,0 +1,27 @@
+var capacitorSmsReadPlugin = (function (exports, core) {
+    'use strict';
+
+    const SmsReadPlugin = core.registerPlugin('SmsReadPlugin', {
+        web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.SmsReadPluginWeb()),
+    });
+
+    class SmsReadPluginWeb extends core.WebPlugin {
+        async startListening(_options) {
+            throw this.unavailable('SMS User Consent is only available on Android.');
+        }
+        async stopListening() {
+            throw this.unavailable('SMS User Consent is only available on Android.');
+        }
+    }
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        SmsReadPluginWeb: SmsReadPluginWeb
+    });
+
+    exports.SmsReadPlugin = SmsReadPlugin;
+
+    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 SmsReadPlugin = registerPlugin('SmsReadPlugin', {\n    web: () => import('./web').then((m) => new m.SmsReadPluginWeb()),\n});\nexport * from './definitions';\nexport { SmsReadPlugin };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class SmsReadPluginWeb extends WebPlugin {\n    async startListening(_options) {\n        throw this.unavailable('SMS User Consent is only available on Android.');\n    }\n    async stopListening() {\n        throw this.unavailable('SMS User Consent is only available on Android.');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,aAAa,GAAGA,mBAAc,CAAC,eAAe,EAAE;IACtD,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,gBAAgB,EAAE,CAAC;IACpE,CAAC;;ICFM,MAAM,gBAAgB,SAASC,cAAS,CAAC;IAChD,IAAI,MAAM,cAAc,CAAC,QAAQ,EAAE;IACnC,QAAQ,MAAM,IAAI,CAAC,WAAW,CAAC,gDAAgD,CAAC;IAChF,IAAI;IACJ,IAAI,MAAM,aAAa,GAAG;IAC1B,QAAQ,MAAM,IAAI,CAAC,WAAW,CAAC,gDAAgD,CAAC;IAChF,IAAI;IACJ;;;;;;;;;;;;;;;"}

package/ios/Sources/SmsReadPluginPlugin/SmsReadPlugin.swift

@@ -0,0 +1,6 @@
+import Foundation
+
+/// iOS has no programmatic SMS-read API; this type is intentionally a no-op
+/// placeholder so the package keeps its conventional implementation file.
+@objc public class SmsReadPlugin: NSObject {
+}

package/ios/Sources/SmsReadPluginPlugin/SmsReadPluginPlugin.swift

@@ -0,0 +1,25 @@
+import Foundation
+import Capacitor
+
+/**
+ * SMS reading via the User Consent API is an Android-only capability. On iOS,
+ * SMS OTPs are surfaced by the system keyboard (AutoFill) and there is no
+ * equivalent programmatic API, so these methods report as unavailable.
+ */
+@objc(SmsReadPluginPlugin)
+public class SmsReadPluginPlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "SmsReadPluginPlugin"
+    public let jsName = "SmsReadPlugin"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "startListening", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "stopListening", returnType: CAPPluginReturnPromise)
+    ]
+
+    @objc func startListening(_ call: CAPPluginCall) {
+        call.unavailable("SMS User Consent is only available on Android.")
+    }
+
+    @objc func stopListening(_ call: CAPPluginCall) {
+        call.unavailable("SMS User Consent is only available on Android.")
+    }
+}

package/ios/Tests/SmsReadPluginPluginTests/SmsReadPluginTests.swift

@@ -0,0 +1,10 @@
+import XCTest
+@testable import SmsReadPluginPlugin
+
+class SmsReadPluginTests: XCTestCase {
+    func testPlaceholder() {
+        // SMS reading is Android-only; the iOS implementation is a no-op
+        // placeholder, so there is nothing functional to assert here.
+        XCTAssertNotNil(SmsReadPlugin())
+    }
+}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "sms-read-plugin-android",
+  "version": "0.0.1",
+  "description": "A plugin used to read sms for android apps",
+  "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",
+    "SmsReadPluginAndroid.podspec"
+  ],
+  "author": "Gokul Narayanan <ngokulnarayanan@gmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ev-voltpath/sms-read-plugin-capcitor-android.git.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ev-voltpath/sms-read-plugin-capcitor-android.git/issues"
+  },
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "xcodebuild -scheme SmsReadPluginAndroid -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 SmsReadPluginPlugin --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": "^8.0.0",
+    "@capacitor/core": "^8.0.0",
+    "@capacitor/docgen": "^0.3.1",
+    "@capacitor/ios": "^8.0.0",
+    "@ionic/eslint-config": "^0.4.0",
+    "@ionic/prettier-config": "^4.0.0",
+    "@ionic/swiftlint-config": "^2.0.0",
+    "eslint": "^8.57.1",
+    "prettier": "^3.6.2",
+    "prettier-plugin-java": "^2.7.7",
+    "rimraf": "^6.1.0",
+    "rollup": "^4.53.2",
+    "swiftlint": "^2.0.0",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "@capacitor/core": ">=8.0.0"
+  },
+  "prettier": "@ionic/prettier-config",
+  "swiftlint": "@ionic/swiftlint-config",
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  }
+}