doc and changelog

urbanairship · Dec 20, 2024 · c25e011 · c25e011
1 parent e8c0c48
commit c25e011
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Airship Expo Plugin Changelog
 
+## Version 1.4.0 - December 20, 2024
+Minor version that adds support for Aiship Plugin Extender.
+
 ## Version 1.3.2 - December 13, 2024
 Patch version that fixes the Notification Service Extension for EAS builds.
 

diff --git a/README.md b/README.md
@@ -20,12 +20,16 @@ Add the plugin to the app.json:
       {
         "android":{
           "icon": "./assets/ic_notification.png",
-          "customNotificationChannels": "./assets/notification_channels.xml"
+          "customNotificationChannels": "./assets/notification_channels.xml",
+          "airshipExtender": "./assets/AirshipExtender.kt"
         },
         "ios":{
           "mode": "development",
           "notificationService": "./assets/NotificationService.swift",
-          "notificationServiceInfo": "./assets/NotificationServiceExtension-Info.plist"
+          "notificationServiceInfo": "./assets/NotificationServiceExtension-Info.plist",
+          "notificationServiceTargetName": "NotificationServiceExtension",
+          "developmentTeamID": "MY_TEAM_ID",
+          "airshipExtender": "./assets/AirshipPluginExtender.swift"
         }
       }
     ]
@@ -35,11 +39,15 @@ Add the plugin to the app.json:
 Android Config:
 - icon: Required. Local path to an image to use as the icon for push notifications. 96x96 all-white png with transparency. The name of the icon will be the resource name.
 - customNotificationChannels: Optional. The local path to a Custom Notification Channels resource file.
+- airshipExtender: Optional. The local path to a AirshipExtender.kt file.
 
 iOS Config:
 - mode: Required. The APNS entitlement. Either `development` or `production`.
-- notificationService: Optional. The local path to a custom Notification Service Extension.
+- notificationService: Optional. The local path to a custom Notification Service Extension or `DEFAULT_AIRSHIP_SERVICE_EXTENSION` for Airship's default one.
 - notificationServiceInfo: Optional. Airship will use a default one if not provided. The local path to a Notification Service Extension Info.plist.
+- notificationServiceTargetName: Optional. Defaults to NotificationServiceExtension if not provided.
+- developmentTeamID: Optional. The Apple Development Team ID used to configure the Notification Service Extension target.
+- airshipExtender: Optional. The local path to a AirshipPluginExtender.swift file.
 
 ## Calling takeOff
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "airship-expo-plugin",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "Airship Expo config plugin",
   "main": "./app.plugin.js",
   "scripts": {

diff --git a/plugin/src/withAirship.ts b/plugin/src/withAirship.ts
@@ -15,7 +15,9 @@ export type AirshipAndroidPluginProps = {
    * Optional. The local path to a Custom Notification Channels resource file.
    */
   customNotificationChannels?: string;
-
+  /**
+   * Optional. The local path to a AirshipExtender.kt file.
+   */
   airshipExtender?: string;
 };
 
@@ -41,7 +43,9 @@ export type AirshipIOSPluginProps = {
    * Optional. The Apple Development Team ID used to configure the Notification Service Extension target.
    */
   developmentTeamID?: string;
-
+  /**
+   * Optional. The local path to a AirshipPluginExtender.swift file.
+   */
   airshipExtender?: string;
 }