@ua/capacitor-airship 2.2.0 → 2.4.0

package/dist/esm/types.d.ts

@@ -172,6 +172,15 @@ export interface DisplayPreferenceCenterEvent {
      */
     preferenceCenterId: string;
 }
+/**
+ * Event fired whenever any of the Live Activities update, create, or end.
+ */
+export interface LiveActivitiesUpdatedEvent {
+    /**
+     * The Live Activities.
+     */
+    activities: LiveActivity[];
+}
 /**
  * Custom event
  */
@@ -549,6 +558,10 @@ export interface InboxMessage {
      * The message sent date in milliseconds.
      */
     sentDate: number;
+    /**
+     * Optional - The message expiration date in milliseconds.
+     */
+    expirationDate?: number;
     /**
      * Optional - The icon url for the message.
      */
@@ -698,3 +711,220 @@ export interface FeatureFlag {
      */
     readonly _internal: unknown;
 }
+/**
+ * Live Activity info.
+ */
+export interface LiveActivity {
+    /**
+     * The activity ID.
+     */
+    id: string;
+    /**
+     * The attribute types.
+     */
+    attributeTypes: string;
+    /**
+     * The content.
+     */
+    content: LiveActivityContent;
+    /**
+     * The attributes.
+     */
+    attributes: JsonObject;
+}
+/**
+ * Live Activity content.
+ */
+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.
+ */
+export interface LiveActivityRequest {
+    /**
+     * Attributes types. This should match the Activity type of your Live Activity.
+     */
+    attributesType: string;
+}
+/**
+ * Live Activity list request.
+ */
+export interface LiveActivityListRequest extends LiveActivityRequest {
+}
+/**
+ * Live Activity start request.
+ */
+export interface LiveActivityStartRequest extends LiveActivityRequest {
+    /**
+     * Dynamic content.
+     */
+    content: LiveActivityContent;
+    /**
+     * Fixed attributes.
+     */
+    attributes: JsonObject;
+}
+/**
+ * Live Activity update request.
+ */
+export interface LiveActivityUpdateRequest extends LiveActivityRequest {
+    /**
+     * The Live Activity ID to update.
+     */
+    activityId: string;
+    /**
+     * Dynamic content.
+     */
+    content: LiveActivityContent;
+}
+/**
+ * Live Activity end request.
+ */
+export interface LiveActivityEndRequest extends LiveActivityRequest {
+    /**
+     * The Live Activity ID to update.
+     */
+    activityId: string;
+    /**
+     * Dynamic content.
+     */
+    content?: LiveActivityContent;
+    /**
+     * Dismissal policy. Defaults to `LiveActivityDismissalPolicyDefault`.
+     */
+    dismissalPolicy?: LiveActivityDismissalPolicy;
+}
+export declare 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';
+    date: string;
+}
+/**
+ * Live Update info.
+ */
+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.
+ */
+export interface LiveUpdateListRequest {
+    type: string;
+}
+/**
+ * Live Update update request.
+ */
+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.
+ */
+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;
+}
+/**
+ * Live Update start request.
+ */
+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;
+}

package/dist/esm/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAoIA;;GAEG;AACH,MAAM,CAAN,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,uCAAmB,CAAA;IAEnB;;OAEG;IACH,qCAAiB,CAAA;IAEjB;;OAEG;IACH,oDAAgC,CAAA;AAClC,CAAC,EAfW,gBAAgB,KAAhB,gBAAgB,QAe3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC;;OAEG;IACH,6DAAiC,CAAA;AACnC,CAAC,EALW,wBAAwB,KAAxB,wBAAwB,QAKnC;AAsFD;;GAEG;AACH,MAAM,KAAW,GAAG,CAwKnB;AAxKD,WAAiB,GAAG;IA0BlB;;OAEG;IACH,IAAY,kBA6BX;IA7BD,WAAY,kBAAkB;QAC5B;;WAEG;QACH,qCAAe,CAAA;QACf;;WAEG;QACH,qCAAe,CAAA;QACf;;WAEG;QACH,qCAAe,CAAA;QACf;;WAEG;QACH,0CAAoB,CAAA;QACpB;;WAEG;QACH,sDAAgC,CAAA;QAChC;;WAEG;QACH,4FAAsE,CAAA;QACtE;;WAEG;QACH,iDAA2B,CAAA;IAC7B,CAAC,EA7BW,kBAAkB,GAAlB,sBAAkB,KAAlB,sBAAkB,QA6B7B;IAED;;OAEG;IACH,IAAY,4BAqBX;IArBD,WAAY,4BAA4B;QACtC;;WAEG;QACH,+CAAe,CAAA;QACf;;WAEG;QACH,+CAAe,CAAA;QAEf;;;WAGG;QACH,6CAAa,CAAA;QAEb;;;WAGG;QACH,iDAAiB,CAAA;IACnB,CAAC,EArBW,4BAA4B,GAA5B,gCAA4B,KAA5B,gCAA4B,QAqBvC;IAED;;OAEG;IACH,IAAY,6BAyCX;IAzCD,WAAY,6BAA6B;QACvC;;WAEG;QACH,gDAAe,CAAA;QACf;;WAEG;QACH,gDAAe,CAAA;QACf;;WAEG;QACH,gDAAe,CAAA;QACf;;WAEG;QACH,qDAAoB,CAAA;QACpB;;WAEG;QACH,2DAA0B,CAAA;QAC1B;;WAEG;QACH,2EAA0C,CAAA;QAC1C;;WAEG;QACH,iEAAgC,CAAA;QAChC;;WAEG;QACH,8DAA6B,CAAA;QAC7B;;WAEG;QACH,yEAAwC,CAAA;QACxC;;WAEG;QACH,iEAAgC,CAAA;IAClC,CAAC,EAzCW,6BAA6B,GAA7B,iCAA6B,KAA7B,iCAA6B,QAyCxC;IAED;;OAEG;IACH,IAAY,4BAyBX;IAzBD,WAAY,4BAA4B;QACtC;;WAEG;QACH,gEAAgC,CAAA;QAEhC;;WAEG;QACH,iDAAiB,CAAA;QAEjB;;WAEG;QACH,yDAAyB,CAAA;QAEzB;;WAEG;QACH,2DAA2B,CAAA;QAE3B;;WAEG;QACH,uDAAuB,CAAA;IACzB,CAAC,EAzBW,4BAA4B,GAA5B,gCAA4B,KAA5B,gCAA4B,QAyBvC;AAQH,CAAC,EAxKgB,GAAG,KAAH,GAAG,QAwKnB;AAwLD;;GAEG;AACH,MAAM,CAAN,IAAY,OAWX;AAXD,WAAY,OAAO;IACjB,gDAAqC,CAAA;IACrC,2CAAgC,CAAA;IAChC,wBAAa,CAAA;IACb,iBAAiB;IACjB,wBAAa,CAAA;IACb,kCAAuB,CAAA;IACvB,oDAAyC,CAAA;IACzC,gCAAqB,CAAA;IACrB,iBAAiB;IACjB,gCAAqB,CAAA;AACvB,CAAC,EAXW,OAAO,KAAP,OAAO,QAWlB;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,gCAAW,CAAA;IACX,gCAAW,CAAA;IACX,gCAAW,CAAA;IACX,oCAAe,CAAA;AACjB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B","sourcesContent":["export type JsonValue =\n  | string\n  | number\n  | boolean\n  | null\n  | JsonObject\n  | JsonArray;\n\nexport type JsonObject = {\n  [key: string]: JsonValue;\n};\n\nexport type JsonArray = JsonValue[];\n\nexport interface ChannelCreatedEvent {\n  /**\n   * The channel ID.\n   */\n  channelId: string;\n}\n\nexport interface PushTokenReceivedEvent {\n  /**\n   * The push token.\n   */\n  pushToken: string;\n}\n\n/**\n * Event fired when a push is received.\n */\nexport interface PushReceivedEvent {\n  /**\n   * The push payload.\n   */\n  pushPayload: PushPayload;\n\n  /**\n   * Indicates whether the push was received when the application was in the background or foreground.\n   */\n  isForeground: boolean;\n}\n\n/**\n * The push payload.\n */\nexport interface PushPayload {\n  /**\n   * The alert.\n   */\n  alert?: string;\n  /**\n   * The title.\n   */\n  title?: string;\n  /**\n   * The subtitle.\n   */\n  subtitle?: string;\n  /**\n   * The notification ID.\n   */\n  notificationId?: string;\n  /**\n   * The notification extras.\n   */\n  extras: JsonObject;\n}\n\n/**\n * Event fired when the user initiates a notification response.\n */\nexport interface NotificationResponseEvent {\n  /**\n   * The push notification.\n   */\n  pushPayload: PushPayload;\n\n  /**\n   * The action button ID, if available.\n   */\n  actionId?: string;\n\n  /**\n   * Indicates whether the response was a foreground action.\n   * This value is always if the user taps the main notification,\n   * otherwise it is defined by the notification action button.\n   */\n  isForeground: boolean;\n}\n\n/**\n * Push notification status.\n */\nexport interface PushNotificationStatus {\n  /**\n   * If user notifications are enabled on [Airship.push].\n   */\n  isUserNotificationsEnabled: boolean;\n\n  /**\n   * If notifications are allowed at the system level for the application.\n   */\n  areNotificationsAllowed: boolean;\n\n  /**\n   * If the push feature is enabled on [Airship.privacyManager].\n   */\n  isPushPrivacyFeatureEnabled: boolean;\n\n  /*\n   * If push registration was able to generate a token.\n   */\n  isPushTokenRegistered: boolean;\n\n  /*\n   * If Airship is able to send and display a push notification.\n   */\n  isOptedIn: boolean;\n\n  /*\n   * Checks for isUserNotificationsEnabled, areNotificationsAllowed, and isPushPrivacyFeatureEnabled. If this flag\n   * is true but `isOptedIn` is false, that means push token was not able to be registered.\n   */\n  isUserOptedIn: boolean;\n\n  /**\n   * The notification permission status.\n   */\n  notificationPermissionStatus: PermissionStatus;\n}\n\n/**\n * Enum of permission status.\n */\nexport enum PermissionStatus {\n  /**\n   * Permission is granted.\n   */\n  Granted = 'granted',\n\n  /**\n   * Permission is denied.\n   */\n  Denied = 'denied',\n\n  /**\n   * Permission has not yet been requested.\n   */\n  NotDetermined = 'not_determined',\n}\n\n/**\n * Fallback when prompting for permission and the permission is\n * already denied on iOS or is denied silently on Android.\n */\nexport enum PromptPermissionFallback {\n  /**\n   * Take the user to the system settings to enable the permission.\n   */\n  SystemSettings = \"systemSettings\"\n}\n\n/**\n * Event fired when the notification status changes.\n */\nexport interface PushNotificationStatusChangedEvent {\n  /**\n   * The push notification status.\n   */\n  status: PushNotificationStatus;\n}\n\n/**\n * Event fired when the Message Center is updated.\n */\nexport interface MessageCenterUpdatedEvent {\n  /**\n   * The unread message count.\n   */\n  messageUnreadCount: number;\n  /**\n   * The total message count.\n   */\n  messageCount: number;\n}\n\n/**\n * Event fired when the Message Center is requested to be displayed.\n */\nexport interface DisplayMessageCenterEvent {\n  /**\n   * The message ID, if available.\n   */\n  messageId?: string;\n}\n\n/**\n * Event fired when a deep link is opened.\n */\nexport interface DeepLinkEvent {\n  /**\n   * The deep link string.\n   */\n  deepLink: string;\n}\n\n/**\n * Event fired when a preference center is requested to be displayed.\n */\nexport interface DisplayPreferenceCenterEvent {\n  /**\n   * The preference center Id.\n   */\n  preferenceCenterId: string;\n}\n\n/**\n * Custom event\n */\nexport interface CustomEvent {\n  /**\n   * Event name\n   */\n  eventName: string;\n  /**\n   * Event value\n   */\n  eventValue?: number;\n  /**\n   * Event properties\n   */\n  properties: JsonObject;\n  /**\n   * Transaction ID\n   */\n  transactionId?: string;\n  /**\n   * Interaction ID\n   */\n  interactionId?: string;\n  /**\n   * Interaction type\n   */\n  interactionType?: string;\n}\n\n/**\n * iOS options\n */\nexport namespace iOS {\n  /**\n   * Quiet time\n   */\n  export interface QuietTime {\n    /**\n     * Start hour. Must be 0-23.\n     */\n    startHour: number;\n\n    /**\n     * Start minute. Must be 0-59.\n     */\n    startMinute: number;\n\n    /**\n     * End hour. Must be 0-23.\n     */\n    endHour: number;\n\n    /**\n     * End minute. Must be 0-59.\n     */\n    endMinute: number;\n  }\n\n  /**\n   * Enum of notification options. iOS only.\n   */\n  export enum NotificationOption {\n    /**\n     * Alerts.\n     */\n    Alert = 'alert',\n    /**\n     * Sounds.\n     */\n    Sound = 'sound',\n    /**\n     * Badges.\n     */\n    Badge = 'badge',\n    /**\n     * Car play.\n     */\n    CarPlay = 'car_play',\n    /**\n     * Critical Alert.\n     */\n    CriticalAlert = 'critical_alert',\n    /**\n     * Provides app notification settings.\n     */\n    ProvidesAppNotificationSettings = 'provides_app_notification_settings',\n    /**\n     * Provisional.\n     */\n    Provisional = 'provisional',\n  }\n\n  /**\n   * Enum of foreground notification options.\n   */\n  export enum ForegroundPresentationOption {\n    /**\n     * Play the sound associated with the notification.\n     */\n    Sound = 'sound',\n    /**\n     * Apply the notification's badge value to the app’s icon.\n     */\n    Badge = 'badge',\n\n    /**\n     * Show the notification in Notification Center. On iOS 13 an older,\n     * this will also show the notification as a banner.\n     */\n    List = 'list',\n\n    /**\n     * Present the notification as a banner. On iOS 13 an older,\n     * this will also show the notification in the Notification Center.\n     */\n    Banner = 'banner',\n  }\n\n  /**\n   * Enum of authorized notification options.\n   */\n  export enum AuthorizedNotificationSetting {\n    /**\n     * Alerts.\n     */\n    Alert = 'alert',\n    /**\n     * Sounds.\n     */\n    Sound = 'sound',\n    /**\n     * Badges.\n     */\n    Badge = 'badge',\n    /**\n     * CarPlay.\n     */\n    CarPlay = 'car_play',\n    /**\n     * Lock screen.\n     */\n    LockScreen = 'lock_screen',\n    /**\n     * Notification center.\n     */\n    NotificationCenter = 'notification_center',\n    /**\n     * Critical alert.\n     */\n    CriticalAlert = 'critical_alert',\n    /**\n     * Announcement.\n     */\n    Announcement = 'announcement',\n    /**\n     * Scheduled delivery.\n     */\n    ScheduledDelivery = 'scheduled_delivery',\n    /**\n     * Time sensitive.\n     */\n    TimeSensitive = 'time_sensitive',\n  }\n\n  /**\n   * Enum of authorized status.\n   */\n  export enum AuthorizedNotificationStatus {\n    /**\n     * Not determined.\n     */\n    NotDetermined = 'not_determined',\n\n    /**\n     * Denied.\n     */\n    Denied = 'denied',\n\n    /**\n     * Authorized.\n     */\n    Authorized = 'authorized',\n\n    /**\n     * Provisional.\n     */\n    Provisional = 'provisional',\n\n    /**\n     * Ephemeral.\n     */\n    Ephemeral = 'ephemeral',\n  }\n\n  export interface AuthorizedNotificationSettingsChangedEvent {\n    /**\n     * Authorized settings.\n     */\n    authorizedSettings: AuthorizedNotificationSetting[];\n  }\n}\n\nexport namespace Android {\n  /**\n   * Android notification config.\n   */\n  export interface NotificationConfig {\n    /**\n     * The icon resource name.\n     */\n    icon?: string;\n    /**\n     * The large icon resource name.\n     */\n    largeIcon?: string;\n    /**\n     * The default android notification channel ID.\n     */\n    defaultChannelId?: string;\n    /**\n     * The accent color. Must be a hex value #AARRGGBB.\n     */\n    accentColor?: string;\n  }\n}\n\n/**\n * Airship config environment\n */\nexport interface ConfigEnvironment {\n  /**\n   * App key.\n   */\n  appKey: string;\n\n  /**\n   * App secret.\n   */\n  appSecret: string;\n\n  /**\n   * Optional log level.\n   */\n  logLevel?: LogLevel;\n\n  /**\n   * Optional iOS config\n   */\n  ios?: {\n    /**\n     * Log privacy level. By default it logs at `private`, not logging anything lower than info to the console\n     * and redacting logs with string interpolation. `public` will log all configured log levels to the console\n     * without redacting any of the log lines.\n     */\n    logPrivacyLevel?: 'private' | 'public';\n  };\n}\n\n/**\n * Possible sites.\n */\nexport type Site = 'us' | 'eu';\n\n/**\n * Log levels.\n */\nexport type LogLevel =\n  | 'verbose'\n  | 'debug'\n  | 'info'\n  | 'warning'\n  | 'error'\n  | 'none';\n\n/**\n * Airship config\n */\nexport interface AirshipConfig {\n  /**\n   * Default environment.\n   */\n  default?: ConfigEnvironment;\n\n  /**\n   * Development environment. Overrides default environment if inProduction is false.\n   */\n  development?: ConfigEnvironment;\n\n  /**\n   * Production environment. Overrides default environment if inProduction is true.\n   */\n  production?: ConfigEnvironment;\n\n  /**\n   * Cloud site.\n   */\n  site?: Site;\n\n  /**\n   * Switches the environment from development or production. If the value is not\n   * set, Airship will determine the value at runtime.\n   */\n  inProduction?: boolean;\n\n  /**\n   * URL allow list.\n   */\n  urlAllowList?: string[];\n\n  /**\n   * URL allow list for open URL scope.\n   */\n  urlAllowListScopeOpenUrl?: string[];\n\n  /**\n   * URL allow list for JS bridge injection.\n   */\n  urlAllowListScopeJavaScriptInterface?: string[];\n\n  /**\n   * Enables delayed channel creation.\n   * Deprecated. Use the Private Manager to disable all features instead.\n   */\n  isChannelCreationDelayEnabled?: boolean;\n\n  /**\n   * Initial config URL for custom Airship domains. The URL\n   * should also be added to the urlAllowList.\n   */\n  initialConfigUrl?: string;\n\n  /**\n   * Enabled features. Defaults to all.\n   */\n  enabledFeatures?: Feature[];\n\n  /**\n   * Enables channel capture feature.\n   * This config is enabled by default.\n   */\n  isChannelCaptureEnabled?: boolean;\n\n  /**\n   * Whether to suppress console error messages about missing allow list entries during takeOff.\n   * This config is disabled by default.\n   */\n  suppressAllowListError?: boolean;\n\n  /**\n   * Pauses In-App Automation on launch.\n   */\n  autoPauseInAppAutomationOnLaunch?: boolean;\n\n  /**\n   * iOS config.\n   */\n  ios?: {\n    /**\n     * itunesId for rate app and app store deep links.\n     */\n    itunesId?: string;\n  };\n\n  /**\n   * Android config.\n   */\n  android?: {\n    /**\n     * App store URI\n     */\n    appStoreUri?: string;\n\n    /**\n     * Fcm app name if using multiple FCM projects.\n     */\n    fcmFirebaseAppName?: string;\n\n    /**\n     * Notification config.\n     */\n    notificationConfig?: Android.NotificationConfig;\n  };\n}\n\n/**\n * Enum of authorized Features.\n */\nexport enum Feature {\n  InAppAutomation = 'in_app_automation',\n  MessageCenter = 'message_center',\n  Push = 'push',\n  // No longer used\n  Chat = 'chat',\n  Analytics = 'analytics',\n  TagsAndAttributes = 'tags_and_attributes',\n  Contacts = 'contacts',\n  // No longer used\n  Location = 'location',\n}\n\n/**\n * All available features.\n */\nexport const FEATURES_ALL = Object.values(Feature);\n\n/**\n * Subscription Scope types.\n */\nexport enum SubscriptionScope {\n  App = 'app',\n  Web = 'web',\n  Sms = 'sms',\n  Email = 'email',\n}\n\nexport interface InboxMessage {\n  /**\n   * The message ID. Needed to display, mark as read, or delete the message.\n   */\n  id: string;\n  /**\n   * The message title.\n   */\n  title: string;\n  /**\n   * The message sent date in milliseconds.\n   */\n  sentDate: number;\n  /**\n   * Optional - The icon url for the message.\n   */\n  listIconUrl: string;\n  /**\n   * The unread / read status of the message.\n   */\n  isRead: boolean;\n  /**\n   * String to String map of any message extras.\n   */\n  extras: Record<string, string>;\n}\n\n// ---\n// See: https://github.com/urbanairship/web-push-sdk/blob/master/src/remote-data/preference-center.ts\n// ---\n\n/**\n * A preference center definition.\n *\n * @typedef {object} PreferenceCenter\n * @property {string} id the ID of the preference center\n * @property {Array<PreferenceCenter.CommonSection>} sections a list of sections\n * @property {?CommonDisplay} display display information\n */\nexport type PreferenceCenter = {\n  id: string;\n  sections: Section[];\n  display?: CommonDisplay;\n};\n\n/**\n * Preference center display information.\n * @typedef {object} CommonDisplay\n * @property {string} name\n * @property {?string} description\n */\nexport type CommonDisplay = {\n  name: string;\n  description?: string;\n};\n\nexport type Icon = {\n  icon: string;\n};\n\nexport type IconDisplay = CommonDisplay & Partial<Icon>;\n\nexport interface ItemBase {\n  type: unknown;\n  id: string;\n  display: CommonDisplay;\n  conditions?: Condition[];\n}\n\n/**\n * A channel subscription item.\n * @typedef {object} ChannelSubscriptionItem\n * @memberof PreferenceCenter\n * @property {\"channel_subscription\"} type\n * @property {string} id the item identifier\n * @property {?CommonDisplay} display display information\n * @property {string} subscription_id the subscription list id\n */\nexport interface ChannelSubscriptionItem extends ItemBase {\n  type: 'channel_subscription';\n  subscription_id: string;\n}\n\nexport interface ContactSubscriptionGroupItem extends ItemBase {\n  type: 'contact_subscription_group';\n  id: string;\n  subscription_id: string;\n  components: ContactSubscriptionGroupItemComponent[];\n}\n\nexport interface ContactSubscriptionGroupItemComponent {\n  scopes: SubscriptionScope[];\n  display: Omit<CommonDisplay, 'description'>;\n}\n\nexport interface ContactSubscriptionItem extends ItemBase {\n  type: 'contact_subscription';\n  scopes: SubscriptionScope[];\n  subscription_id: string;\n}\n\nexport interface AlertItem extends ItemBase {\n  type: 'alert';\n  display: IconDisplay;\n  button?: Button;\n}\n\nexport interface ConditionBase {\n  type: unknown;\n}\n\nexport interface NotificationOptInCondition extends ConditionBase {\n  type: 'notification_opt_in';\n  when_status: 'opt_in' | 'opt_out';\n}\n\nexport type Condition = NotificationOptInCondition;\n\n// Changed from `unknown` in spec\nexport type Actions = {\n  [key: string]: JsonValue;\n};\n\nexport interface Button {\n  text: string;\n  content_description?: string;\n  actions: Actions;\n}\n\nexport interface SectionBase {\n  type: unknown;\n  id: string;\n  display?: CommonDisplay;\n  items: Item[];\n}\n\n/**\n * @typedef {object} CommonSection\n * @memberof PreferenceCenter\n * @property {\"section\"} type\n * @property {string} id the section identifier\n * @property {?CommonDisplay} display display information\n * @property {Array<PreferenceCenter.ChannelSubscriptionItem>} items list of\n *   section items\n */\nexport interface CommonSection extends SectionBase {\n  type: 'section';\n}\n\nexport interface LabeledSectionBreak extends SectionBase {\n  type: 'labeled_section_break';\n  items: never;\n}\n\nexport type Item =\n  | ChannelSubscriptionItem\n  | ContactSubscriptionGroupItem\n  | ContactSubscriptionItem\n  | AlertItem;\n\nexport type Section = CommonSection | LabeledSectionBreak;\n\n/**\n * An interface representing the eligibility status of a flag, and optional\n * variables associated with the flag.\n */\nexport interface FeatureFlag {\n  /**\n   * A boolean representing flag eligibility; will be `true` if the current\n   * contact is eligible for the flag.\n   */\n  readonly isEligible: boolean;\n  /**\n   * A variables associated with the flag, if any. Will be `null` if no data\n   * is associated with the flag, or if the flag does not exist.\n   */\n  readonly variables: unknown | null;\n  /**\n   * A boolean representing if the flag exists or not. For ease of use and\n   * deployment, asking for a flag by any name will return a `FeatureFlag`\n   * interface, even if the flag was not found to exist. However this property\n   * may be checked to determine if the flag was actually resolved to a known\n   * flag name.\n   */\n  readonly exists: boolean;\n\n  /**\n   * Reporting Metadata, the shape of which is private and not to be relied\n   * upon. When not provided, an interaction cannot be tracked on the flag.\n   * @ignore\n   */\n  readonly _internal: unknown;\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAoIA;;GAEG;AACH,MAAM,CAAN,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,uCAAmB,CAAA;IAEnB;;OAEG;IACH,qCAAiB,CAAA;IAEjB;;OAEG;IACH,oDAAgC,CAAA;AAClC,CAAC,EAfW,gBAAgB,KAAhB,gBAAgB,QAe3B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC;;OAEG;IACH,6DAAiC,CAAA;AACnC,CAAC,EALW,wBAAwB,KAAxB,wBAAwB,QAKnC;AAiGD;;GAEG;AACH,MAAM,KAAW,GAAG,CAwKnB;AAxKD,WAAiB,GAAG;IA0BlB;;OAEG;IACH,IAAY,kBA6BX;IA7BD,WAAY,kBAAkB;QAC5B;;WAEG;QACH,qCAAe,CAAA;QACf;;WAEG;QACH,qCAAe,CAAA;QACf;;WAEG;QACH,qCAAe,CAAA;QACf;;WAEG;QACH,0CAAoB,CAAA;QACpB;;WAEG;QACH,sDAAgC,CAAA;QAChC;;WAEG;QACH,4FAAsE,CAAA;QACtE;;WAEG;QACH,iDAA2B,CAAA;IAC7B,CAAC,EA7BW,kBAAkB,GAAlB,sBAAkB,KAAlB,sBAAkB,QA6B7B;IAED;;OAEG;IACH,IAAY,4BAqBX;IArBD,WAAY,4BAA4B;QACtC;;WAEG;QACH,+CAAe,CAAA;QACf;;WAEG;QACH,+CAAe,CAAA;QAEf;;;WAGG;QACH,6CAAa,CAAA;QAEb;;;WAGG;QACH,iDAAiB,CAAA;IACnB,CAAC,EArBW,4BAA4B,GAA5B,gCAA4B,KAA5B,gCAA4B,QAqBvC;IAED;;OAEG;IACH,IAAY,6BAyCX;IAzCD,WAAY,6BAA6B;QACvC;;WAEG;QACH,gDAAe,CAAA;QACf;;WAEG;QACH,gDAAe,CAAA;QACf;;WAEG;QACH,gDAAe,CAAA;QACf;;WAEG;QACH,qDAAoB,CAAA;QACpB;;WAEG;QACH,2DAA0B,CAAA;QAC1B;;WAEG;QACH,2EAA0C,CAAA;QAC1C;;WAEG;QACH,iEAAgC,CAAA;QAChC;;WAEG;QACH,8DAA6B,CAAA;QAC7B;;WAEG;QACH,yEAAwC,CAAA;QACxC;;WAEG;QACH,iEAAgC,CAAA;IAClC,CAAC,EAzCW,6BAA6B,GAA7B,iCAA6B,KAA7B,iCAA6B,QAyCxC;IAED;;OAEG;IACH,IAAY,4BAyBX;IAzBD,WAAY,4BAA4B;QACtC;;WAEG;QACH,gEAAgC,CAAA;QAEhC;;WAEG;QACH,iDAAiB,CAAA;QAEjB;;WAEG;QACH,yDAAyB,CAAA;QAEzB;;WAEG;QACH,2DAA2B,CAAA;QAE3B;;WAEG;QACH,uDAAuB,CAAA;IACzB,CAAC,EAzBW,4BAA4B,GAA5B,gCAA4B,KAA5B,gCAA4B,QAyBvC;AAQH,CAAC,EAxKgB,GAAG,KAAH,GAAG,QAwKnB;AAwLD;;GAEG;AACH,MAAM,CAAN,IAAY,OAWX;AAXD,WAAY,OAAO;IACjB,gDAAqC,CAAA;IACrC,2CAAgC,CAAA;IAChC,wBAAa,CAAA;IACb,iBAAiB;IACjB,wBAAa,CAAA;IACb,kCAAuB,CAAA;IACvB,oDAAyC,CAAA;IACzC,gCAAqB,CAAA;IACrB,iBAAiB;IACjB,gCAAqB,CAAA;AACvB,CAAC,EAXW,OAAO,KAAP,OAAO,QAWlB;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,gCAAW,CAAA;IACX,gCAAW,CAAA;IACX,gCAAW,CAAA;IACX,oCAAe,CAAA;AACjB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B","sourcesContent":["export type JsonValue =\n  | string\n  | number\n  | boolean\n  | null\n  | JsonObject\n  | JsonArray;\n\nexport type JsonObject = {\n  [key: string]: JsonValue;\n};\n\nexport type JsonArray = JsonValue[];\n\nexport interface ChannelCreatedEvent {\n  /**\n   * The channel ID.\n   */\n  channelId: string;\n}\n\nexport interface PushTokenReceivedEvent {\n  /**\n   * The push token.\n   */\n  pushToken: string;\n}\n\n/**\n * Event fired when a push is received.\n */\nexport interface PushReceivedEvent {\n  /**\n   * The push payload.\n   */\n  pushPayload: PushPayload;\n\n  /**\n   * Indicates whether the push was received when the application was in the background or foreground.\n   */\n  isForeground: boolean;\n}\n\n/**\n * The push payload.\n */\nexport interface PushPayload {\n  /**\n   * The alert.\n   */\n  alert?: string;\n  /**\n   * The title.\n   */\n  title?: string;\n  /**\n   * The subtitle.\n   */\n  subtitle?: string;\n  /**\n   * The notification ID.\n   */\n  notificationId?: string;\n  /**\n   * The notification extras.\n   */\n  extras: JsonObject;\n}\n\n/**\n * Event fired when the user initiates a notification response.\n */\nexport interface NotificationResponseEvent {\n  /**\n   * The push notification.\n   */\n  pushPayload: PushPayload;\n\n  /**\n   * The action button ID, if available.\n   */\n  actionId?: string;\n\n  /**\n   * Indicates whether the response was a foreground action.\n   * This value is always if the user taps the main notification,\n   * otherwise it is defined by the notification action button.\n   */\n  isForeground: boolean;\n}\n\n/**\n * Push notification status.\n */\nexport interface PushNotificationStatus {\n  /**\n   * If user notifications are enabled on [Airship.push].\n   */\n  isUserNotificationsEnabled: boolean;\n\n  /**\n   * If notifications are allowed at the system level for the application.\n   */\n  areNotificationsAllowed: boolean;\n\n  /**\n   * If the push feature is enabled on [Airship.privacyManager].\n   */\n  isPushPrivacyFeatureEnabled: boolean;\n\n  /*\n   * If push registration was able to generate a token.\n   */\n  isPushTokenRegistered: boolean;\n\n  /*\n   * If Airship is able to send and display a push notification.\n   */\n  isOptedIn: boolean;\n\n  /*\n   * Checks for isUserNotificationsEnabled, areNotificationsAllowed, and isPushPrivacyFeatureEnabled. If this flag\n   * is true but `isOptedIn` is false, that means push token was not able to be registered.\n   */\n  isUserOptedIn: boolean;\n\n  /**\n   * The notification permission status.\n   */\n  notificationPermissionStatus: PermissionStatus;\n}\n\n/**\n * Enum of permission status.\n */\nexport enum PermissionStatus {\n  /**\n   * Permission is granted.\n   */\n  Granted = 'granted',\n\n  /**\n   * Permission is denied.\n   */\n  Denied = 'denied',\n\n  /**\n   * Permission has not yet been requested.\n   */\n  NotDetermined = 'not_determined',\n}\n\n/**\n * Fallback when prompting for permission and the permission is\n * already denied on iOS or is denied silently on Android.\n */\nexport enum PromptPermissionFallback {\n  /**\n   * Take the user to the system settings to enable the permission.\n   */\n  SystemSettings = \"systemSettings\"\n}\n\n/**\n * Event fired when the notification status changes.\n */\nexport interface PushNotificationStatusChangedEvent {\n  /**\n   * The push notification status.\n   */\n  status: PushNotificationStatus;\n}\n\n/**\n * Event fired when the Message Center is updated.\n */\nexport interface MessageCenterUpdatedEvent {\n  /**\n   * The unread message count.\n   */\n  messageUnreadCount: number;\n  /**\n   * The total message count.\n   */\n  messageCount: number;\n}\n\n/**\n * Event fired when the Message Center is requested to be displayed.\n */\nexport interface DisplayMessageCenterEvent {\n  /**\n   * The message ID, if available.\n   */\n  messageId?: string;\n}\n\n/**\n * Event fired when a deep link is opened.\n */\nexport interface DeepLinkEvent {\n  /**\n   * The deep link string.\n   */\n  deepLink: string;\n}\n\n/**\n * Event fired when a preference center is requested to be displayed.\n */\nexport interface DisplayPreferenceCenterEvent {\n  /**\n   * The preference center Id.\n   */\n  preferenceCenterId: string;\n}\n\n/**\n * Event fired whenever any of the Live Activities update, create, or end.\n */\nexport interface LiveActivitiesUpdatedEvent {\n  /**\n   * The Live Activities.\n   */\n  activities: LiveActivity[];\n}\n\n\n/**\n * Custom event\n */\nexport interface CustomEvent {\n  /**\n   * Event name\n   */\n  eventName: string;\n  /**\n   * Event value\n   */\n  eventValue?: number;\n  /**\n   * Event properties\n   */\n  properties: JsonObject;\n  /**\n   * Transaction ID\n   */\n  transactionId?: string;\n  /**\n   * Interaction ID\n   */\n  interactionId?: string;\n  /**\n   * Interaction type\n   */\n  interactionType?: string;\n}\n\n/**\n * iOS options\n */\nexport namespace iOS {\n  /**\n   * Quiet time\n   */\n  export interface QuietTime {\n    /**\n     * Start hour. Must be 0-23.\n     */\n    startHour: number;\n\n    /**\n     * Start minute. Must be 0-59.\n     */\n    startMinute: number;\n\n    /**\n     * End hour. Must be 0-23.\n     */\n    endHour: number;\n\n    /**\n     * End minute. Must be 0-59.\n     */\n    endMinute: number;\n  }\n\n  /**\n   * Enum of notification options. iOS only.\n   */\n  export enum NotificationOption {\n    /**\n     * Alerts.\n     */\n    Alert = 'alert',\n    /**\n     * Sounds.\n     */\n    Sound = 'sound',\n    /**\n     * Badges.\n     */\n    Badge = 'badge',\n    /**\n     * Car play.\n     */\n    CarPlay = 'car_play',\n    /**\n     * Critical Alert.\n     */\n    CriticalAlert = 'critical_alert',\n    /**\n     * Provides app notification settings.\n     */\n    ProvidesAppNotificationSettings = 'provides_app_notification_settings',\n    /**\n     * Provisional.\n     */\n    Provisional = 'provisional',\n  }\n\n  /**\n   * Enum of foreground notification options.\n   */\n  export enum ForegroundPresentationOption {\n    /**\n     * Play the sound associated with the notification.\n     */\n    Sound = 'sound',\n    /**\n     * Apply the notification's badge value to the app’s icon.\n     */\n    Badge = 'badge',\n\n    /**\n     * Show the notification in Notification Center. On iOS 13 an older,\n     * this will also show the notification as a banner.\n     */\n    List = 'list',\n\n    /**\n     * Present the notification as a banner. On iOS 13 an older,\n     * this will also show the notification in the Notification Center.\n     */\n    Banner = 'banner',\n  }\n\n  /**\n   * Enum of authorized notification options.\n   */\n  export enum AuthorizedNotificationSetting {\n    /**\n     * Alerts.\n     */\n    Alert = 'alert',\n    /**\n     * Sounds.\n     */\n    Sound = 'sound',\n    /**\n     * Badges.\n     */\n    Badge = 'badge',\n    /**\n     * CarPlay.\n     */\n    CarPlay = 'car_play',\n    /**\n     * Lock screen.\n     */\n    LockScreen = 'lock_screen',\n    /**\n     * Notification center.\n     */\n    NotificationCenter = 'notification_center',\n    /**\n     * Critical alert.\n     */\n    CriticalAlert = 'critical_alert',\n    /**\n     * Announcement.\n     */\n    Announcement = 'announcement',\n    /**\n     * Scheduled delivery.\n     */\n    ScheduledDelivery = 'scheduled_delivery',\n    /**\n     * Time sensitive.\n     */\n    TimeSensitive = 'time_sensitive',\n  }\n\n  /**\n   * Enum of authorized status.\n   */\n  export enum AuthorizedNotificationStatus {\n    /**\n     * Not determined.\n     */\n    NotDetermined = 'not_determined',\n\n    /**\n     * Denied.\n     */\n    Denied = 'denied',\n\n    /**\n     * Authorized.\n     */\n    Authorized = 'authorized',\n\n    /**\n     * Provisional.\n     */\n    Provisional = 'provisional',\n\n    /**\n     * Ephemeral.\n     */\n    Ephemeral = 'ephemeral',\n  }\n\n  export interface AuthorizedNotificationSettingsChangedEvent {\n    /**\n     * Authorized settings.\n     */\n    authorizedSettings: AuthorizedNotificationSetting[];\n  }\n}\n\nexport namespace Android {\n  /**\n   * Android notification config.\n   */\n  export interface NotificationConfig {\n    /**\n     * The icon resource name.\n     */\n    icon?: string;\n    /**\n     * The large icon resource name.\n     */\n    largeIcon?: string;\n    /**\n     * The default android notification channel ID.\n     */\n    defaultChannelId?: string;\n    /**\n     * The accent color. Must be a hex value #AARRGGBB.\n     */\n    accentColor?: string;\n  }\n}\n\n/**\n * Airship config environment\n */\nexport interface ConfigEnvironment {\n  /**\n   * App key.\n   */\n  appKey: string;\n\n  /**\n   * App secret.\n   */\n  appSecret: string;\n\n  /**\n   * Optional log level.\n   */\n  logLevel?: LogLevel;\n\n  /**\n   * Optional iOS config\n   */\n  ios?: {\n    /**\n     * Log privacy level. By default it logs at `private`, not logging anything lower than info to the console\n     * and redacting logs with string interpolation. `public` will log all configured log levels to the console\n     * without redacting any of the log lines.\n     */\n    logPrivacyLevel?: 'private' | 'public';\n  };\n}\n\n/**\n * Possible sites.\n */\nexport type Site = 'us' | 'eu';\n\n/**\n * Log levels.\n */\nexport type LogLevel =\n  | 'verbose'\n  | 'debug'\n  | 'info'\n  | 'warning'\n  | 'error'\n  | 'none';\n\n/**\n * Airship config\n */\nexport interface AirshipConfig {\n  /**\n   * Default environment.\n   */\n  default?: ConfigEnvironment;\n\n  /**\n   * Development environment. Overrides default environment if inProduction is false.\n   */\n  development?: ConfigEnvironment;\n\n  /**\n   * Production environment. Overrides default environment if inProduction is true.\n   */\n  production?: ConfigEnvironment;\n\n  /**\n   * Cloud site.\n   */\n  site?: Site;\n\n  /**\n   * Switches the environment from development or production. If the value is not\n   * set, Airship will determine the value at runtime.\n   */\n  inProduction?: boolean;\n\n  /**\n   * URL allow list.\n   */\n  urlAllowList?: string[];\n\n  /**\n   * URL allow list for open URL scope.\n   */\n  urlAllowListScopeOpenUrl?: string[];\n\n  /**\n   * URL allow list for JS bridge injection.\n   */\n  urlAllowListScopeJavaScriptInterface?: string[];\n\n  /**\n   * Enables delayed channel creation.\n   * Deprecated. Use the Private Manager to disable all features instead.\n   */\n  isChannelCreationDelayEnabled?: boolean;\n\n  /**\n   * Initial config URL for custom Airship domains. The URL\n   * should also be added to the urlAllowList.\n   */\n  initialConfigUrl?: string;\n\n  /**\n   * Enabled features. Defaults to all.\n   */\n  enabledFeatures?: Feature[];\n\n  /**\n   * Enables channel capture feature.\n   * This config is enabled by default.\n   */\n  isChannelCaptureEnabled?: boolean;\n\n  /**\n   * Whether to suppress console error messages about missing allow list entries during takeOff.\n   * This config is disabled by default.\n   */\n  suppressAllowListError?: boolean;\n\n  /**\n   * Pauses In-App Automation on launch.\n   */\n  autoPauseInAppAutomationOnLaunch?: boolean;\n\n  /**\n   * iOS config.\n   */\n  ios?: {\n    /**\n     * itunesId for rate app and app store deep links.\n     */\n    itunesId?: string;\n  };\n\n  /**\n   * Android config.\n   */\n  android?: {\n    /**\n     * App store URI\n     */\n    appStoreUri?: string;\n\n    /**\n     * Fcm app name if using multiple FCM projects.\n     */\n    fcmFirebaseAppName?: string;\n\n    /**\n     * Notification config.\n     */\n    notificationConfig?: Android.NotificationConfig;\n  };\n}\n\n/**\n * Enum of authorized Features.\n */\nexport enum Feature {\n  InAppAutomation = 'in_app_automation',\n  MessageCenter = 'message_center',\n  Push = 'push',\n  // No longer used\n  Chat = 'chat',\n  Analytics = 'analytics',\n  TagsAndAttributes = 'tags_and_attributes',\n  Contacts = 'contacts',\n  // No longer used\n  Location = 'location',\n}\n\n/**\n * All available features.\n */\nexport const FEATURES_ALL = Object.values(Feature);\n\n/**\n * Subscription Scope types.\n */\nexport enum SubscriptionScope {\n  App = 'app',\n  Web = 'web',\n  Sms = 'sms',\n  Email = 'email',\n}\n\nexport interface InboxMessage {\n  /**\n   * The message ID. Needed to display, mark as read, or delete the message.\n   */\n  id: string;\n  /**\n   * The message title.\n   */\n  title: string;\n  /**\n   * The message sent date in milliseconds.\n   */\n  sentDate: number;\n  /**\n   * Optional - The message expiration date in milliseconds.\n   */\n  expirationDate?: number;\n  /**\n   * Optional - The icon url for the message.\n   */\n  listIconUrl: string;\n  /**\n   * The unread / read status of the message.\n   */\n  isRead: boolean;\n  /**\n   * String to String map of any message extras.\n   */\n  extras: Record<string, string>;\n}\n\n// ---\n// See: https://github.com/urbanairship/web-push-sdk/blob/master/src/remote-data/preference-center.ts\n// ---\n\n/**\n * A preference center definition.\n *\n * @typedef {object} PreferenceCenter\n * @property {string} id the ID of the preference center\n * @property {Array<PreferenceCenter.CommonSection>} sections a list of sections\n * @property {?CommonDisplay} display display information\n */\nexport type PreferenceCenter = {\n  id: string;\n  sections: Section[];\n  display?: CommonDisplay;\n};\n\n/**\n * Preference center display information.\n * @typedef {object} CommonDisplay\n * @property {string} name\n * @property {?string} description\n */\nexport type CommonDisplay = {\n  name: string;\n  description?: string;\n};\n\nexport type Icon = {\n  icon: string;\n};\n\nexport type IconDisplay = CommonDisplay & Partial<Icon>;\n\nexport interface ItemBase {\n  type: unknown;\n  id: string;\n  display: CommonDisplay;\n  conditions?: Condition[];\n}\n\n/**\n * A channel subscription item.\n * @typedef {object} ChannelSubscriptionItem\n * @memberof PreferenceCenter\n * @property {\"channel_subscription\"} type\n * @property {string} id the item identifier\n * @property {?CommonDisplay} display display information\n * @property {string} subscription_id the subscription list id\n */\nexport interface ChannelSubscriptionItem extends ItemBase {\n  type: 'channel_subscription';\n  subscription_id: string;\n}\n\nexport interface ContactSubscriptionGroupItem extends ItemBase {\n  type: 'contact_subscription_group';\n  id: string;\n  subscription_id: string;\n  components: ContactSubscriptionGroupItemComponent[];\n}\n\nexport interface ContactSubscriptionGroupItemComponent {\n  scopes: SubscriptionScope[];\n  display: Omit<CommonDisplay, 'description'>;\n}\n\nexport interface ContactSubscriptionItem extends ItemBase {\n  type: 'contact_subscription';\n  scopes: SubscriptionScope[];\n  subscription_id: string;\n}\n\nexport interface AlertItem extends ItemBase {\n  type: 'alert';\n  display: IconDisplay;\n  button?: Button;\n}\n\nexport interface ConditionBase {\n  type: unknown;\n}\n\nexport interface NotificationOptInCondition extends ConditionBase {\n  type: 'notification_opt_in';\n  when_status: 'opt_in' | 'opt_out';\n}\n\nexport type Condition = NotificationOptInCondition;\n\n// Changed from `unknown` in spec\nexport type Actions = {\n  [key: string]: JsonValue;\n};\n\nexport interface Button {\n  text: string;\n  content_description?: string;\n  actions: Actions;\n}\n\nexport interface SectionBase {\n  type: unknown;\n  id: string;\n  display?: CommonDisplay;\n  items: Item[];\n}\n\n/**\n * @typedef {object} CommonSection\n * @memberof PreferenceCenter\n * @property {\"section\"} type\n * @property {string} id the section identifier\n * @property {?CommonDisplay} display display information\n * @property {Array<PreferenceCenter.ChannelSubscriptionItem>} items list of\n *   section items\n */\nexport interface CommonSection extends SectionBase {\n  type: 'section';\n}\n\nexport interface LabeledSectionBreak extends SectionBase {\n  type: 'labeled_section_break';\n  items: never;\n}\n\nexport type Item =\n  | ChannelSubscriptionItem\n  | ContactSubscriptionGroupItem\n  | ContactSubscriptionItem\n  | AlertItem;\n\nexport type Section = CommonSection | LabeledSectionBreak;\n\n/**\n * An interface representing the eligibility status of a flag, and optional\n * variables associated with the flag.\n */\nexport interface FeatureFlag {\n  /**\n   * A boolean representing flag eligibility; will be `true` if the current\n   * contact is eligible for the flag.\n   */\n  readonly isEligible: boolean;\n  /**\n   * A variables associated with the flag, if any. Will be `null` if no data\n   * is associated with the flag, or if the flag does not exist.\n   */\n  readonly variables: unknown | null;\n  /**\n   * A boolean representing if the flag exists or not. For ease of use and\n   * deployment, asking for a flag by any name will return a `FeatureFlag`\n   * interface, even if the flag was not found to exist. However this property\n   * may be checked to determine if the flag was actually resolved to a known\n   * flag name.\n   */\n  readonly exists: boolean;\n\n  /**\n   * Reporting Metadata, the shape of which is private and not to be relied\n   * upon. When not provided, an interaction cannot be tracked on the flag.\n   * @ignore\n   */\n  readonly _internal: unknown;\n}\n\n\n/**\n * Live Activity info.\n */\nexport interface LiveActivity {\n  /**\n   * The activity ID.\n   */\n  id: string;\n  /**\n   * The attribute types.\n   */\n  attributeTypes: string;\n  /**\n   * The content.\n   */\n  content: LiveActivityContent;\n  /**\n   * The attributes.\n   */\n  attributes: JsonObject;\n}\n\n/**\n * Live Activity content.\n */\nexport interface LiveActivityContent {\n  /**\n   * The content state.\n   */\n  state: JsonObject;\n  /**\n   * Optional ISO 8601 date string that defines when the Live Activity will be stale.\n   */\n  staleDate?: string;\n  /**\n   * The relevance score.\n   */\n  relevanceScore: number;\n}\n\n/**\n * Base Live Activity request.\n */\nexport interface LiveActivityRequest {\n  /**\n   * Attributes types. This should match the Activity type of your Live Activity.\n   */\n  attributesType: string;\n}\n\n/**\n * Live Activity list request.\n */\nexport interface LiveActivityListRequest extends LiveActivityRequest {}\n\n/**\n * Live Activity start request.\n */\nexport interface LiveActivityStartRequest extends LiveActivityRequest {\n  /**\n   * Dynamic content.\n   */\n  content: LiveActivityContent;\n  /**\n   * Fixed attributes.\n   */\n  attributes: JsonObject;\n}\n\n/**\n * Live Activity update request.\n */\nexport interface LiveActivityUpdateRequest extends LiveActivityRequest {\n  /**\n   * The Live Activity ID to update.\n   */\n  activityId: string;\n  /**\n   * Dynamic content.\n   */\n  content: LiveActivityContent;\n}\n\n/**\n * Live Activity end request.\n */\nexport interface LiveActivityEndRequest extends LiveActivityRequest {\n  /**\n   * The Live Activity ID to update.\n   */\n  activityId: string;\n  /**\n   * Dynamic content.\n   */\n  content?: LiveActivityContent;\n\n  /**\n   * Dismissal policy. Defaults to `LiveActivityDismissalPolicyDefault`.\n   */\n  dismissalPolicy?: LiveActivityDismissalPolicy;\n}\n\nexport type LiveActivityDismissalPolicy =\n  | LiveActivityDismissalPolicyImmediate\n  | LiveActivityDismissalPolicyDefault\n  | LiveActivityDismissalPolicyAfterDate;\n\n/**\n * Dismissal policy to immediately dismiss the Live Activity on end.\n */\nexport interface LiveActivityDismissalPolicyImmediate {\n  type: 'immediate';\n}\n\n/**\n * Dismissal policy to dismiss the Live Activity after the expiration.\n */\nexport interface LiveActivityDismissalPolicyDefault {\n  type: 'default';\n}\n\n/**\n * Dismissal policy to dismiss the Live Activity after a given date.\n */\nexport interface LiveActivityDismissalPolicyAfterDate {\n  type: 'after';\n  // ISO 8601 date string.\n  date: string;\n}\n\n/**\n * Live Update info.\n */\nexport interface LiveUpdate {\n  /**\n   * The Live Update name.\n   */\n  name: string;\n\n  /**\n   * The Live Update type.\n   */\n  type: string;\n\n  /**\n   * Dynamic content.\n   */\n  content: JsonObject;\n\n  /**\n   *  ISO 8601 date string of the last content update.\n   */\n  lastContentUpdateTimestamp: string;\n\n  /**\n   * ISO 8601 date string of the last state update.\n   */\n  lastStateChangeTimestamp: string;\n\n  /**\n   * Optional ISO 8601 date string that defines when to end this Live Update.\n   */\n  dismissTimestamp?: string;\n}\n\n\n/**\n * Live Update list request.\n */\nexport interface LiveUpdateListRequest {\n  type: string;\n}\n\n/**\n * Live Update update request.\n */\nexport interface LiveUpdateUpdateRequest {\n  /**\n   * The Live Update name.\n   */\n  name: string;\n  /**\n   * Dynamic content.\n   */\n  content: JsonObject;\n\n  /**\n   * Optional ISO 8601 date string, used to filter out of order updates/\n   */\n  timestamp?: string;\n\n  /**\n   * Optional ISO 8601 date string that defines when to end this Live Update.\n   */\n  dismissTimestamp?: string;\n}\n\n/**\n * Live Update end request.\n */\nexport interface LiveUpdateEndRequest {\n  /**\n   * The Live Update name.\n   */\n  name: string;\n\n  /**\n   * Dynamic content.\n   */\n  content?: JsonObject;\n\n  /**\n   * Optional ISO 8601 date string, used to filter out of order updates/\n   */\n  timestamp?: string;\n\n  /**\n   * Optional ISO 8601 date string that defines when to end this Live Update.\n   */\n  dismissTimestamp?: string;\n}\n\n/**\n * Live Update start request.\n */\nexport interface LiveUpdateStartRequest {\n  /**\n   * The Live Update name.\n   */\n  name: string;\n\n  /**\n   * The Live Update type.\n   */\n  type: string;\n\n  /**\n   * Dynamic content.\n   */\n  content: JsonObject;\n\n  /**\n   * Optional ISO 8601 date string, used to filter out of order updates/\n   */\n  timestamp?: string;\n\n  /**\n   * Optional ISO 8601 date string that defines when to end this Live Update.\n   */\n  dismissTimestamp?: string;\n}"]}

package/dist/plugin.cjs.js

@@ -150,6 +150,7 @@ var EventType;
     EventType["DisplayPreferenceCenter"] = "display_preference_center";
     EventType["PushTokenReceived"] = "push_token_received";
     EventType["IOSAuthorizedNotificationSettingsChanged"] = "ios_authorized_notification_settings_changed";
+    EventType["IOSLiveActivitiesUpdated"] = "ios_live_activities_updated";
 })(EventType || (EventType = {}));
 
 /* Copyright Airship and Contributors */
@@ -1052,6 +1053,116 @@ class AirshipPushAndroid {
     }
 }
 
+/**
+ * Live Activity manager.
+ */
+class AirshipLiveActivityManager {
+    constructor(plugin) {
+        this.plugin = plugin;
+    }
+    /**
+     * Lists any Live Activities for the request.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    list(request) {
+        return this.plugin.perform('liveActivityManager#list', request);
+    }
+    /**
+     * Lists all Live Activities.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    listAll() {
+        return this.plugin.perform('liveActivityManager#listAll');
+    }
+    /**
+     * Starts a Live Activity.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    start(request) {
+        return this.plugin.perform('liveActivityManager#start', request);
+    }
+    /**
+     * Updates a Live Activity.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    update(request) {
+        return this.plugin.perform('liveActivityManager#update', request);
+    }
+    /**
+     * Ends a Live Activity.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    end(request) {
+        return this.plugin.perform('liveActivityManager#end', request);
+    }
+    /**
+     * Adds a Live Activity listener.
+     */
+    onLiveActivityUpdates(listener) {
+        return this.plugin.addListener(EventType.IOSLiveActivitiesUpdated, listener);
+    }
+}
+
+/**
+ * Live Update manager.
+ */
+class AirshipLiveUpdateManager {
+    constructor(plugin) {
+        this.plugin = plugin;
+    }
+    /**
+     * Lists any Live Updates for the request.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    list(request) {
+        return this.plugin.perform('liveUpdateManager#list', request);
+    }
+    /**
+     * Lists all Live Updates.
+     * @returns A promise with the result.
+     */
+    listAll() {
+        return this.plugin.perform('liveUpdateManager#listAll');
+    }
+    /**
+     * Starts a Live Update.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    start(request) {
+        return this.plugin.perform('liveUpdateManager#start', request);
+    }
+    /**
+     * Updates a Live Update.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    update(request) {
+        return this.plugin.perform('liveUpdateManager#update', request);
+    }
+    /**
+     * Ends a Live Update.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    end(request) {
+        return this.plugin.perform('liveUpdateManager#end', request);
+    }
+    /**
+     * Clears all Live Updates.
+     * @returns A promise with the result.
+     */
+    clearAll() {
+        return this.plugin.perform('liveUpdateManager#clearAll');
+    }
+}
+
 /**
  * Airship
  */
@@ -1069,6 +1180,8 @@ class AirshipRoot {
         this.privacyManager = new AirshipPrivacyManager(plugin);
         this.push = new AirshipPush(plugin);
         this.featureFlagManager = new AirshipFeatureFlagManager(plugin);
+        this.iOS = new AirshipRootIOS(plugin);
+        this.android = new AirshipRootAndroid(plugin);
     }
     /**
      * Calls takeOff. If Airship is already configured for
@@ -1094,6 +1207,16 @@ class AirshipRoot {
         return this.plugin.addListener(EventType.DeepLink, listener);
     }
 }
+class AirshipRootIOS {
+    constructor(plugin) {
+        this.liveActivityManager = new AirshipLiveActivityManager(plugin);
+    }
+}
+class AirshipRootAndroid {
+    constructor(plugin) {
+        this.liveUpdateManager = new AirshipLiveUpdateManager(plugin);
+    }
+}
 
 /// <reference types="@capacitor/cli" />
 class AirshipPluginWrapper {
@@ -1301,6 +1424,8 @@ exports.AirshipChannel = AirshipChannel;
 exports.AirshipContact = AirshipContact;
 exports.AirshipFeatureFlagManager = AirshipFeatureFlagManager;
 exports.AirshipInApp = AirshipInApp;
+exports.AirshipLiveActivityManager = AirshipLiveActivityManager;
+exports.AirshipLiveUpdateManager = AirshipLiveUpdateManager;
 exports.AirshipLocale = AirshipLocale;
 exports.AirshipMessageCenter = AirshipMessageCenter;
 exports.AirshipPreferenceCenter = AirshipPreferenceCenter;