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/airship/index.ts

@@ -35,7 +35,7 @@ declare const window: Window & { Airship: any };
   pluginName: 'Airship',
   plugin: '@ua/cordova-airship',
   pluginRef: 'Airship',
-  repo: 'https://github.com/urbanairship/urbanairship-cordova',
+  repo: 'https://www.npmjs.com/package/@ua/cordova-airship',
   install: 'ionic cordova plugin add @ua/cordova-airship',
   platforms: ['Android', 'iOS'],
 })
@@ -52,14 +52,6 @@ export class Airship extends AwesomeCordovaNativePlugin {
   public preferenceCenter: AirshipPreferenceCenter;
   public privacyManager: AirshipPrivacyManager;
   public push: AirshipPush;
-  /**
-   * Live Activity manager. iOS only.
-   */
-  public liveActivityManager: AirshipLiveActivityManager;
-  /**
-   * Live Update manager. Android only.
-   */
-  public liveUpdateManager: AirshipLiveUpdateManager;
 
   /**
    * Call after platform ready
@@ -265,252 +257,6 @@ export interface DisplayPreferenceCenterEvent {
   preferenceCenterId: string;
 }
 
-/**
- * Event fired when Live Activities are updated. iOS only.
- */
-export interface LiveActivitiesUpdatedEvent {
-  /**
-   * The Live Activities.
-   */
-  activities: LiveActivity[];
-}
-
-/**
- * Live Activity info. iOS only.
- */
-export interface LiveActivity {
-  /**
-   * The activity ID.
-   */
-  id: string;
-  /**
-   * The attribute types.
-   */
-  attributeTypes: string;
-  /**
-   * The content.
-   */
-  content: LiveActivityContent;
-  /**
-   * The attributes.
-   */
-  attributes: JsonObject;
-}
-
-/**
- * Live Activity content. iOS only.
- */
-export interface LiveActivityContent {
-  /**
-   * The content state.
-   */
-  state: JsonObject;
-  /**
-   * Optional ISO 8601 date string that defines when the Live Activity will be stale.
-   */
-  staleDate?: string;
-  /**
-   * The relevance score.
-   */
-  relevanceScore: number;
-}
-
-/**
- * Base Live Activity request. iOS only.
- */
-export interface LiveActivityRequest {
-  /**
-   * Attributes type. This should match the Activity type of your Live Activity.
-   */
-  attributesType: string;
-}
-
-/**
- * Live Activity list request. iOS only.
- */
-export type LiveActivityListRequest = LiveActivityRequest;
-
-/**
- * Live Activity start request. iOS only.
- */
-export interface LiveActivityStartRequest extends LiveActivityRequest {
-  /**
-   * Dynamic content.
-   */
-  content: LiveActivityContent;
-  /**
-   * Fixed attributes.
-   */
-  attributes: JsonObject;
-}
-
-/**
- * Live Activity update request. iOS only.
- */
-export interface LiveActivityUpdateRequest extends LiveActivityRequest {
-  /**
-   * The Live Activity ID to update.
-   */
-  activityId: string;
-  /**
-   * Dynamic content.
-   */
-  content: LiveActivityContent;
-}
-
-/**
- * Live Activity end request. iOS only.
- */
-export interface LiveActivityEndRequest extends LiveActivityRequest {
-  /**
-   * The Live Activity ID to end.
-   */
-  activityId: string;
-  /**
-   * Dynamic content.
-   */
-  content?: LiveActivityContent;
-  /**
-   * Dismissal policy. Defaults to `LiveActivityDismissalPolicyDefault`.
-   */
-  dismissalPolicy?: LiveActivityDismissalPolicy;
-}
-
-export type LiveActivityDismissalPolicy =
-  LiveActivityDismissalPolicyImmediate | LiveActivityDismissalPolicyDefault | LiveActivityDismissalPolicyAfterDate;
-
-/**
- * Dismissal policy to immediately dismiss the Live Activity on end.
- */
-export interface LiveActivityDismissalPolicyImmediate {
-  type: 'immediate';
-}
-
-/**
- * Dismissal policy to dismiss the Live Activity after the expiration.
- */
-export interface LiveActivityDismissalPolicyDefault {
-  type: 'default';
-}
-
-/**
- * Dismissal policy to dismiss the Live Activity after a given date.
- */
-export interface LiveActivityDismissalPolicyAfterDate {
-  type: 'after';
-  /**
-   * ISO 8601 date string.
-   */
-  date: string;
-}
-
-/**
- * Live Update info. Android only.
- */
-export interface LiveUpdate {
-  /**
-   * The Live Update name.
-   */
-  name: string;
-  /**
-   * The Live Update type.
-   */
-  type: string;
-  /**
-   * Dynamic content.
-   */
-  content: JsonObject;
-  /**
-   * ISO 8601 date string of the last content update.
-   */
-  lastContentUpdateTimestamp: string;
-  /**
-   * ISO 8601 date string of the last state update.
-   */
-  lastStateChangeTimestamp: string;
-  /**
-   * Optional ISO 8601 date string that defines when to end this Live Update.
-   */
-  dismissTimestamp?: string;
-}
-
-/**
- * Live Update list request. Android only.
- */
-export interface LiveUpdateListRequest {
-  type: string;
-}
-
-/**
- * Live Update start request. Android only.
- */
-export interface LiveUpdateStartRequest {
-  /**
-   * The Live Update name.
-   */
-  name: string;
-  /**
-   * The Live Update type.
-   */
-  type: string;
-  /**
-   * Dynamic content.
-   */
-  content: JsonObject;
-  /**
-   * Optional ISO 8601 date string, used to filter out of order updates.
-   */
-  timestamp?: string;
-  /**
-   * Optional ISO 8601 date string that defines when to end this Live Update.
-   */
-  dismissTimestamp?: string;
-}
-
-/**
- * Live Update update request. Android only.
- */
-export interface LiveUpdateUpdateRequest {
-  /**
-   * The Live Update name.
-   */
-  name: string;
-  /**
-   * Dynamic content.
-   */
-  content: JsonObject;
-  /**
-   * Optional ISO 8601 date string, used to filter out of order updates.
-   */
-  timestamp?: string;
-  /**
-   * Optional ISO 8601 date string that defines when to end this Live Update.
-   */
-  dismissTimestamp?: string;
-}
-
-/**
- * Live Update end request. Android only.
- */
-export interface LiveUpdateEndRequest {
-  /**
-   * The Live Update name.
-   */
-  name: string;
-  /**
-   * Dynamic content.
-   */
-  content?: JsonObject;
-  /**
-   * Optional ISO 8601 date string, used to filter out of order updates.
-   */
-  timestamp?: string;
-  /**
-   * Optional ISO 8601 date string that defines when to end this Live Update.
-   */
-  dismissTimestamp?: string;
-}
-
 /**
  * iOS options
  */
@@ -702,18 +448,6 @@ export interface ConfigEnvironment {
    * Optional log level.
    */
   logLevel?: LogLevel;
-
-  /**
-   * Optional iOS config.
-   */
-  ios?: {
-    /**
-     * Log privacy level. By default it logs at `private`, not logging anything lower than info to the console
-     * and redacting logs with string interpolation. `public` will log all configured log levels to the console
-     * without redacting any of the log lines.
-     */
-    logPrivacyLevel?: 'private' | 'public';
-  };
 }
 
 /**
@@ -885,14 +619,12 @@ export namespace Android {
  * Enum of authorized Features.
  */
 export enum Feature {
-  All = 'all',
   InAppAutomation = 'in_app_automation',
   MessageCenter = 'message_center',
   Push = 'push',
   Analytics = 'analytics',
   TagsAndAttributes = 'tags_and_attributes',
   Contacts = 'contacts',
-  FeatureFlags = 'feature_flags',
 }
 
 /**
@@ -1264,17 +996,6 @@ export interface AttributeEditor {
    */
   setAttribute(name: string, value: string | number | boolean | Date): AttributeEditor;
 
-  /**
-   * Adds a JSON attribute.
-   *
-   * @param name The attribute name.
-   * @param instanceId The instance ID.
-   * @param json The json value. Must not contain `exp` as top level key.
-   * @param expiration Optional expiration.
-   * @return The attribute editor instance.
-   */
-  setJsonAttribute(name: string, instanceId: string, json: Record<string, any>, expiration?: Date): AttributeEditor;
-
   /**
    * Removes an attribute.
    * @param name The name of the attribute to remove.
@@ -1282,14 +1003,6 @@ export interface AttributeEditor {
    */
   removeAttribute(name: string): AttributeEditor;
 
-  /**
-   * Removes a JSON attribute.
-   * @param name The name of the attribute to remove.
-   * @param instanceId The instance ID.
-   * @return The attribute editor instance.
-   */
-  removeJsonAttribute(name: string, instanceId: string): AttributeEditor;
-
   /**
    * Applies the attribute operations.
    * @param success Success callback.
@@ -1331,15 +1044,6 @@ class AirshipPush {
     return;
   }
 
-  /**
-   * Enables user notifications and prompts the user for permission, if needed.
-   * @returns Whether user notifications are enabled after the request.
-   */
-  @CordovaInstance()
-  enableUserNotifications(): Promise<boolean> {
-    return;
-  }
-
   /**
    * Gets the notification status.
    */
@@ -1482,13 +1186,6 @@ export interface AirshipPushIOS {
    */
   getBadgeNumber(success: (badge: number) => void, error?: (err: string) => void): void;
 
-  /**
-   * Resets the badge number to zero.
-   * @param success Success callback.
-   * @param error Error callback.
-   */
-  resetBadge(success?: () => void, error?: (err: string) => void): void;
-
   /**
    * Gets the list of authorized notification settings.
    * @param success Success callback.
@@ -1853,41 +1550,6 @@ export interface AirshipFeatureFlagManager {
   trackInteraction(flag: FeatureFlag, success?: () => void, error?: (err: string) => void): void;
 }
 
-/**
- * Options for email channel registration.
- */
-export interface EmailRegistrationOptions {
-  /**
-   * Transactional opt-in date as milliseconds since epoch.
-   */
-  transactionalOptedIn?: number;
-
-  /**
-   * Commercial opt-in date as milliseconds since epoch.
-   */
-  commercialOptedIn?: number;
-
-  /**
-   * Custom properties for the email channel.
-   */
-  properties?: Record<string, string>;
-
-  /**
-   * Request double opt-in for commercial messages when `commercialOptedIn` is not set.
-   */
-  doubleOptIn?: boolean;
-}
-
-/**
- * Options for SMS channel registration.
- */
-export interface SmsRegistrationOptions {
-  /**
-   * The sender ID.
-   */
-  senderId: string;
-}
-
 /**
  * Airship contact.
  */
@@ -1958,26 +1620,6 @@ class AirshipContact {
   reset(): Promise<void> {
     return;
   }
-
-  /**
-   * Registers an email channel for the contact.
-   * @param email The email address.
-   * @param options Registration options.
-   */
-  @CordovaInstance()
-  registerEmail(email: string, options: EmailRegistrationOptions): Promise<void> {
-    return;
-  }
-
-  /**
-   * Registers an SMS channel for the contact.
-   * @param msisdn The MSISDN, including country code.
-   * @param options Registration options.
-   */
-  @CordovaInstance()
-  registerSMS(msisdn: string, options: SmsRegistrationOptions): Promise<void> {
-    return;
-  }
 }
 
 /**
@@ -2123,114 +1765,3 @@ export interface AirshipActions {
     error?: (err: string) => void
   ): void;
 }
-
-/**
- * Live Activity manager. iOS only.
- */
-export interface AirshipLiveActivityManager {
-  /**
-   * Lists any Live Activities for the request.
-   * @param request The request options.
-   * @param success Success callback with the list.
-   * @param error Error callback.
-   */
-  list(
-    request: LiveActivityListRequest,
-    success: (activities: LiveActivity[]) => void,
-    error?: (err: string) => void
-  ): void;
-
-  /**
-   * Lists all Live Activities.
-   * @param success Success callback with the list.
-   * @param error Error callback.
-   */
-  listAll(success: (activities: LiveActivity[]) => void, error?: (err: string) => void): void;
-
-  /**
-   * Starts a Live Activity.
-   * @param request The request options.
-   * @param success Success callback with the started activity.
-   * @param error Error callback.
-   */
-  start(
-    request: LiveActivityStartRequest,
-    success: (activity: LiveActivity) => void,
-    error?: (err: string) => void
-  ): void;
-
-  /**
-   * Updates a Live Activity.
-   * @param request The request options.
-   * @param success Success callback.
-   * @param error Error callback.
-   */
-  update(request: LiveActivityUpdateRequest, success?: () => void, error?: (err: string) => void): void;
-
-  /**
-   * Ends a Live Activity.
-   * @param request The request options.
-   * @param success Success callback.
-   * @param error Error callback.
-   */
-  end(request: LiveActivityEndRequest, success?: () => void, error?: (err: string) => void): void;
-
-  /**
-   * Live Activities updated listener.
-   *
-   * @param callback The callback.
-   * @return A cancellable that can be used to cancel the listener.
-   */
-  onLiveActivitiesUpdated(callback: (event: LiveActivitiesUpdatedEvent) => void): Cancellable;
-}
-
-/**
- * Live Update manager. Android only.
- */
-export interface AirshipLiveUpdateManager {
-  /**
-   * Lists any Live Updates for the request.
-   * @param request The request options.
-   * @param success Success callback with the list.
-   * @param error Error callback.
-   */
-  list(request: LiveUpdateListRequest, success: (updates: LiveUpdate[]) => void, error?: (err: string) => void): void;
-
-  /**
-   * Lists all Live Updates.
-   * @param success Success callback with the list.
-   * @param error Error callback.
-   */
-  listAll(success: (updates: LiveUpdate[]) => void, error?: (err: string) => void): void;
-
-  /**
-   * Starts a Live Update.
-   * @param request The request options.
-   * @param success Success callback.
-   * @param error Error callback.
-   */
-  start(request: LiveUpdateStartRequest, success?: () => void, error?: (err: string) => void): void;
-
-  /**
-   * Updates a Live Update.
-   * @param request The request options.
-   * @param success Success callback.
-   * @param error Error callback.
-   */
-  update(request: LiveUpdateUpdateRequest, success?: () => void, error?: (err: string) => void): void;
-
-  /**
-   * Ends a Live Update.
-   * @param request The request options.
-   * @param success Success callback.
-   * @param error Error callback.
-   */
-  end(request: LiveUpdateEndRequest, success?: () => void, error?: (err: string) => void): void;
-
-  /**
-   * Clears all Live Updates.
-   * @param success Success callback.
-   * @param error Error callback.
-   */
-  clearAll(success?: () => void, error?: (err: string) => void): void;
-}

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;
+  }
 }