@capawesome/capacitor-android-sms-retriever 0.0.1 → 0.1.0

package/README.md

@@ -1,4 +1,4 @@
-# @capawesome/capacitor-android-sms-retriever
+# Capacitor Android SMS Retriever Plugin
 
 Capacitor plugin for OTP autofill on Android via the SMS User Consent and Phone Number Hint APIs.
 
@@ -17,9 +17,13 @@ Capacitor plugin for OTP autofill on Android via the SMS User Consent and Phone
 
 Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!
 
-## Newsletter
+## Use Cases
 
-Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
+The Android SMS Retriever plugin is typically used in phone number verification flows, for example:
+
+- **OTP autofill**: Retrieve an incoming verification SMS after a one-tap system consent dialog and extract the one-time code, so the user doesn't have to type it manually.
+- **Phone number prefill**: Prefill the phone number input field of your sign-up or login form via the system bottom sheet.
+- **Play-policy-safe SMS verification**: Implement SMS-based verification without requesting any SMS permissions, using the SMS User Consent and Phone Number Hint APIs.
 
 ## Compatibility
 
@@ -76,6 +80,12 @@ No configuration required for this plugin.
 
 ## Usage
 
+The following examples show how to prefill the user's phone number and retrieve a verification SMS.
+
+### Prefill the user's phone number
+
+Request the user's phone number via the Phone Number Hint API. A system bottom sheet is displayed that lets the user pick one of the phone numbers associated with the device, for example to prefill a phone number input field. Only available on Android:
+
 ```typescript
 import { AndroidSmsRetriever } from '@capawesome/capacitor-android-sms-retriever';
 
@@ -83,6 +93,14 @@ const requestPhoneNumber = async () => {
   const { phoneNumber } = await AndroidSmsRetriever.requestPhoneNumber();
   return phoneNumber;
 };
+```
+
+### Retrieve a verification SMS
+
+Retrieve an incoming verification SMS via the SMS User Consent API. A system consent dialog is displayed when a matching SMS is received, and the promise resolves with the full message text once the user consents, so your app can extract the one-time code itself (see [Extracting the One-Time Code](#extracting-the-one-time-code)). Only available on Android:
+
+```typescript
+import { AndroidSmsRetriever } from '@capawesome/capacitor-android-sms-retriever';
 
 const retrieveSms = async () => {
   const { message } = await AndroidSmsRetriever.retrieveSms();
@@ -197,6 +215,46 @@ For the SMS User Consent API to detect a message, the SMS must:
 
 The underlying broadcast waits up to 5 minutes for a matching SMS. If no message is received within this time, the promise rejects with the error code `TIMEOUT`.
 
+## FAQ
+
+### How is this plugin different from other similar plugins?
+
+It implements OTP autofill on Android through the SMS User Consent and Phone Number Hint APIs, so you can read a verification SMS and prefill the user's phone number without requesting any SMS permissions and while staying within Google Play policy. It's a focused, fully typed API that handles the system consent dialog and bottom sheet for you, and it's actively maintained against the latest Capacitor and Android versions. On iOS you don't need it at all — the WebView already autofills one-time codes — and the README explains exactly how.
+
+### Does this plugin require any SMS permissions?
+
+No, the plugin uses the SMS User Consent and Phone Number Hint APIs, which are Play-policy-safe and require no SMS permissions. Instead of reading SMS messages silently, the user explicitly consents via a one-tap system dialog before your app receives the message.
+
+### Does this plugin work on iOS or Web?
+
+No, this plugin only provides an Android implementation and you don't need one on iOS. iOS already autofills one-time codes from incoming SMS messages in `WKWebView` when the input field uses `autocomplete="one-time-code"`. On iOS and Web, all methods reject as unimplemented.
+
+### Why does `retrieveSms` reject with the error code `TIMEOUT`?
+
+The underlying broadcast waits up to 5 minutes for a matching SMS. If no matching message is received within this time, the promise rejects with the error code `TIMEOUT`. Make sure the SMS is sent while the broadcast is active and meets the requirements of the SMS User Consent API.
+
+### Why is my SMS message not detected?
+
+For the SMS User Consent API to detect a message, the SMS must contain a one-time code that the user sends back to your server to complete the verification, be no longer than 140 bytes, and not originate from a phone number in the user's contacts. See [Extracting the One-Time Code](#extracting-the-one-time-code) for more information.
+
+### Can I filter incoming messages by sender?
+
+Yes, you can pass the `senderPhoneNumber` option to the `retrieveSms(...)` method to only retrieve messages from a specific sender. If not provided, the SMS from any sender is retrieved.
+
+### Can I use this plugin with Ionic, React, Vue or Angular?
+
+Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects.
+
+## Related Plugins
+
+- [SMS Composer](https://capawesome.io/docs/sdks/capacitor/sms-composer/): Open the native SMS composer prefilled with recipients and a message body.
+- [Password Autofill](https://capawesome.io/docs/sdks/capacitor/password-autofill/): Save passwords to the platform credential store.
+- [SIM](https://capawesome.io/docs/sdks/capacitor/sim/): Read SIM card and carrier information.
+
+## Newsletter
+
+Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
+
 ## Changelog
 
 See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/android-sms-retriever/CHANGELOG.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capawesome/capacitor-android-sms-retriever",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Capacitor plugin for OTP autofill on Android via the SMS User Consent and Phone Number Hint APIs.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -33,11 +33,21 @@
       "url": "https://opencollective.com/capawesome"
     }
   ],
-  "homepage": "https://capawesome.io/docs/plugins/android-sms-retriever/",
+  "homepage": "https://capawesome.io/docs/sdks/capacitor/android-sms-retriever/",
   "keywords": [
     "capacitor",
+    "capacitor-plugin",
     "plugin",
-    "native"
+    "native",
+    "android",
+    "sms retriever",
+    "otp",
+    "otp autofill",
+    "one-time code",
+    "sms verification",
+    "sms user consent",
+    "phone number hint",
+    "phone verification"
   ],
   "scripts": {
     "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",