cordova-plugin-reteno 2.2.0 → 2.2.2

package/docs/Ionic/SetupGuide/Android.md

@@ -0,0 +1,173 @@
+# Android
+
+### Getting started with Reteno for Ionic (Cordova)
+
+## Installation
+
+> Requirement: `cordova-android >= 12.0.0`.
+
+1. Install plugin:
+
+```sh
+ionic cordova plugin add cordova-plugin-reteno --variable RETENO_ACCESS_KEY=YOUR_KEY
+```
+
+2. Install Ionic wrapper from npmjs:
+
+```sh
+npm install awesome-cordova-plugins-reteno @awesome-cordova-plugins/core
+```
+
+Choose the wrapper major that matches your `@awesome-cordova-plugins/core` (v5–v9). API is identical across versions — see the compatibility matrix in [Setup overview](./README.md#2-install-wrapper-awesome-cordova-plugins-reteno).
+
+3. Add Android platform if needed:
+
+```sh
+ionic cordova platform add android
+```
+
+## Configure via `config.xml`
+
+```xml
+<widget ...>
+  <plugin name="cordova-plugin-reteno" spec="cordova-plugin-reteno">
+    <variable name="RETENO_ACCESS_KEY" value="YOUR_KEY" />
+  </plugin>
+</widget>
+```
+
+Notes:
+
+- Access-key precedence: `RETENO_ACCESS_KEY` → deprecated `SDK_ACCESS_KEY` → AndroidManifest meta-data injected by the plugin. New integrations should use `RETENO_ACCESS_KEY`.
+- If you changed plugin variables, usually you need reinstall/re-add:
+  - `ionic cordova plugin rm cordova-plugin-reteno && ionic cordova plugin add ...`
+  - or `ionic cordova platform rm android && ionic cordova platform add android`
+
+## Request notification permission (Android 13+)
+
+Android 13+ (`targetSdkVersion >= 33`) requires runtime permission for notifications. The plugin injects `POST_NOTIFICATIONS` into the manifest, but you still must request it at runtime:
+
+```ts
+const granted = await this.reteno.requestNotificationPermission();
+// granted: 1 — granted, 0 — declined
+```
+
+## Initialize SDK
+
+Use `Platform.ready()` and call `this.reteno.init(...)` once. Full example is in [Setup overview](./README.md#initialize-the-sdk).
+
+## Firebase Cloud Messaging
+
+- Download `google-services.json` from Firebase Console.
+- Place it in project root or `resources/android/`.
+
+![](https://raw.githubusercontent.com/reteno-com/reteno-mobile-documentation/main/Ionic/SetupGuide/Resources/google-services-json.png)
+
+![](https://raw.githubusercontent.com/reteno-com/reteno-mobile-documentation/main/Ionic/SetupGuide/Resources/FirebaseConsole.png)
+
+![](https://raw.githubusercontent.com/reteno-com/reteno-mobile-documentation/main/Ionic/SetupGuide/Resources/CloudConsole1.png)
+
+![](https://raw.githubusercontent.com/reteno-com/reteno-mobile-documentation/main/Ionic/SetupGuide/Resources/CloudConsole2.png)
+
+Official references:
+
+- [Set up Firebase for FCM](https://docs.reteno.com/reference/setting-up-your-firebase-application-for-firebase-cloud-messaging)
+- [Connect app in Reteno](https://docs.reteno.com/docs/connect-your-mobile-app)
+
+## Without Firebasex
+
+If you do not need `cordova-plugin-firebasex` features, Reteno push still works on Android. For FCM to work, your Cordova Android project must have:
+
+1. `google-services.json` from Firebase Console.
+2. Google Services Gradle plugin (`com.google.gms.google-services`) applied.
+
+How to verify:
+
+- `platforms/android/app/google-services.json` exists.
+- `platforms/android/app/build.gradle` contains `com.google.gms.google-services`.
+- Build logs do not contain `google-services.json not found`.
+
+## Warning: Reteno + Firebasex
+
+If Firebasex registers its own `FirebaseMessagingService`, Reteno may not receive FCM callbacks.
+
+## Custom FCM service (optional)
+
+Only if you need custom native handling: extend `RetenoFirebaseMessagingService` and call `super` methods.
+
+## Capacitor setup (Android)
+
+Capacitor uses Cordova plugins through a compatibility layer, but does not execute Cordova plugin hooks. Some automatic steps from Cordova must be done manually.
+
+### 1. Install plugin and sync
+
+```sh
+npm install cordova-plugin-reteno
+npx cap sync android
+```
+
+Install the Ionic wrapper from npm:
+
+```sh
+npm install awesome-cordova-plugins-reteno @awesome-cordova-plugins/core
+```
+
+### 2. Configure `RETENO_ACCESS_KEY` in `capacitor.config.ts`
+
+```ts
+import { CapacitorConfig } from '@capacitor/cli';
+
+const config: CapacitorConfig = {
+  // ...
+  cordova: {
+    preferences: {
+      RETENO_ACCESS_KEY: 'YOUR_KEY',
+    },
+  },
+};
+
+export default config;
+```
+
+The plugin's `reteno.gradle` script automatically reads this value from `capacitor.config.json` (generated by Capacitor CLI from `capacitor.config.ts`) and patches the Android manifest at build time. No manual manifest editing is required.
+
+Then run:
+
+```sh
+npx cap sync android
+```
+
+You can also pass key explicitly in JS:
+
+```ts
+await this.reteno.init({ accessKey: 'YOUR_KEY' });
+```
+
+### 3. Add `google-services.json` manually
+
+Cordova hook that auto-copies `google-services.json` does not run in Capacitor.
+
+1. Download `google-services.json` from Firebase Console.
+2. Copy it to `android/app/google-services.json`.
+3. Run `npx cap sync android`.
+
+### 4. Verify Google Services Gradle plugin
+
+Check `android/app/build.gradle` contains:
+
+```gradle
+apply plugin: 'com.google.gms.google-services'
+```
+
+If not, add it manually or install `@capacitor-firebase/messaging` (or similar).
+
+### 5. Initialize and request permission
+
+```ts
+await this.reteno.init();
+const granted = await this.reteno.requestNotificationPermission();
+```
+
+## Deeplinks in push payloads
+
+Reteno can deliver deeplinks, but routing inside Ionic app should be handled by app-level deeplink layer (scheme/App Links/provider).

package/docs/Ionic/SetupGuide/IOS.md

@@ -0,0 +1,354 @@
+# Ionic iOS SDK Setup
+
+Official guide: https://docs.reteno.com/reference/ios
+
+## Minimum SDK Requirements
+
+- iOS 15.0+
+- Xcode 15.0+
+- Swift 5.7+
+
+## Install plugin and wrapper
+
+```sh
+ionic cordova plugin add cordova-plugin-reteno --variable RETENO_ACCESS_KEY=YOUR_KEY
+npm install awesome-cordova-plugins-reteno @awesome-cordova-plugins/core
+```
+
+For Ionic projects that use an older `@awesome-cordova-plugins/core` major (v5/v6/v7/v8), install the matching wrapper major — see the compatibility matrix in [Setup overview](./README.md#2-install-wrapper-awesome-cordova-plugins-reteno).
+
+In `config.xml` add:
+
+```xml
+<preference name="deployment-target" value="15.0" />
+<preference name="RETENO_ACCESS_KEY" value="YOUR_RETENO_ACCESS_KEY" />
+```
+
+`RETENO_ACCESS_KEY` is the preferred name. The deprecated `SDK_ACCESS_KEY` preference remains supported for backward compatibility.
+
+## Add Notification Service Extension (NSE)
+
+1. `File > New > Target...` -> `Notification Service Extension`
+2. Name: `NotificationServiceExtension`
+3. Do not activate scheme.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/reteno-com/reteno-mobile-documentation/main/Ionic/SetupGuide/Resources/create_notification_service_extension.png" width="50%"/>
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/reteno-com/reteno-mobile-documentation/main/Ionic/SetupGuide/Resources/choose_options_for_extension.png" width="50%"/>
+</p>
+
+4. Ensure extension deployment target equals main app target.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/reteno-com/reteno-mobile-documentation/main/Ionic/SetupGuide/Resources/configure_target.png" width="50%"/>
+</p>
+
+5. Replace `NotificationService.swift`:
+
+```swift
+import UserNotifications
+import Reteno
+
+class NotificationService: RetenoNotificationServiceExtension {}
+```
+
+## Add App Groups
+
+Enable App Groups in main target and `NotificationServiceExtension`.
+Group format:
+
+`group.{bundle_id}.reteno-local-storage`
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/reteno-com/reteno-mobile-documentation/main/Ionic/SetupGuide/Resources/add_group_main_target.png" width="50%"/>
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/reteno-com/reteno-mobile-documentation/main/Ionic/SetupGuide/Resources/app_groups_capability.png" width="50%"/>
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/reteno-com/reteno-mobile-documentation/main/Ionic/SetupGuide/Resources/add_group_in_extension.png" width="50%"/>
+</p>
+
+## Podfile for extension targets
+
+Main target pod is injected by plugin automatically.
+For extension targets add in `platforms/ios/Podfile`:
+
+```ruby
+target 'App' do
+  target 'NotificationServiceExtension' do
+    inherit! :search_paths
+    pod 'Reteno', '2.7.6'
+  end
+
+  target 'NotificationContentExtension' do
+    inherit! :search_paths
+    pod 'Reteno', '2.7.6'
+  end
+end
+```
+
+## Optional: Notification Content Extension (Images Carousel)
+
+Required for rich push with an **Images Carousel**. Provides the `UNNotificationContentExtension` entry point that renders the custom carousel UI.
+
+Official guide: https://docs.reteno.com/reference/ios-images-carousel
+
+### Create the extension target
+
+In Xcode: **File → New → Target → Notification Content Extension**. Name it `NotificationContentExtension`.
+
+### Replace extension files
+
+1. **Delete** the generated `MainInterface.storyboard` — it is not used with `RetenoCarouselNotificationViewController`.
+2. Replace `NotificationViewController.swift`:
+
+```swift
+import Reteno
+
+final class NotificationViewController: RetenoCarouselNotificationViewController {}
+```
+
+### Update `Info.plist` of the NCE
+
+Open `NotificationContentExtension/Info.plist` as source code and replace the `NSExtension` dict with:
+
+```xml
+<key>NSExtension</key>
+<dict>
+    <key>NSExtensionAttributes</key>
+    <dict>
+        <key>UNNotificationExtensionCategory</key>
+        <string>ImageCarousel</string>
+        <key>UNNotificationExtensionInitialContentSizeRatio</key>
+        <real>0.5</real>
+        <key>UNNotificationExtensionUserInteractionEnabled</key>
+        <true/>
+    </dict>
+    <key>NSExtensionPointIdentifier</key>
+    <string>com.apple.usernotifications.content-extension</string>
+    <key>NSExtensionPrincipalClass</key>
+    <string>$(PRODUCT_MODULE_NAME).NotificationViewController</string>
+</dict>
+```
+
+### Deployment target
+
+Make sure the NCE **Deployment Target** in Xcode matches the main app target (iOS 15.0+). A mismatch is the most common reason carousel images fail to display.
+
+### Embed App Extensions — Copy only when installing
+
+> **This step must be done manually in Xcode.**
+
+In Xcode: **Main target → Build Phases → Embed App Extensions**. For **both** `NotificationServiceExtension` and `NotificationContentExtension` ensure **"Copy only when installing"** is **unchecked**.
+
+If this checkbox is left on, the extensions will not be embedded during Debug builds and carousel images will not appear.
+
+## Capacitor setup (iOS)
+
+Capacitor uses Cordova plugins through a compatibility layer, but does not execute Cordova plugin hooks. Some automatic Cordova steps must be done manually.
+
+### 1. Install plugin and sync
+
+```sh
+npm install cordova-plugin-reteno
+npx cap sync ios
+```
+
+Install the Ionic wrapper from npm:
+
+```sh
+npm install awesome-cordova-plugins-reteno @awesome-cordova-plugins/core
+```
+
+### 2. Configure preferences and notification handling in `capacitor.config.ts`
+
+```ts
+import { CapacitorConfig } from '@capacitor/cli';
+
+const config: CapacitorConfig = {
+  // ...
+  ios: {
+    // Reteno must remain UNUserNotificationCenter.delegate to capture the push
+    // response that cold-launched the app.
+    handleApplicationNotifications: false,
+  },
+  cordova: {
+    preferences: {
+      RETENO_ACCESS_KEY: 'YOUR_RETENO_ACCESS_KEY',
+      IOS_DEVICE_TOKEN_HANDLING_MODE: 'manual', // default
+    },
+  },
+};
+
+export default config;
+```
+
+Run:
+
+```sh
+npx cap sync ios
+```
+
+Capacitor installs its own `UNUserNotificationCenter` delegate by default. The `handleApplicationNotifications: false` setting prevents that router from replacing Reteno, allowing Reteno to capture a cold-start push response and replay its linked in-app after JavaScript initialization.
+
+> This setting is required for push-linked in-app messages on a cold start. If the app uses Capacitor push or local-notification plugins, their notification callbacks must instead be forwarded explicitly because Capacitor's notification router is disabled.
+
+### 3. Podfile path and extension pods
+
+In Capacitor projects Podfile is `ios/App/Podfile` (not `platforms/ios/Podfile`).
+
+For extension targets (`NotificationServiceExtension`, `NotificationContentExtension`), add pods manually inside main target block:
+
+```ruby
+target 'App' do
+  # ... existing pods ...
+
+  target 'NotificationServiceExtension' do
+    inherit! :search_paths
+    pod 'Reteno', '2.7.6'
+  end
+
+  target 'NotificationContentExtension' do
+    inherit! :search_paths
+    pod 'Reteno', '2.7.6'
+  end
+end
+```
+
+Then run:
+
+```sh
+cd ios/App && pod install
+```
+
+### 4. Xcode setup
+
+Open `ios/App/App.xcworkspace` and complete the same iOS setup steps:
+
+- Add NSE target.
+- Add NCE target (if using carousel).
+- Enable App Groups for app + extensions.
+- Uncheck `Copy only when installing` for app extensions.
+
+### 5. Firebase setup (if using FCM)
+
+1. Add `GoogleService-Info.plist` to the main app target in Xcode.
+2. Add `pod 'FirebaseMessaging'` to `ios/App/Podfile` in main target.
+3. Run `cd ios/App && pod install`.
+
+No AppDelegate changes are required for standard flow.
+
+### 6. Initialize and request permission
+
+```ts
+await this.reteno.init();
+await this.reteno.requestNotificationPermission();
+```
+
+## Initialize SDK
+
+Call `this.reteno.init(...)` after `Platform.ready()`. See [Setup overview](./README.md#initialize-the-sdk).
+
+## Request Notification Permission
+
+```ts
+await this.reteno.requestNotificationPermission();
+```
+
+## Provide Device Token
+
+```ts
+await this.reteno.setDeviceToken(token);
+```
+
+## Using FCM (Firebase Cloud Messaging) on iOS
+
+### 1. `FirebaseMessaging` pod
+
+Cordova flow: plugin includes `FirebaseMessaging` pod automatically via `plugin.xml`.
+Capacitor flow: verify `pod 'FirebaseMessaging'` exists in `ios/App/Podfile`; if missing, add it manually.
+
+### 2. Add `GoogleService-Info.plist`
+
+Download `GoogleService-Info.plist` from the [Firebase Console](https://console.firebase.google.com/) and add it to your **iOS app target** in Xcode:
+
+- Cordova: open `platforms/ios/<AppName>.xcworkspace`.
+- Capacitor: open `ios/App/App.xcworkspace`.
+- Drag `GoogleService-Info.plist` into the project navigator under the main app target.
+- Make sure **"Copy items if needed"** is checked and the file is added to the **main app target** (not only extension targets).
+
+If your app calls `FirebaseApp.configure()` without this file, Firebase will crash at runtime. The plugin avoids auto-configuring Firebase when the file is missing and logs a warning in manual mode.
+
+### 3. Configure AppDelegate
+
+Nothing to do. Firebase iOS SDK uses **method swizzling** by default — it automatically intercepts `didRegisterForRemoteNotificationsWithDeviceToken` and forwards the APNS token to Firebase without any AppDelegate code.
+
+### 4. `IOS_DEVICE_TOKEN_HANDLING_MODE` defaults to `manual`
+
+`IOS_DEVICE_TOKEN_HANDLING_MODE` defaults to `manual`, so no extra config is required for the Firebase flow in most cases.
+
+If you previously overrode it to `automatic`, switch it back to `manual` to use FCM token forwarding.
+Only set `automatic` when you intentionally want APNS-only token handling by the native Reteno SDK.
+
+Supported modes:
+
+- `manual` (default)
+- `automatic`
+
+Any value other than `automatic` is treated as `manual`.
+Mode is read during `init()` and cannot be changed at runtime from JS.
+
+Change mode in `config.xml`:
+
+```xml
+<preference name="IOS_DEVICE_TOKEN_HANDLING_MODE" value="automatic" />
+```
+
+After changes run `ionic cordova prepare ios` and rebuild.
+
+For Capacitor apps, set this value in `capacitor.config.ts` under `cordova.preferences` and run `npx cap sync ios`.
+
+When `IOS_DEVICE_TOKEN_HANDLING_MODE` is `manual` **and** Firebase is configured (either already configured by the app or auto-configured because `GoogleService-Info.plist` is present), the plugin automatically:
+
+1. Subscribes to Firebase Messaging delegate token updates — every future FCM token rotation is forwarded to Reteno immediately.
+2. Tries to forward the already-cached FCM token on warm starts.
+
+## In-app status/pause
+
+Usage examples are documented in:
+
+- [InAppMessages/README.md](../InAppMessages/README.md)
+
+## Screen tracking note
+
+In Ionic/Cordova apps use manual tracking:
+
+```ts
+await this.reteno.logScreenView('ScreenName');
+```
+
+Automatic native screen tracking is usually not meaningful in WebView-based apps.
+
+## Custom Notification Behavior (iOS)
+
+```ts
+await this.reteno.setWillPresentNotificationOptions({
+  options: ['badge', 'sound', 'banner'],
+  emitEvent: true,
+});
+
+await this.reteno.setDidReceiveNotificationResponseHandler({
+  enabled: true,
+  emitEvent: true,
+});
+```
+
+## Deeplinks in push payloads
+
+For hybrid routing use your app deeplink layer (custom scheme / Universal Links / provider).

package/docs/Ionic/SetupGuide/README.md

@@ -0,0 +1,167 @@
+# Ionic SDK Setup
+
+### Reteno for Ionic (Cordova)
+
+## Overview
+
+`Reteno` for Ionic uses the `cordova-plugin-reteno` plugin with the Ionic Native wrapper package `awesome-cordova-plugins-reteno`.
+
+##### Supported stack
+
+- Ionic app with Cordova runtime
+- iOS 15.0+
+- Android with `cordova-android >= 12.0.0`
+
+`cordova-plugin-reteno@2.2.2` includes Reteno Android SDK 2.10.2 and Reteno iOS SDK 2.7.6.
+
+## Install plugin and wrapper
+
+### 1. Install Cordova plugin
+
+```sh
+ionic cordova plugin add cordova-plugin-reteno --variable RETENO_ACCESS_KEY=YOUR_KEY
+```
+
+### 2. Install wrapper (`awesome-cordova-plugins-reteno`)
+
+Pick the wrapper major version that matches your installed `@awesome-cordova-plugins/core`
+(the core package tracks Ionic ecosystem majors). The core runtime API is consistent across
+v5–v9. Newer wrapper releases may add TypeScript declarations for fields supported by the
+Cordova plugin. For example, `awesome-cordova-plugins-reteno@9.2.0` adds the `marketId`
+declaration.
+
+| Wrapper version | `@awesome-cordova-plugins/core` | Install |
+|---|---|---|
+| `awesome-cordova-plugins-reteno@5` | `^5.45.0` | `npm install awesome-cordova-plugins-reteno@5 @awesome-cordova-plugins/core@5` |
+| `awesome-cordova-plugins-reteno@6` | `^6.16.0` | `npm install awesome-cordova-plugins-reteno@6 @awesome-cordova-plugins/core@6` |
+| `awesome-cordova-plugins-reteno@7` | `^7.0.1` | `npm install awesome-cordova-plugins-reteno@7 @awesome-cordova-plugins/core@7` |
+| `awesome-cordova-plugins-reteno@8` | `^8.1.0` | `npm install awesome-cordova-plugins-reteno@8 @awesome-cordova-plugins/core@8` |
+| `awesome-cordova-plugins-reteno@9` | `^9.1.2` | `npm install awesome-cordova-plugins-reteno@9 @awesome-cordova-plugins/core@9` |
+
+If you already have `@awesome-cordova-plugins/core` installed, keep that major and install the matching wrapper:
+
+```sh
+# Example: core already at v8 — install wrapper v8
+npm install awesome-cordova-plugins-reteno@8
+```
+
+Fresh install of latest:
+
+```sh
+npm install awesome-cordova-plugins-reteno @awesome-cordova-plugins/core
+```
+
+### 3. Register provider
+
+```ts
+import { AwesomeCordovaPluginReteno } from 'awesome-cordova-plugins-reteno';
+
+@NgModule({
+  providers: [AwesomeCordovaPluginReteno],
+})
+export class AppModule {}
+```
+
+## Initialize the SDK
+
+Call `init(...)` after `Platform.ready()`:
+
+```ts
+import { Platform } from '@ionic/angular';
+import { AwesomeCordovaPluginReteno } from 'awesome-cordova-plugins-reteno';
+
+constructor(
+  private platform: Platform,
+  private reteno: AwesomeCordovaPluginReteno,
+) {
+  this.platform.ready().then(async () => {
+    await this.reteno.init({
+      isDebugMode: false,
+      pauseInAppMessages: false,
+      pausePushInAppMessages: false,
+      inAppMessagesPauseBehaviour: 'POSTPONE_IN_APPS',
+      lifecycleTrackingOptions: {
+        appLifecycleEnabled: true,
+        foregroundLifecycleEnabled: false,
+        pushSubscriptionEnabled: true,
+        sessionStartEventsEnabled: true,
+        sessionEndEventsEnabled: true,
+      },
+      sessionDurationSeconds: 30 * 60,
+      isAutomaticScreenReportingEnabled: false, // iOS only
+    });
+  });
+}
+```
+
+### Options reference
+
+All fields are optional.
+
+| Option | Type | iOS | Android | Notes |
+|---|---|:---:|:---:|---|
+| `accessKey` | `string` | ✅ | ✅ | Overrides `RETENO_ACCESS_KEY` (or legacy `SDK_ACCESS_KEY`) from `config.xml`. Usually not needed. |
+| `isDebugMode` | `boolean` | ✅ | ✅ | Enables near real-time event monitoring for test devices. |
+| `pauseInAppMessages` | `boolean` | ✅ | ✅ | Start SDK with in-app messages paused. |
+| `pausePushInAppMessages` | `boolean` | — | ✅ | Android-only. Safe to pass on iOS (ignored). |
+| `inAppMessagesPauseBehaviour` | `'SKIP_IN_APPS' \| 'POSTPONE_IN_APPS'` | ✅ | — | iOS-only via `init()`. On Android use runtime method in [InAppMessages](../InAppMessages/README.md). |
+| `isAutomaticScreenReportingEnabled` | `boolean` | ✅ | — | iOS-only. Not recommended in hybrid WebView apps; use `logScreenView()` manually. |
+| `lifecycleTrackingOptions` | `object \| 'ALL' \| 'NONE'` | ✅ | ✅ | See [App Lifecycle Events](../AppLifeCycleEvents/README.md). On iOS, set before/inside `init()`. |
+| `sessionDurationSeconds` | `number` | ✅ | ✅ | Optional session reset duration (Android 2.9.4+, iOS 2.7.0+). |
+
+### Access key
+
+Recommended: set `RETENO_ACCESS_KEY` in `config.xml` (or via `ionic cordova plugin add --variable RETENO_ACCESS_KEY=...`). The plugin reads it automatically, so passing `accessKey` in JS is optional. The deprecated `SDK_ACCESS_KEY` name remains supported for backward compatibility.
+
+### Calling `init()` multiple times
+
+`init()` is idempotent: after first successful call, next calls resolve immediately without re-initializing native SDK. Options from later calls are ignored.
+
+## TypeScript types
+
+All payload and response types are exported from the wrapper package. Prefer them over `any` for better autocompletion and type safety:
+
+```ts
+import {
+  AwesomeCordovaPluginReteno,
+  RetenoInitializeOptions,
+  UserAttributes,
+  UserAttributesAnonymous,
+  SetUserAttributesPayload,
+  LogEventPayload,
+  LogEcommerceEventPayload,
+  NotificationPresentationOption,
+  InAppLifecyclePayload,
+  AppInboxMessage,
+  AppInboxMessages,
+  GetRecommendationsPayload,
+  RecommendationsResponse,
+  RetenoPushButtonClickedPayload,
+} from 'awesome-cordova-plugins-reteno';
+```
+
+## Setup guides
+
+- [iOS](./IOS.md)
+- [Android](./Android.md)
+
+Capacitor developers should use the dedicated sections inside platform setup guides:
+
+- [Capacitor setup (iOS)](./IOS.md#capacitor-setup-ios)
+- [Capacitor setup (Android)](./Android.md#capacitor-setup-android)
+
+## Feature guides
+
+- [Tracking user information](../Tracking%20user%20information/README.md)
+- [Tracking user behaviour](../Tracking%20user%20behaviour/README.md)
+- [Push notification](../Push%20notification/README.md)
+- [In-app messages](../InAppMessages/README.md)
+- [Ecommerce](../Ecommerce/README.md)
+- [Recommendations](../Recommendations/README.md)
+- [App Inbox](../AppInbox/README.md)
+- [Action Buttons](../Action%20Buttons/README.md)
+- [App Lifecycle Events](../AppLifeCycleEvents/README.md)
+
+##### Licence
+
+Reteno Cordova plugin is released under MIT. See [LICENSE](https://github.com/reteno-com/reteno-cordova/blob/main/LICENSE).