react-native-notify-kit 10.4.9 → 10.6.0

package/server/dist/validation.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateInput = validateInput;
+const PREFIX = '[react-native-notify-kit/server]';
+const RESERVED_DATA_KEYS = ['notifee_options', 'notifee_data'];
+function err(category, message) {
+    return new Error(`${PREFIX} ${category}: ${message}`);
+}
+function isNonEmptyString(value) {
+    return typeof value === 'string' && value.length > 0;
+}
+function validateInput(input) {
+    if (input === null || typeof input !== 'object') {
+        throw err('Validation', 'input must be an object');
+    }
+    const routingCount = (input.token !== undefined ? 1 : 0) +
+        (input.topic !== undefined ? 1 : 0) +
+        (input.condition !== undefined ? 1 : 0);
+    if (routingCount !== 1) {
+        throw err('Routing', `exactly one of 'token', 'topic', or 'condition' must be provided. Got: ${routingCount}`);
+    }
+    if (input.token !== undefined && !isNonEmptyString(input.token)) {
+        throw err('Routing', "'token' must be a non-empty string");
+    }
+    if (input.topic !== undefined && !isNonEmptyString(input.topic)) {
+        throw err('Routing', "'topic' must be a non-empty string");
+    }
+    if (input.condition !== undefined && !isNonEmptyString(input.condition)) {
+        throw err('Routing', "'condition' must be a non-empty string");
+    }
+    const { notification } = input;
+    if (notification === null || typeof notification !== 'object') {
+        throw err('Validation', "'notification' is required and must be an object");
+    }
+    if (notification.id !== undefined && !isNonEmptyString(notification.id)) {
+        throw err('Validation', 'notification.id must be a non-empty string when provided');
+    }
+    if (!isNonEmptyString(notification.title)) {
+        throw err('Validation', 'notification.title is required and must be a non-empty string');
+    }
+    if (!isNonEmptyString(notification.body)) {
+        throw err('Validation', 'notification.body is required and must be a non-empty string');
+    }
+    if (notification.data !== undefined) {
+        if (notification.data === null || typeof notification.data !== 'object') {
+            throw err('Validation', "'notification.data' must be an object");
+        }
+        for (const reserved of RESERVED_DATA_KEYS) {
+            if (Object.prototype.hasOwnProperty.call(notification.data, reserved)) {
+                throw err('Validation', "'notifee_options' and 'notifee_data' are reserved keys and cannot be used in notification.data");
+            }
+        }
+        for (const [key, value] of Object.entries(notification.data)) {
+            if (typeof value !== 'string') {
+                throw err('Validation', `FCM data values must be strings. Got ${typeof value} for key '${key}'. Use JSON.stringify() if you need to pass complex values.`);
+            }
+        }
+    }
+    const attachments = notification.ios?.attachments;
+    if (attachments !== undefined) {
+        if (!Array.isArray(attachments)) {
+            throw err('iOS', "'notification.ios.attachments' must be an array");
+        }
+        for (const attachment of attachments) {
+            if (attachment === null ||
+                typeof attachment !== 'object' ||
+                typeof attachment.url !== 'string') {
+                throw err('iOS', "each attachment must be an object with a string 'url' field");
+            }
+            if (!attachment.url.startsWith('https://')) {
+                throw err('iOS', `iOS attachments require https:// URLs. Got: ${attachment.url}`);
+            }
+        }
+    }
+    if (input.options !== undefined) {
+        const { options } = input;
+        if (options === null || typeof options !== 'object') {
+            throw err('Validation', "'options' must be an object");
+        }
+        if (options.androidPriority !== undefined &&
+            options.androidPriority !== 'high' &&
+            options.androidPriority !== 'normal') {
+            throw err('Validation', `'options.androidPriority' must be 'high' or 'normal'. Got: ${String(options.androidPriority)}`);
+        }
+        if (options.iosBadgeCount !== undefined &&
+            (typeof options.iosBadgeCount !== 'number' ||
+                !Number.isFinite(options.iosBadgeCount) ||
+                options.iosBadgeCount < 0 ||
+                !Number.isInteger(options.iosBadgeCount))) {
+            throw err('Validation', "'options.iosBadgeCount' must be a non-negative integer");
+        }
+        if (options.ttl !== undefined &&
+            (typeof options.ttl !== 'number' || !Number.isInteger(options.ttl) || options.ttl <= 0)) {
+            throw err('Validation', `options.ttl must be a positive integer (seconds). Got: ${String(options.ttl)}`);
+        }
+        if (options.collapseKey !== undefined && !isNonEmptyString(options.collapseKey)) {
+            throw err('Validation', "'options.collapseKey' must be a non-empty string");
+        }
+    }
+    const actions = notification.android?.actions;
+    if (Array.isArray(actions)) {
+        const pressActionIds = new Set();
+        for (const action of actions) {
+            const pressActionId = action?.pressAction?.id;
+            if (typeof pressActionId !== 'string') {
+                continue;
+            }
+            if (pressActionIds.has(pressActionId)) {
+                throw err('Android', "'notification.android.actions' pressAction IDs must be unique within the notification");
+            }
+            pressActionIds.add(pressActionId);
+        }
+    }
+}
+//# sourceMappingURL=validation.js.map

package/server/dist/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":";;AAaA,sCA4IC;AAvJD,MAAM,MAAM,GAAG,kCAAkC,CAAC;AAClD,MAAM,kBAAkB,GAAG,CAAC,iBAAiB,EAAE,cAAc,CAAU,CAAC;AAExE,SAAS,GAAG,CAAC,QAAgB,EAAE,OAAe;IAC5C,OAAO,IAAI,KAAK,CAAC,GAAG,MAAM,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AACvD,CAAC;AAED,SAAgB,aAAa,CAAC,KAA4B;IACxD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,MAAM,GAAG,CAAC,YAAY,EAAE,yBAAyB,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,YAAY,GAChB,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1C,IAAI,YAAY,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,GAAG,CACP,SAAS,EACT,0EAA0E,YAAY,EAAE,CACzF,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChE,MAAM,GAAG,CAAC,SAAS,EAAE,oCAAoC,CAAC,CAAC;IAC7D,CAAC;IACD,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAChE,MAAM,GAAG,CAAC,SAAS,EAAE,oCAAoC,CAAC,CAAC;IAC7D,CAAC;IACD,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QACxE,MAAM,GAAG,CAAC,SAAS,EAAE,wCAAwC,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,CAAC;IAC/B,IAAI,YAAY,KAAK,IAAI,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC9D,MAAM,GAAG,CAAC,YAAY,EAAE,kDAAkD,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,YAAY,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC;QACxE,MAAM,GAAG,CAAC,YAAY,EAAE,0DAA0D,CAAC,CAAC;IACtF,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1C,MAAM,GAAG,CAAC,YAAY,EAAE,+DAA+D,CAAC,CAAC;IAC3F,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;QACzC,MAAM,GAAG,CAAC,YAAY,EAAE,8DAA8D,CAAC,CAAC;IAC1F,CAAC;IAED,IAAI,YAAY,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACpC,IAAI,YAAY,CAAC,IAAI,KAAK,IAAI,IAAI,OAAO,YAAY,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACxE,MAAM,GAAG,CAAC,YAAY,EAAE,uCAAuC,CAAC,CAAC;QACnE,CAAC;QACD,KAAK,MAAM,QAAQ,IAAI,kBAAkB,EAAE,CAAC;YAC1C,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC;gBACtE,MAAM,GAAG,CACP,YAAY,EACZ,gGAAgG,CACjG,CAAC;YACJ,CAAC;QACH,CAAC;QACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7D,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,MAAM,GAAG,CACP,YAAY,EACZ,wCAAwC,OAAO,KAAK,aAAa,GAAG,6DAA6D,CAClI,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,EAAE,WAAW,CAAC;IAClD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YAChC,MAAM,GAAG,CAAC,KAAK,EAAE,iDAAiD,CAAC,CAAC;QACtE,CAAC;QACD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,IACE,UAAU,KAAK,IAAI;gBACnB,OAAO,UAAU,KAAK,QAAQ;gBAC9B,OAAO,UAAU,CAAC,GAAG,KAAK,QAAQ,EAClC,CAAC;gBACD,MAAM,GAAG,CAAC,KAAK,EAAE,6DAA6D,CAAC,CAAC;YAClF,CAAC;YACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC3C,MAAM,GAAG,CAAC,KAAK,EAAE,+CAA+C,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC;YACpF,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAChC,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QAC1B,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YACpD,MAAM,GAAG,CAAC,YAAY,EAAE,6BAA6B,CAAC,CAAC;QACzD,CAAC;QACD,IACE,OAAO,CAAC,eAAe,KAAK,SAAS;YACrC,OAAO,CAAC,eAAe,KAAK,MAAM;YAClC,OAAO,CAAC,eAAe,KAAK,QAAQ,EACpC,CAAC;YACD,MAAM,GAAG,CACP,YAAY,EACZ,8DAA8D,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAChG,CAAC;QACJ,CAAC;QACD,IACE,OAAO,CAAC,aAAa,KAAK,SAAS;YACnC,CAAC,OAAO,OAAO,CAAC,aAAa,KAAK,QAAQ;gBACxC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC;gBACvC,OAAO,CAAC,aAAa,GAAG,CAAC;gBACzB,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,EAC3C,CAAC;YACD,MAAM,GAAG,CAAC,YAAY,EAAE,wDAAwD,CAAC,CAAC;QACpF,CAAC;QACD,IACE,OAAO,CAAC,GAAG,KAAK,SAAS;YACzB,CAAC,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,EACvF,CAAC;YACD,MAAM,GAAG,CACP,YAAY,EACZ,0DAA0D,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAChF,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YAChF,MAAM,GAAG,CAAC,YAAY,EAAE,kDAAkD,CAAC,CAAC;QAC9E,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC;IAC9C,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;QAEzC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,aAAa,GAAG,MAAM,EAAE,WAAW,EAAE,EAAE,CAAC;YAC9C,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACtC,SAAS;YACX,CAAC;YAED,IAAI,cAAc,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;gBACtC,MAAM,GAAG,CACP,SAAS,EACT,uFAAuF,CACxF,CAAC;YACJ,CAAC;YACD,cAAc,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;AACH,CAAC"}

package/server/src/android.ts

@@ -5,8 +5,8 @@ type BuildAndroidContext = {
   ttlSeconds?: number;
 };
 
-function toAndroidPriority(priority: NotifyKitOptions['androidPriority']): 'HIGH' | 'NORMAL' {
-  return priority === 'normal' ? 'NORMAL' : 'HIGH';
+function toAndroidPriority(priority: NotifyKitOptions['androidPriority']): 'high' | 'normal' {
+  return priority === 'normal' ? 'normal' : 'high';
 }
 
 export function buildAndroidPayload(
@@ -18,10 +18,10 @@ export function buildAndroidPayload(
     priority: toAndroidPriority(options.androidPriority),
   };
   if (context.collapseKey !== undefined) {
-    output.collapse_key = context.collapseKey;
+    output.collapseKey = context.collapseKey;
   }
   if (context.ttlSeconds !== undefined) {
-    output.ttl = `${context.ttlSeconds}s`;
+    output.ttl = context.ttlSeconds * 1000;
   }
   return output;
 }

package/server/src/validation.ts

@@ -131,4 +131,24 @@ export function validateInput(input: NotifyKitPayloadInput): void {
       throw err('Validation', "'options.collapseKey' must be a non-empty string");
     }
   }
+
+  const actions = notification.android?.actions;
+  if (Array.isArray(actions)) {
+    const pressActionIds = new Set<string>();
+
+    for (const action of actions) {
+      const pressActionId = action?.pressAction?.id;
+      if (typeof pressActionId !== 'string') {
+        continue;
+      }
+
+      if (pressActionIds.has(pressActionId)) {
+        throw err(
+          'Android',
+          "'notification.android.actions' pressAction IDs must be unique within the notification",
+        );
+      }
+      pressActionIds.add(pressActionId);
+    }
+  }
 }

package/src/NotifeeApiModule.ts

@@ -602,6 +602,7 @@ export default class NotifeeApiModule extends NotifeeNativeModule implements Mod
             ios,
             android: {
               alarm: AndroidNotificationSetting.ENABLED,
+              fullScreenIntent: AndroidNotificationSetting.ENABLED,
             },
             web: {},
           };
@@ -614,6 +615,7 @@ export default class NotifeeApiModule extends NotifeeNativeModule implements Mod
       authorizationStatus: AuthorizationStatus.NOT_DETERMINED,
       android: {
         alarm: AndroidNotificationSetting.ENABLED,
+        fullScreenIntent: AndroidNotificationSetting.ENABLED,
       },
       ios: {
         alert: 1,
@@ -725,6 +727,7 @@ export default class NotifeeApiModule extends NotifeeNativeModule implements Mod
             ios,
             android: {
               alarm: AndroidNotificationSetting.ENABLED,
+              fullScreenIntent: AndroidNotificationSetting.ENABLED,
             },
             web: {},
           };
@@ -737,6 +740,7 @@ export default class NotifeeApiModule extends NotifeeNativeModule implements Mod
       authorizationStatus: AuthorizationStatus.NOT_DETERMINED,
       android: {
         alarm: AndroidNotificationSetting.ENABLED,
+        fullScreenIntent: AndroidNotificationSetting.ENABLED,
       },
       ios: {
         alert: 1,

package/src/internal/fcmContract.d.ts

@@ -55,7 +55,7 @@ export type NotifyKitIosConfig = {
 export type NotifyKitNotification = {
   /**
    * Optional notification identifier. When provided, it is also used as the
-   * FCM collapse key (Android `collapse_key`, iOS `apns-collapse-id`) unless
+   * FCM collapse key (Android `collapseKey`, iOS `apns-collapse-id`) unless
    * `options.collapseKey` is explicitly set. Collapse key precedence (Rule 7):
    *   1. `options.collapseKey` if set
    *   2. `notification.id` if set
@@ -92,9 +92,9 @@ export type NotifyKitPayloadInput = {
 export type ApnsInterruptionLevel = 'passive' | 'active' | 'time-sensitive' | 'critical';
 
 export type NotifyKitAndroidOutput = {
-  priority: 'HIGH' | 'NORMAL';
-  collapse_key?: string;
-  ttl?: string;
+  priority: 'high' | 'normal';
+  collapseKey?: string;
+  ttl?: number;
 };
 
 export type NotifyKitApnsAps = {
@@ -125,10 +125,12 @@ export type NotifyKitApnsOutput = {
   payload: NotifyKitApnsPayload;
 };
 
-export type NotifyKitPayloadOutput = {
-  token?: string;
-  topic?: string;
-  condition?: string;
+type NotifyKitPayloadTarget =
+  | { token: string; topic?: never; condition?: never }
+  | { topic: string; token?: never; condition?: never }
+  | { condition: string; token?: never; topic?: never };
+
+export type NotifyKitPayloadOutput = NotifyKitPayloadTarget & {
   data: Record<string, string>;
   android: NotifyKitAndroidOutput;
   apns: NotifyKitApnsOutput;

package/src/types/Notification.ts

@@ -277,7 +277,8 @@ export interface NotificationPressAction {
 /**
  * The interface used to describe a full-screen action for a notification.
  *
- * By setting a `fullScreenAction`, when the notification is displayed, it will launch a full-screen intent.
+ * Setting a `fullScreenAction` configures the notification to request Full-Screen Intent presentation from Android.
+ * Actual full-screen presentation depends on the app's Full-Screen Intent access and Android platform conditions.
  *
  * On Android; when provided to a notification action, the action will only open you application if
  * a `launchActivity` and/or a `mainComponent` is provided.

package/src/types/NotificationAndroid.ts

@@ -62,9 +62,9 @@ export interface NotificationAndroid {
   autoCancel?: boolean;
 
   /**
-   * Overrides the current number of active notifications shown on the device.
-   *
-   * If no number is provided, the system displays the current number of active notifications.
+   * Sets the number associated with this notification. Compatible Android launchers may use it for
+   * the app icon badge, but numeric display is launcher-dependent and it is not equivalent to the
+   * global iOS `notifee.setBadgeCount()` API.
    */
   badgeCount?: number;
 
@@ -276,8 +276,10 @@ export interface NotificationAndroid {
   pressAction?: NotificationPressAction | null;
 
   /**
-   * The `fullScreenAction` property allows you to show a custom UI
-   * in full screen when the notification is displayed.
+   * The `fullScreenAction` property requests Full-Screen Intent presentation from Android
+   * when the notification is displayed.
+   *
+   * Actual full-screen presentation depends on the app's Full-Screen Intent access and Android platform conditions.
    *
    * View the [FullScreenAction](/react-native/android/behaviour#full-screen) documentation to learn
    * more.
@@ -501,6 +503,17 @@ export interface AndroidNotificationSettings {
    * View the [Trigger](/react-native/android/triggers#android-12-limitations) documentation for more information.
    */
   alarm: AndroidNotificationSetting;
+
+  /**
+   * Enum describing whether the app currently has the Android access required to use full-screen intents.
+   *
+   * API < 29 reports `ENABLED` because the later permission model does not apply. API 29–33 reflects
+   * `USE_FULL_SCREEN_INTENT`. API 34+ reflects Android's full-screen intent special app access,
+   * which may be restricted or revoked by the system, installer, or user.
+   *
+   * `ENABLED` does not guarantee that a particular notification will be presented full-screen.
+   */
+  fullScreenIntent?: AndroidNotificationSetting;
 }
 
 /**

package/src/validators/validateAndroidNotification.ts

@@ -103,6 +103,13 @@ export default function validateAndroidNotification(
       throw new Error(`'notification.android.actions' invalid AndroidAction. ${e.message}.`);
     }
 
+    const pressActionIds = new Set<string>(actions.map(action => action.pressAction.id));
+    if (pressActionIds.size !== actions.length) {
+      throw new Error(
+        "'notification.android.actions' pressAction IDs must be unique within the notification.",
+      );
+    }
+
     if (actions.length) {
       out.actions = actions;
     }

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '10.4.9';
+export const version = '10.6.0';