@capawesome/capacitor-sms-composer 0.0.1

package/CapawesomeCapacitorSmsComposer.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapawesomeCapacitorSmsComposer'
+  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/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '15.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robin Genz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Package.swift

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

package/README.md

@@ -0,0 +1,200 @@
+# @capawesome/capacitor-sms-composer
+
+Capacitor plugin to open the native SMS composer prefilled with recipients and a message body.
+
+<div class="capawesome-z29o10a">
+  <a href="https://cloud.capawesome.io/" target="_blank">
+    <img alt="Deliver Live Updates to your Capacitor app with Capawesome Cloud" src="https://cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.png?t=1" />
+  </a>
+</div>
+
+## Features
+
+- ✉️ **Compose**: Open the native SMS composer prefilled with recipients and a message body.
+- ✅ **Capability check**: Check whether the device is able to compose and send SMS messages.
+- 🔒 **Privacy-friendly**: The user always reviews and sends the message. The plugin never sends SMS on its own.
+- 📦 **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS.
+- 🔁 **Up-to-date**: Always supports the latest Capacitor version.
+
+Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!
+
+## 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/).
+
+## Compatibility
+
+| Plugin Version | Capacitor Version | Status         |
+| -------------- | ----------------- | -------------- |
+| 0.x.x          | >=8.x.x           | Active support |
+
+## Installation
+
+You can use our **AI-Assisted Setup** to install the plugin.
+Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:
+
+```bash
+npx skills add capawesome-team/skills --skill capacitor-plugins
+```
+
+Then use the following prompt:
+
+```
+ Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-sms-composer` plugin in my project.
+```
+
+If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below:
+
+```bash
+npm install @capawesome/capacitor-sms-composer
+npx cap sync
+```
+
+This plugin is only available on **Android** and **iOS**. On Web, all methods reject as unimplemented.
+
+### Android
+
+No additional configuration is required. The plugin declares the necessary `<queries>` element for the `smsto` scheme in its `AndroidManifest.xml`, so the SMS capability can be detected on Android 11 (API level 30) and higher.
+
+## Configuration
+
+No configuration required for this plugin.
+
+## Usage
+
+```typescript
+import { SmsComposer } from '@capawesome/capacitor-sms-composer';
+
+const canComposeSms = async () => {
+  const { canCompose } = await SmsComposer.canComposeSms();
+  return canCompose;
+};
+
+const composeSms = async () => {
+  const { status } = await SmsComposer.composeSms({
+    recipients: ['+41791234567'],
+    body: 'Hello from Capacitor!',
+  });
+  return status;
+};
+```
+
+## API
+
+<docgen-index>
+
+* [`canComposeSms()`](#cancomposesms)
+* [`composeSms(...)`](#composesms)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### canComposeSms()
+
+```typescript
+canComposeSms() => Promise<CanComposeSmsResult>
+```
+
+Check whether the device is able to compose and send SMS messages.
+
+On devices without SMS capability (e.g. Wi-Fi-only tablets or iPads),
+this resolves with `canCompose` set to `false`.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#cancomposesmsresult">CanComposeSmsResult</a>&gt;</code>
+
+**Since:** 0.1.0
+
+--------------------
+
+
+### composeSms(...)
+
+```typescript
+composeSms(options: ComposeSmsOptions) => Promise<ComposeSmsResult>
+```
+
+Open the native SMS composer prefilled with the given recipients and body.
+
+The user reviews the message and decides whether to send it. The plugin
+never sends the message itself.
+
+The call resolves once the composer is dismissed. If the device is not
+able to compose SMS messages, the call rejects as unavailable.
+
+Only available on Android and iOS.
+
+| Param         | Type                                                            |
+| ------------- | --------------------------------------------------------------- |
+| **`options`** | <code><a href="#composesmsoptions">ComposeSmsOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#composesmsresult">ComposeSmsResult</a>&gt;</code>
+
+**Since:** 0.1.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### CanComposeSmsResult
+
+| Prop             | Type                 | Description                                                  | Since |
+| ---------------- | -------------------- | ------------------------------------------------------------ | ----- |
+| **`canCompose`** | <code>boolean</code> | Whether the device is able to compose and send SMS messages. | 0.1.0 |
+
+
+#### ComposeSmsResult
+
+| Prop         | Type                                                          | Description                                                                                                                                                        | Since |
+| ------------ | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
+| **`status`** | <code><a href="#smscomposestatus">SmsComposeStatus</a></code> | The status of the SMS composer after it was dismissed. On Android, the status is always `unknown` because the system does not report whether the message was sent. | 0.1.0 |
+
+
+#### ComposeSmsOptions
+
+| Prop             | Type                  | Description                                                | Since |
+| ---------------- | --------------------- | ---------------------------------------------------------- | ----- |
+| **`body`**       | <code>string</code>   | The message body to prefill in the composer.               | 0.1.0 |
+| **`recipients`** | <code>string[]</code> | The recipients (phone numbers) to prefill in the composer. | 0.1.0 |
+
+
+### Type Aliases
+
+
+#### SmsComposeStatus
+
+The status of the SMS composer after it was dismissed.
+
+- `sent`: The user sent the message.
+- `canceled`: The user canceled the composer without sending the message.
+- `unknown`: The result is unknown. This is always the case on Android.
+
+<code>'canceled' | 'sent' | 'unknown'</code>
+
+</docgen-api>
+
+## Result Status
+
+The `composeSms(...)` method resolves with a `status` once the composer is dismissed:
+
+- On **iOS**, the status reflects the actual outcome (`sent`, `canceled`).
+- On **Android**, the status is always `unknown` because the system does not report whether the message was sent.
+
+## Multiple Recipients
+
+Multiple recipients are joined with a semicolon (`;`) in the underlying `smsto:` URI on Android. Some messaging apps expect a comma (`,`) instead, so multi-recipient prefilling may not work reliably across all Android messaging apps.
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/sms-composer/CHANGELOG.md).
+
+## License
+
+See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/sms-composer/LICENSE).

package/android/build.gradle

@@ -0,0 +1,58 @@
+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'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.13.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace = "io.capawesome.capacitorjs.plugins.smscomposer"
+    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.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,8 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <queries>
+        <intent>
+            <action android:name="android.intent.action.SENDTO" />
+            <data android:scheme="smsto" />
+        </intent>
+    </queries>
+</manifest>

package/android/src/main/java/io/capawesome/capacitorjs/plugins/smscomposer/SmsComposer.java

@@ -0,0 +1,52 @@
+package io.capawesome.capacitorjs.plugins.smscomposer;
+
+import android.content.ActivityNotFoundException;
+import android.content.Intent;
+import android.net.Uri;
+import android.text.TextUtils;
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import io.capawesome.capacitorjs.plugins.smscomposer.classes.CustomExceptions;
+import io.capawesome.capacitorjs.plugins.smscomposer.classes.options.ComposeSmsOptions;
+import io.capawesome.capacitorjs.plugins.smscomposer.classes.results.ComposeSmsResult;
+import io.capawesome.capacitorjs.plugins.smscomposer.interfaces.NonEmptyResultCallback;
+import java.util.List;
+
+public class SmsComposer {
+
+    public static final String STATUS_UNKNOWN = "unknown";
+
+    private final SmsComposerPlugin plugin;
+
+    public SmsComposer(@NonNull SmsComposerPlugin plugin) {
+        this.plugin = plugin;
+    }
+
+    public boolean canComposeSms() {
+        Intent intent = createSendToIntent(null);
+        return intent.resolveActivity(plugin.getContext().getPackageManager()) != null;
+    }
+
+    public void composeSms(@NonNull ComposeSmsOptions options, @NonNull NonEmptyResultCallback<ComposeSmsResult> callback) {
+        Intent intent = createSendToIntent(options.getRecipients());
+        String body = options.getBody();
+        if (body != null) {
+            intent.putExtra("sms_body", body);
+        }
+        try {
+            plugin.getActivity().startActivity(intent);
+            callback.success(new ComposeSmsResult(STATUS_UNKNOWN));
+        } catch (ActivityNotFoundException exception) {
+            callback.error(CustomExceptions.COMPOSE_FAILED);
+        }
+    }
+
+    @NonNull
+    private Intent createSendToIntent(@Nullable List<String> recipients) {
+        String uri = "smsto:";
+        if (recipients != null && !recipients.isEmpty()) {
+            uri += TextUtils.join(";", recipients);
+        }
+        return new Intent(Intent.ACTION_SENDTO, Uri.parse(uri));
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/smscomposer/SmsComposerPlugin.java

@@ -0,0 +1,96 @@
+package io.capawesome.capacitorjs.plugins.smscomposer;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import io.capawesome.capacitorjs.plugins.smscomposer.classes.CustomException;
+import io.capawesome.capacitorjs.plugins.smscomposer.classes.options.ComposeSmsOptions;
+import io.capawesome.capacitorjs.plugins.smscomposer.classes.results.CanComposeSmsResult;
+import io.capawesome.capacitorjs.plugins.smscomposer.classes.results.ComposeSmsResult;
+import io.capawesome.capacitorjs.plugins.smscomposer.interfaces.NonEmptyResultCallback;
+import io.capawesome.capacitorjs.plugins.smscomposer.interfaces.Result;
+
+@CapacitorPlugin(name = "SmsComposer")
+public class SmsComposerPlugin extends Plugin {
+
+    public static final String ERROR_UNKNOWN_ERROR = "An unknown error has occurred.";
+    public static final String TAG = "SmsComposerPlugin";
+
+    private SmsComposer implementation;
+
+    @Override
+    public void load() {
+        super.load();
+        this.implementation = new SmsComposer(this);
+    }
+
+    @PluginMethod
+    public void canComposeSms(PluginCall call) {
+        try {
+            CanComposeSmsResult result = new CanComposeSmsResult(implementation.canComposeSms());
+            resolveCall(call, result);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void composeSms(PluginCall call) {
+        try {
+            if (!implementation.canComposeSms()) {
+                rejectCallAsUnavailable(call);
+                return;
+            }
+
+            ComposeSmsOptions options = new ComposeSmsOptions(call);
+            NonEmptyResultCallback<ComposeSmsResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull ComposeSmsResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.composeSms(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    private void rejectCall(@NonNull PluginCall call, @NonNull Exception exception) {
+        String message = exception.getMessage();
+        if (message == null) {
+            message = ERROR_UNKNOWN_ERROR;
+        }
+        String code = null;
+        if (exception instanceof CustomException) {
+            code = ((CustomException) exception).getCode();
+        }
+        Logger.error(TAG, message, exception);
+        call.reject(message, code);
+    }
+
+    private void rejectCallAsUnavailable(@NonNull PluginCall call) {
+        call.unavailable("This method is not available on this platform.");
+    }
+
+    private void resolveCall(@NonNull PluginCall call) {
+        call.resolve();
+    }
+
+    private void resolveCall(@NonNull PluginCall call, @Nullable Result result) {
+        if (result == null) {
+            call.resolve();
+        } else {
+            call.resolve(result.toJSObject());
+        }
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/smscomposer/classes/CustomException.java

@@ -0,0 +1,20 @@
+package io.capawesome.capacitorjs.plugins.smscomposer.classes;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+public class CustomException extends Exception {
+
+    @Nullable
+    private final String code;
+
+    public CustomException(@Nullable String code, @NonNull String message) {
+        super(message);
+        this.code = code;
+    }
+
+    @Nullable
+    public String getCode() {
+        return code;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/smscomposer/classes/CustomExceptions.java

@@ -0,0 +1,9 @@
+package io.capawesome.capacitorjs.plugins.smscomposer.classes;
+
+public class CustomExceptions {
+
+    public static final CustomException COMPOSE_FAILED = new CustomException(
+        "COMPOSE_FAILED",
+        "The SMS composer failed to compose or present the message."
+    );
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/smscomposer/classes/options/ComposeSmsOptions.java

@@ -0,0 +1,45 @@
+package io.capawesome.capacitorjs.plugins.smscomposer.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.PluginCall;
+import java.util.List;
+import org.json.JSONException;
+
+public class ComposeSmsOptions {
+
+    @Nullable
+    private final String body;
+
+    @Nullable
+    private final List<String> recipients;
+
+    public ComposeSmsOptions(@NonNull PluginCall call) {
+        this.recipients = getRecipientsFromCall(call);
+        this.body = call.getString("body");
+    }
+
+    @Nullable
+    public String getBody() {
+        return body;
+    }
+
+    @Nullable
+    public List<String> getRecipients() {
+        return recipients;
+    }
+
+    @Nullable
+    private static List<String> getRecipientsFromCall(@NonNull PluginCall call) {
+        JSArray array = call.getArray("recipients");
+        if (array == null) {
+            return null;
+        }
+        try {
+            return array.toList();
+        } catch (JSONException exception) {
+            return null;
+        }
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/smscomposer/classes/results/CanComposeSmsResult.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.smscomposer.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.smscomposer.interfaces.Result;
+
+public class CanComposeSmsResult implements Result {
+
+    private final boolean canCompose;
+
+    public CanComposeSmsResult(boolean canCompose) {
+        this.canCompose = canCompose;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("canCompose", canCompose);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/smscomposer/classes/results/ComposeSmsResult.java

@@ -0,0 +1,23 @@
+package io.capawesome.capacitorjs.plugins.smscomposer.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.smscomposer.interfaces.Result;
+
+public class ComposeSmsResult implements Result {
+
+    @NonNull
+    private final String status;
+
+    public ComposeSmsResult(@NonNull String status) {
+        this.status = status;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("status", status);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/smscomposer/interfaces/Callback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.smscomposer.interfaces;
+
+public interface Callback {
+    void error(Exception exception);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/smscomposer/interfaces/NonEmptyResultCallback.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.smscomposer.interfaces;
+
+import androidx.annotation.NonNull;
+
+public interface NonEmptyResultCallback<T extends Result> extends Callback {
+    void success(@NonNull T result);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/smscomposer/interfaces/Result.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.smscomposer.interfaces;
+
+import com.getcapacitor.JSObject;
+
+public interface Result {
+    JSObject toJSObject();
+}