feat(mobile-messaging): sync wrapper with upstream SDK v8.6.0

Add chat/config APIs introduced in recent plugin releases and mark
stale members as deprecated instead of removing them.

src/@awesome-cordova-plugins/plugins/applovin/index.ts

@@ -3,27 +3,10 @@ import { AwesomeCordovaNativePlugin, Cordova, Plugin } from '@awesome-cordova-pl
 import { Observable } from 'rxjs';
 
 export interface InitializeConfig {
-  /**
-   * @deprecated Never populated by the native SDKs. Use `hasUserConsent` instead.
-   */
-  hasUserConsentValue?: boolean;
-  /**
-   * @deprecated Never populated by the native SDKs, and the underlying `isAgeRestrictedUser`
-   * field was removed upstream in cordova-plugin-applovin-max@2.0.0.
-   */
-  isAgeRestrictedUserValue?: boolean;
-  /**
-   * @deprecated Never populated by the native SDKs. Use `isDoNotSell` instead.
-   */
-  isDoNotSellValue?: boolean;
-  /**
-   * @deprecated Never populated by the native SDKs. Use `isTablet` instead.
-   */
-  isTabletValue?: boolean;
-  hasUserConsent: boolean;
-  isDoNotSell: boolean;
-  isTablet: boolean;
-  countryCode: string;
+  hasUserConsentValue: boolean;
+  isAgeRestrictedUserValue: boolean;
+  isDoNotSellValue: boolean;
+  isTabletValue: boolean;
 }
 
 export interface AdInfo {
@@ -34,11 +17,6 @@ export interface AdInfo {
   revenue: number;
 }
 
-export interface AdRewardInfo extends AdInfo {
-  rewardLabel: string;
-  rewardAmount: number;
-}
-
 export enum AdViewPosition {
   TOP_CENTER = 'top_center',
   TOP_RIGHT = 'top_right',
@@ -50,10 +28,6 @@ export enum AdViewPosition {
   BOTTOM_RIGHT = 'bottom_right',
 }
 
-/**
- * @deprecated Only produced by the now-removed `getConsentDialogState` method
- * (removed upstream in cordova-plugin-applovin-max@2.0.0).
- */
 export enum ConsentDialogState {
   UNKNOWN = 0,
   APPLIES = 1,
@@ -106,22 +80,11 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  /**
-   * Check whether the SDK has been initialized.
-   */
-  @Cordova()
-  isInitialized(): Promise<boolean> {
-    return;
-  }
-
   @Cordova()
   showMediationDebugger(): Promise<any> {
     return;
   }
 
-  /**
-   * @deprecated Removed upstream in cordova-plugin-applovin-max@2.0.0.
-   */
   @Cordova()
   getConsentDialogState(): Promise<ConsentDialogState> {
     return;
@@ -137,17 +100,11 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  /**
-   * @deprecated Removed upstream in cordova-plugin-applovin-max@2.0.0.
-   */
   @Cordova()
   setIsAgeRestrictedUser(isAgeRestrictedUser: boolean): Promise<any> {
     return;
   }
 
-  /**
-   * @deprecated Removed upstream in cordova-plugin-applovin-max@2.0.0.
-   */
   @Cordova()
   isAgeRestrictedUser(): Promise<boolean> {
     return;
@@ -173,11 +130,8 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  /**
-   * @param {boolean} muted Whether ads should be muted.
-   */
   @Cordova()
-  setMuted(muted: boolean): Promise<any> {
+  setMuted(): Promise<boolean> {
     return;
   }
 
@@ -191,19 +145,6 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  /** SEGMENT TARGETING */
-
-  /**
-   * Add a segment for segment targeting. Must be called before `initialize()`.
-   *
-   * @param {number} key The segment key.
-   * @param {number[]} values The segment values.
-   */
-  @Cordova()
-  addSegment(key: number, values: number[]): Promise<any> {
-    return;
-  }
-
   @Cordova()
   trackEvent(event: string, parameters?: object): Promise<any> {
     return;
@@ -226,11 +167,6 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  @Cordova()
-  updateBannerPosition(adUnitId: string, position: AdViewPosition): Promise<any> {
-    return;
-  }
-
   @Cordova()
   setBannerExtraParameter(adUnitId: string, key: string, value: string): Promise<any> {
     return;
@@ -251,46 +187,6 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  @Cordova({
-    eventObservable: true,
-    event: 'OnBannerAdLoadedEvent',
-  })
-  onBannerAdLoaded(): Observable<AdInfo> {
-    return;
-  }
-
-  @Cordova({
-    eventObservable: true,
-    event: 'OnBannerAdLoadFailedEvent',
-  })
-  onBannerAdLoadFailed(): Observable<AdInfo> {
-    return;
-  }
-
-  @Cordova({
-    eventObservable: true,
-    event: 'OnBannerAdClickedEvent',
-  })
-  onBannerAdClicked(): Observable<AdInfo> {
-    return;
-  }
-
-  @Cordova({
-    eventObservable: true,
-    event: 'OnBannerAdExpandedEvent',
-  })
-  onBannerAdExpanded(): Observable<AdInfo> {
-    return;
-  }
-
-  @Cordova({
-    eventObservable: true,
-    event: 'OnBannerAdCollapsedEvent',
-  })
-  onBannerAdCollapsed(): Observable<AdInfo> {
-    return;
-  }
-
   /** MRECS */
 
   @Cordova()
@@ -308,11 +204,6 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  @Cordova()
-  updateMRecPosition(adUnitId: string, position: AdViewPosition): Promise<any> {
-    return;
-  }
-
   @Cordova()
   setMRecExtraParameter(adUnitId: string, key: string, value: string): Promise<any> {
     return;
@@ -333,46 +224,6 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  @Cordova({
-    eventObservable: true,
-    event: 'OnMRecAdLoadedEvent',
-  })
-  onMRecAdLoaded(): Observable<AdInfo> {
-    return;
-  }
-
-  @Cordova({
-    eventObservable: true,
-    event: 'OnMRecAdLoadFailedEvent',
-  })
-  onMRecAdLoadFailed(): Observable<AdInfo> {
-    return;
-  }
-
-  @Cordova({
-    eventObservable: true,
-    event: 'OnMRecAdClickedEvent',
-  })
-  onMRecAdClicked(): Observable<AdInfo> {
-    return;
-  }
-
-  @Cordova({
-    eventObservable: true,
-    event: 'OnMRecAdExpandedEvent',
-  })
-  onMRecAdExpanded(): Observable<AdInfo> {
-    return;
-  }
-
-  @Cordova({
-    eventObservable: true,
-    event: 'OnMRecAdCollapsedEvent',
-  })
-  onMRecAdCollapsed(): Observable<AdInfo> {
-    return;
-  }
-
   /** INTERSTITIALS */
 
   @Cordova()
@@ -380,14 +231,6 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  /**
-   * @param {string} adUnitId The ad unit id to check.
-   */
-  @Cordova()
-  isInterstitialReady(adUnitId: string): Promise<boolean> {
-    return;
-  }
-
   @Cordova()
   showInterstitial(adUnitId: string, placement?: string): Promise<any> {
     return;
@@ -406,14 +249,6 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  @Cordova({
-    eventObservable: true,
-    event: 'OnInterstitialClickedEvent',
-  })
-  onInterstitialClicked(): Observable<AdInfo> {
-    return;
-  }
-
   @Cordova({
     eventObservable: true,
     event: 'OnInterstitialLoadFailedEvent',
@@ -453,14 +288,6 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  /**
-   * @param {string} adUnitId The ad unit id to check.
-   */
-  @Cordova()
-  isRewardedAdReady(adUnitId: string): Promise<boolean> {
-    return;
-  }
-
   @Cordova()
   showRewardedAd(adUnitId: string, placement?: string): Promise<any> {
     return;
@@ -479,14 +306,6 @@ export class Applovin extends AwesomeCordovaNativePlugin {
     return;
   }
 
-  @Cordova({
-    eventObservable: true,
-    event: 'OnRewardedAdClickedEvent',
-  })
-  onRewardedAdClicked(): Observable<AdInfo> {
-    return;
-  }
-
   @Cordova({
     eventObservable: true,
     event: 'OnRewardedAdLoadFailedEvent',
@@ -513,17 +332,9 @@ export class Applovin extends AwesomeCordovaNativePlugin {
 
   @Cordova({
     eventObservable: true,
-    event: 'OnRewardedAdFailedToDisplayEvent',
+    event: 'OnRewardedAdAdFailedToDisplayEvent',
   })
   onRewardedAdAdFailedToDisplay(): Observable<AdInfo> {
     return;
   }
-
-  @Cordova({
-    eventObservable: true,
-    event: 'OnRewardedAdReceivedRewardEvent',
-  })
-  onRewardedAdReceivedReward(): Observable<AdRewardInfo> {
-    return;
-  }
 }

src/@awesome-cordova-plugins/plugins/mobile-messaging/index.ts

@@ -9,6 +9,9 @@ export type Event =
   | 'notificationTapped'
   | 'tokenReceived'
   | 'registrationUpdated'
+  /**
+   * @deprecated No longer part of the supported events list in the upstream SDK (confirmed absent as of v8.6.0, and as far back as v5.0.0).
+   */
   | 'geofenceEntered'
   | 'actionTapped'
   | 'installationUpdated'
@@ -18,6 +21,9 @@ export type Event =
   | 'inAppChat.availabilityUpdated'
   | 'inAppChat.unreadMessageCounterUpdated'
   | 'deeplink'
+  /**
+   * @deprecated No longer part of the supported events list in the upstream SDK (confirmed absent as of v8.6.0, and as far back as v5.0.0).
+   */
   | 'inAppChat.viewStateChanged';
 
 export interface CustomEvent {
@@ -34,6 +40,14 @@ export interface Configuration {
   geofencingEnabled?: boolean;
   inAppChatEnabled?: boolean;
   fullFeaturedInAppsEnabled?: boolean | undefined;
+  /**
+   * Set to true to enable debug logging.
+   */
+  loggingEnabled?: boolean;
+  /**
+   * List of trusted domain strings for web views, e.g. ['example.com', 'trusted.org']
+   */
+  trustedDomains?: string[];
   /**
    * Message storage save callback
    */
@@ -42,12 +56,40 @@ export interface Configuration {
   ios?: {
     notificationTypes?: string[]; // ['alert', 'badge', 'sound']
     forceCleanup?: boolean;
+    /**
+     * @deprecated Removed upstream in v7.3.0. Replaced by the top-level `loggingEnabled` option.
+     */
     logging?: boolean;
+    /**
+     * Set to true to disable automatic registration for remote notifications. Default: false
+     */
+    registeringForRemoteNotificationsDisabled?: boolean;
+    /**
+     * Set to true to prevent the SDK from overriding UNUserNotificationCenterDelegate. Default: false
+     */
+    overridingNotificationCenterDelegateDisabled?: boolean;
+    /**
+     * Set to true to prevent the SDK from unregistering for remote notifications when stopping the SDK or after depersonalization. Default: false
+     */
+    unregisteringForRemoteNotificationsDisabled?: boolean;
+    /**
+     * Settings for web view configuration in in-app messages
+     */
+    webViewSettings?: {
+      title?: string;
+      barTintColor?: string;
+      titleColor?: string;
+      tintColor?: string;
+    };
   };
   android?: {
     notificationIcon?: string; // a resource name for a status bar icon (without extension), located in '/platforms/android/app/src/main/res/mipmap'
+    notificationChannelId?: string; // identifier for notification channel
+    notificationChannelName?: string; // user visible name for notification channel
+    notificationSound?: string; // a resource name for a notification sound (without extension), located in '/platforms/android/app/src/main/res/raw'
     multipleNotifications?: boolean; // set to 'true' to enable multiple notifications
     notificationAccentColor?: string; // set to hex color value in format '#RRGGBB' or '#AARRGGBB'
+    withBannerForegroundNotificationsEnabled?: boolean; // set to true to always display Push notifications as Banner
     firebaseOptions?: {
       apiKey: string;
       applicationId: string;
@@ -78,9 +120,9 @@ export interface Configuration {
           icon?: string;
           textInputActionButtonTitle?: string;
           textInputPlaceholder?: string;
-        }
+        },
       ];
-    }
+    },
   ];
 }
 
@@ -110,7 +152,14 @@ export interface Installation {
   deviceModel?: string;
   deviceSecure?: boolean;
   language?: string;
+  /**
+   * @deprecated Renamed upstream in v7.9.1 to `deviceTimezoneOffset`.
+   */
   deviceTimezoneId?: string;
+  /**
+   * UTC-related timezone offset that identifies the current timezone of a device.
+   */
+  deviceTimezoneOffset?: string;
   applicationUserId?: string;
   deviceName?: string;
   customAttributes?: Record<string, string | number | boolean>;
@@ -129,6 +178,14 @@ export interface PersonalizeContext {
   userIdentity: UserIdentity;
   userAttributes?: Record<string, string | number | boolean | any[]>;
   forceDepersonalize?: boolean;
+  /**
+   * Set to true if you want to keep the installation as a lead when personalizing it. Default: false
+   */
+  keepAsLead?: boolean;
+  /**
+   * Set to true to mark this installation as primary for the personalized user. Default: false
+   */
+  setDeviceAsPrimary?: boolean;
 }
 
 export interface GeoData {
@@ -276,6 +333,17 @@ export interface ChatSettingsIOS {
   navigationBarTitleColor: string;
 }
 
+/**
+ * Exception raised by the in-app chat widget and passed to the handler registered via `setChatExceptionHandler`.
+ */
+export interface ChatException {
+  code: string;
+  name: string;
+  message: string;
+  origin: string;
+  platform: string;
+}
+
 /**
  * @name Mobile Messaging
  * @description
@@ -665,7 +733,7 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin {
 
   /**
    * Updates JWT used for user data fetching and personalization.
-   * 
+   *
    * @name setUserDataJwt
    * @param jwt - JWT in a predefined format
    * @param {Function} errorCallback will be called on error
@@ -674,4 +742,127 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin {
   setUserDataJwt(jwt: string, errorCallback?: (error: MobileMessagingError) => void) {
     return;
   }
+
+  /**
+   * Un register all handlers for a MobileMessaging library event.
+   *
+   * @name unregisterAllHandlers
+   * @param event
+   */
+  @Cordova({
+    sync: true,
+  })
+  unregisterAllHandlers(event: Event): void {
+    return;
+  }
+
+  /**
+   * Sets the JWT provider used to authenticate in-app chat sessions.
+   *
+   * The `jwtProvider` callback returns a JSON Web Token (JWT) used for chat authentication,
+   * either synchronously (returning a string) or asynchronously (returning a Promise<string>).
+   * It may be invoked multiple times during the widget's lifecycle, so it should always return
+   * a fresh and valid JWT.
+   *
+   * @param jwtProvider A callback function that returns a JWT string or a Promise that resolves to one.
+   * @param errorCallback Optional error handler for catching exceptions thrown during JWT generation.
+   */
+  @Cordova({
+    sync: true,
+  })
+  setChatJwtProvider(jwtProvider: () => string | Promise<string>, errorCallback?: (error: any) => void): void {
+    return;
+  }
+
+  /**
+   * Sets the chat exception handler in case you want to intercept and display errors coming
+   * from the chat on your own (instead of relying on the prebuilt error banners).
+   * Passing `null` removes the previously set handler.
+   *
+   * @param exceptionHandler A function called with the chat exception when it is triggered, or `null` to remove the handler.
+   * @param errorCallback Optional error handler for catching exceptions thrown when handling exceptions from the native side.
+   */
+  @Cordova({
+    sync: true,
+  })
+  setChatExceptionHandler(
+    exceptionHandler: ((exception: ChatException) => void) | null,
+    errorCallback?: (error: any) => void
+  ): void {
+    return;
+  }
+
+  /**
+   * Checks if in-app chat is currently available.
+   *
+   * @name isChatAvailable
+   * @param resultCallback will be called upon completion with the boolean availability value.
+   */
+  @Cordova({ sync: true })
+  isChatAvailable(resultCallback: (available: boolean) => void): void {
+    return;
+  }
+
+  /**
+   * Sets chat language.
+   *
+   * @name setLanguage
+   * @param language to be set
+   * @param {Function} errorCallback will be called on error
+   */
+  @Cordova()
+  setLanguage(language: string, errorCallback?: (error: MobileMessagingError) => void) {
+    return;
+  }
+
+  /**
+   * Set contextual data of the widget.
+   *
+   * @param data contextual data in the form of a JSON string
+   * @param allMultiThreadStrategy multi-thread strategy flag, true -> ALL, false -> ACTIVE
+   * @param {Function} errorCallback will be called on error
+   */
+  @Cordova()
+  sendContextualData(
+    data: string,
+    allMultiThreadStrategy: boolean,
+    errorCallback?: (error: MobileMessagingError) => void
+  ) {
+    return;
+  }
+
+  /**
+   * Cleans up the SDK, removing all data and stopping all services.
+   * After cleanup, you should call `init()` again with a new configuration to restart the SDK.
+   * The JWT supplier is also cleared during cleanup.
+   *
+   * @name cleanup
+   */
+  @Cordova()
+  cleanup(): Promise<any> {
+    return;
+  }
+
+  /**
+   * Sets chat customization.
+   *
+   * @name setChatCustomization
+   * @param customization Chat customization JSON object.
+   */
+  @Cordova()
+  setChatCustomization(customization: any): Promise<any> {
+    return;
+  }
+
+  /**
+   * Sets widget theme.
+   *
+   * @name setWidgetTheme
+   * @param widgetTheme Widget theme name.
+   * @param {Function} errorCallback will be called on error
+   */
+  @Cordova()
+  setWidgetTheme(widgetTheme: string, errorCallback?: (error: MobileMessagingError) => void) {
+    return;
+  }
 }