expo-notification-service-extension-plugin/types/types.ts

Expo plugin that expects a notification service extension file as an input and copies it to XCode binaries

/**
 * NSEPluginProps refer to the properties set by the user in their app config file (e.g: app.json)
 */
export type NSEPluginProps = {
    /**
     * (required) Used to configure APNs environment entitlement. "development" or "production"
     */
    mode: Mode;

    /**
     * (required) The local path to a custom Notification Service Extension (NSE), written in Objective-C. The NSE will typically start as a copy
     * of the default NSE found at (support/serviceExtensionFiles/NotificationService.m, then altered to support any custom
     * logic required.
     */
    iosNSEFilePath: string;


    /**
     * (optional) This will enable the Notification Service Extension to filter and modify incoming push notifications before they
     * appear on the user's device. Requires com.apple.developer.usernotifications.filtering entitlement.
     */
    filtering: boolean;

    /**
     * (optional) Used to configure Apple Team ID. You can find your Apple Team ID by running expo credentials:manager e.g: "91SW8A37CR"
     */
    devTeam?: string;

    /**
     * (optional) Target IPHONEOS_DEPLOYMENT_TARGET value to be used when adding the iOS NSE. A deployment target is nothing more than
     * the minimum version of the operating system the application can run on. This value should match the value in your Podfile e.g: "12.0".
     */
    iPhoneDeploymentTarget?: string;
};

export const NSE_PLUGIN_PROPS: string[] = [
    "mode",
    "iosNSEFilePath",
    "filtering",
    "devTeam",
    "iPhoneDeploymentTarget"
];

export enum Mode {
    Dev = "development",
    Prod = "production"
}