@capacitor-mlkit/genai-rewriting 8.1.0

package/CapacitorMlkitGenaiRewriting.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorMlkitGenaiRewriting'
+  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,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Robin Genz
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,429 @@
+# Capacitor ML Kit GenAI Rewriting Plugin
+
+Unofficial Capacitor plugin for [ML Kit GenAI Rewriting](https://developers.google.com/ml-kit/genai/rewriting).[^1]
+
+> [!WARNING]
+> The ML Kit GenAI APIs are currently in **beta**. The API surface and behavior may change in future releases.
+
+<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>
+
+## Use Cases
+
+The GenAI Rewriting plugin is typically used to reword short messages in different tones and styles on-device using Gemini Nano, for example:
+
+- **Tone adjustments**: Rewrite a message to sound more friendly or more professional before sending it.
+- **Length adjustments**: Shorten or elaborate a draft to fit the situation.
+- **Expressive messaging**: Add emojis or rephrase text to give it a fresh look.
+
+## Requirements
+
+This plugin uses [Gemini Nano](https://developers.google.com/ml-kit/genai), which runs entirely on-device. It is only available on Android and has the following device requirements:
+
+- The device must support Gemini Nano (see [supported devices](https://developers.google.com/ml-kit/genai#supported_devices)).
+- The device must run Android API level 26 or higher.
+- The device must not have an unlocked bootloader.
+
+Use the `checkFeatureStatus(...)` method to check whether the feature is available on the device.
+
+## Compatibility
+
+| Plugin Version | Capacitor Version | Status         |
+| -------------- | ----------------- | -------------- |
+| 8.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 `@capacitor-mlkit/genai-rewriting` 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 @capacitor-mlkit/genai-rewriting
+npx cap sync
+```
+
+### Android
+
+#### API level
+
+This plugin requires a minimum API level of 26. Make sure to set the `minSdkVersion` in your `variables.gradle` file to at least `26`.
+
+#### Variables
+
+This plugin will use the following project variables (defined in your app’s `variables.gradle` file):
+
+- `$mlkitGenaiRewritingVersion` version of `com.google.mlkit:genai-rewriting` (default: `1.0.0-beta1`)
+
+## Usage
+
+The following example shows how to check the feature status, download the feature and rewrite a text.
+
+### Check the feature status
+
+Before using the rewriting feature, check whether it is available on the device. The feature availability depends on the configured output type and language:
+
+```typescript
+import {
+  FeatureStatus,
+  GenAiRewriting,
+  Language,
+  OutputType,
+} from '@capacitor-mlkit/genai-rewriting';
+
+const checkFeatureStatus = async () => {
+  const { featureStatus } = await GenAiRewriting.checkFeatureStatus({
+    language: Language.English,
+    outputType: OutputType.Elaborate,
+  });
+  return featureStatus === FeatureStatus.Available;
+};
+```
+
+### Download the feature
+
+If the feature status is `DOWNLOADABLE`, download the feature before using it. Add a listener for the `downloadProgress` event to get notified about the download progress:
+
+```typescript
+import { GenAiRewriting, Language, OutputType } from '@capacitor-mlkit/genai-rewriting';
+
+const downloadFeature = async () => {
+  await GenAiRewriting.addListener('downloadProgress', event => {
+    console.log('Total bytes downloaded:', event.totalBytesDownloaded);
+  });
+  await GenAiRewriting.downloadFeature({
+    language: Language.English,
+    outputType: OutputType.Elaborate,
+  });
+};
+```
+
+### Rewrite a text
+
+Pass the text to `rewrite(...)` to generate the rewritten suggestions. Add a listener for the `inferenceProgress` event to receive partial results as they are generated:
+
+```typescript
+import { GenAiRewriting, Language, OutputType } from '@capacitor-mlkit/genai-rewriting';
+
+const rewrite = async () => {
+  await GenAiRewriting.addListener('inferenceProgress', event => {
+    console.log('Partial result:', event.text);
+  });
+  const { results } = await GenAiRewriting.rewrite({
+    text: 'Capacitor is an open source native runtime for building Web Native apps.',
+    language: Language.English,
+    outputType: OutputType.Elaborate,
+  });
+  return results;
+};
+```
+
+## API
+
+<docgen-index>
+
+* [`checkFeatureStatus(...)`](#checkfeaturestatus)
+* [`downloadFeature(...)`](#downloadfeature)
+* [`rewrite(...)`](#rewrite)
+* [`addListener('downloadProgress', ...)`](#addlistenerdownloadprogress-)
+* [`addListener('inferenceProgress', ...)`](#addlistenerinferenceprogress-)
+* [`removeAllListeners()`](#removealllisteners)
+* [Interfaces](#interfaces)
+* [Enums](#enums)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### checkFeatureStatus(...)
+
+```typescript
+checkFeatureStatus(options?: FeatureOptions | undefined) => Promise<CheckFeatureStatusResult>
+```
+
+Check the current availability status of the rewriting feature.
+
+If the status is `DOWNLOADABLE`, you can download the feature
+using `downloadFeature(...)`.
+
+Only available on Android.
+
+| Param         | Type                                                      |
+| ------------- | --------------------------------------------------------- |
+| **`options`** | <code><a href="#featureoptions">FeatureOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#checkfeaturestatusresult">CheckFeatureStatusResult</a>&gt;</code>
+
+**Since:** 8.2.0
+
+--------------------
+
+
+### downloadFeature(...)
+
+```typescript
+downloadFeature(options?: FeatureOptions | undefined) => Promise<void>
+```
+
+Download the rewriting feature.
+
+The `downloadProgress` event listener will notify you about
+the download progress. The returned promise resolves when
+the download is complete or the feature is already available.
+
+Only available on Android.
+
+| Param         | Type                                                      |
+| ------------- | --------------------------------------------------------- |
+| **`options`** | <code><a href="#featureoptions">FeatureOptions</a></code> |
+
+**Since:** 8.2.0
+
+--------------------
+
+
+### rewrite(...)
+
+```typescript
+rewrite(options: RewriteOptions) => Promise<RewriteResult>
+```
+
+Rewrite the given text in the configured style.
+
+The `inferenceProgress` event listener will notify you about
+partial results as they are generated. The returned promise
+resolves with the full result.
+
+Only available on Android.
+
+| Param         | Type                                                      |
+| ------------- | --------------------------------------------------------- |
+| **`options`** | <code><a href="#rewriteoptions">RewriteOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#rewriteresult">RewriteResult</a>&gt;</code>
+
+**Since:** 8.2.0
+
+--------------------
+
+
+### addListener('downloadProgress', ...)
+
+```typescript
+addListener(eventName: 'downloadProgress', listenerFunc: (event: DownloadProgressEvent) => void) => Promise<PluginListenerHandle>
+```
+
+Called while the rewriting feature is being downloaded.
+
+Only available on Android.
+
+| Param              | Type                                                                                        |
+| ------------------ | ------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'downloadProgress'</code>                                                             |
+| **`listenerFunc`** | <code>(event: <a href="#downloadprogressevent">DownloadProgressEvent</a>) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 8.2.0
+
+--------------------
+
+
+### addListener('inferenceProgress', ...)
+
+```typescript
+addListener(eventName: 'inferenceProgress', listenerFunc: (event: InferenceProgressEvent) => void) => Promise<PluginListenerHandle>
+```
+
+Called when a new partial result is available during inference.
+
+Only available on Android.
+
+| Param              | Type                                                                                          |
+| ------------------ | --------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'inferenceProgress'</code>                                                              |
+| **`listenerFunc`** | <code>(event: <a href="#inferenceprogressevent">InferenceProgressEvent</a>) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 8.2.0
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => Promise<void>
+```
+
+Remove all listeners for this plugin.
+
+**Since:** 8.2.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### CheckFeatureStatusResult
+
+| Prop                | Type                                                    | Description                                               | Since |
+| ------------------- | ------------------------------------------------------- | --------------------------------------------------------- | ----- |
+| **`featureStatus`** | <code><a href="#featurestatus">FeatureStatus</a></code> | The current availability status of the rewriting feature. | 8.2.0 |
+
+
+#### FeatureOptions
+
+The feature availability depends on the configured output type
+and language. Therefore, `checkFeatureStatus(...)` and
+`downloadFeature(...)` take the same base options as `rewrite(...)`.
+
+| Prop             | Type                                              | Description                                            | Default                           | Since |
+| ---------------- | ------------------------------------------------- | ------------------------------------------------------ | --------------------------------- | ----- |
+| **`language`**   | <code><a href="#language">Language</a></code>     | The language of the input text.                        | <code>Language.English</code>     | 8.2.0 |
+| **`outputType`** | <code><a href="#outputtype">OutputType</a></code> | The style in which the input text should be rewritten. | <code>OutputType.Elaborate</code> | 8.2.0 |
+
+
+#### RewriteResult
+
+| Prop          | Type                  | Description                                                               | Since |
+| ------------- | --------------------- | ------------------------------------------------------------------------- | ----- |
+| **`results`** | <code>string[]</code> | The rewritten text suggestions, sorted in descending order of confidence. | 8.2.0 |
+
+
+#### RewriteOptions
+
+| Prop       | Type                | Description                                              | Since |
+| ---------- | ------------------- | -------------------------------------------------------- | ----- |
+| **`text`** | <code>string</code> | The text to rewrite. The input must be under 256 tokens. | 8.2.0 |
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+#### DownloadProgressEvent
+
+| Prop                       | Type                | Description                                  | Since |
+| -------------------------- | ------------------- | -------------------------------------------- | ----- |
+| **`totalBytesDownloaded`** | <code>number</code> | The total number of bytes downloaded so far. | 8.2.0 |
+
+
+#### InferenceProgressEvent
+
+| Prop       | Type                | Description                         | Since |
+| ---------- | ------------------- | ----------------------------------- | ----- |
+| **`text`** | <code>string</code> | The new text of the partial result. | 8.2.0 |
+
+
+### Enums
+
+
+#### FeatureStatus
+
+| Members            | Value                       | Description                                                 | Since |
+| ------------------ | --------------------------- | ----------------------------------------------------------- | ----- |
+| **`Available`**    | <code>'AVAILABLE'</code>    | The feature is available to use.                            | 8.2.0 |
+| **`Downloadable`** | <code>'DOWNLOADABLE'</code> | The feature can be downloaded using `downloadFeature(...)`. | 8.2.0 |
+| **`Downloading`**  | <code>'DOWNLOADING'</code>  | The feature is currently being downloaded.                  | 8.2.0 |
+| **`Unavailable`**  | <code>'UNAVAILABLE'</code>  | The feature is not available on this device.                | 8.2.0 |
+
+
+#### Language
+
+| Members        | Value                   | Since |
+| -------------- | ----------------------- | ----- |
+| **`English`**  | <code>'ENGLISH'</code>  | 8.2.0 |
+| **`French`**   | <code>'FRENCH'</code>   | 8.2.0 |
+| **`German`**   | <code>'GERMAN'</code>   | 8.2.0 |
+| **`Italian`**  | <code>'ITALIAN'</code>  | 8.2.0 |
+| **`Japanese`** | <code>'JAPANESE'</code> | 8.2.0 |
+| **`Korean`**   | <code>'KOREAN'</code>   | 8.2.0 |
+| **`Spanish`**  | <code>'SPANISH'</code>  | 8.2.0 |
+
+
+#### OutputType
+
+| Members            | Value                       | Description                                    | Since |
+| ------------------ | --------------------------- | ---------------------------------------------- | ----- |
+| **`Elaborate`**    | <code>'ELABORATE'</code>    | Elaborate the input text.                      | 8.2.0 |
+| **`Emojify`**      | <code>'EMOJIFY'</code>      | Insert appropriate emojis into the input text. | 8.2.0 |
+| **`Shorten`**      | <code>'SHORTEN'</code>      | Shorten the input text.                        | 8.2.0 |
+| **`Friendly`**     | <code>'FRIENDLY'</code>     | Make the input text more friendly.             | 8.2.0 |
+| **`Professional`** | <code>'PROFESSIONAL'</code> | Make the input text more professional.         | 8.2.0 |
+| **`Rephrase`**     | <code>'REPHRASE'</code>     | Rephrase the input text.                       | 8.2.0 |
+
+</docgen-api>
+
+## FAQ
+
+### What are the requirements to use this plugin?
+
+The rewriting is performed on-device by Gemini Nano. This requires a device that supports Gemini Nano, Android API level 26 or higher and a locked bootloader (see [Requirements](#requirements)). Use the `checkFeatureStatus(...)` method to check whether the feature is available on the device.
+
+### Why is this plugin only available on Android?
+
+The ML Kit GenAI APIs are based on Gemini Nano and AICore, which are currently only available on Android. On iOS and Web, all methods reject with an appropriate error.
+
+### How large can the input text be?
+
+The input must be under 256 tokens.
+
+### Why does `rewrite(...)` return multiple results?
+
+The model may return more than one suggestion. The suggestions are sorted in descending order of confidence, so the first result is the most confident one.
+
+### How do I get the rewritten text as a stream?
+
+Add a listener for the `inferenceProgress` event before calling `rewrite(...)`. The listener is called with each partial result as it is generated. The promise returned by `rewrite(...)` resolves with the full result.
+
+### 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
+
+- [Translation](https://capawesome.io/docs/sdks/capacitor/mlkit/translation/): Unofficial Capacitor plugin for ML Kit Translation.
+- [Smart Reply](https://capawesome.io/docs/sdks/capacitor/mlkit/smart-reply/): Unofficial Capacitor plugin for ML Kit Smart Reply.
+
+## Terms & Privacy
+
+This plugin uses the [Google ML Kit](https://developers.google.com/ml-kit):
+
+- [Terms & Privacy](https://developers.google.com/ml-kit/terms)
+- [Android Data Disclosure](https://developers.google.com/ml-kit/android-data-disclosure)
+- [iOS Data Disclosure](https://developers.google.com/ml-kit/ios-data-disclosure)
+
+## 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-mlkit/blob/main/packages/genai-rewriting/CHANGELOG.md).
+
+## License
+
+See [LICENSE](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/genai-rewriting/LICENSE).
+
+[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.