@ua/capacitor-airship 1.0.0

package/dist/esm/types.d.ts

@@ -0,0 +1,651 @@
+export declare type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
+export declare type JsonObject = {
+    [key: string]: JsonValue;
+};
+export declare type JsonArray = JsonValue[];
+export interface ChannelCreatedEvent {
+    /**
+     * The channel ID.
+     */
+    channelId: string;
+}
+export interface PushTokenReceivedEvent {
+    /**
+     * The push token.
+     */
+    pushToken: string;
+}
+/**
+ * Event fired when a push is received.
+ */
+export interface PushReceivedEvent {
+    pushPayload: PushPayload;
+}
+/**
+ * The push payload.
+ */
+export interface PushPayload {
+    /**
+     * The alert.
+     */
+    alert?: string;
+    /**
+     * The title.
+     */
+    title?: string;
+    /**
+     * The subtitle.
+     */
+    subtitle?: string;
+    /**
+     * The notification ID.
+     */
+    notificationId?: string;
+    /**
+     * The notification extras.
+     */
+    extras: JsonObject;
+}
+/**
+ * Event fired when the user initiates a notification response.
+ */
+export interface NotificationResponseEvent {
+    /**
+     * The push notification.
+     */
+    pushPayload: PushPayload;
+    /**
+     * The action button ID, if available.
+     */
+    actionId?: string;
+    /**
+     * Indicates whether the response was a foreground action.
+     * This value is always if the user taps the main notification,
+     * otherwise it is defined by the notification action button.
+     */
+    isForeground: boolean;
+}
+/**
+ * Push notification status.
+ */
+export interface PushNotificationStatus {
+    /**
+     * If user notifications are enabled on [Airship.push].
+     */
+    isUserNotificationsEnabled: boolean;
+    /**
+     * If notifications are allowed at the system level for the application.
+     */
+    areNotificationsAllowed: boolean;
+    /**
+     * If the push feature is enabled on [Airship.privacyManager].
+     */
+    isPushPrivacyFeatureEnabled: boolean;
+    isPushTokenRegistered: boolean;
+    isOptedIn: boolean;
+    isUserOptedIn: boolean;
+}
+/**
+ * Event fired when the notification status changes.
+ */
+export interface PushNotificationStatusChangedEvent {
+    /**
+     * The push notification status.
+     */
+    status: PushNotificationStatus;
+}
+/**
+ * Event fired when the Message Center is updated.
+ */
+export interface MessageCenterUpdatedEvent {
+    /**
+     * The unread message count.
+     */
+    messageUnreadCount: number;
+    /**
+     * The total message count.
+     */
+    messageCount: number;
+}
+/**
+ * Event fired when the Message Center is requested to be displayed.
+ */
+export interface DisplayMessageCenterEvent {
+    /**
+     * The message ID, if available.
+     */
+    messageId?: string;
+}
+/**
+ * Event fired when a deep link is opened.
+ */
+export interface DeepLinkEvent {
+    /**
+     * The deep link string.
+     */
+    deepLink: string;
+}
+/**
+ * Event fired when a preference center is requested to be displayed.
+ */
+export interface DisplayPreferenceCenterEvent {
+    /**
+     * The preference center Id.
+     */
+    preferenceCenterId: string;
+}
+/**
+ * Custom event
+ */
+export interface CustomEvent {
+    /**
+     * Event name
+     */
+    eventName: string;
+    /**
+     * Event value
+     */
+    eventValue?: number;
+    /**
+     * Event properties
+     */
+    properties: JsonObject;
+    /**
+     * Transaction ID
+     */
+    transactionId?: string;
+    /**
+     * Interaction ID
+     */
+    interactionId?: string;
+    /**
+     * Interaction type
+     */
+    interactionType?: string;
+}
+/**
+ * iOS options
+ */
+export declare namespace iOS {
+    /**
+     * Quiet time
+     */
+    interface QuietTime {
+        /**
+         * Start hour. Must be 0-23.
+         */
+        startHour: number;
+        /**
+         * Start minute. Must be 0-59.
+         */
+        startMinute: number;
+        /**
+         * End hour. Must be 0-23.
+         */
+        endHour: number;
+        /**
+         * End minute. Must be 0-59.
+         */
+        endMinute: number;
+    }
+    /**
+     * Enum of notification options. iOS only.
+     */
+    enum NotificationOption {
+        /**
+         * Alerts.
+         */
+        Alert = "alert",
+        /**
+         * Sounds.
+         */
+        Sound = "sound",
+        /**
+         * Badges.
+         */
+        Badge = "badge",
+        /**
+         * Car play.
+         */
+        CarPlay = "car_play",
+        /**
+         * Critical Alert.
+         */
+        CriticalAlert = "critical_alert",
+        /**
+         * Provides app notification settings.
+         */
+        ProvidesAppNotificationSettings = "provides_app_notification_settings",
+        /**
+         * Provisional.
+         */
+        Provisional = "provisional"
+    }
+    /**
+     * Enum of foreground notification options.
+     */
+    enum ForegroundPresentationOption {
+        /**
+         * Play the sound associated with the notification.
+         */
+        Sound = "sound",
+        /**
+         * Apply the notification's badge value to the app’s icon.
+         */
+        Badge = "badge",
+        /**
+         * Show the notification in Notification Center. On iOS 13 an older,
+         * this will also show the notification as a banner.
+         */
+        List = "list",
+        /**
+         * Present the notification as a banner. On iOS 13 an older,
+         * this will also show the notification in the Notification Center.
+         */
+        Banner = "banner"
+    }
+    /**
+     * Enum of authorized notification options.
+     */
+    enum AuthorizedNotificationSetting {
+        /**
+         * Alerts.
+         */
+        Alert = "alert",
+        /**
+         * Sounds.
+         */
+        Sound = "sound",
+        /**
+         * Badges.
+         */
+        Badge = "badge",
+        /**
+         * CarPlay.
+         */
+        CarPlay = "car_play",
+        /**
+         * Lock screen.
+         */
+        LockScreen = "lock_screen",
+        /**
+         * Notification center.
+         */
+        NotificationCenter = "notification_center",
+        /**
+         * Critical alert.
+         */
+        CriticalAlert = "critical_alert",
+        /**
+         * Announcement.
+         */
+        Announcement = "announcement",
+        /**
+         * Scheduled delivery.
+         */
+        ScheduledDelivery = "scheduled_delivery",
+        /**
+         * Time sensitive.
+         */
+        TimeSensitive = "time_sensitive"
+    }
+    /**
+     * Enum of authorized status.
+     */
+    enum AuthorizedNotificationStatus {
+        /**
+         * Not determined.
+         */
+        NotDetermined = "not_determined",
+        /**
+         * Denied.
+         */
+        Denied = "denied",
+        /**
+         * Authorized.
+         */
+        Authorized = "authorized",
+        /**
+         * Provisional.
+         */
+        Provisional = "provisional",
+        /**
+         * Ephemeral.
+         */
+        Ephemeral = "ephemeral"
+    }
+    interface AuthorizedNotificationSettingsChangedEvent {
+        /**
+         * Authorized settings.
+         */
+        authorizedSettings: AuthorizedNotificationSetting[];
+    }
+}
+export declare namespace Android {
+    /**
+     * Android notification config.
+     */
+    interface NotificationConfig {
+        /**
+         * The icon resource name.
+         */
+        icon?: string;
+        /**
+         * The large icon resource name.
+         */
+        largeIcon?: string;
+        /**
+         * The default android notification channel ID.
+         */
+        defaultChannelId?: string;
+        /**
+         * The accent color. Must be a hex value #AARRGGBB.
+         */
+        accentColor?: string;
+    }
+}
+/**
+ * Airship config environment
+ */
+export interface ConfigEnvironment {
+    /**
+     * App key.
+     */
+    appKey: string;
+    /**
+     * App secret.
+     */
+    appSecret: string;
+    /**
+     * Optional log level.
+     */
+    logLevel?: LogLevel;
+}
+/**
+ * Possible sites.
+ */
+export declare type Site = 'us' | 'eu';
+/**
+ * Log levels.
+ */
+export declare type LogLevel = 'verbose' | 'debug' | 'info' | 'warning' | 'error' | 'none';
+/**
+ * Airship config
+ */
+export interface AirshipConfig {
+    /**
+     * Default environment.
+     */
+    default?: ConfigEnvironment;
+    /**
+     * Development environment. Overrides default environment if inProduction is false.
+     */
+    development?: ConfigEnvironment;
+    /**
+     * Production environment. Overrides default environment if inProduction is true.
+     */
+    production?: ConfigEnvironment;
+    /**
+     * Cloud site.
+     */
+    site?: Site;
+    /**
+     * Switches the environment from development or production. If the value is not
+     * set, Airship will determine the value at runtime.
+     */
+    inProduction?: boolean;
+    /**
+     * URL allow list.
+     */
+    urlAllowList?: string[];
+    /**
+     * URL allow list for open URL scope.
+     */
+    urlAllowListScopeOpenUrl?: string[];
+    /**
+     * URL allow list for JS bridge injection.
+     */
+    urlAllowListScopeJavaScriptInterface?: string[];
+    /**
+     * Enables delayed channel creation.
+     * Deprecated. Use the Private Manager to disable all features instead.
+     */
+    isChannelCreationDelayEnabled?: boolean;
+    /**
+     * Initial config URL for custom Airship domains. The URL
+     * should also be added to the urlAllowList.
+     */
+    initialConfigUrl?: string;
+    /**
+     * Enabled features. Defaults to all.
+     */
+    enabledFeatures?: Feature[];
+    /**
+     * Enables channel capture feature.
+     * This config is enabled by default.
+     */
+    isChannelCaptureEnabled?: boolean;
+    /**
+     * Whether to suppress console error messages about missing allow list entries during takeOff.
+     * This config is disabled by default.
+     */
+    suppressAllowListError?: boolean;
+    /**
+     * Pauses In-App Automation on launch.
+     */
+    autoPauseInAppAutomationOnLaunch?: boolean;
+    /**
+     * iOS config.
+     */
+    ios?: {
+        /**
+         * itunesId for rate app and app store deep links.
+         */
+        itunesId?: string;
+    };
+    /**
+     * Android config.
+     */
+    android?: {
+        /**
+         * App store URI
+         */
+        appStoreUri?: string;
+        /**
+         * Fcm app name if using multiple FCM projects.
+         */
+        fcmFirebaseAppName?: string;
+        /**
+         * Notification config.
+         */
+        notificationConfig?: Android.NotificationConfig;
+    };
+}
+/**
+ * Enum of authorized Features.
+ */
+export declare enum Feature {
+    InAppAutomation = "in_app_automation",
+    MessageCenter = "message_center",
+    Push = "push",
+    Chat = "chat",
+    Analytics = "analytics",
+    TagsAndAttributes = "tags_and_attributes",
+    Contacts = "contacts",
+    Location = "location"
+}
+/**
+ * All available features.
+ */
+export declare const FEATURES_ALL: Feature[];
+/**
+ * Subscription Scope types.
+ */
+export declare enum SubscriptionScope {
+    App = "app",
+    Web = "web",
+    Sms = "sms",
+    Email = "email"
+}
+export interface InboxMessage {
+    /**
+     * The message ID. Needed to display, mark as read, or delete the message.
+     */
+    id: string;
+    /**
+     * The message title.
+     */
+    title: string;
+    /**
+     * The message sent date in milliseconds.
+     */
+    sentDate: number;
+    /**
+     * Optional - The icon url for the message.
+     */
+    listIconUrl: string;
+    /**
+     * The unread / read status of the message.
+     */
+    isRead: boolean;
+    /**
+     * String to String map of any message extras.
+     */
+    extras: Record<string, string>;
+}
+/**
+ * A preference center definition.
+ *
+ * @typedef {object} PreferenceCenter
+ * @property {string} id the ID of the preference center
+ * @property {Array<PreferenceCenter.CommonSection>} sections a list of sections
+ * @property {?CommonDisplay} display display information
+ */
+export declare type PreferenceCenter = {
+    id: string;
+    sections: Section[];
+    display?: CommonDisplay;
+};
+/**
+ * Preference center display information.
+ * @typedef {object} CommonDisplay
+ * @property {string} name
+ * @property {?string} description
+ */
+export declare type CommonDisplay = {
+    name: string;
+    description?: string;
+};
+export declare type Icon = {
+    icon: string;
+};
+export declare type IconDisplay = CommonDisplay & Partial<Icon>;
+export interface ItemBase {
+    type: unknown;
+    id: string;
+    display: CommonDisplay;
+    conditions?: Condition[];
+}
+/**
+ * A channel subscription item.
+ * @typedef {object} ChannelSubscriptionItem
+ * @memberof PreferenceCenter
+ * @property {"channel_subscription"} type
+ * @property {string} id the item identifier
+ * @property {?CommonDisplay} display display information
+ * @property {string} subscription_id the subscription list id
+ */
+export interface ChannelSubscriptionItem extends ItemBase {
+    type: 'channel_subscription';
+    subscription_id: string;
+}
+export interface ContactSubscriptionGroupItem extends ItemBase {
+    type: 'contact_subscription_group';
+    id: string;
+    subscription_id: string;
+    components: ContactSubscriptionGroupItemComponent[];
+}
+export interface ContactSubscriptionGroupItemComponent {
+    scopes: SubscriptionScope[];
+    display: Omit<CommonDisplay, 'description'>;
+}
+export interface ContactSubscriptionItem extends ItemBase {
+    type: 'contact_subscription';
+    scopes: SubscriptionScope[];
+    subscription_id: string;
+}
+export interface AlertItem extends ItemBase {
+    type: 'alert';
+    display: IconDisplay;
+    button?: Button;
+}
+export interface ConditionBase {
+    type: unknown;
+}
+export interface NotificationOptInCondition extends ConditionBase {
+    type: 'notification_opt_in';
+    when_status: 'opt_in' | 'opt_out';
+}
+export declare type Condition = NotificationOptInCondition;
+export declare type Actions = {
+    [key: string]: JsonValue;
+};
+export interface Button {
+    text: string;
+    content_description?: string;
+    actions: Actions;
+}
+export interface SectionBase {
+    type: unknown;
+    id: string;
+    display?: CommonDisplay;
+    items: Item[];
+}
+/**
+ * @typedef {object} CommonSection
+ * @memberof PreferenceCenter
+ * @property {"section"} type
+ * @property {string} id the section identifier
+ * @property {?CommonDisplay} display display information
+ * @property {Array<PreferenceCenter.ChannelSubscriptionItem>} items list of
+ *   section items
+ */
+export interface CommonSection extends SectionBase {
+    type: 'section';
+}
+export interface LabeledSectionBreak extends SectionBase {
+    type: 'labeled_section_break';
+    items: never;
+}
+export declare type Item = ChannelSubscriptionItem | ContactSubscriptionGroupItem | ContactSubscriptionItem | AlertItem;
+export declare type Section = CommonSection | LabeledSectionBreak;
+/**
+ * An interface representing the eligibility status of a flag, and optional
+ * variables associated with the flag.
+ */
+export interface FeatureFlag {
+    /**
+     * A boolean representing flag eligibility; will be `true` if the current
+     * contact is eligible for the flag.
+     */
+    readonly isEligible: boolean;
+    /**
+     * A variables associated with the flag, if any. Will be `null` if no data
+     * is associated with the flag, or if the flag does not exist.
+     */
+    readonly variables: unknown | null;
+    /**
+     * A boolean representing if the flag exists or not. For ease of use and
+     * deployment, asking for a flag by any name will return a `FeatureFlag`
+     * interface, even if the flag was not found to exist. However this property
+     * may be checked to determine if the flag was actually resolved to a known
+     * flag name.
+     */
+    readonly exists: boolean;
+    /**
+     * Reporting Metadata, the shape of which is private and not to be relied
+     * upon. When not provided, an interaction cannot be tracked on the flag.
+     * @ignore
+     */
+    readonly _internal: unknown;
+}