appsonair-react-native-apppush 0.0.1-alpha

package/lib/typescript/module/src/index.d.ts

@@ -0,0 +1,392 @@
+import type { InstallationIdEvent, LogLevel, NotificationOpenedEvent, NotificationReceivedEvent, NotificationWillDisplayEvent, PermissionChangedEvent, PermissionStatus, PushConfig, PushErrorEvent, PushSubscriptionChangedEvent, PushSubscriptionState, RequestPermissionOptions, SilentNotificationEvent, Subscription, TokenUpdatedEvent, UserStateChangedEvent } from './types';
+export * from './types';
+/**
+ * Starts the SDK. Await this once, before any other call.
+ *
+ * On Android the wrapper supplies the `Context` itself; on iOS it resolves the
+ * App Group and enables AppDelegate swizzling. Neither detail is exposed here.
+ */
+export declare function initialize(config?: PushConfig): Promise<void>;
+/** Whether {@link initialize} has completed in this JS context. */
+export declare function isInitialized(): boolean;
+/** The AppsOnAir-assigned device id. */
+export declare function getDeviceId(): Promise<string>;
+/** The backend-assigned subscription id. `null` until the device registers. */
+export declare function getSubscriptionId(): Promise<string | null>;
+/** The external id linked via {@link login}. `null` while anonymous. */
+export declare function getExternalId(): Promise<string | null>;
+/** Associates this device with your own user id. */
+export declare function login(externalId: string): Promise<void>;
+/** Unlinks the external id, returning the device to an anonymous subscription. */
+export declare function logout(): Promise<void>;
+/** Alias of {@link login}, for teams that prefer the noun. */
+export declare const setUserId: typeof login;
+/** APNs hex token on iOS, FCM token on Android. `null` before registration. */
+export declare function getToken(): Promise<string | null>;
+/** Alias of {@link getToken}. */
+export declare const getDeviceToken: typeof getToken;
+/**
+ * Prompts for notification permission and resolves the resulting grant state.
+ *
+ * Parity E1: Android needs a live Activity. The bridge resolves the current one
+ * and rejects if none is attached rather than crashing.
+ */
+export declare function requestPermission(options?: RequestPermissionOptions): Promise<boolean>;
+/**
+ * Whether notifications are currently permitted.
+ *
+ * Parity E3/E4/E6: iOS reads a cache and Android reads live, so the iOS bridge
+ * refreshes first. The two native shapes (`async` vs sync, `permission` vs
+ * `isPermissionGranted`) are collapsed into this one promise.
+ */
+export declare function getPermission(): Promise<boolean>;
+/**
+ * The granular permission state.
+ *
+ * Parity C7: iOS reports all five values. **Android reports only `authorized`
+ * or `denied`** — it never returns `notDetermined`, so do not gate a
+ * cross-platform pre-prompt on that value.
+ */
+export declare function getPermissionStatus(): Promise<PermissionStatus>;
+/**
+ * Whether a permission prompt can still be shown.
+ *
+ * Parity E2 — **known divergence, not yet fixed in the native SDKs.** iOS
+ * returns `true` only before the user has ever been asked. Android returns
+ * `true` whenever permission is not granted, *including after a permanent
+ * denial*. Treat a `true` on Android as "not granted", not as "never asked".
+ */
+export declare function canRequestPermission(): Promise<boolean>;
+/** Quiet iOS 12+ provisional authorization. **iOS only** — a no-op on Android. */
+export declare function registerForProvisionalAuthorization(): Promise<void>;
+export declare const notifications: {
+    /** Dismisses every notification this app has posted. */
+    clearAll(): Promise<void>;
+    /**
+     * Dismisses one notification by its payload `notification_id`.
+     *
+     * Parity F2: on Android the id is hashed to find the posted notification, so
+     * two ids that hash alike could collide. iOS matches the request identifier
+     * exactly.
+     */
+    remove(notificationId: string): Promise<void>;
+    /** Dismisses several notifications. Android loops; iOS removes them in one call. */
+    removeMany(notificationIds: string[]): Promise<void>;
+    /** Dismisses a notification group. **Android only** — a no-op on iOS. */
+    removeGroup(groupKey: string): Promise<void>;
+};
+export declare const badge: {
+    /**
+     * The SDK's badge count.
+     *
+     * Parity G1/G3: iOS reads the OS badge. Android has no OS read API, so this
+     * returns the SDK's own persisted value, which can drift from what the
+     * launcher actually shows.
+     */
+    get(): Promise<number>;
+    /**
+     * Sets the badge count.
+     *
+     * Parity G3: reliable on iOS. On Android this is a best-effort launcher
+     * broadcast that silently does nothing outside Samsung / MIUI / ASUS — which
+     * is why nothing here reports success.
+     */
+    set(count: number): Promise<void>;
+    /** Adds `delta` to the badge and resolves the new value, clamped at 0. */
+    increment(delta?: number): Promise<number>;
+    /** Clears the badge. */
+    clear(): Promise<void>;
+    /** Clears the badge whenever the app foregrounds. **iOS only.** */
+    setAutoClearOnForeground(enabled: boolean): Promise<void>;
+};
+export declare const user: {
+    /** The AppsOnAir device id. */
+    getAppsOnAirId(): Promise<string>;
+    getExternalId: typeof getExternalId;
+    addTag(key: string, value: string): Promise<void>;
+    addTags(tags: Record<string, string>): Promise<void>;
+    removeTag(key: string): Promise<void>;
+    removeTags(keys: string[]): Promise<void>;
+    /**
+     * The user's tags.
+     *
+     * **Android round-trips to the backend** once the device has a
+     * `subscriptionId`, replacing its local cache with the result; before
+     * registration it resolves the local cache without a network call. **iOS reads
+     * its local cache only.** So a tag set on another device shows up on Android
+     * and not on iOS, and the Android call can reject on a network failure where
+     * iOS cannot.
+     */
+    getTags(): Promise<Record<string, string>>;
+    addAlias(label: string, id: string): Promise<void>;
+    addAliases(aliases: Record<string, string>): Promise<void>;
+    removeAlias(label: string): Promise<void>;
+    removeAliases(labels: string[]): Promise<void>;
+    /**
+     * Adds an email identifier.
+     *
+     * Parity A5 — **known Android bug.** Android persists emails but never reads
+     * them back on restart, so an email added here silently vanishes when the app
+     * relaunches. The wrapper cannot work around it; it needs an SDK fix.
+     */
+    addEmail(address: string): Promise<void>;
+    removeEmail(address: string): Promise<void>;
+    setLanguage(languageCode: string): Promise<void>;
+    /**
+     * The device language.
+     *
+     * Parity 1.5 — Android reads this live; iOS snapshots it once at init and
+     * never refreshes, so a mid-session language change is stale on iOS.
+     */
+    getLanguage(): Promise<string>;
+    /** The current push subscription: `{ id, token, optedIn }`. */
+    getPushSubscription(): Promise<PushSubscriptionState>;
+    /** Opts this device back in to push delivery. */
+    optIn(): Promise<void>;
+    /** Opts this device out of push delivery without unregistering the token. */
+    optOut(): Promise<void>;
+    /**
+     * The subscription's enabled state as the backend sees it.
+     *
+     * Distinct from `getPushSubscription().optedIn`, which is the purely local
+     * `!optedOut` flag on both platforms. The two derive it differently and
+     * converge only in steady state:
+     *
+     * - **Android** reads it back from `/subscriptions`, so it reflects what the
+     *   server actually stored. Before the device registers it falls back to the
+     *   local value without a network call.
+     * - **iOS** computes the same flag it would send: an APNs token exists, the
+     *   user has not opted out, *and* the OS currently grants permission. So
+     *   revoking permission in Settings flips this to `false` on iOS while
+     *   Android keeps reporting the server's stored value.
+     */
+    getOptedIn(): Promise<boolean>;
+};
+export declare const consent: {
+    setRequired(required: boolean): Promise<void>;
+    getRequired(): Promise<boolean>;
+    setGiven(given: boolean): Promise<void>;
+    getGiven(): Promise<boolean>;
+};
+export declare const debug: {
+    /** Sets SDK log verbosity. Safe to call before {@link initialize}. */
+    setLogLevel(level: LogLevel): Promise<void>;
+};
+/** Fires when a notification arrives while the app is in the foreground. */
+export declare function onNotificationReceived(callback: (event: NotificationReceivedEvent) => void): Subscription;
+/** Fires when the user taps a notification or one of its action buttons. */
+export declare function onNotificationOpened(callback: (event: NotificationOpenedEvent) => void): Subscription;
+/**
+ * Fires in the foreground *before* the notification is displayed, giving you a
+ * chance to suppress it.
+ *
+ * `preventDefault()` must be called synchronously inside the handler — the
+ * native side is holding the notification until this returns, and releases it
+ * anyway after a short timeout so a throwing handler cannot wedge delivery.
+ *
+ * All registered handlers run; the notification is suppressed if *any* of them
+ * calls `preventDefault()`.
+ *
+ * **`preventDefault()` is honoured on Android only.** iOS decides presentation
+ * synchronously and cannot wait for a JS answer — see
+ * {@link NotificationWillDisplayEvent.preventDefault}. The event itself fires on
+ * both platforms.
+ */
+export declare function onNotificationWillDisplay(callback: (event: NotificationWillDisplayEvent) => void): Subscription;
+/** Fires when the OS notification permission changes. */
+export declare function onPermissionChanged(callback: (event: PermissionChangedEvent) => void): Subscription;
+/** Fires when the push subscription's token or opt-in state changes. */
+export declare function onSubscriptionChanged(callback: (event: PushSubscriptionChangedEvent) => void): Subscription;
+/** Fires on {@link login} / {@link logout}. */
+export declare function onUserStateChanged(callback: (event: UserStateChangedEvent) => void): Subscription;
+/**
+ * Fires when the device registration token is issued or refreshed.
+ *
+ * This is the push-side counterpart to {@link getToken}: the getter answers
+ * "what is the token now", this answers "the token just changed" — which is when
+ * your backend needs to hear about it. A token can rotate at any point in a
+ * session, so a one-shot `getToken()` at startup will eventually go stale.
+ *
+ * `environment` is the APNs endpoint the backend must send to. It is
+ * `'sandbox'` or `'production'` on iOS and always `null` on Android, where FCM
+ * routes for you.
+ *
+ * Events raised before the first subscriber exists are dropped rather than
+ * queued on both platforms, so read {@link getToken} once after subscribing if
+ * you need the current value too.
+ */
+export declare function onTokenUpdated(callback: (event: TokenUpdatedEvent) => void): Subscription;
+/**
+ * Fires on an SDK-level failure — token registration, a denied permission, a
+ * missing Firebase config.
+ *
+ * These are conditions the SDK hits on its own schedule, outside any call you
+ * made, so they surface here rather than as a rejected promise. A promise
+ * rejection from a method you called carries the same `code` values.
+ *
+ * Without a subscriber these failures are silent, which is why this is worth
+ * wiring even if it only ever logs.
+ */
+export declare function onError(callback: (event: PushErrorEvent) => void): Subscription;
+/**
+ * Fires for a data-only push that is delivered without being displayed.
+ *
+ * Supported on both platforms, but they are triggered differently and your
+ * backend has to send for both: iOS uses the APNs `content-available` flag,
+ * while Android keys off a `silent: "true"` data entry, since FCM has no
+ * transport-level equivalent. See {@link SilentNotificationEvent}.
+ *
+ * iOS invokes the OS completion handler as soon as this event is emitted, so
+ * the handler cannot extend the app's background execution window: treat it as
+ * a notification that the payload arrived, not as a place to await work.
+ */
+export declare function onSilentNotification(callback: (event: SilentNotificationEvent) => void): Subscription;
+/**
+ * Fires when the Firebase Installation ID becomes available.
+ *
+ * **Android only** — the event name is registered on iOS so the two bridges
+ * stay diffable, but nothing ever emits it there.
+ */
+export declare function onInstallationIdUpdated(callback: (event: InstallationIdEvent) => void): Subscription;
+declare const AppPushService: {
+    initialize: typeof initialize;
+    isInitialized: typeof isInitialized;
+    getDeviceId: typeof getDeviceId;
+    getSubscriptionId: typeof getSubscriptionId;
+    getExternalId: typeof getExternalId;
+    login: typeof login;
+    logout: typeof logout;
+    setUserId: typeof login;
+    getToken: typeof getToken;
+    getDeviceToken: typeof getToken;
+    requestPermission: typeof requestPermission;
+    getPermission: typeof getPermission;
+    getPermissionStatus: typeof getPermissionStatus;
+    canRequestPermission: typeof canRequestPermission;
+    registerForProvisionalAuthorization: typeof registerForProvisionalAuthorization;
+    notifications: {
+        /** Dismisses every notification this app has posted. */
+        clearAll(): Promise<void>;
+        /**
+         * Dismisses one notification by its payload `notification_id`.
+         *
+         * Parity F2: on Android the id is hashed to find the posted notification, so
+         * two ids that hash alike could collide. iOS matches the request identifier
+         * exactly.
+         */
+        remove(notificationId: string): Promise<void>;
+        /** Dismisses several notifications. Android loops; iOS removes them in one call. */
+        removeMany(notificationIds: string[]): Promise<void>;
+        /** Dismisses a notification group. **Android only** — a no-op on iOS. */
+        removeGroup(groupKey: string): Promise<void>;
+    };
+    badge: {
+        /**
+         * The SDK's badge count.
+         *
+         * Parity G1/G3: iOS reads the OS badge. Android has no OS read API, so this
+         * returns the SDK's own persisted value, which can drift from what the
+         * launcher actually shows.
+         */
+        get(): Promise<number>;
+        /**
+         * Sets the badge count.
+         *
+         * Parity G3: reliable on iOS. On Android this is a best-effort launcher
+         * broadcast that silently does nothing outside Samsung / MIUI / ASUS — which
+         * is why nothing here reports success.
+         */
+        set(count: number): Promise<void>;
+        /** Adds `delta` to the badge and resolves the new value, clamped at 0. */
+        increment(delta?: number): Promise<number>;
+        /** Clears the badge. */
+        clear(): Promise<void>;
+        /** Clears the badge whenever the app foregrounds. **iOS only.** */
+        setAutoClearOnForeground(enabled: boolean): Promise<void>;
+    };
+    user: {
+        /** The AppsOnAir device id. */
+        getAppsOnAirId(): Promise<string>;
+        getExternalId: typeof getExternalId;
+        addTag(key: string, value: string): Promise<void>;
+        addTags(tags: Record<string, string>): Promise<void>;
+        removeTag(key: string): Promise<void>;
+        removeTags(keys: string[]): Promise<void>;
+        /**
+         * The user's tags.
+         *
+         * **Android round-trips to the backend** once the device has a
+         * `subscriptionId`, replacing its local cache with the result; before
+         * registration it resolves the local cache without a network call. **iOS reads
+         * its local cache only.** So a tag set on another device shows up on Android
+         * and not on iOS, and the Android call can reject on a network failure where
+         * iOS cannot.
+         */
+        getTags(): Promise<Record<string, string>>;
+        addAlias(label: string, id: string): Promise<void>;
+        addAliases(aliases: Record<string, string>): Promise<void>;
+        removeAlias(label: string): Promise<void>;
+        removeAliases(labels: string[]): Promise<void>;
+        /**
+         * Adds an email identifier.
+         *
+         * Parity A5 — **known Android bug.** Android persists emails but never reads
+         * them back on restart, so an email added here silently vanishes when the app
+         * relaunches. The wrapper cannot work around it; it needs an SDK fix.
+         */
+        addEmail(address: string): Promise<void>;
+        removeEmail(address: string): Promise<void>;
+        setLanguage(languageCode: string): Promise<void>;
+        /**
+         * The device language.
+         *
+         * Parity 1.5 — Android reads this live; iOS snapshots it once at init and
+         * never refreshes, so a mid-session language change is stale on iOS.
+         */
+        getLanguage(): Promise<string>;
+        /** The current push subscription: `{ id, token, optedIn }`. */
+        getPushSubscription(): Promise<PushSubscriptionState>;
+        /** Opts this device back in to push delivery. */
+        optIn(): Promise<void>;
+        /** Opts this device out of push delivery without unregistering the token. */
+        optOut(): Promise<void>;
+        /**
+         * The subscription's enabled state as the backend sees it.
+         *
+         * Distinct from `getPushSubscription().optedIn`, which is the purely local
+         * `!optedOut` flag on both platforms. The two derive it differently and
+         * converge only in steady state:
+         *
+         * - **Android** reads it back from `/subscriptions`, so it reflects what the
+         *   server actually stored. Before the device registers it falls back to the
+         *   local value without a network call.
+         * - **iOS** computes the same flag it would send: an APNs token exists, the
+         *   user has not opted out, *and* the OS currently grants permission. So
+         *   revoking permission in Settings flips this to `false` on iOS while
+         *   Android keeps reporting the server's stored value.
+         */
+        getOptedIn(): Promise<boolean>;
+    };
+    consent: {
+        setRequired(required: boolean): Promise<void>;
+        getRequired(): Promise<boolean>;
+        setGiven(given: boolean): Promise<void>;
+        getGiven(): Promise<boolean>;
+    };
+    debug: {
+        /** Sets SDK log verbosity. Safe to call before {@link initialize}. */
+        setLogLevel(level: LogLevel): Promise<void>;
+    };
+    onNotificationReceived: typeof onNotificationReceived;
+    onNotificationOpened: typeof onNotificationOpened;
+    onNotificationWillDisplay: typeof onNotificationWillDisplay;
+    onPermissionChanged: typeof onPermissionChanged;
+    onSubscriptionChanged: typeof onSubscriptionChanged;
+    onUserStateChanged: typeof onUserStateChanged;
+    onTokenUpdated: typeof onTokenUpdated;
+    onError: typeof onError;
+    onSilentNotification: typeof onSilentNotification;
+    onInstallationIdUpdated: typeof onInstallationIdUpdated;
+};
+export default AppPushService;
+//# sourceMappingURL=index.d.ts.map

package/lib/typescript/module/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.tsx"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,mBAAmB,EACnB,QAAQ,EACR,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,sBAAsB,EACtB,gBAAgB,EAChB,UAAU,EACV,cAAc,EAEd,4BAA4B,EAC5B,qBAAqB,EACrB,wBAAwB,EACxB,uBAAuB,EACvB,YAAY,EACZ,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB,cAAc,SAAS,CAAC;AAqGxB;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,MAAM,GAAE,UAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAGvE;AAED,mEAAmE;AACnE,wBAAgB,aAAa,IAAI,OAAO,CAEvC;AAID,wCAAwC;AACxC,wBAAgB,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,CAE7C;AAED,+EAA+E;AAC/E,wBAAgB,iBAAiB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAE1D;AAED,wEAAwE;AACxE,wBAAgB,aAAa,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAEtD;AAED,oDAAoD;AACpD,wBAAgB,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGvD;AAED,kFAAkF;AAClF,wBAAgB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAEtC;AAED,8DAA8D;AAC9D,eAAO,MAAM,SAAS,cAAQ,CAAC;AAI/B,+EAA+E;AAC/E,wBAAgB,QAAQ,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAEjD;AAED,iCAAiC;AACjC,eAAO,MAAM,cAAc,iBAAW,CAAC;AAIvC;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,OAAO,CAAC,CAIlB;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,CAEhD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,IAAI,OAAO,CAAC,gBAAgB,CAAC,CAI/D;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAAC,OAAO,CAAC,CAEvD;AAED,kFAAkF;AAClF,wBAAgB,mCAAmC,IAAI,OAAO,CAAC,IAAI,CAAC,CAInE;AAID,eAAO,MAAM,aAAa;IACxB,wDAAwD;gBAC5C,QAAQ,IAAI,CAAC;IAMzB;;;;;;OAMG;2BACoB,MAAM,GAAG,QAAQ,IAAI,CAAC;IAO7C,oFAAoF;gCACxD,MAAM,EAAE,GAAG,QAAQ,IAAI,CAAC;IAWpD,yEAAyE;0BACnD,MAAM,GAAG,QAAQ,IAAI,CAAC;CAM7C,CAAC;AAIF,eAAO,MAAM,KAAK;IAChB;;;;;;OAMG;WACI,QAAQ,MAAM,CAAC;IAItB;;;;;;OAMG;eACQ,MAAM,GAAG,QAAQ,IAAI,CAAC;IAOjC,0EAA0E;+BACpD,QAAQ,MAAM,CAAC;IASrC,wBAAwB;aACf,QAAQ,IAAI,CAAC;IAItB,mEAAmE;sCACjC,OAAO,GAAG,QAAQ,IAAI,CAAC;CAK1D,CAAC;AAIF,eAAO,MAAM,IAAI;IACf,+BAA+B;sBACb,QAAQ,MAAM,CAAC;;gBAMrB,MAAM,SAAS,MAAM,GAAG,QAAQ,IAAI,CAAC;kBAKnC,OAAO,MAAM,EAAE,MAAM,CAAC,GAAG,QAAQ,IAAI,CAAC;mBAIrC,MAAM,GAAG,QAAQ,IAAI,CAAC;qBAKpB,MAAM,EAAE,GAAG,QAAQ,IAAI,CAAC;IAIzC;;;;;;;;;OASG;eACQ,QAAQ,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC;oBAM1B,MAAM,MAAM,MAAM,GAAG,QAAQ,IAAI,CAAC;wBAM9B,OAAO,MAAM,EAAE,MAAM,CAAC,GAAG,QAAQ,IAAI,CAAC;uBAIvC,MAAM,GAAG,QAAQ,IAAI,CAAC;0BAKnB,MAAM,EAAE,GAAG,QAAQ,IAAI,CAAC;IAI9C;;;;;;OAMG;sBACe,MAAM,GAAG,QAAQ,IAAI,CAAC;yBAKnB,MAAM,GAAG,QAAQ,IAAI,CAAC;8BAKjB,MAAM,GAAG,QAAQ,IAAI,CAAC;IAOhD;;;;;OAKG;mBACY,QAAQ,MAAM,CAAC;IAI9B,+DAA+D;2BACxC,QAAQ,qBAAqB,CAAC;IAMrD,iDAAiD;aACxC,QAAQ,IAAI,CAAC;IAItB,6EAA6E;cACnE,QAAQ,IAAI,CAAC;IAIvB;;;;;;;;;;;;;;OAcG;kBACW,QAAQ,OAAO,CAAC;CAG/B,CAAC;AAQF,eAAO,MAAM,OAAO;0BACI,OAAO,GAAG,QAAQ,IAAI,CAAC;mBAK9B,QAAQ,OAAO,CAAC;oBAGf,OAAO,GAAG,QAAQ,IAAI,CAAC;gBAG3B,QAAQ,OAAO,CAAC;CAG7B,CAAC;AAIF,eAAO,MAAM,KAAK;IAChB,sEAAsE;uBACnD,QAAQ,GAAG,QAAQ,IAAI,CAAC;CAG5C,CAAC;AAYF,4EAA4E;AAC5E,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,CAAC,KAAK,EAAE,yBAAyB,KAAK,IAAI,GACnD,YAAY,CAEd;AAED,4EAA4E;AAC5E,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,CAAC,KAAK,EAAE,uBAAuB,KAAK,IAAI,GACjD,YAAY,CAEd;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,CAAC,KAAK,EAAE,4BAA4B,KAAK,IAAI,GACtD,YAAY,CAYd;AAoDD,yDAAyD;AACzD,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,GAChD,YAAY,CAEd;AAED,wEAAwE;AACxE,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,CAAC,KAAK,EAAE,4BAA4B,KAAK,IAAI,GACtD,YAAY,CAEd;AAED,+CAA+C;AAC/C,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,IAAI,GAC/C,YAAY,CAEd;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,GAC3C,YAAY,CAEd;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CACrB,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,GACxC,YAAY,CAEd;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,CAAC,KAAK,EAAE,uBAAuB,KAAK,IAAI,GACjD,YAAY,CAEd;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,GAC7C,YAAY,CAEd;AAID,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;;QAzclB,wDAAwD;oBAC5C,QAAQ,IAAI,CAAC;QAMzB;;;;;;WAMG;+BACoB,MAAM,GAAG,QAAQ,IAAI,CAAC;QAO7C,oFAAoF;oCACxD,MAAM,EAAE,GAAG,QAAQ,IAAI,CAAC;QAWpD,yEAAyE;8BACnD,MAAM,GAAG,QAAQ,IAAI,CAAC;;;QAW5C;;;;;;WAMG;eACI,QAAQ,MAAM,CAAC;QAItB;;;;;;WAMG;mBACQ,MAAM,GAAG,QAAQ,IAAI,CAAC;QAOjC,0EAA0E;mCACpD,QAAQ,MAAM,CAAC;QASrC,wBAAwB;iBACf,QAAQ,IAAI,CAAC;QAItB,mEAAmE;0CACjC,OAAO,GAAG,QAAQ,IAAI,CAAC;;;QAUzD,+BAA+B;0BACb,QAAQ,MAAM,CAAC;;oBAMrB,MAAM,SAAS,MAAM,GAAG,QAAQ,IAAI,CAAC;sBAKnC,OAAO,MAAM,EAAE,MAAM,CAAC,GAAG,QAAQ,IAAI,CAAC;uBAIrC,MAAM,GAAG,QAAQ,IAAI,CAAC;yBAKpB,MAAM,EAAE,GAAG,QAAQ,IAAI,CAAC;QAIzC;;;;;;;;;WASG;mBACQ,QAAQ,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC;wBAM1B,MAAM,MAAM,MAAM,GAAG,QAAQ,IAAI,CAAC;4BAM9B,OAAO,MAAM,EAAE,MAAM,CAAC,GAAG,QAAQ,IAAI,CAAC;2BAIvC,MAAM,GAAG,QAAQ,IAAI,CAAC;8BAKnB,MAAM,EAAE,GAAG,QAAQ,IAAI,CAAC;QAI9C;;;;;;WAMG;0BACe,MAAM,GAAG,QAAQ,IAAI,CAAC;6BAKnB,MAAM,GAAG,QAAQ,IAAI,CAAC;kCAKjB,MAAM,GAAG,QAAQ,IAAI,CAAC;QAOhD;;;;;WAKG;uBACY,QAAQ,MAAM,CAAC;QAI9B,+DAA+D;+BACxC,QAAQ,qBAAqB,CAAC;QAMrD,iDAAiD;iBACxC,QAAQ,IAAI,CAAC;QAItB,6EAA6E;kBACnE,QAAQ,IAAI,CAAC;QAIvB;;;;;;;;;;;;;;WAcG;sBACW,QAAQ,OAAO,CAAC;;;8BAYR,OAAO,GAAG,QAAQ,IAAI,CAAC;uBAK9B,QAAQ,OAAO,CAAC;wBAGf,OAAO,GAAG,QAAQ,IAAI,CAAC;oBAG3B,QAAQ,OAAO,CAAC;;;QAQ5B,sEAAsE;2BACnD,QAAQ,GAAG,QAAQ,IAAI,CAAC;;;;;;;;;;;;CA+O5C,CAAC;AAEF,eAAe,cAAc,CAAC"}

package/lib/typescript/module/src/types.d.ts

@@ -0,0 +1,221 @@
+/**
+ * Cross-platform types for the AppsOnAir Push SDK.
+ *
+ * Where the two native SDKs disagree, this file defines the single shape the
+ * wrapper exposes and the native bridges normalise to. Every such decision
+ * traces to a row in `appsonair-push-notification-android/CROSS_PLATFORM_PARITY.md`;
+ * the row id is cited so the reason survives.
+ */
+export interface PushConfig {
+    /** Print SDK logs to the console. Keep `false` in production. */
+    debug?: boolean;
+}
+/**
+ * There is deliberately no `appGroupId` option.
+ *
+ * The parity audit's A1 row proposes one, but the native iOS initializer is
+ * `initialize(debug:swizzle:)` — it takes no App Group argument. iOS resolves the
+ * group itself, from an `AppsOnAirAppGroup` string in the app's Info.plist, else
+ * the convention `group.<bundle-id>.appsonair`. Accepting the value here would be
+ * a knob that silently does nothing, so it is configured where it is actually
+ * read. See the README's iOS setup section.
+ */
+/** An action button attached to the notification payload. */
+export interface NotificationActionButton {
+    id: string;
+    title: string;
+}
+/** A media attachment, or one entry synthesised from `imageUrl`. */
+export interface NotificationAttachment {
+    id: string | null;
+    url: string;
+}
+/**
+ * A received or tapped notification.
+ *
+ * Parity C1: iOS emits 14 fields, Android 6. This is the union — fields the
+ * running platform cannot source resolve to `null` (or `[]`), never `undefined`.
+ * The per-field platform notes below are the authoritative support matrix.
+ */
+export interface PushNotification {
+    /** Payload `notification_id`. */
+    id: string | null;
+    /** Payload `campaign_id`. **iOS only** — `null` on Android. */
+    campaignId: string | null;
+    /** Payload `template_id`. **iOS only** — `null` on Android. */
+    templateId: string | null;
+    /** Payload `sent_at`, ISO-8601 exactly as received. **iOS only.** */
+    sentAt: string | null;
+    title: string | null;
+    /** Second line above the body. **iOS only** — Android has no subtitle concept. */
+    subtitle: string | null;
+    body: string | null;
+    /** Payload `url` — deep link opened on tap. */
+    launchUrl: string | null;
+    /** Payload `image_url`. On iOS this loses to `attachments` when both are present. */
+    imageUrl: string | null;
+    /** Payload `attachments`. **iOS only** — always `[]` on Android. */
+    attachments: NotificationAttachment[];
+    /** Payload `actions`. Supported on both platforms. */
+    actionButtons: NotificationActionButton[];
+    /** Payload `badge_increment`. **iOS only** — `null` on Android. */
+    badgeIncrement: number | null;
+    /** Payload `collapse_id` (iOS) / `collapse_key` (Android). */
+    collapseId: string | null;
+    /** Sound file name in `res/raw`, no extension. **Android only** — `null` on iOS. */
+    sound: string | null;
+    /** Notification channel id. **Android only** — `null` on iOS. */
+    channelId: string | null;
+    /**
+     * Flattened string map of the payload's custom keys.
+     *
+     * Parity C1: Android's native `data` map is already `Map<String, String>`;
+     * the iOS bridge flattens `userInfo` to match, so this field has the same
+     * meaning on both platforms.
+     */
+    data: Record<string, string>;
+    /**
+     * The complete unmodified payload. Shapes differ per platform (APNs `userInfo`
+     * vs the FCM data bundle) — reach for `data` first, and use this only for keys
+     * that survive neither flattening nor the typed fields above.
+     */
+    rawPayload: Record<string, unknown>;
+}
+export interface TokenUpdatedEvent {
+    /** APNs hex token on iOS, FCM registration token on Android. */
+    token: string;
+    /**
+     * Parity B1/C8: which APNs endpoint the backend must use.
+     * **iOS only** — always `null` on Android, where FCM routes for you.
+     */
+    environment: 'sandbox' | 'production' | null;
+}
+export interface NotificationOpenedEvent {
+    notification: PushNotification;
+    /** `null` when the notification body was tapped; set for an action-button tap. */
+    actionId: string | null;
+    /** The payload's launch URL, if any. */
+    url: string | null;
+}
+export interface NotificationReceivedEvent {
+    notification: PushNotification;
+}
+/**
+ * Fired while the app is in the foreground, before the notification is displayed.
+ *
+ * Parity B4/F7: `preventDefault()` is exposed, presentation options are not —
+ * iOS lets the OS present, Android builds the notification itself, so any
+ * option set would mean different things on each platform.
+ */
+export interface NotificationWillDisplayEvent {
+    notification: PushNotification;
+    /**
+     * Suppress the system notification. Must be called synchronously in the handler.
+     *
+     * **Honoured on Android only.** The Android SDK calls its foreground listeners
+     * on FCM's background thread, so the bridge can park there while JS decides.
+     * iOS's `handleWillPresent(notification:)` returns its presentation options
+     * synchronously with no completion handler to hold open, so by the time a JS
+     * handler runs the notification has already been presented. On iOS this event
+     * is informational and calling `preventDefault()` does nothing.
+     */
+    preventDefault: () => void;
+}
+export interface PermissionChangedEvent {
+    granted: boolean;
+}
+export interface PushSubscriptionState {
+    id: string | null;
+    token: string | null;
+    optedIn: boolean;
+}
+export interface PushSubscriptionChangedEvent {
+    previous: PushSubscriptionState;
+    current: PushSubscriptionState;
+}
+export interface UserState {
+    /** The external id linked via `login()`. `null` while anonymous. */
+    externalId: string | null;
+    /** The AppsOnAir-assigned device id. */
+    appsOnAirId: string;
+}
+export interface UserStateChangedEvent {
+    current: UserState;
+}
+/**
+ * A data-only push that is delivered without being displayed.
+ *
+ * Parity F5 — supported on both platforms, but the two are triggered
+ * differently and your backend has to send for both:
+ *
+ * - **iOS** uses the APNs transport flag, `content-available: 1`.
+ * - **Android** has no transport-level equivalent in FCM, so the SDK keys off a
+ *   `silent: "true"` entry in the data payload. A data push *without* that key
+ *   renders as a visible notification and fires no listener here.
+ *
+ * On iOS the OS completion handler is invoked as soon as the event is emitted,
+ * so a handler cannot extend the background execution window.
+ */
+export interface SilentNotificationEvent {
+    data: Record<string, string>;
+}
+/** Firebase Installation ID. Parity B2: **Android only.** */
+export interface InstallationIdEvent {
+    id: string;
+}
+/**
+ * Parity C5: the union of both platforms' error codes in one casing.
+ * `tokenRegistrationFailed` is the shared name for iOS `apnsRegistrationFailed`
+ * and Android `TOKEN_FETCH_FAILED`.
+ *
+ * Native `PushError.cause` is dropped — a `Throwable` does not cross the bridge.
+ */
+export type PushErrorCode = 'notInitialized' | 'permissionDenied'
+/** **Android only.** No `google-services.json`, or the plugin was not applied. */
+ | 'firebaseNotConfigured' | 'tokenRegistrationFailed' | 'installationIdFetchFailed' | 'unknown';
+export interface PushErrorEvent {
+    code: PushErrorCode;
+    message: string;
+}
+/** Parity C6: one casing for both platforms; the bridge maps to the native enum. */
+export type LogLevel = 'none' | 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'verbose';
+/**
+ * Parity C7: iOS reports all five states. Android has no granular type and
+ * reports only `authorized` or `denied` — it can never return `notDetermined`,
+ * so do not branch on that value for a cross-platform pre-prompt.
+ */
+export type PermissionStatus = 'notDetermined' | 'denied' | 'authorized' | 'provisional' | 'ephemeral';
+export interface RequestPermissionOptions {
+    /**
+     * When permission was already permanently denied, send the user to the OS
+     * settings screen instead of failing silently. Defaults to `false`.
+     */
+    fallbackToSettings?: boolean;
+}
+/** Mirrors `NotificationManager.IMPORTANCE_*`. */
+export type NotificationChannelImportance = 'none' | 'min' | 'low' | 'default' | 'high' | 'max';
+/** Parity F4: **Android only.** A no-op on iOS, which has no channel concept. */
+export interface NotificationChannelConfig {
+    id: string;
+    name: string;
+    importance?: NotificationChannelImportance;
+    description?: string;
+    /** Sound file name in `res/raw`, without extension. */
+    sound?: string;
+}
+/**
+ * Parity H1: the two native APIs share no method name, parameter, or unit —
+ * iOS takes seconds via BGTaskScheduler, Android minutes via WorkManager. This
+ * is the single shape; each bridge converts.
+ */
+export interface BackgroundSyncOptions {
+    /** Defaults to 60. iOS converts to seconds and treats it as a *minimum* delay. */
+    intervalMinutes?: number;
+    /** Android WorkManager constraint. Ignored on iOS. Defaults to `true`. */
+    requireNetwork?: boolean;
+}
+/** Returned by every `on*` subscribe helper. Call `remove()` to unsubscribe. */
+export interface Subscription {
+    remove: () => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/typescript/module/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,MAAM,WAAW,UAAU;IACzB,iEAAiE;IACjE,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;;;GASG;AAIH,6DAA6D;AAC7D,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;CACf;AAED,oEAAoE;AACpE,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,iCAAiC;IACjC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,+DAA+D;IAC/D,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,+DAA+D;IAC/D,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,qEAAqE;IACrE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,kFAAkF;IAClF,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,+CAA+C;IAC/C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,qFAAqF;IACrF,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,oEAAoE;IACpE,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,sDAAsD;IACtD,aAAa,EAAE,wBAAwB,EAAE,CAAC;IAC1C,mEAAmE;IACnE,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,8DAA8D;IAC9D,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,oFAAoF;IACpF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,iEAAiE;IACjE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE7B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACrC;AAID,MAAM,WAAW,iBAAiB;IAChC,gEAAgE;IAChE,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,WAAW,EAAE,SAAS,GAAG,YAAY,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,gBAAgB,CAAC;IAC/B,kFAAkF;IAClF,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,wCAAwC;IACxC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC,YAAY,EAAE,gBAAgB,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B;IAC3C,YAAY,EAAE,gBAAgB,CAAC;IAC/B;;;;;;;;;OASG;IACH,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,qBAAqB,CAAC;IAChC,OAAO,EAAE,qBAAqB,CAAC;CAChC;AAED,MAAM,WAAW,SAAS;IACxB,oEAAoE;IACpE,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,SAAS,CAAC;CACpB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B;AAED,6DAA6D;AAC7D,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GACrB,gBAAgB,GAChB,kBAAkB;AACpB,kFAAkF;GAChF,uBAAuB,GACvB,yBAAyB,GACzB,2BAA2B,GAC3B,SAAS,CAAC;AAEd,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;CACjB;AAID,oFAAoF;AACpF,MAAM,MAAM,QAAQ,GAChB,MAAM,GACN,OAAO,GACP,OAAO,GACP,MAAM,GACN,MAAM,GACN,OAAO,GACP,SAAS,CAAC;AAEd;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,QAAQ,GACR,YAAY,GACZ,aAAa,GACb,WAAW,CAAC;AAEhB,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAID,kDAAkD;AAClD,MAAM,MAAM,6BAA6B,GACrC,MAAM,GACN,KAAK,GACL,KAAK,GACL,SAAS,GACT,MAAM,GACN,KAAK,CAAC;AAEV,iFAAiF;AACjF,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,6BAA6B,CAAC;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAID;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,kFAAkF;IAClF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,0EAA0E;IAC1E,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,gFAAgF;AAChF,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB"}