@fishonfire/bubbles-expo 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,306 @@
+import { LocaleAndTimeZone, DeviceClient, DeviceClientOptions, RequestOptions, UpdateDeviceOptions } from '@fishonfire/bubbles-js';
+import * as Notifications from 'expo-notifications';
+import { Notification } from 'expo-notifications';
+import * as react from 'react';
+import { ReactNode } from 'react';
+
+declare const BUBBLES_NOTIFICATIONS_EXPO_EXTRA_KEY = "bubblesNotificationsExpo";
+declare const ANDROID_CHANNEL_IMPORTANCE_VALUES: readonly ["min", "low", "default", "high", "max"];
+type AndroidChannelImportance = (typeof ANDROID_CHANNEL_IMPORTANCE_VALUES)[number];
+interface BubblesNotificationsRuntimeConfig {
+    defaultChannelId: string;
+    defaultChannelName: string;
+    androidChannelImportance: AndroidChannelImportance;
+}
+declare function getBubblesNotificationsRuntimeConfig(): BubblesNotificationsRuntimeConfig;
+
+interface StoredDeviceState {
+    deviceId: string | null;
+    apiBaseUrl: string | null;
+    appKey: string | null;
+}
+type StoredDeviceStateUpdate = Partial<StoredDeviceState>;
+declare function readStoredDeviceState(): StoredDeviceState;
+declare function storeDeviceState(state: StoredDeviceState): StoredDeviceState;
+declare function patchStoredDeviceState(update: StoredDeviceStateUpdate): StoredDeviceState;
+declare function readStoredDeviceId(): string | null;
+declare function readStoredApiBaseUrl(): string | null;
+declare function readStoredAppKey(): string | null;
+declare function storeDeviceId(deviceId: string | null): StoredDeviceState;
+declare function storeApiBaseUrl(apiBaseUrl: string | null): StoredDeviceState;
+declare function storeAppKey(appKey: string | null): StoredDeviceState;
+
+type BubblesDevicePlatform = 'android' | 'ios';
+interface BuildBubblesDevicePayloadOptions {
+    userId: string;
+    aliasing?: string[] | null;
+    platform: BubblesDevicePlatform;
+    pushToken: string | null;
+    fid?: string | null;
+    appVersion?: string | null;
+    notificationsEnabled: boolean;
+    localeAndTimeZone?: LocaleAndTimeZone;
+}
+interface BuildBubblesCreateDevicePayloadOptions extends BuildBubblesDevicePayloadOptions {
+    appId: string | number;
+}
+interface BubblesDevicePayload {
+    user_id: string;
+    aliasing: string[];
+    platform: BubblesDevicePlatform;
+    push_token: string | null;
+    fid?: string | null;
+    app_version?: string;
+    locale: string;
+    timezone?: string;
+    notifications_enabled: boolean;
+}
+interface BubblesCreateDevicePayload extends BubblesDevicePayload {
+    app_id: string | number;
+}
+type BubblesUpdateDevicePayload = BubblesDevicePayload;
+declare function buildCreateDevicePayload(options: BuildBubblesCreateDevicePayloadOptions): BubblesCreateDevicePayload;
+declare function buildUpdateDevicePayload(options: BuildBubblesDevicePayloadOptions): BubblesUpdateDevicePayload;
+
+declare class BubblesAppAuthenticationError extends Error {
+    readonly cause: unknown;
+    constructor(cause?: unknown);
+}
+interface BubblesDeviceClientOptions extends DeviceClientOptions {
+    appKey?: string;
+}
+type DeviceClientFactoryOptions$1 = Omit<BubblesDeviceClientOptions, 'baseUrl'>;
+interface BubblesDeviceClientInput {
+    apiBaseUrl?: string;
+    appKey: string;
+    client?: DeviceClient;
+    clientOptions?: DeviceClientFactoryOptions$1;
+}
+interface CreateBubblesDeviceOptions extends BuildBubblesCreateDevicePayloadOptions, BubblesDeviceClientInput {
+    requestOptions?: RequestOptions;
+}
+interface UpdateBubblesDeviceOptions extends BuildBubblesDevicePayloadOptions, BubblesDeviceClientInput {
+    deviceId: string | number;
+    requestOptions?: UpdateDeviceOptions;
+}
+interface SyncBubblesDeviceOptions extends BuildBubblesCreateDevicePayloadOptions, BubblesDeviceClientInput {
+    deviceId: string | number | null;
+    createRequestOptions?: RequestOptions;
+    updateRequestOptions?: UpdateDeviceOptions;
+}
+interface SyncBubblesDeviceResult<TResponse = unknown> {
+    action: 'created' | 'updated';
+    deviceId: string | null;
+    response: TResponse;
+}
+declare function createBubblesDeviceClient(options: BubblesDeviceClientOptions): DeviceClient;
+declare function extractDeviceIdFromDeviceResponse(value: unknown): string | null;
+declare function createBubblesDevice<TResponse = unknown>(options: CreateBubblesDeviceOptions): Promise<TResponse>;
+declare function updateBubblesDevice<TResponse = unknown>(options: UpdateBubblesDeviceOptions): Promise<TResponse>;
+declare function syncBubblesDevice<TResponse = unknown>(options: SyncBubblesDeviceOptions): Promise<SyncBubblesDeviceResult<TResponse>>;
+
+type DeviceClientFactoryOptions = Omit<DeviceClientOptions, 'baseUrl'>;
+/**
+ * Public delivery status labels accepted by the Bubbles device API.
+ *
+ * Client-side notification callbacks are source-specific observations:
+ * "received" means app-observed, "shown" may be
+ * confirmed/requested/inferred depending on source, "clicked"
+ * means app-observed user interaction, and "disabled" describes
+ * permission/device capability.
+ */
+declare const BUBBLES_DELIVERY_STATUSES: {
+    readonly notificationReceived: "received";
+    readonly notificationShown: "shown";
+    readonly notificationClicked: "clicked";
+    readonly notificationsDisabled: "disabled";
+};
+type BubblesDeliveryStatus = (typeof BUBBLES_DELIVERY_STATUSES)[keyof typeof BUBBLES_DELIVERY_STATUSES];
+interface BubblesDeliveryStatusPayload {
+    status?: BubblesDeliveryStatus;
+    error?: string;
+}
+interface BuildBubblesDeliveryStatusPayloadOptions {
+    status?: BubblesDeliveryStatus;
+    error?: string | null;
+}
+interface PostBubblesDeliveryStatusOptions extends BuildBubblesDeliveryStatusPayloadOptions {
+    apiBaseUrl?: string;
+    appKey: string;
+    deviceId: string | number;
+    notificationId: string | number;
+    client?: DeviceClient;
+    clientOptions?: DeviceClientFactoryOptions;
+    requestOptions?: RequestOptions;
+}
+declare function buildBubblesDeliveryStatusPayload(options: BuildBubblesDeliveryStatusPayloadOptions): BubblesDeliveryStatusPayload;
+declare function postBubblesDeliveryStatus(options: PostBubblesDeliveryStatusOptions): Promise<void>;
+
+interface PostStoredBubblesDeliveryStatusOptions {
+    source: string;
+    notificationId: string | null;
+    status?: BubblesDeliveryStatus;
+    error?: string | null;
+    actionId?: string | null;
+    storedDeviceState?: StoredDeviceState;
+}
+declare function postStoredBubblesDeliveryStatus(options: PostStoredBubblesDeliveryStatusOptions): Promise<StoredDeviceState>;
+declare function flushStoredBubblesDeliveryStatuses(storedDeviceState?: StoredDeviceState): Promise<StoredDeviceState>;
+
+interface StoredDeliveryStatusEvent {
+    key: string;
+    notificationId: string;
+    status?: BubblesDeliveryStatus;
+    error?: string;
+    actionId?: string;
+    createdAt: string;
+}
+interface StoredDeliveryStatusLedger {
+    pendingEvents: StoredDeliveryStatusEvent[];
+    postedEventKeys: string[];
+}
+interface CreateStoredDeliveryStatusEventOptions {
+    notificationId: string;
+    status?: BubblesDeliveryStatus;
+    error?: string | null;
+    actionId?: string | null;
+}
+declare function buildStoredDeliveryStatusEventKey(options: Omit<CreateStoredDeliveryStatusEventOptions, 'error'> & {
+    error?: string;
+}): string;
+declare function createStoredDeliveryStatusEvent(options: CreateStoredDeliveryStatusEventOptions): StoredDeliveryStatusEvent;
+declare function readStoredDeliveryStatusLedger(): StoredDeliveryStatusLedger;
+declare function storeDeliveryStatusLedger(ledger: StoredDeliveryStatusLedger): StoredDeliveryStatusLedger;
+declare function enqueueStoredDeliveryStatusEvent(event: StoredDeliveryStatusEvent): StoredDeliveryStatusLedger;
+declare function markStoredDeliveryStatusEventPosted(event: StoredDeliveryStatusEvent): StoredDeliveryStatusLedger;
+
+interface EnsureDefaultNotificationChannelOptions {
+    channelId?: string;
+    channelName?: string;
+    importance?: AndroidChannelImportance;
+}
+interface DefaultNotificationChannelConfig {
+    channelId: string;
+    channelName: string;
+    importance: AndroidChannelImportance;
+}
+declare function getAndroidNotificationChannelImportance(value: AndroidChannelImportance): Notifications.AndroidImportance;
+declare function getDefaultNotificationChannelConfig(options?: EnsureDefaultNotificationChannelOptions): DefaultNotificationChannelConfig;
+declare function ensureDefaultNotificationChannel(options?: EnsureDefaultNotificationChannelOptions): Promise<Notifications.NotificationChannel | null>;
+
+declare function registerBubblesBackgroundHandlers(): void;
+
+type PermissionRequestOptions = Parameters<typeof Notifications.requestPermissionsAsync>[0];
+interface GetNotificationPermissionsOptions {
+    requestPermissions?: boolean;
+    permissionRequestOptions?: PermissionRequestOptions;
+}
+declare function isNotificationPermissionGranted(permissions: Notifications.NotificationPermissionsStatus): boolean;
+declare function describeNotificationPermissionStatus(permissions: Notifications.NotificationPermissionsStatus): string;
+declare function getNotificationPermissions(options?: GetNotificationPermissionsOptions): Promise<Notifications.NotificationPermissionsStatus>;
+declare function ensureNotificationPermissions(options?: GetNotificationPermissionsOptions): Promise<Notifications.NotificationPermissionsStatus>;
+
+type SupportedPlatform = 'android' | 'ios';
+
+type NativeTokenType = 'fcm';
+type GetDeviceTokenOptions = GetNotificationPermissionsOptions;
+interface DeviceTokenResult {
+    platform: SupportedPlatform;
+    tokenType: NativeTokenType;
+    token: string;
+}
+interface DeviceRegistrationState {
+    platform: SupportedPlatform;
+    tokenType: NativeTokenType | null;
+    token: string | null;
+    permissionStatus: string;
+    notificationsEnabled: boolean;
+}
+declare function getDeviceRegistrationState(options?: GetDeviceTokenOptions): Promise<DeviceRegistrationState>;
+declare function getDeviceToken(options?: GetDeviceTokenOptions): Promise<DeviceTokenResult>;
+declare function getFCMToken(options?: GetDeviceTokenOptions): Promise<string>;
+
+interface RegisterDeviceOptions {
+    requestPermissions?: boolean;
+    permissionRequestOptions?: PermissionRequestOptions;
+}
+interface ForegroundPresentationOptions {
+    shouldShowBanner?: boolean;
+    shouldShowList?: boolean;
+    shouldPlaySound?: boolean;
+    shouldSetBadge?: boolean;
+}
+interface BubblesNotificationsLogoutEvent {
+    previousUserId: string;
+    deviceId: string | null;
+}
+interface BubblesNotificationResponseEvent {
+    notification: Notification;
+    url: string | null;
+    notificationId: string | null;
+    deviceId: string | null;
+    data: Record<string, unknown>;
+}
+interface BubblesNotificationsProviderProps {
+    appId: string | number;
+    appKey: string;
+    apiBaseUrl: string;
+    ready: boolean;
+    userId: string | null;
+    aliasing?: string[];
+    appVersion?: string | null;
+    onLogout?: (event: BubblesNotificationsLogoutEvent) => Promise<void> | void;
+    foregroundPresentation?: ForegroundPresentationOptions;
+    onNotificationResponse?: (event: BubblesNotificationResponseEvent) => void;
+    children: ReactNode;
+}
+interface BubblesNotificationsContextValue {
+    registerDevice: (options?: RegisterDeviceOptions) => Promise<void>;
+    deviceId: string | null;
+    pushToken: string | null;
+    tokenType: NativeTokenType | null;
+    permissionStatus: string;
+    notificationsEnabled: boolean;
+    isSyncing: boolean;
+    error: Error | null;
+}
+
+declare function BubblesNotificationsProvider(props: BubblesNotificationsProviderProps): react.JSX.Element;
+
+declare function useBubblesNotifications(): BubblesNotificationsContextValue;
+
+interface BubblesNotificationDataContract {
+    notification_id: string;
+    url?: string;
+    type?: string;
+    resource_id?: string;
+    message_title?: string;
+    body?: string;
+    source?: string;
+    message_id?: string;
+    campaign_id?: string;
+    [key: string]: string | undefined;
+}
+interface BubblesVisibleNotificationPayloadContract {
+    notification: {
+        title: string;
+        body: string;
+    };
+    data: BubblesNotificationDataContract;
+}
+interface BubblesSilentNotificationPayloadContract {
+    data: BubblesNotificationDataContract;
+}
+type BubblesForegroundNotificationPayloadContract = BubblesVisibleNotificationPayloadContract;
+interface BubblesNotificationPayload {
+    data: Record<string, unknown>;
+    notificationId: string | null;
+    messageTitle: string | null;
+    body: string | null;
+    source: string | null;
+    messageId: string | null;
+    campaignId: string | null;
+    url: string | null;
+}
+
+export { ANDROID_CHANNEL_IMPORTANCE_VALUES, type AndroidChannelImportance, BUBBLES_DELIVERY_STATUSES, BUBBLES_NOTIFICATIONS_EXPO_EXTRA_KEY, BubblesAppAuthenticationError, type BubblesCreateDevicePayload, type BubblesDeliveryStatus, type BubblesDeliveryStatusPayload, type BubblesDevicePayload, type BubblesDevicePlatform, type BubblesForegroundNotificationPayloadContract, type BubblesNotificationDataContract, type BubblesNotificationPayload, type BubblesNotificationResponseEvent, type BubblesNotificationsContextValue, type BubblesNotificationsLogoutEvent, BubblesNotificationsProvider, type BubblesNotificationsProviderProps, type BubblesNotificationsRuntimeConfig, type BubblesSilentNotificationPayloadContract, type BubblesUpdateDevicePayload, type BubblesVisibleNotificationPayloadContract, type BuildBubblesCreateDevicePayloadOptions, type BuildBubblesDeliveryStatusPayloadOptions, type BuildBubblesDevicePayloadOptions, type CreateBubblesDeviceOptions, type CreateStoredDeliveryStatusEventOptions, type DefaultNotificationChannelConfig, type DeviceRegistrationState, type DeviceTokenResult, type EnsureDefaultNotificationChannelOptions, type ForegroundPresentationOptions, type GetDeviceTokenOptions, type GetNotificationPermissionsOptions, type NativeTokenType, type PermissionRequestOptions, type PostBubblesDeliveryStatusOptions, type PostStoredBubblesDeliveryStatusOptions, type RegisterDeviceOptions, type StoredDeliveryStatusEvent, type StoredDeliveryStatusLedger, type StoredDeviceState, type StoredDeviceStateUpdate, type SupportedPlatform, type SyncBubblesDeviceOptions, type SyncBubblesDeviceResult, type UpdateBubblesDeviceOptions, buildBubblesDeliveryStatusPayload, buildCreateDevicePayload, buildStoredDeliveryStatusEventKey, buildUpdateDevicePayload, createBubblesDevice, createBubblesDeviceClient, createStoredDeliveryStatusEvent, describeNotificationPermissionStatus, enqueueStoredDeliveryStatusEvent, ensureDefaultNotificationChannel, ensureNotificationPermissions, extractDeviceIdFromDeviceResponse, flushStoredBubblesDeliveryStatuses, getAndroidNotificationChannelImportance, getBubblesNotificationsRuntimeConfig, getDefaultNotificationChannelConfig, getDeviceRegistrationState, getDeviceToken, getFCMToken, getNotificationPermissions, isNotificationPermissionGranted, markStoredDeliveryStatusEventPosted, patchStoredDeviceState, postBubblesDeliveryStatus, postStoredBubblesDeliveryStatus, readStoredApiBaseUrl, readStoredAppKey, readStoredDeliveryStatusLedger, readStoredDeviceId, readStoredDeviceState, registerBubblesBackgroundHandlers, storeApiBaseUrl, storeAppKey, storeDeliveryStatusLedger, storeDeviceId, storeDeviceState, syncBubblesDevice, updateBubblesDevice, useBubblesNotifications };

package/dist/index.d.ts

@@ -0,0 +1,306 @@
+import { LocaleAndTimeZone, DeviceClient, DeviceClientOptions, RequestOptions, UpdateDeviceOptions } from '@fishonfire/bubbles-js';
+import * as Notifications from 'expo-notifications';
+import { Notification } from 'expo-notifications';
+import * as react from 'react';
+import { ReactNode } from 'react';
+
+declare const BUBBLES_NOTIFICATIONS_EXPO_EXTRA_KEY = "bubblesNotificationsExpo";
+declare const ANDROID_CHANNEL_IMPORTANCE_VALUES: readonly ["min", "low", "default", "high", "max"];
+type AndroidChannelImportance = (typeof ANDROID_CHANNEL_IMPORTANCE_VALUES)[number];
+interface BubblesNotificationsRuntimeConfig {
+    defaultChannelId: string;
+    defaultChannelName: string;
+    androidChannelImportance: AndroidChannelImportance;
+}
+declare function getBubblesNotificationsRuntimeConfig(): BubblesNotificationsRuntimeConfig;
+
+interface StoredDeviceState {
+    deviceId: string | null;
+    apiBaseUrl: string | null;
+    appKey: string | null;
+}
+type StoredDeviceStateUpdate = Partial<StoredDeviceState>;
+declare function readStoredDeviceState(): StoredDeviceState;
+declare function storeDeviceState(state: StoredDeviceState): StoredDeviceState;
+declare function patchStoredDeviceState(update: StoredDeviceStateUpdate): StoredDeviceState;
+declare function readStoredDeviceId(): string | null;
+declare function readStoredApiBaseUrl(): string | null;
+declare function readStoredAppKey(): string | null;
+declare function storeDeviceId(deviceId: string | null): StoredDeviceState;
+declare function storeApiBaseUrl(apiBaseUrl: string | null): StoredDeviceState;
+declare function storeAppKey(appKey: string | null): StoredDeviceState;
+
+type BubblesDevicePlatform = 'android' | 'ios';
+interface BuildBubblesDevicePayloadOptions {
+    userId: string;
+    aliasing?: string[] | null;
+    platform: BubblesDevicePlatform;
+    pushToken: string | null;
+    fid?: string | null;
+    appVersion?: string | null;
+    notificationsEnabled: boolean;
+    localeAndTimeZone?: LocaleAndTimeZone;
+}
+interface BuildBubblesCreateDevicePayloadOptions extends BuildBubblesDevicePayloadOptions {
+    appId: string | number;
+}
+interface BubblesDevicePayload {
+    user_id: string;
+    aliasing: string[];
+    platform: BubblesDevicePlatform;
+    push_token: string | null;
+    fid?: string | null;
+    app_version?: string;
+    locale: string;
+    timezone?: string;
+    notifications_enabled: boolean;
+}
+interface BubblesCreateDevicePayload extends BubblesDevicePayload {
+    app_id: string | number;
+}
+type BubblesUpdateDevicePayload = BubblesDevicePayload;
+declare function buildCreateDevicePayload(options: BuildBubblesCreateDevicePayloadOptions): BubblesCreateDevicePayload;
+declare function buildUpdateDevicePayload(options: BuildBubblesDevicePayloadOptions): BubblesUpdateDevicePayload;
+
+declare class BubblesAppAuthenticationError extends Error {
+    readonly cause: unknown;
+    constructor(cause?: unknown);
+}
+interface BubblesDeviceClientOptions extends DeviceClientOptions {
+    appKey?: string;
+}
+type DeviceClientFactoryOptions$1 = Omit<BubblesDeviceClientOptions, 'baseUrl'>;
+interface BubblesDeviceClientInput {
+    apiBaseUrl?: string;
+    appKey: string;
+    client?: DeviceClient;
+    clientOptions?: DeviceClientFactoryOptions$1;
+}
+interface CreateBubblesDeviceOptions extends BuildBubblesCreateDevicePayloadOptions, BubblesDeviceClientInput {
+    requestOptions?: RequestOptions;
+}
+interface UpdateBubblesDeviceOptions extends BuildBubblesDevicePayloadOptions, BubblesDeviceClientInput {
+    deviceId: string | number;
+    requestOptions?: UpdateDeviceOptions;
+}
+interface SyncBubblesDeviceOptions extends BuildBubblesCreateDevicePayloadOptions, BubblesDeviceClientInput {
+    deviceId: string | number | null;
+    createRequestOptions?: RequestOptions;
+    updateRequestOptions?: UpdateDeviceOptions;
+}
+interface SyncBubblesDeviceResult<TResponse = unknown> {
+    action: 'created' | 'updated';
+    deviceId: string | null;
+    response: TResponse;
+}
+declare function createBubblesDeviceClient(options: BubblesDeviceClientOptions): DeviceClient;
+declare function extractDeviceIdFromDeviceResponse(value: unknown): string | null;
+declare function createBubblesDevice<TResponse = unknown>(options: CreateBubblesDeviceOptions): Promise<TResponse>;
+declare function updateBubblesDevice<TResponse = unknown>(options: UpdateBubblesDeviceOptions): Promise<TResponse>;
+declare function syncBubblesDevice<TResponse = unknown>(options: SyncBubblesDeviceOptions): Promise<SyncBubblesDeviceResult<TResponse>>;
+
+type DeviceClientFactoryOptions = Omit<DeviceClientOptions, 'baseUrl'>;
+/**
+ * Public delivery status labels accepted by the Bubbles device API.
+ *
+ * Client-side notification callbacks are source-specific observations:
+ * "received" means app-observed, "shown" may be
+ * confirmed/requested/inferred depending on source, "clicked"
+ * means app-observed user interaction, and "disabled" describes
+ * permission/device capability.
+ */
+declare const BUBBLES_DELIVERY_STATUSES: {
+    readonly notificationReceived: "received";
+    readonly notificationShown: "shown";
+    readonly notificationClicked: "clicked";
+    readonly notificationsDisabled: "disabled";
+};
+type BubblesDeliveryStatus = (typeof BUBBLES_DELIVERY_STATUSES)[keyof typeof BUBBLES_DELIVERY_STATUSES];
+interface BubblesDeliveryStatusPayload {
+    status?: BubblesDeliveryStatus;
+    error?: string;
+}
+interface BuildBubblesDeliveryStatusPayloadOptions {
+    status?: BubblesDeliveryStatus;
+    error?: string | null;
+}
+interface PostBubblesDeliveryStatusOptions extends BuildBubblesDeliveryStatusPayloadOptions {
+    apiBaseUrl?: string;
+    appKey: string;
+    deviceId: string | number;
+    notificationId: string | number;
+    client?: DeviceClient;
+    clientOptions?: DeviceClientFactoryOptions;
+    requestOptions?: RequestOptions;
+}
+declare function buildBubblesDeliveryStatusPayload(options: BuildBubblesDeliveryStatusPayloadOptions): BubblesDeliveryStatusPayload;
+declare function postBubblesDeliveryStatus(options: PostBubblesDeliveryStatusOptions): Promise<void>;
+
+interface PostStoredBubblesDeliveryStatusOptions {
+    source: string;
+    notificationId: string | null;
+    status?: BubblesDeliveryStatus;
+    error?: string | null;
+    actionId?: string | null;
+    storedDeviceState?: StoredDeviceState;
+}
+declare function postStoredBubblesDeliveryStatus(options: PostStoredBubblesDeliveryStatusOptions): Promise<StoredDeviceState>;
+declare function flushStoredBubblesDeliveryStatuses(storedDeviceState?: StoredDeviceState): Promise<StoredDeviceState>;
+
+interface StoredDeliveryStatusEvent {
+    key: string;
+    notificationId: string;
+    status?: BubblesDeliveryStatus;
+    error?: string;
+    actionId?: string;
+    createdAt: string;
+}
+interface StoredDeliveryStatusLedger {
+    pendingEvents: StoredDeliveryStatusEvent[];
+    postedEventKeys: string[];
+}
+interface CreateStoredDeliveryStatusEventOptions {
+    notificationId: string;
+    status?: BubblesDeliveryStatus;
+    error?: string | null;
+    actionId?: string | null;
+}
+declare function buildStoredDeliveryStatusEventKey(options: Omit<CreateStoredDeliveryStatusEventOptions, 'error'> & {
+    error?: string;
+}): string;
+declare function createStoredDeliveryStatusEvent(options: CreateStoredDeliveryStatusEventOptions): StoredDeliveryStatusEvent;
+declare function readStoredDeliveryStatusLedger(): StoredDeliveryStatusLedger;
+declare function storeDeliveryStatusLedger(ledger: StoredDeliveryStatusLedger): StoredDeliveryStatusLedger;
+declare function enqueueStoredDeliveryStatusEvent(event: StoredDeliveryStatusEvent): StoredDeliveryStatusLedger;
+declare function markStoredDeliveryStatusEventPosted(event: StoredDeliveryStatusEvent): StoredDeliveryStatusLedger;
+
+interface EnsureDefaultNotificationChannelOptions {
+    channelId?: string;
+    channelName?: string;
+    importance?: AndroidChannelImportance;
+}
+interface DefaultNotificationChannelConfig {
+    channelId: string;
+    channelName: string;
+    importance: AndroidChannelImportance;
+}
+declare function getAndroidNotificationChannelImportance(value: AndroidChannelImportance): Notifications.AndroidImportance;
+declare function getDefaultNotificationChannelConfig(options?: EnsureDefaultNotificationChannelOptions): DefaultNotificationChannelConfig;
+declare function ensureDefaultNotificationChannel(options?: EnsureDefaultNotificationChannelOptions): Promise<Notifications.NotificationChannel | null>;
+
+declare function registerBubblesBackgroundHandlers(): void;
+
+type PermissionRequestOptions = Parameters<typeof Notifications.requestPermissionsAsync>[0];
+interface GetNotificationPermissionsOptions {
+    requestPermissions?: boolean;
+    permissionRequestOptions?: PermissionRequestOptions;
+}
+declare function isNotificationPermissionGranted(permissions: Notifications.NotificationPermissionsStatus): boolean;
+declare function describeNotificationPermissionStatus(permissions: Notifications.NotificationPermissionsStatus): string;
+declare function getNotificationPermissions(options?: GetNotificationPermissionsOptions): Promise<Notifications.NotificationPermissionsStatus>;
+declare function ensureNotificationPermissions(options?: GetNotificationPermissionsOptions): Promise<Notifications.NotificationPermissionsStatus>;
+
+type SupportedPlatform = 'android' | 'ios';
+
+type NativeTokenType = 'fcm';
+type GetDeviceTokenOptions = GetNotificationPermissionsOptions;
+interface DeviceTokenResult {
+    platform: SupportedPlatform;
+    tokenType: NativeTokenType;
+    token: string;
+}
+interface DeviceRegistrationState {
+    platform: SupportedPlatform;
+    tokenType: NativeTokenType | null;
+    token: string | null;
+    permissionStatus: string;
+    notificationsEnabled: boolean;
+}
+declare function getDeviceRegistrationState(options?: GetDeviceTokenOptions): Promise<DeviceRegistrationState>;
+declare function getDeviceToken(options?: GetDeviceTokenOptions): Promise<DeviceTokenResult>;
+declare function getFCMToken(options?: GetDeviceTokenOptions): Promise<string>;
+
+interface RegisterDeviceOptions {
+    requestPermissions?: boolean;
+    permissionRequestOptions?: PermissionRequestOptions;
+}
+interface ForegroundPresentationOptions {
+    shouldShowBanner?: boolean;
+    shouldShowList?: boolean;
+    shouldPlaySound?: boolean;
+    shouldSetBadge?: boolean;
+}
+interface BubblesNotificationsLogoutEvent {
+    previousUserId: string;
+    deviceId: string | null;
+}
+interface BubblesNotificationResponseEvent {
+    notification: Notification;
+    url: string | null;
+    notificationId: string | null;
+    deviceId: string | null;
+    data: Record<string, unknown>;
+}
+interface BubblesNotificationsProviderProps {
+    appId: string | number;
+    appKey: string;
+    apiBaseUrl: string;
+    ready: boolean;
+    userId: string | null;
+    aliasing?: string[];
+    appVersion?: string | null;
+    onLogout?: (event: BubblesNotificationsLogoutEvent) => Promise<void> | void;
+    foregroundPresentation?: ForegroundPresentationOptions;
+    onNotificationResponse?: (event: BubblesNotificationResponseEvent) => void;
+    children: ReactNode;
+}
+interface BubblesNotificationsContextValue {
+    registerDevice: (options?: RegisterDeviceOptions) => Promise<void>;
+    deviceId: string | null;
+    pushToken: string | null;
+    tokenType: NativeTokenType | null;
+    permissionStatus: string;
+    notificationsEnabled: boolean;
+    isSyncing: boolean;
+    error: Error | null;
+}
+
+declare function BubblesNotificationsProvider(props: BubblesNotificationsProviderProps): react.JSX.Element;
+
+declare function useBubblesNotifications(): BubblesNotificationsContextValue;
+
+interface BubblesNotificationDataContract {
+    notification_id: string;
+    url?: string;
+    type?: string;
+    resource_id?: string;
+    message_title?: string;
+    body?: string;
+    source?: string;
+    message_id?: string;
+    campaign_id?: string;
+    [key: string]: string | undefined;
+}
+interface BubblesVisibleNotificationPayloadContract {
+    notification: {
+        title: string;
+        body: string;
+    };
+    data: BubblesNotificationDataContract;
+}
+interface BubblesSilentNotificationPayloadContract {
+    data: BubblesNotificationDataContract;
+}
+type BubblesForegroundNotificationPayloadContract = BubblesVisibleNotificationPayloadContract;
+interface BubblesNotificationPayload {
+    data: Record<string, unknown>;
+    notificationId: string | null;
+    messageTitle: string | null;
+    body: string | null;
+    source: string | null;
+    messageId: string | null;
+    campaignId: string | null;
+    url: string | null;
+}
+
+export { ANDROID_CHANNEL_IMPORTANCE_VALUES, type AndroidChannelImportance, BUBBLES_DELIVERY_STATUSES, BUBBLES_NOTIFICATIONS_EXPO_EXTRA_KEY, BubblesAppAuthenticationError, type BubblesCreateDevicePayload, type BubblesDeliveryStatus, type BubblesDeliveryStatusPayload, type BubblesDevicePayload, type BubblesDevicePlatform, type BubblesForegroundNotificationPayloadContract, type BubblesNotificationDataContract, type BubblesNotificationPayload, type BubblesNotificationResponseEvent, type BubblesNotificationsContextValue, type BubblesNotificationsLogoutEvent, BubblesNotificationsProvider, type BubblesNotificationsProviderProps, type BubblesNotificationsRuntimeConfig, type BubblesSilentNotificationPayloadContract, type BubblesUpdateDevicePayload, type BubblesVisibleNotificationPayloadContract, type BuildBubblesCreateDevicePayloadOptions, type BuildBubblesDeliveryStatusPayloadOptions, type BuildBubblesDevicePayloadOptions, type CreateBubblesDeviceOptions, type CreateStoredDeliveryStatusEventOptions, type DefaultNotificationChannelConfig, type DeviceRegistrationState, type DeviceTokenResult, type EnsureDefaultNotificationChannelOptions, type ForegroundPresentationOptions, type GetDeviceTokenOptions, type GetNotificationPermissionsOptions, type NativeTokenType, type PermissionRequestOptions, type PostBubblesDeliveryStatusOptions, type PostStoredBubblesDeliveryStatusOptions, type RegisterDeviceOptions, type StoredDeliveryStatusEvent, type StoredDeliveryStatusLedger, type StoredDeviceState, type StoredDeviceStateUpdate, type SupportedPlatform, type SyncBubblesDeviceOptions, type SyncBubblesDeviceResult, type UpdateBubblesDeviceOptions, buildBubblesDeliveryStatusPayload, buildCreateDevicePayload, buildStoredDeliveryStatusEventKey, buildUpdateDevicePayload, createBubblesDevice, createBubblesDeviceClient, createStoredDeliveryStatusEvent, describeNotificationPermissionStatus, enqueueStoredDeliveryStatusEvent, ensureDefaultNotificationChannel, ensureNotificationPermissions, extractDeviceIdFromDeviceResponse, flushStoredBubblesDeliveryStatuses, getAndroidNotificationChannelImportance, getBubblesNotificationsRuntimeConfig, getDefaultNotificationChannelConfig, getDeviceRegistrationState, getDeviceToken, getFCMToken, getNotificationPermissions, isNotificationPermissionGranted, markStoredDeliveryStatusEventPosted, patchStoredDeviceState, postBubblesDeliveryStatus, postStoredBubblesDeliveryStatus, readStoredApiBaseUrl, readStoredAppKey, readStoredDeliveryStatusLedger, readStoredDeviceId, readStoredDeviceState, registerBubblesBackgroundHandlers, storeApiBaseUrl, storeAppKey, storeDeliveryStatusLedger, storeDeviceId, storeDeviceState, syncBubblesDevice, updateBubblesDevice, useBubblesNotifications };