react-native-notify-kit 10.1.0 → 10.2.0

package/src/types/Notification.ts

@@ -192,7 +192,7 @@ export interface TriggerNotification {
 }
 
 /**
- * An interface representing a Notifee event.
+ * An interface representing a Notify Kit event.
  *
  * View the [Events](/react-native/events) documentation to learn more about foreground and
  * background events.

package/src/types/NotificationIOS.ts

@@ -79,25 +79,20 @@ export interface NotificationIOS {
   threadId?: string;
 
   /**
-   * The argument that is inserted in the IOSCategory.summaryFormat for this notification.
-   *
-   * See `IOSCategory.summaryFormat`.
+   * Kept for compatibility. No-op on supported iOS versions because notification summary
+   * arguments are ignored by iOS 15+.
    *
    * @platform ios iOS >= 12
+   * @deprecated May be removed in a future major release.
    */
   summaryArgument?: string;
 
   /**
-   * A number that indicates how many items in the summary are being represented.
-   *
-   * For example if a messages app sends one notification for 3 new messages in a group chat,
-   * the summaryArgument could be the name of the group chat and the summaryArgumentCount should be 3.
-   *
-   * If set, value cannot be 0 or less.
-   *
-   * See `IOSCategory.summaryFormat`.
+   * Kept for compatibility. No-op on supported iOS versions because notification summary
+   * arguments are ignored by iOS 15+.
    *
    * @platform ios iOS >= 12
+   * @deprecated May be removed in a future major release.
    */
   summaryArgumentCount?: number;
 
@@ -113,7 +108,7 @@ export interface NotificationIOS {
   /**
    * Optional property to customise how notifications are presented when the app is in the foreground.
    *
-   * By default, Notifee will show iOS notifications in heads-up mode if your app is currently in the foreground.
+   * By default, Notify Kit will show iOS notifications in heads-up mode if your app is currently in the foreground.
    */
   foregroundPresentationOptions?: IOSForegroundPresentationOptions;
 
@@ -147,7 +142,7 @@ export interface IOSCommunicationInfoPerson {
 /**
  * An interface to customise how notifications are shown when the app is in the foreground.
  *
- * By default, Notifee will show iOS notifications in heads-up mode if your app is currently in the foreground.
+ * By default, Notify Kit will show iOS notifications in heads-up mode if your app is currently in the foreground.
  *
  * View the [Foreground Notifications](/react-native/ios/appearance#foreground-notifications) to learn
  * more.
@@ -180,8 +175,6 @@ export interface IOSForegroundPresentationOptions {
   /**
    * Present the notification as a banner
    *
-   * For iOS 13 and lower, will be equivalent to setting `alert` to true
-   *
    * Defaults to true
    */
   banner?: boolean;
@@ -189,8 +182,6 @@ export interface IOSForegroundPresentationOptions {
   /**
    * Show the notification in Notification Center
    *
-   * For iOS 13 and lower, will be equivalent to setting `alert` to true
-   *
    * Defaults to true
    */
   list?: boolean;
@@ -254,18 +245,20 @@ export interface IOSNotificationPermissions {
   provisional?: boolean;
 
   /**
-   * Request permission for Siri to automatically read out notification messages over AirPods.
+   * Explicit announcement authorization requests are no longer needed because announcement
+   * authorization is included by iOS on supported versions. Kept for API compatibility.
    *
    * Defaults to false.
    *
    * @platform ios iOS >= 13
+   * @deprecated May be removed in a future major release.
    */
   announcement?: boolean;
 
   // TODO later version
   // /**
   //  * Using this permission indicates to iOS that it should display a button for in-app notification
-  //  * settings. Pressing this button when your application is open will trigger a Notifee
+  //  * settings. Pressing this button when your application is open will trigger a Notify Kit
   //  * 'ACTION_PRESS' event with a `pressAction.id` of 'notification-settings'
   //  * (or via getInitialNotification 'pressAction.id' when app launched)
   //  *
@@ -402,13 +395,28 @@ export interface IOSNotificationSettings {
 }
 
 /**
- * TODO docs, used to provide context to Siri
+ * Intent identifiers used to provide category context to Siri.
  *
  * @platform ios
  */
 export enum IOSIntentIdentifier {
+  /**
+   * Start a call intent.
+   *
+   * Maps to Apple's unified `INStartCallIntentIdentifier`.
+   */
+  START_CALL = 25,
+
+  /**
+   * @deprecated Use `START_CALL` instead. Apple deprecated the separate audio call
+   * intent identifier in favor of a unified start call identifier.
+   */
   START_AUDIO_CALL = 0,
 
+  /**
+   * @deprecated Use `START_CALL` instead. Apple deprecated the separate video call
+   * intent identifier in favor of a unified start call identifier.
+   */
   START_VIDEO_CALL = 1,
 
   SEARCH_CALL_HISTORY = 2,
@@ -487,14 +495,13 @@ export interface IOSNotificationCategory {
    */
   allowInCarPlay?: boolean;
 
-  /*
-   * Allow notifications in this category to be announced to the user
-   * via 3rd party services such as Siri.
-   *
-   * For example, if the notification can be automatically read by Siri
-   * while the user is wearing AirPods.
+  /**
+   * Kept for compatibility. No-op on supported iOS versions because announcement category
+   * options are ignored by iOS 15+.
    *
    * Defaults to `false`.
+   *
+   * @deprecated May be removed in a future major release.
    */
   allowAnnouncement?: boolean;
 
@@ -519,6 +526,14 @@ export interface IOSNotificationCategory {
    */
   hiddenPreviewsBodyPlaceholder?: string;
 
+  /**
+   * Intent identifiers used by the system to provide category context to Siri.
+   *
+   * Use `IOSIntentIdentifier.START_CALL` for call categories. Legacy
+   * `START_AUDIO_CALL` and `START_VIDEO_CALL` values remain accepted for source
+   * compatibility, but both map to Apple's unified start call intent identifier.
+   * Categories read back from iOS can return `START_CALL` for call intents.
+   */
   intentIdentifiers?: IOSIntentIdentifier[];
 
   /*
@@ -689,11 +704,11 @@ export type IOSNotificationInterruptionLevel = 'active' | 'critical' | 'passive'
  */
 export interface IOSNotificationConfig {
   /**
-   * Whether Notifee should handle remote (push) notifications on iOS.
+   * Whether Notify Kit should handle remote (push) notifications on iOS.
    *
    * When set to `false`, remote notifications (e.g. from Firebase Cloud Messaging)
    * will be forwarded to the original notification delegate instead of being
-   * processed by Notifee. This allows libraries like React Native Firebase
+   * processed by Notify Kit. This allows libraries like React Native Firebase
    * Messaging to receive tap events via `onNotificationOpenedApp()` and
    * `getInitialNotification()`.
    *

package/src/types/Trigger.ts

@@ -21,13 +21,35 @@ export interface TimestampTrigger {
    *  if set to `RepeatFrequency.HOURLY`, the notification will repeat every hour from the timestamp specified.
    *  if set to `RepeatFrequency.DAILY`, the notification will repeat every day from the timestamp specified.
    *  if set to `RepeatFrequency.WEEKLY`, the notification will repeat every week from the timestamp specified.
+   *  if set to `RepeatFrequency.MONTHLY`, the notification will repeat every calendar month from the timestamp specified.
+   *
+   * Yearly recurrence is not supported.
    */
   repeatFrequency?: RepeatFrequency;
 
+  /**
+   * Multiplier applied to `repeatFrequency` for timestamp triggers.
+   *
+   * For example, `repeatFrequency: RepeatFrequency.DAILY` with
+   * `repeatInterval: 2` repeats every 2 days. `RepeatFrequency.WEEKLY`
+   * with `repeatInterval: 2` repeats every 2 weeks, and
+   * `RepeatFrequency.MONTHLY` with `repeatInterval: 3` repeats every
+   * 3 months.
+   *
+   * Valid only when `repeatFrequency` is set to a repeating value. It is
+   * not valid without `repeatFrequency` or with `RepeatFrequency.NONE`.
+   * Must be a positive integer.
+   *
+   * Defaults to `1` when `repeatFrequency` is set.
+   */
+  repeatInterval?: number;
+
   /**
    * Choose to schedule your trigger notification with Android's AlarmManager API.
    *
-   * By default, trigger notifications are created with Android's WorkManager API.
+   * By default, timestamp trigger notifications use AlarmManager on Android. Set
+   * this to `false` to opt out to WorkManager. `RepeatFrequency.MONTHLY` is not
+   * supported when this is `false`.
    *
    * @platform android
    */
@@ -71,14 +93,36 @@ export interface TimestampTriggerAlarmManager {
 
 /**
  * An interface representing the different frequencies which can be used with `TimestampTrigger.repeatFrequency`.
+ * Supported timestamp repeat frequencies are hourly, daily, weekly, and monthly.
+ * Yearly recurrence is not supported.
  *
  * View the [Triggers](/react-native/triggers) documentation to learn more.
  */
 export enum RepeatFrequency {
+  /**
+   * Do not repeat. `TimestampTrigger.repeatInterval` cannot be used with `NONE`.
+   */
   NONE = -1,
+  /**
+   * Repeat every calendar hour from the timestamp.
+   */
   HOURLY = 0,
+  /**
+   * Repeat every calendar day from the timestamp.
+   */
   DAILY = 1,
+  /**
+   * Repeat every calendar week from the timestamp.
+   */
   WEEKLY = 2,
+  /**
+   * Repeat every calendar month from the timestamp.
+   *
+   * Use `TimestampTrigger.repeatInterval` for intervals such as every 3 months.
+   * Monthly repeats use native calendar semantics; dates that do not exist in a
+   * target month are adjusted by the platform calendar.
+   */
+  MONTHLY = 3,
 }
 
 /**

package/src/validators/validateIOSCategory.ts

@@ -110,12 +110,14 @@ export default function validateIOSCategory(
       throw new Error("'category.intentIdentifiers' expected an array value.");
     }
 
-    const identifiers = Object.values(IOSIntentIdentifier);
+    const identifiers = Object.values(IOSIntentIdentifier).filter(
+      (identifier): identifier is IOSIntentIdentifier => typeof identifier === 'number',
+    );
 
     for (let i = 0; i < category.intentIdentifiers.length; i++) {
       const intentIdentifier = category.intentIdentifiers[i];
 
-      if (!identifiers.includes(intentIdentifier)) {
+      if (typeof intentIdentifier !== 'number' || !identifiers.includes(intentIdentifier)) {
         throw new Error(
           `'category.intentIdentifiers' unexpected intentIdentifier "${intentIdentifier}" at array index "${i}".`,
         );

package/src/validators/validateTrigger.ts

@@ -9,6 +9,7 @@ import {
   isValidEnum,
   isUndefined,
   isBoolean,
+  isAndroid,
 } from '../utils';
 import {
   Trigger,
@@ -100,6 +101,33 @@ function validateTimestampTrigger(trigger: TimestampTrigger): TimestampTrigger {
     out.repeatFrequency = trigger.repeatFrequency;
   }
 
+  const hasRepeatFrequency =
+    objectHasProperty(trigger, 'repeatFrequency') && !isUndefined(trigger.repeatFrequency);
+  const isRepeating = hasRepeatFrequency && trigger.repeatFrequency !== RepeatFrequency.NONE;
+
+  if (objectHasProperty(trigger, 'repeatInterval') && !isUndefined(trigger.repeatInterval)) {
+    if (!hasRepeatFrequency) {
+      throw new Error("'trigger.repeatInterval' requires a repeatFrequency value.");
+    }
+
+    if (trigger.repeatFrequency === RepeatFrequency.NONE) {
+      throw new Error("'trigger.repeatInterval' requires a repeating repeatFrequency value.");
+    }
+
+    if (
+      !isNumber(trigger.repeatInterval) ||
+      !Number.isFinite(trigger.repeatInterval) ||
+      !Number.isInteger(trigger.repeatInterval) ||
+      trigger.repeatInterval <= 0
+    ) {
+      throw new Error("'trigger.repeatInterval' expected a positive integer value.");
+    }
+
+    out.repeatInterval = trigger.repeatInterval;
+  } else if (isRepeating) {
+    out.repeatInterval = 1;
+  }
+
   if (objectHasProperty(trigger, 'alarmManager') && !isUndefined(trigger.alarmManager)) {
     if (isBoolean(trigger.alarmManager)) {
       if (trigger.alarmManager) {
@@ -118,6 +146,16 @@ function validateTimestampTrigger(trigger: TimestampTrigger): TimestampTrigger {
     out.alarmManager = validateTimestampAlarmManager();
   }
 
+  if (
+    isAndroid &&
+    trigger.alarmManager === false &&
+    out.repeatFrequency === RepeatFrequency.MONTHLY
+  ) {
+    throw new Error(
+      "'trigger.repeatFrequency' MONTHLY is not supported when 'trigger.alarmManager' is false.",
+    );
+  }
+
   return out;
 }
 

package/src/version.ts

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